Sign in

v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB
Invoices v2024-06-19

createGovernmentInvoice

Submits an asynchronous government invoice creation request.

Usage Plan:

Rate (requests per second)Burst
0.01671

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

post/tax/invoices/2024-06-19/governmentInvoiceRequests

Request body

inboundPlanIdstring

The unique InboundPlan identifier in which the shipment is contained and for which the invoice will be created.

invoiceTypestring required

Marketplace specific classification of the invoice type. Check 'invoiceType' options using 'getInvoicesAttributes' operation.

marketplaceIdstring required

The government invoices creation request will match the national authoritative source of the given marketplace.

shipmentIdstring required

The unique shipment identifier to get an invoice for.

transactionTypestring required

Marketplace specific classification of the transaction type that originated the invoice. Check 'transactionType' options using 'getInvoicesAttributes' operation.

Example request

{
  "contexts": [
    {
      "name": "testCarrier",
      "address": "An address",
      "contextType": "CarrierDetailsContext",
      "federalTaxId": "46204217000177",
      "regionCode": "SP",
      "regionTaxId": "503348865972",
      "vehicleLicensePlate": "AAA0A00",
      "vehicleRegistrationRegionCode": "SP"
    }
  ],
  "inboundPlanId": "wf44e473-3f4d-4c6d-a80b-230e644b0c39",
  "invoiceType": "REMITTANCE",
  "marketplaceId": "A2Q3Y263D00KWC",
  "shipmentId": "sh109b72-7b27-4e97-9fd1-3b56915fbc95",
  "transactionType": "INBOUND_SHIPMENT"
}

Response

Successfully submitted a government invoice creation request.