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) Fulfillment Inbound Shipment API section:
Datatype | Short description |
---|---|
Address | Postal address information. |
AmazonPrepFeesDetails | The fees for Amazon to prep goods for shipment. |
Amount | The currency code and value. |
ASINInboundGuidance | Reasons why a given ASIN is not recommended for shipment to Amazon's fulfillment network. |
ASINPrepInstructions | Item preparation instructions to help with item sourcing decisions. |
BoxContentsFeeDetails | The manual processing fee per unit and total fee for a shipment. |
BoxContentsSource | Where the seller provided box contents information for a shipment. |
Contact | Contact information for the person in your organization who is responsible for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. |
Dimensions | The dimension values and unit of measurement. |
GuidanceReason | A reason for the current inbound guidance for an item. |
InboundGuidance | Specific inbound guidance for an item. |
InboundShipmentHeader | Inbound shipment information used to create and update inbound shipments. |
InboundShipmentInfo | Information about your inbound shipments. Returned by the ListInboundShipments operation. |
InboundShipmentItem | Item information for an inbound shipment. Submitted with a call to the CreateInboundShipment or UpdateInboundShipment operation. |
InboundShipmentPlan | Inbound shipment information used to create an inbound shipment. Returned by the CreateInboundShipmentPlan operation. |
InboundShipmentPlanItem | Item information used to create an inbound shipment. Returned by the CreateInboundShipmentPlan operation. |
InboundShipmentPlanRequestItem | Item information for creating an inbound shipment plan. Submitted with a call to the CreateInboundShipmentPlan operation. |
IntendedBoxContentsSource | How the seller intends to provide box contents information for a shipment. |
InvalidASIN | An invalid ASIN and the reason it is invalid. |
InvalidSKU | An invalid Seller SKU and the reason it is invalid. |
NonPartneredLtlDataInput | Information that you provide to Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment by a carrier that has not partnered with Amazon. |
NonPartneredLtlDataOutput | Information returned by Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment shipped by a carrier that has not partnered with Amazon. |
NonPartneredSmallParcelDataInput | Information that you provide to Amazon about a Small Parcel shipment shipped by a carrier that has not partnered with Amazon. |
NonPartneredSmallParcelDataOutput | Information returned by Amazon about a Small Parcel shipment by a carrier that has not partnered with Amazon. |
NonPartneredSmallParcelPackageInput | The tracking number of the package, provided by the carrier. |
NonPartneredSmallParcelPackageOutput | Carrier, tracking number, and status information for the package. |
Pallet | Pallet information. |
PartneredEstimate | The estimated shipping cost for a shipment using an Amazon-partnered carrier. |
PartneredLtlDataInput | Information that is required by an Amazon-partnered carrier to ship a Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. |
PartneredLtlDataOutput | Information returned by Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment by an Amazon-partnered carrier. |
PartneredSmallParcelDataInput | Information that is required by an Amazon-partnered carrier to ship a Small Parcel inbound shipment. |
PartneredSmallParcelDataOutput | Information returned by Amazon about a Small Parcel shipment by an Amazon-partnered carrier. |
PartneredSmallParcelPackageInput | Dimension and weight information for the package. |
PartneredSmallParcelPackageOutput | Dimension, weight, and shipping information for the package. |
PrepDetails | A preparation instruction, and who is responsible for that preparation. |
PrepInstruction | Preparation instructions for shipping an item to Amazon's fulfillment network. |
SKUInboundGuidance | Reasons why a given Seller SKU is not recommended for shipment to Amazon's fulfillment network |
SKUPrepInstructions | Labeling requirements and item preparation instructions to help you prepare items for shipment to Amazon's fulfillment network. |
TransportContent | Inbound shipment information, including carrier details, shipment status, and the workflow status for a request for shipment with an Amazon-partnered carrier. |
TransportDetailInput | Information required to create an Amazon-partnered carrier shipping estimate, or to alert the Amazon fulfillment center to the arrival of an inbound shipment by a non-Amazon-partnered carrier. |
TransportDetailOutput | Inbound shipment information, including carrier details and shipment status. |
TransportDocument | The PDF document data and checksum for printing package labels and bills of lading. |
TransportHeader | The shipping Id, information about whether the shipment is by an Amazon-partnered carrier, and information about whether the shipment is Small Parcel or Less Than Truckload/Full Truckload (LTL/FTL). |
TransportResult | The workflow status for a shipment with an Amazon-partnered carrier. |
Weight | The weight value and unit of measurement. |
Postal address information.
The Address datatype is used in a request parameter or in a response element of the following operations:
The following table shows the elements of the Address datatype:
Name | Description | Required | Values |
---|---|---|---|
Name | The name or business name. | Yes | Maximum: 50 characters Type: xs:string |
AddressLine1 | The street address information. | Yes | Maximum: 180 characters Type: xs:string |
AddressLine2 | Additional street address information, if required. | No | Maximum: 60 characters Type: xs:string |
City | The city. | Yes | Maximum: 30 characters Type: xs:string |
DistrictOrCounty | The district or county. | No | Maximum: 25 characters Type: xs:string |
StateOrProvinceCode | The state or province code. | No If state or province codes are used in your marketplace, it is recommended that you include one with your request. This helps Amazon to select the most appropriate Amazon fulfillment center for your inbound shipment plan. |
A two-digit state or province code. Type: xs:string |
CountryCode | The country code. | Yes | A two-character country code, in ISO 3166-1 alpha-2
format. Type: xs:string |
PostalCode | The postal code. | No If postal codes are used in your marketplace, it is recommended that you include one with your request. This helps Amazon to select the most appropriate Amazon fulfillment center for your inbound shipment plan. |
Maximum: 30 characters Type: xs:string |
The fees for Amazon to prep goods for shipment.
The AmazonPrepFeesDetails datatype is used in a response element of the following operations:
The following table shows the elements of the AmazonPrepFeesDetails datatype:
Name | Description | Required | Values |
---|---|---|---|
PrepInstruction | Preparation instructions for shipping an item to Amazon's fulfillment network. | Yes | See PrepInstruction Type: xs:string |
FeePerUnit | The fee for Amazon to prepare 1 unit. | Yes | See Amount Type: Amount |
The currency code and value.
The Amount datatype is used in a request parameter or in a response element of the following operations:
The following table shows the elements of the Amount datatype:
Name | Description | Required | Values |
---|---|---|---|
CurrencyCode | The currency code. | Yes | CurrencyCode values:
In ISO 4217 format . Type: xs:string |
Value | The amount. | Yes | Type: xs:string |
Reasons why a given ASIN is not recommended for shipment to Amazon's fulfillment network.
The ASINInboundGuidance datatype is used in a response element of the following operation:
The following table shows the elements of the ASINInboundGuidance datatype:
Name | Description | Required | Values |
---|---|---|---|
ASIN | The Amazon Standard Identification Number (ASIN) of the item. | Yes | Type: xs:string |
InboundGuidance | Specific inbound guidance for an item. | Yes | Type: InboundGuidance |
GuidanceReasonList | A list of reasons for the current inbound guidance for this item. | No | Type: List of GuidanceReason |
Item preparation instructions to help with item sourcing decisions.
The ASINPrepInstructions datatype is used in a response element of the following operation:
The following table shows the elements of the ASINPrepInstructions datatype:
Name | Description |
---|---|
ASIN |
The Amazon Standard Identification Number (ASIN) of the item.
Type: xs:string |
BarcodeInstruction | Labeling requirements for the item. BarcodeInstruction values:
Type: xs:string |
PrepGuidance | Item preparation instructions. PrepGuidance values:
Type: xs:string |
PrepInstructionList | Preparation instructions for shipping items to Amazon's fulfillment network. Note: The
PrepInstructionList element contains data
only if PrepGuidance =
SeePrepInstructionsList.
Type: List of PrepInstruction |
The manual processing fee per unit and total fee for a shipment.
The BoxContentsFeeDetails datatype is used in a request parameter or in a response element of the following operations:
Where the seller provided box contents information for a shipment. This element is used only in the US marketplace.
The BoxContentsSource datatype is used in a request parameter of the following operations:
Type: xs:string
Values:
Contact information for the person in your organization who is responsible for a Less Than Truckload/Full Truckload (LTL/FTL) shipment.
The Contact datatype is used in a request parameter or in a response element of the following operations:
The following table shows the elements of the Contact datatype:
Name | Description | Required | Values |
---|---|---|---|
Name | The name of the contact person. | Yes | Maximum: 50 characters Type: xs:string |
Phone | The phone number of the contact person. | Yes | Maximum: 20 characters Type: xs:string |
The e-mail address of the contact person. | Yes | Maximum: 50 characters Type: xs:string |
|
Fax | The fax number of the contact person. | Yes | Maximum: 20 characters Type: xs:string |
The dimension values and unit of measurement.
The Dimensions datatype is used in a request parameter or in a response element of the following operations:
The following table shows the elements of the Dimensions datatype:
Name | Description | Required | Values |
---|---|---|---|
Unit | The unit of measurement for the dimensions. | Yes | Unit values:
Type: xs:string |
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 |
A reason for the current inbound guidance for an item.
The GuidanceReason datatype is used in a response element of the following operations:
Type: xs:string
Values:
Specific inbound guidance for an item.
The InboundGuidance datatype is used in a response element of the following operations:
Type: xs:string
Values:
Inbound shipment information used to create and update inbound shipments.
The InboundShipmentHeader datatype is used in a request parameter of the following operations:
The following table shows the elements of the InboundShipmentHeader datatype:
Name | Description | Required | Values |
---|---|---|---|
ShipmentName | The name you choose for your shipment. Use a naming convention that helps you distinguish between shipments over time, such as the date the shipment was created. | Yes | Type: xs:string |
ShipFromAddress | Your return address. | Yes | Type: Address |
DestinationFulfillmentCenterId | The identifier for the Amazon fulfillment center that your shipment will be shipped to. Get this identifier from the InboundShipmentPlans response element returned by the CreateInboundShipmentPlan operation. | Yes | Type: xs:string |
LabelPrepPreference | Your preference for label preparation for an inbound shipment. | Yes |
LabelPrepPreference values:
Note: Unless you are enrolled in the FBA Label Service,
SELLER_LABEL is the only valid LabelPrepPreference value. The
FBA Label Service is not available in India (IN) and is currently in beta
development in Japan (JP). For more information about the FBA Label Service, see the
Seller Central Help for your marketplace.
Default: SELLER_LABEL Type: xs:string |
AreCasesRequired | Indicates whether or not an inbound shipment contains
case-packed boxes. Note: A shipment must either contain all
case-packed boxes or all individually packed boxes.
|
No, unless the boxes in the shipment are case packed. | AreCasesRequired values:
Note: If AreCasesRequired = true
for an inbound shipment, then the value of
QuantityInCase must be greater
than zero for every item in the shipment. Otherwise the
service returns an error.
Default: false Type: xs:boolean |
ShipmentStatus | The status of your inbound shipment. | Yes | ShipmentStatus values when
InboundShipmentHeader is used with
the CreateInboundShipment operation:
The following is an additional
ShipmentStatus value when
InboundShipmentHeader is used
with the UpdateInboundShipment
operation:
Type: xs:string |
IntendedBoxContentsSource | How the seller intends to provide Carton Contents Info for this shipment. | No | This parameter is valid only in the US, Spain, UK,
France, Germany, and Italy marketplaces. Specifying
IntendedBoxContentsSource in other
marketplaces results in an
error. IntendedBoxContentsSource values: NONE, FEED, and 2D_BARCODE Default: NONE |
Information about your inbound shipments. Returned by the ListInboundShipments operation.
The InboundShipmentInfo datatype is used in a response element of the following operations:
The following table shows the elements of the InboundShipmentInfo datatype:
Name | Description | Required | Values |
---|---|---|---|
ShipmentId | The ShipmentId submitted in the request. | No | Type: xs:string |
ShipmentName | A unique name that you provide for your inbound shipment. | No | Type: xs:string |
ShipFromAddress | Your return address. | Yes | Type: Address |
DestinationFulfillmentCenterId | An Amazon fulfillment center identifier created by Amazon. | No | Type: xs:string |
LabelPrepType | The type of label preparation that is required for your inbound shipment. | No | LabelPrepType values:
Note: AMAZON_LABEL is available only
if you are enrolled in the FBA Label Service. The FBA
Label Service is not available in India
(IN) and is currently in beta development in Japan (JP).
For more information about the FBA Label Service, see
the Seller Central Help for your
marketplace.
Type: xs:string |
ShipmentStatus | The status of your inbound shipment. | No | ShipmentStatus values:
Type: xs:string |
AreCasesRequired | Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed. | Yes. | AreCasesRequired values:
Type: xs:boolean |
ConfirmedNeedByDate | Date that the shipment must arrive at an Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. For more information, see GetPreorderInfo. Pre-orders are only available in India and Japan. | No. Returned only for shipments that have been confirmed for pre-order. | In YYYY-MM-DD format. Type: xs:string |
BoxContentsSource | Where the seller provided box contents information for a shipment. This is only returned for shipments to US, Spain, UK, France, Germany, and Italy fulfillment centers. | No |
BoxContentsSource values:
NONE, FEED,
2D_BARCODE, and
INTERACTIVE
Type: BoxContentsSource |
EstimatedBoxContentsFee | An estimate of the manual processing fee charged by Amazon for boxes without box content information. This is only returned when BoxContentsSource is NONE. | No | Type: BoxContentsFeeDetails |
Item information for an inbound shipment. Submitted with a call to the CreateInboundShipment or UpdateInboundShipment operation.
The InboundShipmentItem datatype is used in a request parameter or in a response element of the following operations:
The following table shows the elements of the InboundShipmentItem datatype:
Name | Description | Required | Values |
---|---|---|---|
ShipmentId | A shipment identifier originally returned by the CreateInboundShipmentPlan operation. | No | Read-only value. Any ShipmentId input value is ignored in the
InboundShipmentItems request
parameter of the CreateInboundShipment
and UpdateInboundShipment
operations. Type: xs:string |
SellerSKU | The Seller SKU of the item. | Yes | Type: xs:string |
FulfillmentNetworkSKU | Amazon's fulfillment network SKU of the item. | No | Read-only value. Any FulfillmentNetworkSKU input value is
ignored in the InboundShipmentItems
request parameter of the
CreateInboundShipment and
UpdateInboundShipment
operations. Type: xs:string |
QuantityShipped | The item quantity that you are shipping. | Yes | Type: xs:int |
QuantityReceived | The item quantity that has been received at an Amazon fulfillment center. | No | Read-only value. Any QuantityReceived input value is ignored in
the InboundShipmentItems request
parameter of the CreateInboundShipment
and UpdateInboundShipment
operations. Type: xs:int |
QuantityInCase | The item quantity in each case, for case-packed items. Note that QuantityInCase multiplied by the number of boxes in the inbound shipment equals QuantityShipped. Also note that all of the boxes of an inbound shipment must either be case packed or individually packed. For that reason, when you submit the CreateInboundShipment or the UpdateInboundShipment operation, the value of QuantityInCase must be provided for every item in the shipment or for none of the items in the shipment. | No, unless you specified
QuantityInCase when you submitted
the CreateInboundShipmentPlan operation.
QuantityInCase is always returned by the ListShipmentItems and ListShipmentItemsByNextToken operations. If you specified AreCasesRequired = false when you submitted the CreateInboundShipment or UpdateInboundShipment operation, QuantityInCase will be returned as 0. |
If QuantityInCase is specified, its value must be a divisor of
QuantityShipped. Type: xs:int |
PrepDetailsList | A list of preparation instructions, and who is responsible for each preparation. | No | Type: List of PrepDetails |
ReleaseDate | The date that a pre-order item will be available for sale. For more information, see GetPreorderInfo. Pre-orders are only available in India and Japan. | No | In YYYY-MM-DD format. Type: xs:string |
Inbound shipment information used to create an inbound shipment. Returned by the CreateInboundShipmentPlan operation.
The InboundShipmentPlan datatype is used in a response element of the following operation:
The following table shows the elements of the InboundShipmentPlan datatype:
Name | Description | Required | Values |
---|---|---|---|
ShipmentId | A shipment identifier originally returned by the CreateInboundShipmentPlan operation. | Yes | Type: xs:string |
DestinationFulfillmentCenterId | An Amazon fulfillment center identifier created by Amazon. | Yes | Type: xs:string |
ShipToAddress | The address of the Amazon fulfillment center to ship your items to. | Yes | Type: Address |
LabelPrepType | The type of label preparation that is required for your inbound shipment. | Yes |
LabelPrepType values:
Note: AMAZON_LABEL is available only if
you are enrolled in the FBA Label Service. The FBA Label Service is currently in beta
development in Japan (JP). For more information about the FBA Label Service, see the
Seller Central Help for your marketplace.
Type: xs:string |
Items | SKU and quantity information for the items in your shipment. | Yes | Type: InboundShipmentPlanItem |
EstimatedBoxContentsFee | An estimate of the manual processing fee charged by Amazon for boxes without box content information. This is only returned when BoxContentsSource is NONE. | No | Type: BoxContentsFeeDetails |
Item information used to create an inbound shipment. Returned by the CreateInboundShipmentPlan operation.
The InboundShipmentItem datatype is used in a response element of the following operation:
The following table shows the elements of the InboundShipmentPlanItem datatype:
Name | Description | Required | Values |
---|---|---|---|
SellerSKU | The Seller SKU of the item. | Yes | One of the SellerSKU values that you included with the
CreateInboundShipmentPlan
operation. Type: xs:string |
FulfillmentNetworkSKU | Amazon's fulfillment network SKU of the item. | Yes | The FulfillmentNetworkSKU that Amazon assigned to the
item. Type: xs:string |
Quantity | The item quantity that you are shipping. | Yes | The Quantity value that you included with the item using the
CreateInboundShipmentPlan
operation. Type: xs:int |
PrepDetailsList | A list of preparation instructions, and who is responsible for each preparation. | No | Type: List of PrepDetails |
Item information for creating an inbound shipment plan. Submitted with a call to the CreateInboundShipmentPlan operation.
The InboundShipmentPlanRequestItem datatype is used in a request parameter of the following operation:
The following table shows the elements of the InboundShipmentPlanRequestItem datatype:
Name | Description | Required | Values |
---|---|---|---|
SellerSKU | The Seller SKU of the item. | Yes | Maximum: 200 Type: xs:string |
ASIN | The Amazon Standard Identification Number (ASIN) of the item. | No | A valid ASIN value. Type: xs:string |
Condition | The condition of the item. | No |
Condition values:
Type: xs:string |
Quantity | The item quantity. | Yes | Type: xs:int |
QuantityInCase | The item quantity in each case, for case-packed items. Note that QuantityInCase multiplied by the number of cases in the inbound shipment equals Quantity. Also note that all of the boxes of an inbound shipment must either be case packed or individually packed. For that reason, when you submit the CreateInboundShipmentPlan operation, the value of QuantityInCase must be provided for every item in the shipment or for none of the items in the shipment. | No | If QuantityInCase is specified, its value must be a divisor of
Quantity. Type: xs:int |
PrepDetailsList | A list of preparation instructions, and who is responsible for each preparation. | No | Type: List of PrepDetails |
How the seller intends to provide box contents information for a shipment.
The IntendedBoxContentsSource datatype is used in a request parameter of the following operations:
Type: xs:string
Values:
An invalid ASIN and the reason it is invalid.
The InvalidASIN datatype is used in a response element of the following operation:
The following table shows the elements of the InvalidASIN datatype:
Name | Description |
---|---|
ASIN |
The Amazon Standard Identification Number (ASIN) of the item.
Type: xs:string |
ErrorReason | The reason that the ASIN is
invalid. ErrorReason values:
|
An invalid Seller SKU and the reason it is invalid.
The InvalidSKU datatype is used in a response element of the following operation:
The following table shows the elements of the InvalidSKU datatype:
Name | Description |
---|---|
SellerSKU |
The Seller SKU of the item.
Type: xs:string |
ErrorReason | The reason that the Seller SKU is
invalid. ErrorReason values:
|
Information that you provide to Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment by a carrier that has not partnered with Amazon.
The NonPartneredLtlDataInput datatype is used in a request parameter of the following operation:
The following table shows the elements of the NonPartneredLtlDataInput datatype:
Name | Description | Required | Values |
---|---|---|---|
CarrierName | The carrier that you are using for your inbound shipment. | Yes | CarrierName values in the United Kingdom (UK):
CarrierName values in the United States (US):
Type: xs:string |
ProNumber | The PRO number assigned to your shipment by the carrier. | Yes | A string of numbers, seven to 10 characters in length. Type: xs:string |
Information returned by Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment shipped by a carrier that has not partnered with Amazon.
The NonPartneredLtlDataOutput datatype is used in a response element of the following operation:
The following table shows the elements of the NonPartneredLtlDataOutput datatype:
Name | Description | Required | Values |
---|---|---|---|
CarrierName | The carrier that you are using for your inbound shipment. | Yes | CarrierName values in the United Kingdom (UK):
CarrierName values in the United States (US):
Type: xs:string |
ProNumber | The PRO number assigned to your shipment by the carrier. | Yes | A string of numbers, seven to 10 characters in length. Type: xs:string |
Information that you provide to Amazon about a Small Parcel shipment shipped by a carrier that has not partnered with Amazon.
The NonPartneredSmallParcelDataInput datatype is used in a request parameter of the following operation:
The following table shows the elements of the NonPartneredSmallParcelDataInput datatype:
Name | Description | Required | Values |
---|---|---|---|
CarrierName | The carrier that you are using for your inbound shipment. | Yes | CarrierName values in the United Kingdom (UK):
CarrierName values in the United States (US):
Type: xs:string |
PackageList | A list of tracking numbers provided by the carrier. | Yes | Type: List of NonPartneredSmallParcelPackageInput |
Information returned by Amazon about a Small Parcel shipment by a carrier that has not partnered with Amazon.
The NonPartneredSmallParcelDataOutput datatype is used in a response element of the following operation:
The following table shows the elements of the NonPartneredSmallParcelDataOutput datatype:
Name | Description | Required | Values |
---|---|---|---|
PackageList | A list of packages, including carrier, tracking number, and status information for each package. | Yes | Type: List of NonPartneredSmallParcelPackageOutput |
The tracking number of the package, provided by the carrier.
The NonPartneredSmallParcelPackageInput datatype is used in a request parameter of the following operation:
The following table shows the elements of the NonPartneredSmallParcelPackageInput datatype:
Name | Description | Required | Values |
---|---|---|---|
TrackingId | The tracking number of the package, provided by the carrier. | Yes | Maximum: 30 characters Type: xs:string |
Carrier, tracking number, and status information for the package.
The NonPartneredSmallParcelPackageOutput datatype is used in a response element of the following operation:
The following table shows the elements of the NonPartneredSmallParcelPackageOutput datatype:
Name | Description | Required | Values |
---|---|---|---|
CarrierName | The carrier that you are using for your inbound shipment. | Yes | CarrierName values in the United Kingdom (UK):
CarrierName values in the United States (US):
Type: xs:string |
TrackingId | The tracking number of the package, provided by the carrier. | Yes | Maximum: 30 characters Type: xs:string |
PackageStatus | The shipment status of the package. | Yes | PackageStatus values:
Type: xs:string |
Pallet information.
The Pallet datatype is used in a request parameter or in a response element of the following operations:
The following table shows the elements of the Pallet datatype:
Name | Description | Required | Values |
---|---|---|---|
Dimensions | The dimensions of the pallet. | Yes | Length and width must be 40 inches by 48 inches. Height
must be less than or equal to 60 inches. Type: Dimensions |
Weight | The weight of the pallet. | No | Type: Weight |
IsStacked | Indicates whether pallets will be stacked when carrier arrives for pick-up. | Yes | IsStacked values:
Type: xs:boolean |
The estimated shipping cost for a shipment using an Amazon-partnered carrier.
The PartneredEstimate datatype is used in a response element of the following operation:
The following table shows the elements of the PartneredEstimate datatype:
Name | Description | Required | Values |
---|---|---|---|
Amount | The amount that the Amazon-partnered carrier will charge to ship the inbound shipment. | No. Returned only if the TransportStatus value of the inbound shipment is ESTIMATED, CONFIRMING, or CONFIRMED. |
Type: Amount |
ConfirmDeadline | The date by which this estimate must be confirmed. After this date the estimate is no longer valid and cannot be confirmed. | No. Returned only if the TransportStatus value of the inbound shipment is ESTIMATED. |
In ISO 8601 date time format. Type: xs:dateTime |
VoidDeadline | The date after which a confirmed transportation request can no longer be voided. This date is 24 hours after you confirm a Small Parcel shipment transportation request or one hour after you confirm a Less Than Truckload/Full Truckload (LTL/FTL) shipment transportation request. After the void deadline passes your account will be charged for the shipping cost. | No. Returned only if the TransportStatus value of the inbound shipment is CONFIRMED. |
In ISO 8601 date time format. Type: xs:dateTime |
Information that is required by an Amazon-partnered carrier to ship a Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment.
The PartneredLtlDataInput datatype is used in a request parameter of the following operation:
The following table shows the elements of the PartneredLtlDataInput datatype:
Name | Description | Required | Values |
---|---|---|---|
Contact | Contact information for the person in your organization who is responsible for the shipment. Used by the carrier if they have questions about the shipment. | Yes | Type: Contact |
BoxCount | The number of boxes in the shipment. | Yes | Type: xs:int |
SellerFreightClass | The freight class of the shipment. For information about determining the freight class, contact your carrier. | No. If you do not provide the freight class, Amazon will estimate the freight class based on the contents of the shipment. |
SellerFreightClass values:
50, 55, 60,
65, 70,
77.5, 85,
92.5, 100,
110, 125,
150, 175,
200, 250,
300, 400,
500 Type: xs:string |
FreightReadyDate | The date that the shipment will be ready to be picked up by the carrier. | Yes | At least two days after the date that the request is made. Must be in YYYY-MM-DD format. Type: xs:string |
PalletList | A list of pallet descriptions. | No | Type: List of Pallet |
TotalWeight | The total weight of the shipment. | No | Type: Weight |
SellerDeclaredValue | Your declaration of the total value of the inventory in the shipment. | No | Type: Amount |
Information returned by Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment by an Amazon-partnered carrier.
The PartneredLtlDataOutput datatype is used in a response element of the following operation:
The following table shows the elements of the PartneredLtlDataOutput datatype:
Name | Description | Required | Values |
---|---|---|---|
Contact | Contact information for the person in your organization who is responsible for the shipment. Used by the carrier if they have questions about the shipment. | Yes | Type: Contact |
BoxCount | The number of boxes in the shipment. | Yes | Type: xs:int |
SellerFreightClass | The freight class of the shipment. For information about determining the freight class, contact your carrier. | No. If you do not provide the freight class, Amazon will estimate the freight class based on the contents of the shipment. |
SellerFreightClass values:
50, 55, 60,
65, 70,
77.5, 85,
92.5, 100,
110, 125,
150, 175,
200, 250,
300, 400,
500 Type: xs:string |
FreightReadyDate | The date that the shipment will be ready to be picked up by the carrier. | Yes | At least two days after the date that the request is made. Must be in YYYY-MM-DD format. Type: xs:string |
PalletList | A list of pallet descriptions. | Yes | Type: List of Pallet |
TotalWeight | The total weight of the shipment. | Yes | Type: Weight |
SellerDeclaredValue | Your declaration of the total value of the inventory in the shipment. | No | Type: Amount |
AmazonCalculatedValue | Estimate by Amazon of the total value of the inventory in the shipment. | No | Type: Amount |
PreviewPickupDate | The estimated date that the shipment will be picked up by the carrier. | Yes | In ISO 8601 date time format. Type: xs:dateTime |
PreviewDeliveryDate | The estimated date that the shipment will be delivered to an Amazon fulfillment center. | Yes | In ISO 8601 date time format. Type: xs:dateTime |
PreviewFreightClass | The freight class of the shipment as estimated by Amazon if you did not include a freight class when you called the PutTransportContent operation. | Yes | PreviewFreightClass values: 50,
55, 60,
65, 70,
77.5, 85,
92.5, 100,
110, 125,
150, 175,
200, 250,
300, 400,
500 Type: xs:string |
AmazonReferenceId | A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment. | Yes | Type: xs:string |
IsBillOfLadingAvailable | Indicates whether the bill of lading for the shipment is available. | Yes | IsBillOfLadingAvailable values:
Type: xs:boolean |
PartneredEstimate | The estimated shipping cost using an Amazon-partnered carrier. | No | Type: PartneredEstimate |
CarrierName | The carrier that you are using for your inbound shipment. | Yes | CarrierName values in the United States (US):
Type: xs:string |
Information that is required by an Amazon-partnered carrier to ship a Small Parcel inbound shipment.
The PartneredSmallParcelDataInput datatype is used in a request parameter of the following operation:
The following table shows the elements of the PartneredSmallParcelDataInput datatype:
Name | Description | Required | Values |
---|---|---|---|
CarrierName | Indicates the Amazon-partnered carrier that you want to use for your inbound shipment. | No | CarrierName values in France (FR), Italy (IT), Spain (ES), the
United Kingdom (UK), and the United States (US):
CarrierName values in Germany (DE):
Default: UNITED_PARCEL_SERVICE_INC Type: xs:string |
PackageList | A list of packages, including the dimensions and weight of each package. | Yes | Type: List of PartneredSmallParcelPackageInput |
Information returned by Amazon about a Small Parcel shipment by an Amazon-partnered carrier.
The PartneredSmallParcelDataOutput datatype is used in a response element of the following operation:
The following table shows the elements of the PartneredSmallParcelDataOutput datatype:
Name | Description | Required | Values |
---|---|---|---|
PackageList | A list of packages, including shipping information from the Amazon-partnered carrier. | Yes | Type: List of PartneredSmallParcelPackageOutput |
PartneredEstimate | The estimated shipping cost using an Amazon-partnered carrier. | No | Type: PartneredEstimate |
Dimension and weight information for the package.
The PartneredSmallParcelPackageInput datatype is used in a request parameter of the following operation:
The following table shows the elements of the PartneredSmallParcelPackageInput datatype:
Name | Description | Required | Values |
---|---|---|---|
Dimensions | The dimensions of the package. | Yes | Type: Dimensions |
Weight | The weight of the package. | Yes | Type: Weight |
Dimension, weight, and shipping information for the package.
The PartneredSmallParcelPackageOutput datatype is used in a response element of the following operation:
The following table shows the elements of the PartneredSmallParcelPackageOutput datatype:
Name | Description | Required | Values |
---|---|---|---|
Dimensions | The dimensions of the package. | Yes | Type: Dimensions |
Weight | The weight of the package. | Yes | Type: Weight |
TrackingId | The tracking number of the package, provided by the carrier. | Yes | Maximum: 30 characters Type: xs:string |
PackageStatus | The shipment status of the package. | Yes | PackageStatus values:
Type: xs:string |
CarrierName | The carrier specified with a previous call to PutTransportContent. | Yes | Type: xs:string |
A preparation instruction, and who is responsible for that preparation.
The PrepDetails PrepDetails is used in a request and response element of the following operations:
The following table shows the elements of the PrepDetails PrepDetails:
Name | Description | Required | Values |
---|---|---|---|
PrepInstruction | Preparation instructions for shipping an item to Amazon's fulfillment network. | Yes | See PrepInstruction Type: xs:string |
PrepOwner | Indicates who will prepare the item. | Yes | PrepOwner values:
Default: SELLER Type: xs:string |
Preparation instructions for shipping an item to Amazon's fulfillment network.
The PrepInstruction datatype is used in a response element of the following operations:
The following table shows the elements of the PrepInstruction datatype:
Name | Description |
---|---|
PrepInstruction |
Preparation instructions for shipping an
item to Amazon's fulfillment network.
PrepInstruction values:
Note: One or more PrepInstruction
elements can be returned.
For more information about preparing items for shipment to Amazon's fulfillment network, see the Seller Central Help for your marketplace. Type: xs:string |
For more examples of how PrepInstruction works with PrepOwners, see Preparation examples.
Reasons why a given Seller SKU is not recommended for shipment to Amazon's fulfillment network
The SKUInboundGuidance datatype is used in a response element of the following operation:
The following table shows the elements of the SKUInboundGuidance datatype:
Name | Description | Required | Values |
---|---|---|---|
SellerSKU | The Seller SKU of the item. | Yes | Type: xs:string |
ASIN | The Amazon Standard Identification Number (ASIN) of the item. | Yes | Type: xs:string |
InboundGuidance | Specific inbound guidance for an item. | Yes | Type: InboundGuidance |
GuidanceReasonList | A list of reasons for the current inbound guidance for this item. | No | Type: List of GuidanceReason |
Labeling requirements and item preparation instructions to help you prepare items for shipment to Amazon's fulfillment network.
The SKUPrepInstructions datatype is used in a response element of the following operation:
The following table shows the elements of the SKUPrepInstructions datatype:
Name | Description |
---|---|
SellerSKU |
The Seller SKU of the item.
Type: xs:string |
ASIN |
The Amazon Standard Identification Number (ASIN) of the item.
Type: xs:string |
BarcodeInstruction | Labeling requirements for the item. BarcodeInstruction values:
Type: xs:string |
PrepGuidance | Item preparation instructions. PrepGuidance values:
Type: xs:string |
PrepInstructionList | Preparation instructions for shipping items to Amazon's fulfillment network. Note: The
PrepInstructionList element contains data
only if PrepGuidance =
SeePrepInstructionsList.
Type: List of PrepInstruction |
AmazonPrepFeesDetails | A list of fees for Amazon to prep goods for shipment. Type: List of AmazonPrepFeesDetails |
Inbound shipment information, including carrier details, shipment status, and the workflow status for a request for shipment with an Amazon-partnered carrier.
The TransportContent datatype is used in a response element of the following operation:
The following table shows the elements of the TransportContent datatype:
Name | Description | Required | Values |
---|---|---|---|
TransportHeader | The shipping Id, information about whether the shipment is by an Amazon-partnered carrier, and information about whether the shipment is Small Parcel or Less Than Truckload/Full Truckload (LTL/FTL). | Yes | Type: TransportHeader |
TransportDetails | Inbound shipment information, including carrier details and shipment status. | Yes | Type: TransportDetailOutput |
TransportResult | Workflow status information for a request for shipment with an Amazon-partnered carrier. | Yes | Type: TransportResult |
Information required to create an Amazon-partnered carrier shipping estimate, or to alert the Amazon fulfillment center to the arrival of an inbound shipment by a non-Amazon-partnered carrier.
The TransportDetailInput datatype is used in a request parameter of the following operation:
The following table shows the elements of the TransportDetailInput datatype:
Name | Description | Required | Values |
---|---|---|---|
PartneredSmallParcelData | Information that is required by an Amazon-partnered carrier to ship a Small Parcel inbound shipment. | Yes, if no other element from the TransportDetailInput datatype is specified. | Type: PartneredSmallParcelDataInput |
NonPartneredSmallParcelData | Information that you provide to Amazon about a Small Parcel shipment by a carrier that has not partnered with Amazon. | Yes, if no other element from the TransportDetailInput datatype is specified. | Type: NonPartneredSmallParcelDataInput |
PartneredLtlData | Information that is required by an Amazon-partnered carrier to ship a Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. | Yes, if no other element from the TransportDetailInput datatype is specified. | Type: PartneredLtlDataInput |
NonPartneredLtlData | Information that you provide to Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment by a carrier that has not partnered with Amazon. | Yes, if no other element from the TransportDetailInput datatype is specified. | Type: NonPartneredLtlDataInput |
Inbound shipment information, including carrier details and shipment status.
The TransportDetailOutput datatype is used in a response element of the following operation:
The following table shows the elements of the TransportDetailOutput datatype:
Name | Description | Required | Values |
---|---|---|---|
PartneredSmallParcelData | Information returned by Amazon about a Small Parcel shipment by an Amazon-partnered carrier. | Yes, if no other element from the TransportDetailOutput datatype is returned. | Type: PartneredSmallParcelDataOutput |
NonPartneredSmallParcelData | Information returned by Amazon about a Small Parcel shipment by a carrier that has not partnered with Amazon. | Yes, if no other element from the TransportDetailOutput datatype is returned. | Type: NonPartneredSmallParcelDataOutput |
PartneredLtlData | Information returned by Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment by an Amazon-partnered carrier. | Yes, if no other element from the TransportDetailOutput datatype is returned. | Type: PartneredLtlDataOutput |
NonPartneredLtlData | Information returned by Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment by a carrier that has not partnered with Amazon. | Yes, if no other element from the TransportDetailOutput datatype is returned. | Type: NonPartneredLtlDataOutput |
The PDF document data and checksum for printing package labels and bills of lading.
The TransportDocument datatype is used in a response element of the following operations:
The following table shows the elements of the TransportDocument datatype:
Name | Description | Required | Values |
---|---|---|---|
PdfDocument | Data for printing PDF documents, in the form of a Base64-encoded string. | Yes | Type: xs:string |
Checksum | A Base64-encoded MD5 hash to validate the PDF document data. | Yes | Type: xs:string |
The shipping Id, information about whether the shipment is by an Amazon-partnered carrier, and information about whether the shipment is Small Parcel or Less Than Truckload/Full Truckload (LTL/FTL).
The TransportHeader datatype is used in a response element of the following operation:
The following table shows the elements of the TransportHeader datatype:
Name | Description | Required | Values |
---|---|---|---|
SellerId | Your Amazon seller identifier. | Yes | Type: xs:string |
ShipmentId | A shipment identifier originally returned by the CreateInboundShipmentPlan operation. | Yes | Type: xs:string |
IsPartnered | Indicates whether a PutTransportContent request is for a partnered carrier. | Yes | IsPartnered values:
Type: xs:boolean |
ShipmentType | Specifies the carrier shipment type in a PutTransportContent request. | Yes | ShipmentType values:
Type: xs:string |
The workflow status for a shipment with an Amazon-partnered carrier.
The TransportResult datatype is used in a request parameter or in a response element of the following operations:
The following table shows the elements of the TransportResult datatype:
Name | Description | Required | Values |
---|---|---|---|
TransportStatus | Status of the Amazon-partnered carrier shipment. | Yes | TransportStatus values:
Type: xs:string |
The weight value and unit of measurement.
The Weight datatype is used in a request parameter or in a response element of the following operations:
The following table shows the elements of the Weight datatype:
Name | Description | Required | Values |
---|---|---|---|
Unit | Indicates the unit of weight. | Yes | Unit values:
Type: xs:string |
Value | The weight of the object. | Yes | Type: xs:int |