Fulfillment Inbound API v0 reference

How to create and update inbound shipments of inventory to Amazon's fulfillment network.

Selling Partner API for Fulfillment Inbound

Overview

The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon's fulfillment network.

Version information

Version : v0

Contact information

Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html

License information

License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0

URI scheme

Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Operations

getInboundGuidance
createInboundShipmentPlan
updateInboundShipment
createInboundShipment
getPreorderInfo
confirmPreorder
getPrepInstructions
getTransportDetails
putTransportDetails
voidTransport
estimateTransport
confirmTransport
getLabels
getBillOfLading
getShipments
getShipmentItemsByShipmentId
getShipmentItems

Paths

GET /fba/inbound/v0/itemsGuidance

Operation: getInboundGuidance

Description

Returns information that lets a seller know if Amazon recommends sending an item to a given marketplace. In some cases, Amazon provides guidance for why a given SellerSKU or ASIN is not recommended for shipment to Amazon's fulfillment network. Sellers may still ship items that are not recommended, at their discretion.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
QueryMarketplaceId
required
A marketplace identifier. Specifies the marketplace where the product would be stored.string
QuerySellerSKUList
optional
A list of SellerSKU values. Used to identify items for which you want inbound guidance for shipment to Amazon's fulfillment network. Note: SellerSKU is qualified by the SellerId, which is included with every Selling Partner API operation that you submit. If you specify a SellerSKU that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold.
Max count : 50
< string > array
QueryASINList
optional
A list of ASIN values. Used to identify items for which you want inbound guidance for shipment to Amazon's fulfillment network. Note: If you specify a ASIN that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold.
Max count : 50
< string > array

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetInboundGuidanceResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetInboundGuidanceResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetInboundGuidanceResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetInboundGuidanceResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetInboundGuidanceResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetInboundGuidanceResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetInboundGuidanceResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetInboundGuidanceResponse

POST /fba/inbound/v0/plans

Operation: createInboundShipmentPlan

Description

Returns one or more inbound shipment plans, which provide the information you need to create one or more inbound shipments for a set of items that you specify. Multiple inbound shipment plans might be required so that items can be optimally placed in Amazon's fulfillment network—for example, positioning inventory closer to the customer. Alternatively, two inbound shipment plans might be created with the same Amazon fulfillment center destination if the two shipment plans require different processing—for example, items that require labels must be shipped separately from stickerless, commingled inventory.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
Bodybody
required
The request schema for the createInboundShipmentPlan operation.CreateInboundShipmentPlanRequest

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateInboundShipmentPlanResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateInboundShipmentPlanResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateInboundShipmentPlanResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
CreateInboundShipmentPlanResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateInboundShipmentPlanResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateInboundShipmentPlanResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateInboundShipmentPlanResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateInboundShipmentPlanResponse

PUT /fba/inbound/v0/shipments/{shipmentId}

Operation: updateInboundShipment

Description

Updates or removes items from the inbound shipment identified by the specified shipment identifier. Adding new items is not supported.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
Bodybody
required
The request schema for an inbound shipment.InboundShipmentRequest
PathshipmentId
required
A shipment identifier originally returned by the createInboundShipmentPlan operation.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
InboundShipmentResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
InboundShipmentResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
InboundShipmentResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
InboundShipmentResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
InboundShipmentResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
InboundShipmentResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
InboundShipmentResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
InboundShipmentResponse

POST /fba/inbound/v0/shipments/{shipmentId}

Operation: createInboundShipment

Description

Returns a new inbound shipment based on the specified shipmentId that was returned by the createInboundShipmentPlan operation.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
Bodybody
required
The request schema for an inbound shipment.InboundShipmentRequest
PathshipmentId
required
A shipment identifier originally returned by the createInboundShipmentPlan operation.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
InboundShipmentResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
InboundShipmentResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
InboundShipmentResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
InboundShipmentResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
InboundShipmentResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
InboundShipmentResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
InboundShipmentResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
InboundShipmentResponse

GET /fba/inbound/v0/shipments/{shipmentId}/preorder

Operation: getPreorderInfo

Description

Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathshipmentId
required
A shipment identifier originally returned by the createInboundShipmentPlan operation.string
QueryMarketplaceId
required
A marketplace identifier. Specifies the marketplace the shipment is tied to.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPreorderInfoResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPreorderInfoResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPreorderInfoResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetPreorderInfoResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPreorderInfoResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPreorderInfoResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPreorderInfoResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPreorderInfoResponse

PUT /fba/inbound/v0/shipments/{shipmentId}/preorder/confirm

Operation: confirmPreorder

Description

Returns information needed to confirm a shipment for pre-order. Call this operation after calling the getPreorderInfo operation to get the NeedByDate value and other pre-order information about the shipment.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathshipmentId
required
A shipment identifier originally returned by the createInboundShipmentPlan operation.string
QueryNeedByDate
required
Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value.string (date)
QueryMarketplaceId
required
A marketplace identifier. Specifies the marketplace the shipment is tied to.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmPreorderResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmPreorderResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmPreorderResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmPreorderResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmPreorderResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmPreorderResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmPreorderResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmPreorderResponse

GET /fba/inbound/v0/prepInstructions

Operation: getPrepInstructions

Description

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

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
QueryShipToCountryCode
required
The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country.string ([A-Z]{2})
QuerySellerSKUList
optional
A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon's fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API.

Note: Include seller SKUs that you have used to list items on Amazon's retail website. If you include a seller SKU that you have never used to list an item on Amazon's retail website, the seller SKU is returned in the InvalidSKUList property in the response.
Max count : 50
< string > array
QueryASINList
optional
A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions.

Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.
Max count : 50
< string > array

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPrepInstructionsResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPrepInstructionsResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPrepInstructionsResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetPrepInstructionsResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPrepInstructionsResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPrepInstructionsResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPrepInstructionsResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPrepInstructionsResponse

GET /fba/inbound/v0/shipments/{shipmentId}/transport

Operation: getTransportDetails

Description

Returns current transportation information about an inbound shipment.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathshipmentId
required
A shipment identifier originally returned by the createInboundShipmentPlan operation.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetTransportDetailsResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetTransportDetailsResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetTransportDetailsResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetTransportDetailsResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetTransportDetailsResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetTransportDetailsResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetTransportDetailsResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetTransportDetailsResponse

PUT /fba/inbound/v0/shipments/{shipmentId}/transport

Operation: putTransportDetails

Description

Sends transportation information to Amazon about an inbound shipment.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathshipmentId
required
A shipment identifier originally returned by the createInboundShipmentPlan operation.string
Bodybody
required
The request schema for a putTransportDetails operation.PutTransportDetailsRequest

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
PutTransportDetailsResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
PutTransportDetailsResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
PutTransportDetailsResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
PutTransportDetailsResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
PutTransportDetailsResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
PutTransportDetailsResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
PutTransportDetailsResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
PutTransportDetailsResponse

POST /fba/inbound/v0/shipments/{shipmentId}/transport/void

Operation: voidTransport

Description

Cancels a previously-confirmed request to ship an inbound shipment using an Amazon-partnered carrier.

To be successful, you must call this operation before the VoidDeadline date that is returned by the getTransportDetails operation.

Important: The VoidDeadline 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.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathshipmentId
required
A shipment identifier originally returned by the createInboundShipmentPlan operation.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
VoidTransportResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
VoidTransportResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
VoidTransportResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
VoidTransportResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
VoidTransportResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
VoidTransportResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
VoidTransportResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
VoidTransportResponse

POST /fba/inbound/v0/shipments/{shipmentId}/transport/estimate

Operation: estimateTransport

Description

Initiates the process of estimating the shipping cost for an inbound shipment by an Amazon-partnered carrier.

Prior to calling the estimateTransport operation, you must call the putTransportDetails operation to provide Amazon with the transportation information for the inbound shipment.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathshipmentId
required
A shipment identifier originally returned by the createInboundShipmentPlan operation.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
EstimateTransportResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
EstimateTransportResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
EstimateTransportResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
EstimateTransportResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
EstimateTransportResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
EstimateTransportResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
EstimateTransportResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
EstimateTransportResponse

POST /fba/inbound/v0/shipments/{shipmentId}/transport/confirm

Operation: confirmTransport

Description

Confirms that the seller accepts the Amazon-partnered shipping estimate, agrees to allow Amazon to charge their account for the shipping cost, and requests that the Amazon-partnered carrier ship the inbound shipment.

Prior to calling the confirmTransport operation, you should call the getTransportDetails operation to get the Amazon-partnered shipping estimate.

Important: After confirming the transportation request, if the seller decides that they do not want the Amazon-partnered carrier to ship the inbound shipment, you can call the voidTransport operation to cancel the transportation request. Note that for a Small Parcel shipment, the seller has 24 hours after confirming a transportation request to void the transportation request. For a Less Than Truckload/Full Truckload (LTL/FTL) shipment, the seller has one hour after confirming a transportation request to void it. After the grace period has expired the seller's account will be charged for the shipping cost.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathshipmentId
required
A shipment identifier originally returned by the createInboundShipmentPlan operation.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmTransportResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmTransportResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmTransportResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmTransportResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmTransportResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmTransportResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmTransportResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmTransportResponse

GET /fba/inbound/v0/shipments/{shipmentId}/labels

Operation: getLabels

Description

Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathshipmentId
required
A shipment identifier originally returned by the createInboundShipmentPlan operation.string
QueryPageType
required
The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.enum (PageType)
QueryLabelType
required
The type of labels requested.enum (LabelType)
QueryNumberOfPackages
optional
The number of packages in the shipment.integer
QueryPackageLabelsToPrint
optional
A list of identifiers that specify packages for which you want package labels printed.

Must match CartonId values previously passed using the FBA Inbound Shipment Carton Information Feed. If not, the operation returns the IncorrectPackageIdentifier error code.
Max count : 999
< string > array
QueryNumberOfPallets
optional
The number of pallets in the shipment. This returns four identical labels for each pallet.integer
QueryPageSize
optional
The page size for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.integer
QueryPageStartIndex
optional
The page start index for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments.integer

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetLabelsResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetLabelsResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetLabelsResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetLabelsResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetLabelsResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetLabelsResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetLabelsResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetLabelsResponse

GET /fba/inbound/v0/shipments/{shipmentId}/billOfLading

Operation: getBillOfLading

Description

Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathshipmentId
required
A shipment identifier originally returned by the createInboundShipmentPlan operation.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetBillOfLadingResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetBillOfLadingResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetBillOfLadingResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetBillOfLadingResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetBillOfLadingResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetBillOfLadingResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetBillOfLadingResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetBillOfLadingResponse

GET /fba/inbound/v0/shipments

Operation: getShipments

Description

Returns a list of inbound shipments based on criteria that you specify.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
QueryShipmentStatusList
optional
A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.< enum (ShipmentStatusList) > array
QueryShipmentIdList
optional
A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.< string > array
QueryLastUpdatedAfter
optional
A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.string (date-time)
QueryLastUpdatedBefore
optional
A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.string (date-time)
QueryQueryType
required
Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.enum (QueryType)
QueryNextToken
optional
A string token returned in the response to your previous request.string
QueryMarketplaceId
required
A marketplace identifier. Specifies the marketplace where the product would be stored.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentsResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentsResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentsResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentsResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentsResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentsResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentsResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentsResponse

GET /fba/inbound/v0/shipments/{shipmentId}/items

Operation: getShipmentItemsByShipmentId

Description

Returns a list of items in a specified inbound shipment.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathshipmentId
required
A shipment identifier used for selecting items in a specific inbound shipment.string
QueryMarketplaceId
required
A marketplace identifier. Specifies the marketplace where the product would be stored.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentItemsResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentItemsResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentItemsResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentItemsResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentItemsResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentItemsResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentItemsResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentItemsResponse

GET /fba/inbound/v0/shipmentItems

Operation: getShipmentItems

Description

Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
QueryLastUpdatedAfter
optional
A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.string (date-time)
QueryLastUpdatedBefore
optional
A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.string (date-time)
QueryQueryType
required
Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request.enum (QueryType)
QueryNextToken
optional
A string token returned in the response to your previous request.string
QueryMarketplaceId
required
A marketplace identifier. Specifies the marketplace where the product would be stored.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentItemsResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentItemsResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentItemsResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentItemsResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentItemsResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentItemsResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentItemsResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentItemsResponse

Definitions

Error

Error response returned when the request is unsuccessful.

NameDescriptionSchema
code
required
An error code that identifies the type of error that occured.string
message
required
A message that describes the error condition in a human-readable form.string
details
optional
Additional details that can help the caller understand or fix the issue.string

ErrorList

A list of error responses returned when a request is unsuccessful.

Type : < Error > array

ASINInboundGuidance

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

NameDescriptionSchema
ASIN
required
The Amazon Standard Identification Number (ASIN) of the item.string
InboundGuidance
required
Specific inbound guidance for an item.InboundGuidance
GuidanceReasonList
optional
A list of reasons for the current inbound guidance for this item.GuidanceReasonList

ASINInboundGuidanceList

A list of ASINs and their associated inbound guidance.

Type : < ASINInboundGuidance > array

ASINPrepInstructions

Item preparation instructions to help with item sourcing decisions.

NameDescriptionSchema
ASIN
optional
The Amazon Standard Identification Number (ASIN) of the item.string
BarcodeInstruction
optional
Labeling requirements for the item. For more information about FBA labeling requirements, see the Seller Central Help for your marketplace.BarcodeInstruction
PrepGuidance
optional
Item preparation instructions.PrepGuidance
PrepInstructionList
optional
A list of preparation instructions to help with item sourcing decisions.PrepInstructionList

ASINPrepInstructionsList

A list of item preparation instructions.

Type : < ASINPrepInstructions > array

Address

NameDescriptionSchema
Name
required
Name of the individual or business.
maxLength : 50
string
AddressLine1
required
The street address information.
maxLength : 180
string
AddressLine2
optional
Additional street address information, if required.
maxLength : 60
string
DistrictOrCounty
optional
The district or county.
maxLength : 25
string
City
required
The city.
maxLength : 30
string
StateOrProvinceCode
required
The state or province code.

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.
string
CountryCode
required
The country code in two-character ISO 3166-1 alpha-2 format.string
PostalCode
required
The postal code.

If postal codes are used in your marketplace, we recommended that you include one with your request. This helps Amazon select the most appropriate Amazon fulfillment center for the inbound shipment plan.
maxLength : 30
string

AmazonPrepFeesDetails

The fees for Amazon to prep goods for shipment.

NameDescriptionSchema
PrepInstruction
optional
Preparation instructions for shipping an item to Amazon's fulfillment network. For more information about preparing items for shipment to Amazon's fulfillment network, see the Seller Central Help for your marketplace.PrepInstruction
FeePerUnit
optional
The fee for Amazon to prepare 1 unit.Amount

AmazonPrepFeesDetailsList

A list of preparation instructions and fees for Amazon to prep goods for shipment.

Type : < AmazonPrepFeesDetails > array

Amount

The monetary value.

NameDescriptionSchema
CurrencyCode
required
The currency code.CurrencyCode
Value
required
The amount.BigDecimalType

BarcodeInstruction

Labeling requirements for the item. For more information about FBA labeling requirements, see the Seller Central Help for your marketplace.

Type : enum

ValueDescription
RequiresFNSKULabelIndicates that a scannable FBA product label must be applied to the item. Cover any original bar codes on the item.
CanUseOriginalBarcodeIndicates that the item does not require a scannable FBA product label. The original manufacturer's bar code can be used.
MustProvideSellerSKUAmazon is unable to return labeling requirements. To get labeling requirements for items, call the getPrepInstructions operation.

BigDecimalType

Type : number (double)

BoxContentsFeeDetails

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

NameDescriptionSchema
TotalUnits
optional
The number of units to ship.Quantity
FeePerUnit
optional
The manual processing fee per unit.Amount
TotalFee
optional
The total manual processing fee for the shipment.Amount

BoxContentsSource

Where the seller provided box contents information for a shipment.

Type : enum

ValueDescription
NONEThere is no box contents information for this shipment. Amazon will manually process the box contents information. This may incur a fee.
FEEDBox contents information is provided through the POST_FBA_INBOUND_CARTON_CONTENTS feed.
2D_BARCODEBox contents information is provided by a barcode on the shipment. For more information, see Using 2D barcodes for box content information on Seller Central.
INTERACTIVEBox contents information is provided by an interactive source, such as a web tool.

Condition

The condition of the item.

Type : enum

ValueDescription
NewItemNewItem
NewWithWarrantyNewWithWarranty
NewOEMNewOEM
NewOpenBoxNewOpenBox
UsedLikeNewUsedLikeNew
UsedVeryGoodUsedVeryGood
UsedGoodUsedGood
UsedAcceptableUsedAcceptable
UsedPoorUsedPoor
UsedRefurbishedUsedRefurbished
CollectibleLikeNewCollectibleLikeNew
CollectibleVeryGoodCollectibleVeryGood
CollectibleGoodCollectibleGood
CollectibleAcceptableCollectibleAcceptable
CollectiblePoorCollectiblePoor
RefurbishedWithWarrantyRefurbishedWithWarranty
RefurbishedRefurbished
ClubClub

ConfirmPreorderResult

NameDescriptionSchema
ConfirmedNeedByDate
optional
Date passed in with the NeedByDate parameter. The confirmed shipment must arrive at the Amazon fulfillment center by this date to avoid delivery promise breaks for pre-ordered items. In YYYY-MM-DD format.DateStringType
ConfirmedFulfillableDate
optional
Date that determines which pre-order items in the shipment are eligible for pre-order. The pre-order Buy Box will appear for any pre-order item in the shipment with a release date on or after this date. In YYYY-MM-DD format.DateStringType

ConfirmPreorderResponse

The response schema for the confirmPreorder operation.

NameDescriptionSchema
payload
optional
The payload for the confirmPreorder operation.ConfirmPreorderResult
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

CommonTransportResult

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

ConfirmTransportResponse

The response schema for the confirmTransport operation.

NameDescriptionSchema
payload
optional
The payload for the confirmTransport operation.CommonTransportResult
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

Contact

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

NameDescriptionSchema
Name
required
The name of the contact person.
maxLength : 50
string
Phone
required
The phone number of the contact person.
maxLength : 20
string
Email
required
The email address of the contact person.
maxLength : 50
string
Fax
optional
The fax number of the contact person.
maxLength : 20
string

CreateInboundShipmentPlanRequest

The request schema for the createInboundShipmentPlan operation.

NameDescriptionSchema
ShipFromAddress
required
The address from which the inbound shipment will be sent.Address
LabelPrepPreference
required
The seller's preference for label preparation for an inbound shipment.LabelPrepPreference
ShipToCountryCode
optional
The two-character country code for the country where the inbound shipment is to be sent.

Note: Not required. Specifying both ShipToCountryCode and ShipToCountrySubdivisionCode returns an error.

Values:

ShipToCountryCode values for North America:
  • CA – Canada

  • MX - Mexico

  • US - United States


  • ShipToCountryCode values for MCI sellers in Europe:
  • DE – Germany

  • ES – Spain

  • FR – France

  • GB – United Kingdom

  • IT – Italy


  • Default: The country code for the seller's home marketplace.
    string
    ShipToCountrySubdivisionCode
    optional
    The two-character country code, followed by a dash and then up to three characters that represent the subdivision of the country where the inbound shipment is to be sent. For example, "IN-MH". In full ISO 3166-2 format.

    Note: Not required. Specifying both ShipToCountryCode and ShipToCountrySubdivisionCode returns an error.
    string
    InboundShipmentPlanRequestItems
    required
    -InboundShipmentPlanRequestItemList

    CreateInboundShipmentPlanResult

    NameDescriptionSchema
    InboundShipmentPlans
    optional
    A list of inbound shipment plan informationInboundShipmentPlanList

    CreateInboundShipmentPlanResponse

    The response schema for the createInboundShipmentPlan operation.

    NameDescriptionSchema
    payload
    optional
    The payload for the createInboundShipmentPlan operation.CreateInboundShipmentPlanResult
    errors
    optional
    A list of error responses returned when a request is unsuccessful.ErrorList

    InboundShipmentRequest

    The request schema for an inbound shipment.

    NameDescriptionSchema
    InboundShipmentHeader
    required
    Inbound shipment information used to create and update inbound shipments.InboundShipmentHeader
    InboundShipmentItems
    required
    A list of inbound shipment item information.InboundShipmentItemList
    MarketplaceId
    required
    A marketplace identifier. Specifies the marketplace where the product would be stored.string

    InboundShipmentResult

    NameDescriptionSchema
    ShipmentId
    required
    The shipment identifier submitted in the request.string

    InboundShipmentResponse

    The response schema for this operation.

    NameDescriptionSchema
    payload
    optional
    The payload for this operation.InboundShipmentResult
    errors
    optional
    A list of error responses returned when a request is unsuccessful.ErrorList

    CurrencyCode

    The currency code.

    Type : enum

    ValueDescription
    USDUnited States Dollar.
    GBPBritish pound sterling.

    DateStringType

    Type : string (date)

    Dimensions

    The dimension values and unit of measurement.

    NameDescriptionSchema
    Length
    required
    The length dimension.BigDecimalType
    Width
    required
    The width dimension.BigDecimalType
    Height
    required
    The height dimension.BigDecimalType
    Unit
    required
    The unit of measurement for the dimensions.UnitOfMeasurement

    ErrorReason

    The reason that the ASIN is invalid.

    Type : enum

    ValueDescription
    DoesNotExistIndicates that the ASIN is not included in the Amazon product catalog for any of the marketplaces that the seller participates in.
    InvalidASINThe ASIN is invalid.

    EstimateTransportResponse

    The response schema for the estimateTransport operation.

    NameDescriptionSchema
    payload
    optional
    The payload for the estimateTransport operation.CommonTransportResult
    errors
    optional
    A list of error responses returned when a request is unsuccessful.ErrorList

    GetBillOfLadingResponse

    The response schema for the getBillOfLading operation.

    NameDescriptionSchema
    payload
    optional
    The payload for the getBillOfLading operation.BillOfLadingDownloadURL
    errors
    optional
    A list of error responses returned when a request is unsuccessful.ErrorList

    GetInboundGuidanceResult

    NameDescriptionSchema
    SKUInboundGuidanceList
    optional
    A list of SKU inbound guidance information.SKUInboundGuidanceList
    InvalidSKUList
    optional
    A list of invalid SKU values and the reason they are invalid.InvalidSKUList
    ASINInboundGuidanceList
    optional
    A list of ASINs and their associated inbound guidance.ASINInboundGuidanceList
    InvalidASINList
    optional
    A list of invalid ASIN values and the reasons they are invalid.InvalidASINList

    GetInboundGuidanceResponse

    The response schema for the getInboundGuidance operation.

    NameDescriptionSchema
    payload
    optional
    The payload for the getInboundGuidance operation.GetInboundGuidanceResult
    errors
    optional
    A list of error responses returned when a request is unsuccessful.ErrorList

    LabelDownloadURL

    NameDescriptionSchema
    DownloadURL
    optional
    URL to download the label for the package. Note: The URL will only be valid for 15 secondsstring

    BillOfLadingDownloadURL

    NameDescriptionSchema
    DownloadURL
    optional
    URL to download the bill of lading for the package. Note: The URL will only be valid for 15 secondsstring

    GetLabelsResponse

    The response schema for the getLabels operation.

    NameDescriptionSchema
    payload
    optional
    The payload for the getLabels operation.LabelDownloadURL
    errors
    optional
    A list of error responses returned when a request is unsuccessful.ErrorList

    GetPreorderInfoResult

    NameDescriptionSchema
    ShipmentContainsPreorderableItems
    optional
    Indicates whether the shipment contains items that have been enabled for pre-order. For more information about enabling items for pre-order, see the Seller Central Help.boolean
    ShipmentConfirmedForPreorder
    optional
    Indicates whether this shipment has been confirmed for pre-order.boolean
    NeedByDate
    optional
    Date that the shipment would need to arrive at an Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items if this shipment is later confirmed for pre-order. In YYYY-MM-DD format. See also the confirmPreorder operation.DateStringType
    ConfirmedFulfillableDate
    optional
    Date in YYYY-MM-DD format that determines which pre-order items in the shipment are eligible for pre-order. If this shipment is confirmed for pre-order with a subsequent call to the confirmPreorder operation, the pre-order Buy Box will appear for any pre-order items in the shipment with a release date on or after this date. Call the getShipmentItems operation to get the release dates for the pre-order items in this shipment.DateStringType

    GetPreorderInfoResponse

    The response schema for the getPreorderInfo operation.

    NameDescriptionSchema
    payload
    optional
    The payload for the getPreorderInfo operation.GetPreorderInfoResult
    errors
    optional
    One or more unexpected errors occurred during the operation.ErrorList

    GetPrepInstructionsResult

    NameDescriptionSchema
    SKUPrepInstructionsList
    optional
    A list of SKU labeling requirements and item preparation instructions.SKUPrepInstructionsList
    InvalidSKUList
    optional
    A list of invalid SKU values and the reason they are invalid.InvalidSKUList
    ASINPrepInstructionsList
    optional
    A list of item preparation instructions.ASINPrepInstructionsList
    InvalidASINList
    optional
    A list of invalid ASIN values and the reasons they are invalid.InvalidASINList

    GetPrepInstructionsResponse

    The response schema for the getPrepInstructions operation.

    NameDescriptionSchema
    payload
    optional
    The payload for the getPrepInstructions operation.GetPrepInstructionsResult
    errors
    optional
    A list of error responses returned when a request is unsuccessful.ErrorList

    GetTransportDetailsResult

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

    GetTransportDetailsResponse

    The response schema for the getTransportDetails operation.

    NameDescriptionSchema
    payload
    optional
    The payload for the getTransportDetails operation.GetTransportDetailsResult
    errors
    optional
    A list of error responses returned when a request is unsuccessful.ErrorList

    GuidanceReason

    A reason for the current inbound guidance for an item.

    Type : enum

    ValueDescription
    SlowMovingASINThe ASIN is well stocked and/or not selling quickly.
    NoApplicableGuidanceNo applicable guidance.

    GuidanceReasonList

    A list of inbound guidance reason information.

    Type : < GuidanceReason > array

    InboundGuidance

    Specific inbound guidance for an item.

    Type : enum

    ValueDescription
    InboundNotRecommendedShipping this item to Amazon's fulfillment network is not recommended.
    InboundOKShipping this item to Amazon's fulfillment network should not cause any problems.

    InboundShipmentHeader

    Inbound shipment information used to create and update inbound shipments.

    NameDescriptionSchema
    ShipmentName
    required
    The name for the shipment. Use a naming convention that helps distinguish between shipments over time, such as the date the shipment was created.string
    ShipFromAddress
    required
    The return address.Address
    DestinationFulfillmentCenterId
    required
    The identifier for the fulfillment center to which the shipment will be shipped. Get this value from the InboundShipmentPlan object in the response returned by the createInboundShipmentPlan operation.string
    AreCasesRequired
    optional
    Indicates whether or not an inbound shipment contains case-packed boxes. Note: A shipment must contain either all case-packed boxes or all individually packed boxes.

    Possible 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.
    boolean
    ShipmentStatus
    required
    Indicates the status of the inbound shipment. When used with the createInboundShipment operation, WORKING is the only valid value. When used with the updateInboundShipment operation, possible values are WORKING, SHIPPED or CANCELLED.ShipmentStatus
    LabelPrepPreference
    required
    The preference for label preparation for an inbound shipment.LabelPrepPreference
    IntendedBoxContentsSource
    optional
    How the seller intends to provide box contents information for a shipment.IntendedBoxContentsSource

    InboundShipmentInfo

    Information about the seller's inbound shipments. Returned by the listInboundShipments operation.

    NameDescriptionSchema
    ShipmentId
    optional
    The shipment identifier submitted in the request.string
    ShipmentName
    optional
    The name for the inbound shipment.string
    ShipFromAddress
    required
    The return address.Address
    DestinationFulfillmentCenterId
    optional
    An Amazon fulfillment center identifier created by Amazon.string
    ShipmentStatus
    optional
    Indicates the status of the inbound shipment. When used with the createInboundShipment operation, WORKING is the only valid value. When used with the updateInboundShipment operation, possible values are WORKING, SHIPPED or CANCELLED.ShipmentStatus
    LabelPrepType
    optional
    The type of label preparation that is required for the inbound shipment.LabelPrepType
    AreCasesRequired
    required
    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.boolean
    ConfirmedNeedByDate
    optional
    Date by which the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items.DateStringType
    BoxContentsSource
    optional
    Where the seller provided box contents information for a shipment.BoxContentsSource
    EstimatedBoxContentsFee
    optional
    An estimate of the manual processing fee charged by Amazon for boxes without box content information. This is only returned when BoxContentsSource is NONE.BoxContentsFeeDetails

    InboundShipmentItem

    Item information for an inbound shipment. Submitted with a call to the createInboundShipment or updateInboundShipment operation.

    NameDescriptionSchema
    ShipmentId
    optional
    A shipment identifier originally returned by the createInboundShipmentPlan operation.string
    SellerSKU
    required
    The seller SKU of the item.string
    FulfillmentNetworkSKU
    optional
    Amazon's fulfillment network SKU of the item.string
    QuantityShipped
    required
    The item quantity that you are shipping.Quantity
    QuantityReceived
    optional
    The item quantity that has been received at an Amazon fulfillment center.Quantity
    QuantityInCase
    optional
    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.Quantity
    ReleaseDate
    optional
    The date that a pre-order item will be available for sale.DateStringType
    PrepDetailsList
    optional
    A list of preparation instructions and who is responsible for that preparation.PrepDetailsList

    InboundShipmentItemList

    A list of inbound shipment item information.

    Type : < InboundShipmentItem > array

    InboundShipmentList

    A list of inbound shipment information.

    Type : < InboundShipmentInfo > array

    InboundShipmentPlan

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

    NameDescriptionSchema
    ShipmentId
    required
    A shipment identifier originally returned by the createInboundShipmentPlan operation.string
    DestinationFulfillmentCenterId
    required
    An Amazon fulfillment center identifier created by Amazon.string
    ShipToAddress
    required
    The address of the Amazon fulfillment center to which to ship the items.Address
    LabelPrepType
    required
    The type of label preparation that is required for the inbound shipment.LabelPrepType
    Items
    required
    SKU and quantity information for the items in the shipment.InboundShipmentPlanItemList
    EstimatedBoxContentsFee
    optional
    The manual processing fee per unit and total fee for a shipment.BoxContentsFeeDetails

    InboundShipmentPlanItem

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

    NameDescriptionSchema
    SellerSKU
    required
    The seller SKU of the item.string
    FulfillmentNetworkSKU
    required
    Amazon's fulfillment network SKU of the item.string
    Quantity
    required
    The item quantity that you are shipping.Quantity
    PrepDetailsList
    optional
    A list of preparation instructions and who is responsible for that preparation.PrepDetailsList

    InboundShipmentPlanItemList

    A list of inbound shipment plan item information.

    Type : < InboundShipmentPlanItem > array

    InboundShipmentPlanList

    A list of inbound shipment plan information

    Type : < InboundShipmentPlan > array

    InboundShipmentPlanRequestItem

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

    NameDescriptionSchema
    SellerSKU
    required
    The seller SKU of the item.string
    ASIN
    required
    The Amazon Standard Identification Number (ASIN) of the item.string
    Condition
    required
    The condition of the item.Condition
    Quantity
    required
    The item quantity.Quantity
    QuantityInCase
    optional
    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.Quantity
    PrepDetailsList
    optional
    A list of preparation instructions and who is responsible for that preparation.PrepDetailsList

    InboundShipmentPlanRequestItemList

    Type : < InboundShipmentPlanRequestItem > array

    IntendedBoxContentsSource

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

    Type : enum

    ValueDescription
    NONEThere is no box content information for this shipment. Amazon will manually process the box contents. This may incur a fee.
    FEEDBox content information is provided through the POST_FBA_INBOUND_CARTON_CONTENTS feed.
    2D_BARCODEBox content information is provided by a barcode on the shipment.

    InvalidASIN

    NameDescriptionSchema
    ASIN
    optional
    The Amazon Standard Identification Number (ASIN) of the item.string
    ErrorReason
    optional
    The reason that the ASIN is invalid.ErrorReason

    InvalidASINList

    A list of invalid ASIN values and the reasons they are invalid.

    Type : < InvalidASIN > array

    InvalidSKU

    NameDescriptionSchema
    SellerSKU
    optional
    The seller SKU of the item.string
    ErrorReason
    optional
    The reason why the seller SKU is invalid.ErrorReason

    InvalidSKUList

    A list of invalid SKU values and the reason they are invalid.

    Type : < InvalidSKU > array

    LabelPrepPreference

    The preference for label preparation for an inbound shipment.

    Type : enum

    ValueDescription
    SELLER_LABELThe seller labels the items in the inbound shipment when labels are required.
    AMAZON_LABEL_ONLYAmazon 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_PREFERREDAmazon 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.

    LabelPrepType

    The type of label preparation that is required for the inbound shipment.

    Type : enum

    ValueDescription
    NO_LABELNo label preparation is required. All items in this shipment will be handled as stickerless, commingled inventory.
    SELLER_LABELLabel preparation by the seller is required.
    AMAZON_LABELLabel preparation by Amazon is required.

    Note: AMAZON_LABEL is available only if you are enrolled in the FBA Label Service. For more information about the FBA Label Service, see the Seller Central Help for your marketplace.

    GetShipmentItemsResult

    NameDescriptionSchema
    ItemData
    optional
    A list of item information for an inbound shipment.InboundShipmentItemList
    NextToken
    optional
    When present and not empty, pass this string token in the next request to return the next response page.string

    GetShipmentItemsResponse

    The response schema for the getShipmentItems operation.

    NameDescriptionSchema
    payload
    optional
    The payload for the getShipmentItems operation.GetShipmentItemsResult
    errors
    optional
    A list of error responses returned when a request is unsuccessful.ErrorList

    GetShipmentsResult

    NameDescriptionSchema
    ShipmentData
    optional
    Information about your inbound shipments.InboundShipmentList
    NextToken
    optional
    When present and not empty, pass this string token in the next request to return the next response page.string

    GetShipmentsResponse

    The response schema for the getShipments operation.

    NameDescriptionSchema
    payload
    optional
    The payload for the getShipments operation.GetShipmentsResult
    errors
    optional
    A list of error responses returned when a request is unsuccessful.ErrorList

    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.

    NameDescriptionSchema
    CarrierName
    required
    The carrier that you are using for the inbound shipment.string
    ProNumber
    required
    The PRO number ("progressive number" or "progressive ID") assigned to the shipment by the carrier.ProNumber

    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.

    NameDescriptionSchema
    CarrierName
    required
    The carrier that you are using for the inbound shipment.string
    ProNumber
    required
    The PRO number ("progressive number" or "progressive ID") assigned to the shipment by the carrier.ProNumber

    NonPartneredSmallParcelDataInput

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

    NameDescriptionSchema
    CarrierName
    required
    The carrier that you are using for the inbound shipment.string
    PackageList
    required
    A list of package tracking information.NonPartneredSmallParcelPackageInputList

    NonPartneredSmallParcelDataOutput

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

    NameDescriptionSchema
    PackageList
    required
    A list of packages, including carrier, tracking number, and status information for each package.NonPartneredSmallParcelPackageOutputList

    NonPartneredSmallParcelPackageInput

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

    NameDescriptionSchema
    TrackingId
    required
    The tracking number of the package, provided by the carrier.TrackingId

    NonPartneredSmallParcelPackageInputList

    A list of package tracking information.

    Type : < NonPartneredSmallParcelPackageInput > array

    NonPartneredSmallParcelPackageOutput

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

    NameDescriptionSchema
    CarrierName
    required
    The carrier that you are using for the inbound shipment.string
    TrackingId
    required
    The tracking number of the package, provided by the carrier.TrackingId
    PackageStatus
    required
    The shipment status of the package.PackageStatus

    NonPartneredSmallParcelPackageOutputList

    A list of packages, including carrier, tracking number, and status information for each package.

    Type : < NonPartneredSmallParcelPackageOutput > array

    PackageStatus

    The shipment status of the package.

    Type : enum

    ValueDescription
    SHIPPEDThe carrier has picked up the package from your facility.
    IN_TRANSITThe carrier has made an appointment for delivery to an Amazon fulfillment center.
    DELIVEREDThe carrier has delivered the package to the loading dock of an Amazon fulfillment center.
    CHECKED_INThe Amazon fulfillment center has accepted delivery of the package from the carrier.
    RECEIVINGThe Amazon fulfillment center has begun the receiving process on the package.
    CLOSEDThe Amazon fulfillment center has completed the receiving process on the package.
    DELETEDThe shipment has been deleted.

    Pallet

    Pallet information.

    NameDescriptionSchema
    Dimensions
    required
    The dimensions of the pallet. Length and width must be 40 inches by 48 inches. Height must be less than or equal to 60 inches.Dimensions
    Weight
    optional
    The weight of the pallet.Weight
    IsStacked
    required
    Indicates whether pallets will be stacked when carrier arrives for pick-up.boolean

    PalletList

    A list of pallet information.

    Type : < Pallet > array

    PartneredEstimate

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

    NameDescriptionSchema
    Amount
    required
    The amount that the Amazon-partnered carrier will charge to ship the inbound shipment.Amount
    ConfirmDeadline
    optional
    The date in ISO 8601 date time format by which this estimate must be confirmed. After this date the estimate is no longer valid and cannot be confirmed.

    Returned only if the TransportStatus value of the inbound shipment is ESTIMATED.
    TimeStampStringType
    VoidDeadline
    optional
    The date in ISO 8601 date time format after which a confirmed transportation request can no longer be voided. This date is 24 hours after a Small Parcel shipment transportation request is confirmed or one hour after a Less Than Truckload/Full Truckload (LTL/FTL) shipment transportation request is confirmed. After the void deadline passes the seller's account will be charged for the shipping cost.

    Returned only if the TransportStatus value of the inbound shipment is CONFIRMED.
    TimeStampStringType

    PartneredLtlDataInput

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

    NameDescriptionSchema
    Contact
    optional
    Contact information for the person in the seller's organization who is responsible for the shipment. Used by the carrier if they have questions about the shipment.Contact
    BoxCount
    optional
    The number of boxes in the shipment.UnsignedIntType
    SellerFreightClass
    optional
    The freight class of the shipment. For information about determining the freight class, contact the carrier.SellerFreightClass
    FreightReadyDate
    optional
    The date that the shipment will be ready to be picked up by the carrier.DateStringType
    PalletList
    optional
    A list of pallet information.PalletList
    TotalWeight
    optional
    The total weight of the shipment.Weight
    SellerDeclaredValue
    optional
    The declaration of the total value of the inventory in the shipment.Amount

    PartneredLtlDataOutput

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

    NameDescriptionSchema
    Contact
    required
    Contact information for the person in the seller's organization who is responsible for the shipment. Used by the carrier if they have questions about the shipment.Contact
    BoxCount
    required
    The number of boxes in the shipment.UnsignedIntType
    SellerFreightClass
    optional
    The freight class of the shipment. For information about determining the freight class, contact the carrier.SellerFreightClass
    FreightReadyDate
    required
    The date that the shipment will be ready to be picked up by the carrier. Must be in YYYY-MM-DD format.DateStringType
    PalletList
    required
    A list of pallet information.PalletList
    TotalWeight
    required
    The total weight of the shipment.Weight
    SellerDeclaredValue
    optional
    Your declaration of the total value of the inventory in the shipment.Amount
    AmazonCalculatedValue
    optional
    Estimate by Amazon of the total value of the inventory in the shipment.Amount
    PreviewPickupDate
    required
    The estimated date that the shipment will be picked up by the carrier, in YYYY-MM-DD format.DateStringType
    PreviewDeliveryDate
    required
    The estimated date that the shipment will be delivered to an Amazon fulfillment center, in YYYY-MM-DD format.DateStringType
    PreviewFreightClass
    required
    The freight class of the shipment as estimated by Amazon if you did not include a freight class when you called the putTransportDetails operation.SellerFreightClass
    AmazonReferenceId
    required
    A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment.string
    IsBillOfLadingAvailable
    required
    Indicates whether the bill of lading for the shipment is available.boolean
    PartneredEstimate
    optional
    The estimated shipping cost using an Amazon-partnered carrier.PartneredEstimate
    CarrierName
    required
    The carrier for the inbound shipment.string

    PartneredSmallParcelDataInput

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

    NameDescriptionSchema
    PackageList
    optional
    A list of dimensions and weight information for packages.PartneredSmallParcelPackageInputList
    CarrierName
    optional
    The Amazon-partnered carrier to use for the inbound shipment.
    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.
    string

    PartneredSmallParcelDataOutput

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

    NameDescriptionSchema
    PackageList
    required
    A list of packages, including shipping information from the Amazon-partnered carrier.PartneredSmallParcelPackageOutputList
    PartneredEstimate
    optional
    The estimated shipping cost for a shipment using an Amazon-partnered carrier.PartneredEstimate

    PartneredSmallParcelPackageInput

    Dimension and weight information for the package.

    NameDescriptionSchema
    Dimensions
    required
    The dimension values and unit of measurement.Dimensions
    Weight
    required
    The weight of the package.Weight

    PartneredSmallParcelPackageInputList

    A list of dimensions and weight information for packages.

    Type : < PartneredSmallParcelPackageInput > array

    PartneredSmallParcelPackageOutput

    Dimension, weight, and shipping information for the package.

    NameDescriptionSchema
    Dimensions
    required
    The dimension values and unit of measurement.Dimensions
    Weight
    required
    The weight of the package.Weight
    CarrierName
    required
    The carrier specified with a previous call to putTransportDetails.string
    TrackingId
    required
    The tracking number of the package, provided by the carrier.TrackingId
    PackageStatus
    required
    The shipment status of the package.PackageStatus

    PartneredSmallParcelPackageOutputList

    A list of packages, including shipping information from the Amazon-partnered carrier.

    Type : < PartneredSmallParcelPackageOutput > array

    PrepDetails

    Preparation instructions and who is responsible for the preparation.

    NameDescriptionSchema
    PrepInstruction
    required
    Preparation instructions for shipping an item to Amazon's fulfillment network. For more information about preparing items for shipment to Amazon's fulfillment network, see the Seller Central Help for your marketplace.PrepInstruction
    PrepOwner
    required
    Indicates who will prepare the item.PrepOwner

    PrepDetailsList

    A list of preparation instructions and who is responsible for that preparation.

    Type : < PrepDetails > array

    PrepGuidance

    Item preparation instructions.

    Type : enum

    ValueDescription
    ConsultHelpDocumentsIndicates 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.
    NoAdditionalPrepRequiredIndicates that the item does not require preparation in addition to any item labeling that might be required.
    SeePrepInstructionsListIndicates that the item requires preparation in addition to any item labeling that might be required. See the PrepInstructionList in the response for item preparation instructions.

    PrepInstruction

    Preparation instructions for shipping an item to Amazon's fulfillment network. For more information about preparing items for shipment to Amazon's fulfillment network, see the Seller Central Help for your marketplace.

    Type : enum

    ValueDescription
    PolybaggingIndicates that polybagging is required.
    BubbleWrappingIndicates that bubble wrapping is required.
    TapingIndicates that taping is required.
    BlackShrinkWrappingIndicates that black shrink wrapping is required.
    LabelingIndicates that the FNSKU label should be applied to the item.
    HangGarmentIndicates that the item should be placed on a hanger.

    PrepInstructionList

    A list of preparation instructions to help with item sourcing decisions.

    Type : < PrepInstruction > array

    PrepOwner

    Indicates who will prepare the item.

    Type : enum

    ValueDescription
    AMAZONIndicates Amazon will prepare the item.
    SELLERIndicates the seller will prepare the item.

    ProNumber

    The PRO number ("progressive number" or "progressive ID") assigned to the shipment by the carrier.

    Type : string

    PutTransportDetailsRequest

    The request schema for a putTransportDetails operation.

    NameDescriptionSchema
    IsPartnered
    required
    Indicates whether a putTransportDetails request is for an Amazon-partnered carrier.boolean
    ShipmentType
    required
    Specifies the carrier shipment type in a putTransportDetails request.ShipmentType
    TransportDetails
    required
    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.TransportDetailInput

    PutTransportDetailsResponse

    Workflow status for a shipment with an Amazon-partnered carrier.

    NameDescriptionSchema
    payload
    optional
    The payload for the putTransportDetails operation.CommonTransportResult
    errors
    optional
    A list of error responses returned when a request is unsuccessful.ErrorList

    Quantity

    The item quantity.

    Type : integer (int32)

    SKUInboundGuidance

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

    NameDescriptionSchema
    SellerSKU
    required
    The seller SKU of the item.string
    ASIN
    required
    The Amazon Standard Identification Number (ASIN) of the item.string
    InboundGuidance
    required
    Specific inbound guidance for an item.InboundGuidance
    GuidanceReasonList
    optional
    A list of reasons for the current inbound guidance for this item.GuidanceReasonList

    SKUInboundGuidanceList

    A list of SKU inbound guidance information.

    Type : < SKUInboundGuidance > array

    SKUPrepInstructions

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

    NameDescriptionSchema
    SellerSKU
    optional
    The seller SKU of the item.string
    ASIN
    optional
    The Amazon Standard Identification Number (ASIN) of the item.string
    BarcodeInstruction
    optional
    Labeling requirements for the item. For more information about FBA labeling requirements, see the Seller Central Help for your marketplace.BarcodeInstruction
    PrepGuidance
    optional
    Item preparation instructions.PrepGuidance
    PrepInstructionList
    optional
    A list of preparation instructions to help with item sourcing decisions.PrepInstructionList
    AmazonPrepFeesDetailsList
    optional
    A list of preparation instructions and fees for Amazon to prep goods for shipment.AmazonPrepFeesDetailsList

    SKUPrepInstructionsList

    A list of SKU labeling requirements and item preparation instructions.

    Type : < SKUPrepInstructions > array

    SellerFreightClass

    The freight class of the shipment. For information about determining the freight class, contact the carrier.

    Type : enum

    ValueDescription
    5050
    5555
    6060
    6565
    7070
    77.577.5
    8585
    92.592.5
    100100
    110110
    125125
    150150
    175175
    200200
    250250
    300300
    400400
    500500

    ShipmentStatus

    Indicates the status of the inbound shipment. When used with the createInboundShipment operation, WORKING is the only valid value. When used with the updateInboundShipment operation, possible values are WORKING, SHIPPED or CANCELLED.

    Type : enum

    ValueDescription
    WORKINGThe shipment was created by the seller, but has not yet shipped.
    SHIPPEDThe shipment was picked up by the carrier.
    RECEIVINGThe shipment has arrived at the fulfillment center, but not all items have been marked as received.
    CANCELLEDThe shipment was cancelled by the seller after the shipment was sent to the fulfillment center.
    DELETEDThe shipment was cancelled by the seller before the shipment was sent to the fulfillment center.
    CLOSEDThe shipment has arrived at the fulfillment center and all items have been marked as received.
    ERRORThere was an error with the shipment and it was not processed by Amazon.
    IN_TRANSITThe carrier has notified the fulfillment center that it is aware of the shipment.
    DELIVEREDThe shipment was delivered by the carrier to the fulfillment center.
    CHECKED_INThe shipment was checked-in at the receiving dock of the fulfillment center.

    ShipmentType

    Specifies the carrier shipment type in a putTransportDetails request.

    Type : enum

    ValueDescription
    SPSmall Parcel.
    LTLLess Than Truckload/Full Truckload (LTL/FTL).

    TimeStampStringType

    Type : string (date-time)

    TrackingId

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

    Type : string

    TransportContent

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

    NameDescriptionSchema
    TransportHeader
    required
    The shipping identifier, 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).TransportHeader
    TransportDetails
    required
    Inbound shipment information, including carrier details and shipment status.TransportDetailOutput
    TransportResult
    required
    The workflow status for a shipment with an Amazon-partnered carrier.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.

    NameDescriptionSchema
    PartneredSmallParcelData
    optional
    Information that is required by an Amazon-partnered carrier to ship a Small Parcel inbound shipment.PartneredSmallParcelDataInput
    NonPartneredSmallParcelData
    optional
    Information that you provide to Amazon about a Small Parcel shipment shipped by a carrier that has not partnered with Amazon.NonPartneredSmallParcelDataInput
    PartneredLtlData
    optional
    Information that is required by an Amazon-partnered carrier to ship a Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment.PartneredLtlDataInput
    NonPartneredLtlData
    optional
    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.NonPartneredLtlDataInput

    TransportDetailOutput

    Inbound shipment information, including carrier details and shipment status.

    NameDescriptionSchema
    PartneredSmallParcelData
    optional
    Information returned by Amazon about a Small Parcel shipment by an Amazon-partnered carrier.PartneredSmallParcelDataOutput
    NonPartneredSmallParcelData
    optional
    Information returned by Amazon about a Small Parcel shipment by a carrier that has not partnered with Amazon.NonPartneredSmallParcelDataOutput
    PartneredLtlData
    optional
    Information returned by Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment by an Amazon-partnered carrier.PartneredLtlDataOutput
    NonPartneredLtlData
    optional
    Information returned by Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment shipped by a carrier that has not partnered with Amazon.NonPartneredLtlDataOutput

    TransportHeader

    The shipping identifier, 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).

    NameDescriptionSchema
    SellerId
    required
    The Amazon seller identifier.string
    ShipmentId
    required
    A shipment identifier originally returned by the createInboundShipmentPlan operation.string
    IsPartnered
    required
    Indicates whether a putTransportDetails request is for a partnered carrier.

    Possible values:

  • true – Request is for an Amazon-partnered carrier.

  • false – Request is for a non-Amazon-partnered carrier.
  • boolean
    ShipmentType
    required
    Specifies the carrier shipment type in a putTransportDetails request.ShipmentType

    TransportResult

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

    NameDescriptionSchema
    TransportStatus
    required
    Indicates the status of the Amazon-partnered carrier shipment.TransportStatus
    ErrorCode
    optional
    An error code that identifies the type of error that occured.string
    ErrorDescription
    optional
    A message that describes the error condition.string

    TransportStatus

    Indicates the status of the Amazon-partnered carrier shipment.

    Type : enum

    ValueDescription
    WORKINGYou have successfully called the putTransportDetails operation for this shipment but have not yet called the estimateTransport operation
    ESTIMATINGYou have successfully called the estimateTransport operation for this shipment and the carrier is in the process of estimating the shipment cost.
    ESTIMATEDThe carrier has completed the process of estimating the shipment cost. Your transportation request is ready to be confirmed by you.
    ERROR_ON_ESTIMATINGThere was a problem with your call to the estimateTransport operation and an error was returned.
    CONFIRMINGYou have successfully called the confirmTransport operation but the confirmation process is not yet complete.
    CONFIRMEDYour 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 the seller's account will be charged for the shipping cost
    ERROR_ON_CONFIRMINGThere was a problem with your call to the confirmTransport operation and an error was returned.
    VOIDINGYou have successfully called the voidTransport operation for a confirmed carrier shipment but the voiding process is not yet complete.
    VOIDEDYour confirmed carrier shipment has been voided. The seller's account will not be charged for the shipping cost.
    ERROR_IN_VOIDINGThere was a problem with your call to the voidTransport operation and an error was returned.
    ERRORThere was a problem with your call and an error was returned.

    UnitOfMeasurement

    Indicates the unit of measurement.

    Type : enum

    ValueDescription
    inchesThe unit of measurement is inches.
    centimetersThe unit of measurement is centimeters.

    UnitOfWeight

    Indicates the unit of weight.

    Type : enum

    ValueDescription
    poundsThe unit of weight is pounds.
    kilogramsThe unit of weight is kilograms.

    UnsignedIntType

    Type : integer (int64)

    VoidTransportResponse

    The response schema for the voidTransport operation.

    NameDescriptionSchema
    payload
    optional
    The payload for the voidTransport operation.CommonTransportResult
    errors
    optional
    A list of error responses returned when a request is unsuccessful.ErrorList

    Weight

    The weight of the package.

    NameDescriptionSchema
    Value
    required
    The weight value.BigDecimalType
    Unit
    required
    Indicates the unit of weight.UnitOfWeight

    LabelType

    The type of labels requested.

    Type : enum

    ValueDescription
    BARCODE_2DThis option is provided only for shipments where 2D Barcodes will be applied to all packages. Amazon strongly recommends using the UNIQUE option to get package labels instead of the BARCODE_2D option.
    UNIQUEDocument data for printing unique shipping labels and carrier labels for an inbound shipment.
    PALLETDocument data for printing pallet labels for a Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment.

    ShipmentStatusList

    Type : enum

    ValueDescription
    WORKINGThe shipment was created by the seller, but has not yet shipped.
    SHIPPEDThe shipment was picked up by the carrier.
    RECEIVINGThe shipment has arrived at the fulfillment center, but not all items have been marked as received.
    CANCELLEDThe shipment was cancelled by the seller after the shipment was sent to the fulfillment center.
    DELETEDThe shipment was cancelled by the seller before the shipment was sent to the fulfillment center.
    CLOSEDThe shipment has arrived at the fulfillment center and all items have been marked as received.
    ERRORThere was an error with the shipment and it was not processed by Amazon.
    IN_TRANSITThe carrier has notified the fulfillment center that it is aware of the shipment.
    DELIVEREDThe shipment was delivered by the carrier to the fulfillment center.
    CHECKED_INThe shipment was checked-in at the receiving dock of the fulfillment center.

    PageType

    The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.

    Type : enum

    ValueDescription
    PackageLabel_Letter_2Two labels per US Letter label sheet. This is the only valid value for Amazon-partnered shipments in the US that use United Parcel Service (UPS) as the carrier. Supported in Canada and the US.
    PackageLabel_Letter_4Four labels per US Letter label sheet. This is the only valid value for non-Amazon-partnered shipments in the US. Supported in Canada and the US.
    PackageLabel_Letter_6Six labels per US Letter label sheet. This is the only valid value for non-Amazon-partnered shipments in the US. Supported in Canada and the US.
    PackageLabel_Letter_6_CarrierLeftPackageLabel_Letter_6_CarrierLeft
    PackageLabel_A4_2Two labels per A4 label sheet.
    PackageLabel_A4_4Four labels per A4 label sheet.
    PackageLabel_Plain_PaperOne label per sheet of US Letter paper. Only for non-Amazon-partnered shipments.
    PackageLabel_Plain_Paper_CarrierBottomPackageLabel_Plain_Paper_CarrierBottom
    PackageLabel_ThermalFor use of a thermal printer. Supports Amazon-partnered shipments with UPS.
    PackageLabel_Thermal_UnifiedFor use of a thermal printer. Supports shipments with ATS.
    PackageLabel_Thermal_NonPCPFor use of a thermal printer. Supports non-Amazon-partnered shipments.
    PackageLabel_Thermal_No_Carrier_RotationFor use of a thermal printer. Supports Amazon-partnered shipments with DHL.

    QueryType

    Type : enum

    For use with the operation(s): getShipments
    Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.

    ValueDescription
    SHIPMENTReturns shipments based on the shipment information provided by the ShipmentStatusList or ShipmentIdList parameters.
    DATE_RANGEReturns shipments based on the date range information provided by the LastUpdatedAfter and LastUpdatedBefore parameters.
    NEXT_TOKENReturns shipments by using NextToken to continue returning items specified in a previous request.

    For use with the operation(s): getShipmentItems
    Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request.

    ValueDescription
    DATE_RANGEReturns items based on the date range information provided by the LastUpdatedAfter and LastUpdatedBefore parameters.
    NEXT_TOKENReturns items by using NextToken to continue returning items specified in a previous request.

    Did this page help you?