Amazon Services
Amazon Marketplace Web Service (Amazon MWS) Documentation
Amazon MWS Documentation

Inbound Datatypes

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.

Address

Postal address information.

Operations

The Address datatype is used in a request parameter or in a response element of the following operations:

Datatype content

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

AmazonPrepFeesDetails

The fees for Amazon to prep goods for shipment.

Operations

The AmazonPrepFeesDetails datatype is used in a response element of the following operations:

Datatype content

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

Amount

The currency code and value.

Operations

The Amount datatype is used in a request parameter or in a response element of the following operations:

Datatype content

The following table shows the elements of the Amount datatype:

Name Description Required Values
CurrencyCode The currency code. Yes CurrencyCode values:
  • USD - United States dollars
  • GBP - Great Britain pounds

In ISO 4217 format .

Type: xs:string

Value The amount. Yes Type: xs:string

ASINInboundGuidance

Reasons why a given ASIN is not recommended for shipment to Amazon's fulfillment network.

Operations

The ASINInboundGuidance datatype is used in a response element of the following operation:

Datatype content

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

ASINPrepInstructions

Item preparation instructions to help with item sourcing decisions.

Operations

The ASINPrepInstructions datatype is used in a response element of the following operation:

Datatype content

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:

  • RequiresFNSKULabel - Indicates that a scannable FBA product label must be applied to the item. Cover any original bar codes on the item.
  • MustProvideSellerSKU - Amazon is unable to return labeling requirements. To get labeling requirements for items, call the GetPrepInstructionsForSKU operation.
For more information about FBA labeling requirements, see the Seller Central Help for your marketplace.

Type: xs:string

PrepGuidance Item preparation instructions.

PrepGuidance values:

  • ConsultHelpDocuments - Indicates that Amazon is currently unable to determine the preparation instructions for this item. Amazon might be able to provide guidance at a future date, after evaluating the item.
    Note: It remains your responsibility as a seller to ensure that the item is properly prepared for shipment to Amazon's fulfillment network. For more information about preparing items for shipment to the fulfillment network, see the Seller Central Help for your marketplace.
  • NoAdditionalPrepRequired - Indicates that the item does not require preparation in addition to any item labeling that might be required.
  • SeePrepInstructionsList - Indicates that the item requires preparation in addition to any item labeling that might be required. See the PrepInstructionList response element for item preparation instructions.

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

BoxContentsFeeDetails

The manual processing fee per unit and total fee for a shipment.

Operations

The BoxContentsFeeDetails datatype is used in a request parameter or in a response element of the following operations:

Datatype content

BoxContentsFeeDetails contains these elements:

Name Description Required Values
TotalUnits The number of units to ship. No Type: xs:int
FeePerUnit The manual processing fee per unit. No Type: Amount
TotalFee The total manual processing fee for the shipment. No Type: Amount

BoxContentsSource

Where the seller provided box contents information for a shipment. This element is used only in the US marketplace.

Operations

The BoxContentsSource datatype is used in a request parameter of the following operations:

Type: xs:string

Values:

  • NONE - There is no box content information for this shipment. Amazon will manually process the box contents. This may incur a fee.
  • FEED - Box content information is provided through the _POST_FBA_INBOUND_CARTON_CONTENTS_ feed.
  • 2D_BARCODE - Box content information is provided by a barcode on the shipment. For more information, see Using 2D barcodes for box content information on Seller Central.
  • INTERACTIVE - Box content information is provided by an interactive source, such as a web tool.

Contact

Contact information for the person in your organization who is responsible for a Less Than Truckload/Full Truckload (LTL/FTL) shipment.

Operations

The Contact datatype is used in a request parameter or in a response element of the following operations:

Datatype content

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

Email 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

Dimensions

The dimension values and unit of measurement.

Operations

The Dimensions datatype is used in a request parameter or in a response element of the following operations:

Datatype content

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:
  • inches
  • centimeters

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

GuidanceReason

A reason for the current inbound guidance for an item.

Operations

The GuidanceReason datatype is used in a response element of the following operations:

Type: xs:string

Values:

  • SlowMovingASIN - The ASIN is well stocked and/or not selling quickly.
  • NoApplicableGuidance - No applicable guidance.

InboundGuidance

Specific inbound guidance for an item.

Operations

The InboundGuidance datatype is used in a response element of the following operations:

Type: xs:string

Values:

  • InboundNotRecommended - Shipping this item to Amazon's fulfillment network is not recommended.
  • InboundOK - Shipping this item to Amazon's fulfillment network should not cause any problems.

InboundShipmentHeader

Inbound shipment information used to create and update inbound shipments.

Operations

The InboundShipmentHeader datatype is used in a request parameter of the following operations:

Datatype content

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:
  • SELLER_LABEL - Seller labels the items in the inbound shipment when labels are required.
  • AMAZON_LABEL_ONLY - Amazon attempts to label the items in the inbound shipment when labels are required. If Amazon determines that it does not have the information required to successfully label an item, that item is not included in the inbound shipment plan.
  • AMAZON_LABEL_PREFERRED - Amazon attempts to label the items in the inbound shipment when labels are required. If Amazon determines that it does not have the information required to successfully label an item, that item is included in the inbound shipment plan and the seller must label it.
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 China (CN) or 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:
  • true – All boxes in the shipment must be case packed.
  • false – All boxes in the shipment must be individually packed.
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:
  • WORKING - The shipment was created by the seller, but has not yet shipped.
  • SHIPPED - The shipment was picked up by the carrier.
The following is an additional ShipmentStatus value when InboundShipmentHeader is used with the UpdateInboundShipment operation:
  • CANCELLED - The shipment was cancelled by the seller after the shipment was sent to Amazon's fulfillment network.

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

Type: IntendedBoxContentsSource

InboundShipmentInfo

Information about your inbound shipments. Returned by the ListInboundShipments operation.

Operations

The InboundShipmentInfo datatype is used in a response element of the following operations:

Datatype content

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:
  • NO_LABEL - No label preparation is required. All items in this shipment will be handled as stickerless, commingled inventory. Note that stickerless, commingled inventory is not available for India (IN). IN sellers must label their items before shipping them to Amazon's fulfillment network.
  • SELLER_LABEL - Label preparation by the seller is required.
  • AMAZON_LABEL - Label preparation by Amazon is required.
Note: AMAZON_LABEL is available only if you are enrolled in the FBA Label Service. The FBA Label Service is not available in China (CN) or 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:
  • WORKING - The shipment was created by the seller, but has not yet shipped.
  • SHIPPED - The shipment was picked up by the carrier.
  • IN_TRANSIT - The carrier has notified the Amazon fulfillment center that it is aware of the shipment.
  • DELIVERED - The shipment was delivered by the carrier to the Amazon fulfillment center.
  • CHECKED_IN - The shipment was checked-in at the receiving dock of the Amazon fulfillment center.
  • RECEIVING - The shipment has arrived at the Amazon fulfillment center, but not all items have been marked as received.
  • CLOSED - The shipment has arrived at the Amazon fulfillment center and all items have been marked as received.
  • CANCELLED - The shipment was cancelled by the seller after the shipment was sent to the Amazon fulfillment center.
  • DELETED - The shipment was cancelled by the seller before the shipment was sent to the Amazon fulfillment center.
  • ERROR - There was an error with the shipment and it was not processed by Amazon.

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:
  • true All of the boxes in the inbound shipment are case packed.
  • false None of the boxes in the inbound shipment are case packed.
Default: false

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

InboundShipmentItem

Item information for an inbound shipment. Submitted with a call to the CreateInboundShipment or UpdateInboundShipment operation.

Operations

The InboundShipmentItem datatype is used in a request parameter or in a response element of the following operations:

Datatype content

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

InboundShipmentPlan

Inbound shipment information used to create an inbound shipment. Returned by the CreateInboundShipmentPlan operation.

Operations

The InboundShipmentPlan datatype is used in a response element of the following operation:

Datatype content

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:
  • NO_LABEL - No label preparation is required. All items in this shipment will be handled as stickerless, commingled inventory. Note that stickerless, commingled inventory is not available for India (IN). IN sellers must label their items before shipping them to Amazon's fulfillment network.
  • SELLER_LABEL - Label preparation by the seller is required.
  • AMAZON_LABEL - Label preparation by Amazon is required.
Note: AMAZON_LABEL is available only if you are enrolled in the FBA Label Service. The FBA Label Service is not available in China (CN) 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

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

InboundShipmentPlanItem

Item information used to create an inbound shipment. Returned by the CreateInboundShipmentPlan operation.

Operations

The InboundShipmentItem datatype is used in a response element of the following operation:

Datatype content

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

InboundShipmentPlanRequestItem

Item information for creating an inbound shipment plan. Submitted with a call to the CreateInboundShipmentPlan operation.

Operations

The InboundShipmentPlanRequestItem datatype is used in a request parameter of the following operation:

Datatype content

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:
  • NewItem
  • NewWithWarranty
  • NewOEM
  • NewOpenBox
  • UsedLikeNew
  • UsedVeryGood
  • UsedGood
  • UsedAcceptable
  • UsedPoor
  • UsedRefurbished
  • CollectibleLikeNew
  • CollectibleVeryGood
  • CollectibleGood
  • CollectibleAcceptable
  • CollectiblePoor
  • RefurbishedWithWarranty
  • Refurbished
  • Club

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
Note: Amazon recommends that you create listings for all of the items that you want to include in an inbound shipment plan before calling the CreateInboundShipmentPlan operation. After you have created listings for the items that you want to include in the CreateInboundShipmentPlan operation, include only the SellerSKU and Quantity request parameters when calling the operation. Do not include the ASIN or Condition request parameters.

IntendedBoxContentsSource

How the seller intends to provide box contents information for a shipment.

Operations

The IntendedBoxContentsSource datatype is used in a request parameter of the following operations:

Type: xs:string

Values:

  • NONE - There is no box content information for this shipment. Amazon will manually process the box contents. This may incur a fee.
  • FEED - Box content information is provided through the _POST_FBA_INBOUND_CARTON_CONTENTS_ feed.
  • 2D_BARCODE - Box content information is provided by a barcode on the shipment. For more information, see Using 2D barcodes for box content information on Seller Central.

InvalidASIN

An invalid ASIN and the reason it is invalid.

Operations

The InvalidASIN datatype is used in a response element of the following operation:

Datatype content

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:

  • DoesNotExist - Indicates that the ASIN is not included in the Amazon product catalog for any of the marketplaces that you participate in.

InvalidSKU

An invalid Seller SKU and the reason it is invalid.

Operations

The InvalidSKU datatype is used in a response element of the following operation:

Datatype content

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:

  • DoesNotExist - Indicates that you have never used this Seller SKU to list an item on Amazon's retail website.

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.

Operations

The NonPartneredLtlDataInput datatype is used in a request parameter of the following operation:

Datatype content

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):
  • BUSINESS_POST
  • DHL_AIRWAYS_INC
  • DHL_UK
  • PARCELFORCE
  • DPD
  • TNT_LOGISTICS_CORPORATION
  • TNT
  • YODEL
  • UNITED_PARCEL_SERVICE_INC
  • OTHER

CarrierName values in the United States (US):

  • DHL_EXPRESS_USA_INC
  • FEDERAL_EXPRESS_CORP
  • UNITED_STATES_POSTAL_SERVICE
  • UNITED_PARCEL_SERVICE_INC
  • OTHER

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

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.

Operations

The NonPartneredLtlDataOutput datatype is used in a response element of the following operation:

Datatype content

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):
  • BUSINESS_POST
  • DHL_AIRWAYS_INC
  • DHL_UK
  • PARCELFORCE
  • DPD
  • TNT_LOGISTICS_CORPORATION
  • TNT
  • YODEL
  • UNITED_PARCEL_SERVICE_INC
  • OTHER

CarrierName values in the United States (US):

  • DHL_EXPRESS_USA_INC
  • FEDERAL_EXPRESS_CORP
  • UNITED_STATES_POSTAL_SERVICE
  • UNITED_PARCEL_SERVICE_INC
  • OTHER

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

NonPartneredSmallParcelDataInput

Information that you provide to Amazon about a Small Parcel shipment shipped by a carrier that has not partnered with Amazon.

Operations

The NonPartneredSmallParcelDataInput datatype is used in a request parameter of the following operation:

Datatype content

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):
  • BUSINESS_POST
  • DHL_AIRWAYS_INC
  • DHL_UK
  • PARCELFORCE
  • DPD
  • TNT_LOGISTICS_CORPORATION
  • TNT
  • YODEL
  • UNITED_PARCEL_SERVICE_INC
  • OTHER

CarrierName values in the United States (US):

  • DHL_EXPRESS_USA_INC
  • FEDERAL_EXPRESS_CORP
  • UNITED_STATES_POSTAL_SERVICE
  • UNITED_PARCEL_SERVICE_INC
  • OTHER

Type: xs:string

PackageList A list of tracking numbers provided by the carrier. Yes Type: List of NonPartneredSmallParcelPackageInput

NonPartneredSmallParcelDataOutput

Information returned by Amazon about a Small Parcel shipment by a carrier that has not partnered with Amazon.

Operations

The NonPartneredSmallParcelDataOutput datatype is used in a response element of the following operation:

Datatype content

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

NonPartneredSmallParcelPackageInput

The tracking number of the package, provided by the carrier.

Operations

The NonPartneredSmallParcelPackageInput datatype is used in a request parameter of the following operation:

Datatype content

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

NonPartneredSmallParcelPackageOutput

Carrier, tracking number, and status information for the package.

Operations

The NonPartneredSmallParcelPackageOutput datatype is used in a response element of the following operation:

Datatype content

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):
  • BUSINESS_POST
  • DHL_AIRWAYS_INC
  • DHL_UK
  • PARCELFORCE
  • DPD
  • TNT_LOGISTICS_CORPORATION
  • TNT
  • YODEL
  • UNITED_PARCEL_SERVICE_INC
  • OTHER

CarrierName values in the United States (US):

  • DHL_EXPRESS_USA_INC
  • FEDERAL_EXPRESS_CORP
  • UNITED_STATES_POSTAL_SERVICE
  • UNITED_PARCEL_SERVICE_INC
  • OTHER

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:
  • SHIPPED – The carrier has picked up the package from your facility.
  • IN_TRANSIT - The carrier has made an appointment for delivery to an Amazon fulfillment center.
  • DELIVERED - The carrier has delivered the package to the loading dock of an Amazon fulfillment center.
  • CHECKED_IN - The Amazon fulfillment center has accepted delivery of the package from the carrier.
  • RECEIVING - The Amazon fulfillment center has begun the receiving process on the package.
  • CLOSED - The Amazon fulfillment center has completed the receiving process on the package.

Type: xs:string

Pallet

Pallet information.

Operations

The Pallet datatype is used in a request parameter or in a response element of the following operations:

Datatype content

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:
  • true – Pallets will be stacked.
  • false - Pallets will not be stacked.

Type: xs:boolean

PartneredEstimate

The estimated shipping cost for a shipment using an Amazon-partnered carrier.

Operations

The PartneredEstimate datatype is used in a response element of the following operation:

Datatype content

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

PartneredLtlDataInput

Information that is required by an Amazon-partnered carrier to ship a Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment.

Operations

The PartneredLtlDataInput datatype is used in a request parameter of the following operation:

Datatype content

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

PartneredLtlDataOutput

Information returned by Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment by an Amazon-partnered carrier.

Operations

The PartneredLtlDataOutput datatype is used in a response element of the following operation:

Datatype content

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:
  • true – Bill of lading is available.
  • false – Bill of lading is not available.

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):
  • DHL_EXPRESS_USA_INC
  • FEDERAL_EXPRESS_CORP
  • UNITED_STATES_POSTAL_SERVICE
  • UNITED_PARCEL_SERVICE_INC
  • OTHER

Type: xs:string

PartneredSmallParcelDataInput

Information that is required by an Amazon-partnered carrier to ship a Small Parcel inbound shipment.

Operations

The PartneredSmallParcelDataInput datatype is used in a request parameter of the following operation:

Datatype content

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):
  • UNITED_PARCEL_SERVICE_INC

CarrierName values in Germany (DE):

  • DHL_STANDARD
  • UNITED_PARCEL_SERVICE_INC

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

PartneredSmallParcelDataOutput

Information returned by Amazon about a Small Parcel shipment by an Amazon-partnered carrier.

Operations

The PartneredSmallParcelDataOutput datatype is used in a response element of the following operation:

Datatype content

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

PartneredSmallParcelPackageInput

Dimension and weight information for the package.

Operations

The PartneredSmallParcelPackageInput datatype is used in a request parameter of the following operation:

Datatype content

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

PartneredSmallParcelPackageOutput

Dimension, weight, and shipping information for the package.

Operations

The PartneredSmallParcelPackageOutput datatype is used in a response element of the following operation:

Datatype content

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:
  • SHIPPED – The carrier has picked up the package from your facility.
  • IN_TRANSIT - The carrier has made an appointment for delivery to an Amazon fulfillment center.
  • DELIVERED - The carrier has delivered the package to the loading dock of an Amazon fulfillment center.
  • CHECKED_IN - The Amazon fulfillment center has accepted delivery of the package from the carrier.
  • RECEIVING - The Amazon fulfillment center has begun the receiving process on the package.
  • CLOSED - The Amazon fulfillment center has completed the receiving process on the package.

Type: xs:string

CarrierName The carrier specified with a previous call to PutTransportContent. Yes Type: xs:string

PrepDetails

A preparation instruction, and who is responsible for that preparation.

Operations

The PrepDetails PrepDetails is used in a request and response element of the following operations:

PrepDetails content

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:
  • AMAZON
  • SELLER

Default: SELLER

Type: xs:string

PrepInstruction

Preparation instructions for shipping an item to Amazon's fulfillment network.

Operations

The PrepInstruction datatype is used in a response element of the following operations:

Datatype content

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:

  • Polybagging - Indicates that polybagging is required.
  • BubbleWrapping - Indicates that bubble wrapping is required.
  • Taping - Indicates that taping is required.
  • BlackShrinkWrapping - Indicates that black shrink wrapping is required.
  • Labeling - Indicates that the FNSKU label should be applied to the item.
  • HangGarment - Indicates that the item should be placed on a hanger.
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.

SKUInboundGuidance

Reasons why a given Seller SKU is not recommended for shipment to Amazon's fulfillment network

Operations

The SKUInboundGuidance datatype is used in a response element of the following operation:

Datatype content

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

SKUPrepInstructions

Labeling requirements and item preparation instructions to help you prepare items for shipment to Amazon's fulfillment network.

Operations

The SKUPrepInstructions datatype is used in a response element of the following operation:

Datatype content

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:

  • RequiresFNSKULabel - Indicates that a scannable FBA product label must be applied to the item. Cover any original bar codes on the item.
  • CanUseOriginalBarcode - Indicates that the item does not require a scannable FBA product label. The original manufacturer's bar code can be used.
For more information about FBA labeling requirements, see the Seller Central Help for your marketplace.

Type: xs:string

PrepGuidance Item preparation instructions.

PrepGuidance values:

  • ConsultHelpDocuments - Indicates that Amazon is currently unable to determine the preparation instructions for this item. Amazon might be able to provide guidance at a future date, after evaluating the item.
    Note: It remains your responsibility as a seller to ensure that the item is properly prepared for shipment to Amazon's fulfillment network. For more information about preparing items for shipment to the fulfillment network, see the Seller Central Help for your marketplace.
  • NoAdditionalPrepRequired - Indicates that the item does not require preparation in addition to any item labeling that might be required.
  • SeePrepInstructionsList - Indicates that the item requires preparation in addition to any item labeling that might be required. See the PrepInstructionList response element for item preparation instructions.

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

TransportContent

Inbound shipment information, including carrier details, shipment status, and the workflow status for a request for shipment with an Amazon-partnered carrier.

Operations

The TransportContent datatype is used in a response element of the following operation:

Datatype content

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

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.

Operations

The TransportDetailInput datatype is used in a request parameter of the following operation:

Datatype content

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

TransportDetailOutput

Inbound shipment information, including carrier details and shipment status.

Operations

The TransportDetailOutput datatype is used in a response element of the following operation:

Datatype content

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

TransportDocument

The PDF document data and checksum for printing package labels and bills of lading.

Operations

The TransportDocument datatype is used in a response element of the following operations:

Datatype content

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

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).

Operations

The TransportHeader datatype is used in a response element of the following operation:

Datatype content

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:
  • true – Request is for an Amazon-partnered carrier.
  • false – Request is for a non-Amazon-partnered carrier.

Type: xs:boolean

ShipmentType Specifies the carrier shipment type in a PutTransportContent request. Yes ShipmentType values:
  • SPSmall Parcel
  • LTLLess Than Truckload/Full Truckload (LTL/FTL)

Type: xs:string

TransportResult

The workflow status for a shipment with an Amazon-partnered carrier.

Operations

The TransportResult datatype is used in a request parameter or in a response element of the following operations:

Datatype content

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:
  • WORKING - You have successfully called the PutTransportContent operation for this shipment but have not yet called the  EstimateTransportRequest operation.
  • ERROR_ON_ESTIMATING - There was a problem with your call to the EstimateTransportRequest operation and an error was returned.
  • ESTIMATING - You have successfully called the  EstimateTransportRequest operation for this shipment and the carrier is in the process of estimating the shipment cost.
  • ESTIMATED – The carrier has completed the process of estimating the shipment cost. Your transportation request is ready to be confirmed by you.
  • ERROR_ON_CONFIRMING - There was a problem with your call to the ConfirmTransportRequest operation and an error was returned.
  • CONFIRMING - You have successfully called the ConfirmTransportRequest operation but the confirmation process is not yet complete.
  • CONFIRMED – Your transportation request has been confirmed. Important: For a Small Parcel shipment, you can void your transportation request up to 24 hours after you confirm it. For a Less Than Truckload/Full Truckload (LTL/FTL) shipment, you can void your transportation request up to one hour after you confirm it. After the grace period has expired your account will be charged for the shipping cost.
  • VOIDING - You have successfully called the VoidTransportRequest operation for a confirmed carrier shipment but the voiding process is not yet complete.
  • VOIDED – Your confirmed carrier shipment has been voided. Your account will not be charged for the shipping cost.
  • ERROR_IN_VOIDING - There was a problem with your call to the VoidTransportRequest operation and an error was returned.

Type: xs:string

Weight

The weight value and unit of measurement.

Operations

The Weight datatype is used in a request parameter or in a response element of the following operations:

Datatype content

The following table shows the elements of the Weight datatype:

Name Description Required Values
Unit Indicates the unit of weight. Yes Unit values:
  • pounds
  • kilograms

Type: xs:string

Value The weight of the object. Yes Type: xs:int