Shipment Invoicing API v0 Reference
Retrieve shipment invoice information for Fulfillment by Amazon (FBA) orders in the Brazil marketplace.
Overview
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.
Version information
Version : v0
Contact information
Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html
License information
License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0
URI scheme
BasePath : /
Schemes : HTTPS
Consumes
application/json
Produces
application/json
Operations
getShipmentDetails
submitInvoice
getInvoiceStatus
Paths
GET /fba/outbound/brazil/v0/shipments/{shipmentId}
Operation: getShipmentDetails
Description
Returns the shipment details required to issue an invoice for the specified shipment.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 1.133 | 25 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | shipmentId required | 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. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentDetailsResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentDetailsResponse |
| 401 | The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentDetailsResponse |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentDetailsResponse |
| 404 | The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentDetailsResponse |
| 415 | The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentDetailsResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentDetailsResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentDetailsResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentDetailsResponse |
POST /fba/outbound/brazil/v0/shipments/{shipmentId}/invoice
Operation: submitInvoice
Description
Submits a shipment invoice document for a given shipment.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 1.133 | 25 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | shipmentId required | The identifier for the shipment. | string |
| Body | body required | The request schema for the submitInvoice operation. | SubmitInvoiceRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | SubmitInvoiceResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | SubmitInvoiceResponse |
| 401 | The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | SubmitInvoiceResponse |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | SubmitInvoiceResponse |
| 404 | The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | SubmitInvoiceResponse |
| 415 | The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | SubmitInvoiceResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | SubmitInvoiceResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | SubmitInvoiceResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | SubmitInvoiceResponse |
GET /fba/outbound/brazil/v0/shipments/{shipmentId}/invoice/status
Operation: getInvoiceStatus
Description
Returns the invoice status for the shipment you specify.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 1.133 | 25 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | shipmentId required | The shipment identifier for the shipment. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetInvoiceStatusResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetInvoiceStatusResponse |
| 401 | The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetInvoiceStatusResponse |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetInvoiceStatusResponse |
| 404 | The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetInvoiceStatusResponse |
| 415 | The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetInvoiceStatusResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetInvoiceStatusResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetInvoiceStatusResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetInvoiceStatusResponse |
Definitions
GetShipmentDetailsResponse
The response schema for the getShipmentDetails operation.
| Name | Description | Schema |
|---|---|---|
| payload optional | The payload for the getShipmentDetails operation | ShipmentDetail |
| errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
ShipmentDetail
The information required by a selling partner to issue a shipment invoice.
| Name | Description | Schema |
|---|---|---|
| WarehouseId optional | The Amazon-defined identifier for the warehouse. | string |
| AmazonOrderId optional | The Amazon-defined identifier for the order. | string |
| AmazonShipmentId optional | The Amazon-defined identifier for the shipment. | string |
| PurchaseDate optional | The date and time when the order was created. | string (date-time) |
| ShippingAddress optional | The shipping address details of the shipment. | Address |
| PaymentMethodDetails optional | The list of payment method details. | PaymentMethodDetailItemList |
| MarketplaceId optional | The identifier for the marketplace where the order was placed. | string |
| SellerId optional | The seller identifier. | string |
| BuyerName optional | The name of the buyer. | string |
| BuyerCounty optional | The county of the buyer. | string |
| BuyerTaxInfo optional | Tax information about the buyer. | BuyerTaxInfo |
| MarketplaceTaxInfo optional | Tax information about the marketplace. | MarketplaceTaxInfo |
| SellerDisplayName optional | The seller’s friendly name registered in the marketplace. | string |
| ShipmentItems optional | A list of shipment items. | ShipmentItems |
Address
The shipping address details of the shipment.
| Name | Description | Schema |
|---|---|---|
| Name optional | The name. | string |
| AddressLine1 optional | The street address. | string |
| AddressLine2 optional | Additional street address information, if required. | string |
| AddressLine3 optional | Additional street address information, if required. | string |
| City optional | The city. | string |
| County optional | The county. | string |
| District optional | The district. | string |
| StateOrRegion optional | The state or region. | string |
| PostalCode optional | The postal code. | string |
| CountryCode optional | The country code. | string |
| Phone optional | The phone number. | string |
| AddressType optional | The shipping address type. | AddressTypeEnum |
AddressTypeEnum
The shipping address type.
Type : enum
| Value | Description |
|---|---|
| Residential | The address type is residential. |
| Commercial | The address type is commercial. |
PaymentMethodDetailItemList
The list of payment method details.
Type : < string > array
BuyerTaxInfo
Tax information about the buyer.
| Name | Description | Schema |
|---|---|---|
| CompanyLegalName optional | The legal name of the company. | string |
| TaxingRegion optional | The country or region imposing the tax. | string |
| TaxClassifications optional | The list of tax classifications. | TaxClassificationList |
MarketplaceTaxInfo
Tax information about the marketplace.
| Name | Description | Schema |
|---|---|---|
| CompanyLegalName optional | The legal name of the company. | string |
| TaxingRegion optional | The country or region imposing the tax. | string |
| TaxClassifications optional | The list of tax classifications. | TaxClassificationList |
TaxClassificationList
The list of tax classifications.
Type : < TaxClassification > array
TaxClassification
The tax classification for the entity.
| Name | Description | Schema |
|---|---|---|
| Name optional | The type of tax. | string |
| Value optional | The entity's tax identifier. | string |
ShipmentItems
A list of shipment items.
Type : < ShipmentItem > array
ShipmentItem
The shipment item information required by a seller to issue a shipment invoice.
| Name | Description | Schema |
|---|---|---|
| ASIN optional | The Amazon Standard Identification Number (ASIN) of the item. | string |
| SellerSKU optional | The seller SKU of the item. | string |
| OrderItemId optional | The Amazon-defined identifier for the order item. | string |
| Title optional | The name of the item. | string |
| QuantityOrdered optional | The number of items ordered. | number |
| ItemPrice optional | The selling price of the item multiplied by the quantity ordered. Note that ItemPrice excludes ShippingPrice and GiftWrapPrice. | Money |
| ShippingPrice optional | The shipping price of the item. | Money |
| GiftWrapPrice optional | The gift wrap price of the item. | Money |
| ShippingDiscount optional | The discount on the shipping price. | Money |
| PromotionDiscount optional | The total of all promotional discounts in the offer. | Money |
| SerialNumbers optional | The list of serial numbers. | SerialNumbersList |
Money
The currency type and amount.
| Name | Description | Schema |
|---|---|---|
| CurrencyCode optional | Three-digit currency code in ISO 4217 format. | string |
| Amount optional | The currency amount. | string |
SerialNumbersList
The list of serial numbers.
Type : < string > array
ErrorList
A list of error responses returned when a request is unsuccessful.
Type : < Error > array
Error
An error response returned when the request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| code required | An error code that identifies the type of error that occurred. | string |
| message required | A message that describes the error condition. | string |
| details optional | Additional details that can help the caller understand or fix the issue. | string |
SubmitInvoiceRequest
The request schema for the submitInvoice operation.
| Name | Description | Schema |
|---|---|---|
| InvoiceContent required | Shipment invoice document content. | Blob |
| MarketplaceId optional | An Amazon marketplace identifier. | string |
| ContentMD5Value required | MD5 sum for validating the invoice data. For more information about calculating this value, see Working with Content-MD5 Checksums. | string |
Blob
Shipment invoice document content.
Type : string (byte)
SubmitInvoiceResponse
The response schema for the submitInvoice operation.
| Name | Description | Schema |
|---|---|---|
| errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
ShipmentInvoiceStatusInfo
The shipment invoice status information.
| Name | Description | Schema |
|---|---|---|
| AmazonShipmentId optional | The Amazon-defined shipment identifier. | string |
| InvoiceStatus optional | The shipment invoice status. | ShipmentInvoiceStatus |
ShipmentInvoiceStatus
The shipment invoice status.
Type : enum
| Value | Description |
|---|---|
| Processing | The invoice validation process is in progress. |
| Accepted | The invoice validation process succeeded, and the invoice was successfully ingested. |
| Errored | The invoice validation process failed. |
| NotFound | The requested invoice was not found. |
ShipmentInvoiceStatusResponse
The shipment invoice status response.
| Name | Description | Schema |
|---|---|---|
| Shipments optional | The shipment invoice status information. | ShipmentInvoiceStatusInfo |
GetInvoiceStatusResponse
The response schema for the getInvoiceStatus operation.
| Name | Description | Schema |
|---|---|---|
| payload optional | The payload for the getInvoiceStatus operation. | ShipmentInvoiceStatusResponse |
| errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
Updated 5 months ago