Amazon Marketplace Web Service (MWS) will no longer be available after March 31, 2024. All MWS developers must migrate to Selling Partner API (SP-API) to avoid service disruptions. Refer to the Migration Hub for more information.
The following datatypes are used in the request parameters and response elements of the Amazon Marketplace Web Service (Amazon MWS) Shipment Invoicing API section:
| Datatype | Description |
|---|---|
| Address | The shipping address of the order. |
| BuyerTaxInfo | Tax information about the buyer. |
| MarketplaceTaxInfo | Tax information about the marketplace. |
| Money | Currency type and amount. |
| PaymentMethodDetails | A list of payment methods for the order. |
| SerialNumbers | A list of serial numbers that matches the number of items ordered. |
| ShipmentDetail | The information required by a seller to generate a shipment invoice. |
| Shipment | The invoice processing status for a shipment. |
| ShipmentItem | The item information required by a seller to generate a shipment invoice. |
| TaxClassification | The tax classification for the entity. |
The shipping address of the order.
| Name | Description | Required | Values |
|---|---|---|---|
| Name | The name. | Yes | Type: xs:string |
| AddressLine1 | The street address. | No | Type: xs:string |
| AddressLine2 | Additional street address information, if required. | No | Type: xs:string |
| AddressLine3 | Additional street address information, if required. | No | Type: xs:string |
| City | The city. | No | Type: xs:string |
| County | The county. | No | Type: xs:string |
| District | The district. | No | Type: xs:string |
| StateOrRegion | The state or region. | No | Type: xs:string |
| PostalCode | The postal code. | No | Type: xs:string |
| CountryCode | The country code. | No | A two-character country code, in ISO 3166-1 alpha-2
format. Type: xs:string |
| Phone | The phone number. | No. Not returned for Fulfillment by Amazon (FBA) orders. | Type: xs:string |
| AddressType | Indicates whether the address is commercial or
residential. This element is used only in the US marketplace. |
No | AddressType values:
Commercial,
Residential Type: xs:string |
Tax information about the buyer.
| Name | Description | Required | Values |
|---|---|---|---|
| CompanyLegalName | The legal name of the company. | No | Type: xs:string |
| TaxingRegion | The country or region imposing the tax. | No | Type: xs:string |
| TaxClassifications | The list of tax classifications. | No | Type: TaxClassification |
Tax information about the marketplace.
| Name | Description | Required | Values |
|---|---|---|---|
| CompanyLegalName | The legal name of the company. | No | Type: xs:string |
| TaxingRegion | The country or region imposing the tax. | No | Type: xs:string |
| TaxClassifications | The list of tax classifications. | No | Type: TaxClassification |
Currency type and amount.
| Name | Description | Required | Values |
|---|---|---|---|
| CurrencyCode | Three-digit currency code. In ISO 4217 format . | No | Type: xs:string |
| Amount | The currency amount. | No | Type: xs:string |
A list of payment methods for the order.
| Name | Description | Required | Values |
|---|---|---|---|
| PaymentMethodDetail | A payment method for the order. For example, GiftCertificate or CreditCard. | No | Type: xs:string |
A list of serial numbers that matches the number of items ordered.
| Name | Description | Required | Values |
|---|---|---|---|
| SerialNumber | The serial number of the item. | No | Type: xs:string |
The information required by a seller to generate a shipment invoice.
| Name | Description | Required | Values |
|---|---|---|---|
| AmazonOrderId | The Amazon-defined identifier for the order. | Yes | Type: xs:string |
| AmazonShipmentId | The Amazon-defined identifier for the shipment. | Yes | Type: xs:string |
| SellerId | An anonymized identifier for the seller in the marketplace that the order was placed. | Yes | Type: xs:string |
| PurchaseDate | The date when the order was created. | Yes | Type: xs:dateTime |
| ShippingAddress | The shipping address for the order. | No | Type: Address |
| PaymentMethodDetails | A list of payment methods for the order. | No | Type: PaymentMethodDetails |
| MarketplaceId | An anonymized identifier for the marketplace where the order was placed. | Yes | Type: xs:string |
| BuyerName | The name of the buyer. | No | Type: xs:string |
| BuyerCounty | The county of the buyer. | No. This element is used only in the Brazil marketplace. | Type: xs:string |
| BuyerCounty | The county of the buyer. | No. This element is used only in the Brazil marketplace. | Type: xs:string |
| BuyerTaxInfo | Tax information about the buyer. | Yes | Type: BuyerTaxInfo |
| MarketplaceTaxInfo | Tax information about the marketplace. | No. This element is used only in the Brazil marketplace. | Type: MarketplaceTaxInfo |
| SellerDisplayName | The seller’s friendly name registered in the marketplace. | Yes | Type: xs:string |
| ShipmentItems | A list of shipment items. | Yes | Type: List of ShipmentItem |
| WarehouseId | The Amazon-defined identifier for the warehouse. | No | Type: xs:string |
The invoice processing status for a shipment.
| Name | Description | Required | Values |
|---|---|---|---|
| AmazonShipmentId | An Amazon-defined identifier for the shipment. | Yes | Type: xs:string |
| InvoiceStatus | The status of the invoice submission for the shipment. | Yes | InvoiceStatus values:
Processing,
Accepted,
NotFound,
Errored Type: xs:string |
The item information required by a seller to generate a shipment invoice.
| Name | Description | Required | Values |
|---|---|---|---|
| ASIN | The Amazon Standard Identification Number (ASIN) of the item. | Yes | Type: xs:string |
| SellerSKU | The seller SKU of the item. | No | Type: xs:string |
| OrderItemId | The Amazon-defined identifier for the order item. | Yes | Type: xs:string |
| Title | The name of the item. | No | Type: xs:string |
| QuantityOrdered | The number of items in the order. | Yes | Type: xs:int |
| ItemPrice | The selling price of the item multiplied by the quantity ordered. Note that ItemPrice excludes ShippingPrice and GiftWrapPrice. | No | Type: Money |
| ShippingPrice | The shipping price of the item. | No | Type: Money |
| GiftWrapPrice | The gift wrap price of the item. | No | Type: Money |
| ShippingDiscount | The discount on the shipping price. | No | Type: Money |
| PromotionDiscount | The total of all promotional discounts in the offer. | No | Type: Money |
| SerialNumbers | A list of serial numbers that matches the number of items ordered. | No | Type: SerialNumbers |
The tax classification for the entity.
| Name | Description | Required | Values |
|---|---|---|---|
| Name | The type of tax. | Yes | Type: xs:string |
| Value | The entity's tax identifier. | Yes | Type: xs:string |