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) Easy Ship API section:
| Datatype | Description |
|---|---|
| Dimensions | The dimensions of the scheduled package. |
| InvoiceData | Invoice number and date. |
| Item | Item ID and serial number information. |
| Package | Information about a scheduled package. |
| PackageRequestDetails | Information for scheduling a package. |
| PickupSlot | Pickup slot ID and pickup time information. |
| ScheduledPackageId | Identifies the scheduled package to be updated. |
| ScheduledPackageUpdateDetails | Information for updating a package. |
| Weight | The weight of the scheduled package. |
The dimensions of the scheduled package.
| Name | Description | Required | Values |
|---|---|---|---|
| Length | The length dimension. | Yes | A decimal greater than zero. Type: xs:decimal |
| Width | The width dimension. | Yes | A decimal greater than zero. Type: xs:decimal |
| Height | The height dimension. | Yes | A decimal greater than zero. Type: xs:decimal |
| Unit | The unit of measurement. | Yes | Unit values: "cm" Type: xs:string |
| Name | Identifier for custom package dimensions. | No | Type: xs:string |
Invoice number and date.
| Name | Description | Required | Values |
|---|---|---|---|
| InvoiceNumber | The invoice number. | Yes | Type: xs:string |
| InvoiceDate | The date that the invoice was generated. | No | Type: xs:dateTime |
Item ID and serial number information.
| Name | Description | Required | Values |
|---|---|---|---|
| OrderItemId | The Amazon-defined order item identifier. | Yes | Type: xs:string |
| OrderItemSerialNumberList | A list of serial numbers for the items associated with the OrderItemId value. | Yes | Type: xs:string |
Information about a scheduled package.
| Name | Description | Required | Values |
|---|---|---|---|
| ScheduledPackageId | Identifies the scheduled package to be updated. | Yes | Type: ScheduledPackageId |
| PackageDimensions | The dimensions of the scheduled package. | Yes | Type: Dimensions |
| PackageWeight | The weight of the scheduled package. | Yes | Type: Weight |
| PackageItemsList | Item ID and serial number information. | No | List of Item |
| PackagePickupSlot | Pickup slot ID and pickup time information. | Yes | Type: PickupSlot |
| PackageIdentifier | Optional seller-created identifier that is printed on the shipping label to help the seller identify the package. | No | Type: xs:string |
| Invoice | Invoice number and date. | No | Type: InvoiceData |
| PackageStatus | The status of the package. | No | PackageStatus values:
Type: xs:string |
Information for scheduling a package.
| Name | Description | Required | Values |
|---|---|---|---|
| PackageDimensions | The dimensions of the scheduled package. | No | Type: Dimensions |
| PackageWeight | The weight of the scheduled package. | No | Type: Weight |
| PackageItemList | Item ID and serial number information. Amazon generates a warranty document only if PackageItemList is specified. For retrieving warranty documents, see How to get invoice, shipping label, and warranty documents. | No | List of Item |
| PackagePickupSlot | Pickup slot ID and pickup time information. | Yes | Default: First available pickup slot. Type: PickupSlot |
| PackageIdentifier | Optional seller-created identifier that is printed on the shipping label to help the seller identify the package. | No | Type: xs:string |
Pickup slot ID and pickup time information.
| Name | Description | Required | Values |
|---|---|---|---|
| SlotId | An Amazon-defined identifier for a pickup slot. Get this from a previous call to ListPickupSlots. | Yes | Type: xs:string |
| PickupTimeStart | The start of the pickup time slot. | No | Type: xs:dateTime |
| PickupTimeEnd | The end of the pickup time slot. | No | Type: xs:dateTime |
Identifies the scheduled package to be updated.
| Name | Description | Required | Values |
|---|---|---|---|
| AmazonOrderId | An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship. | Yes | Type: xs:string |
| PackageId | An Amazon-defined identifier for the scheduled package. | No | Type: xs:string |
Information for updating a package.
| Name | Description | Required | Values |
|---|---|---|---|
| ScheduledPackageId | Identifies the scheduled package to be updated. Returned by a previous call to the CreateScheduledPackage operation. | Yes | Type: ScheduledPackageId |
| PackagePickupSlot | Pickup slot ID and pickup time information. Returned by a previous call to the ListPickupSlots operation. | Yes | Type: PickupSlot |
The weight of the scheduled package.
| Name | Description | Required | Values |
|---|---|---|---|
| Value | The weight of the package. | Yes | Type: xs:decimal |
| Unit | The unit of measurement used for weight. | Yes | Unit values: g
(for grams) Type: xs:string |