API docs by Redocly

Selling Partner API for Shipment Invoicing (v0)

Download OpenAPI specification:Download

URL: https://sellercentral.amazon.com/gp/mws/contactus.html

The Selling Partner API for Shipment Invoicing helps you programmatically retrieve shipment invoice information in the Brazil marketplace for a selling partner’s Fulfillment by Amazon (FBA) orders.

shipmentInvoice

getShipmentDetails

Returns the shipment details required to issue an invoice for the specified shipment.

Usage Plans:

Plan type Rate (requests per second) Burst
Default 1.133 25
Selling partner specific Variable Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

path Parameters
shipmentId
required
string

The identifier for the shipment. Get this value from the FBAOutboundShipmentStatus notification. For information about subscribing to notifications, see the Notifications API Use Case Guide.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

submitInvoice

Submits a shipment invoice document for a given shipment.

Usage Plans:

Plan type Rate (requests per second) Burst
Default 1.133 25
Selling partner specific Variable Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

path Parameters
shipmentId
required
string

The identifier for the shipment.

Request Body schema: application/json
InvoiceContent
required
string

Shipment invoice document content.

MarketplaceId
string

An Amazon marketplace identifier.

ContentMD5Value
required
string

MD5 sum for validating the invoice data. For more information about calculating this value, see Working with Content-MD5 Checksums.

Responses

Request samples

Content type
application/json
{
  • "InvoiceContent": "string",
  • "MarketplaceId": "string",
  • "ContentMD5Value": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getInvoiceStatus

Returns the invoice status for the shipment you specify.

Usage Plans:

Plan type Rate (requests per second) Burst
Default 1.133 25
Selling partner specific Variable Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

path Parameters
shipmentId
required
string

The shipment identifier for the shipment.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}