Fulfillment Inbound API v0 Reference
Create and update inbound inventory to Amazon's fulfillment network.
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
getPrepInstructions
getLabels
getBillOfLading
getShipments
getShipmentItemsByShipmentId
getShipmentItems
Paths
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 |
|---|---|
| 2 | 30 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | ShipToCountryCode 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}) |
| Query | SellerSKUList 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 |
| Query | ASINList 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 Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetPrepInstructionsResponse |
| 400 | Request 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 |
| 401 | The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetPrepInstructionsResponse |
| 403 | Indicates 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 |
| 404 | The 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 |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetPrepInstructionsResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetPrepInstructionsResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetPrepInstructionsResponse |
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 |
|---|---|
| 2 | 30 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | shipmentId required | A shipment identifier originally returned by the createInboundShipmentPlan operation. | string |
| Query | PageType 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) |
| Query | LabelType required | The type of labels requested. | enum (LabelType) |
| Query | NumberOfPackages optional | The number of packages in the shipment. | integer |
| Query | PackageLabelsToPrint optional | A list of identifiers that specify packages for which you want package labels printed. If you provide box content information with the FBA Inbound Shipment Carton Information Feed, then PackageLabelsToPrint must match the CartonId values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then PackageLabelsToPrint must match the boxID values from the listShipmentBoxes response. If these values do not match as required, the operation returns the IncorrectPackageIdentifier error code. | < string > array |
| Query | NumberOfPallets optional | The number of pallets in the shipment. This returns four identical labels for each pallet. | integer |
| Query | PageSize 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 |
| Query | PageStartIndex 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 Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetLabelsResponse |
| 400 | Request 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 |
| 401 | The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetLabelsResponse |
| 403 | Indicates 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 |
| 404 | The 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 |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetLabelsResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetLabelsResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : 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 |
|---|---|
| 2 | 30 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | shipmentId required | A shipment identifier originally returned by the createInboundShipmentPlan operation. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetBillOfLadingResponse |
| 400 | Request 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 |
| 401 | The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetBillOfLadingResponse |
| 403 | Indicates 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 |
| 404 | The 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 |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetBillOfLadingResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetBillOfLadingResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : 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 |
|---|---|
| 2 | 30 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | ShipmentStatusList 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 |
| Query | ShipmentIdList 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. Max count : 999 | < string > array |
| Query | LastUpdatedAfter 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) |
| Query | LastUpdatedBefore 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) |
| Query | QueryType 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) |
| Query | NextToken optional | A string token returned in the response to your previous request. | string |
| Query | MarketplaceId required | A marketplace identifier. Specifies the marketplace where the product would be stored. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentsResponse |
| 400 | Request 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 |
| 401 | The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentsResponse |
| 403 | Indicates 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 |
| 404 | The 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 |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentsResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentsResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : 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 |
|---|---|
| 2 | 30 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | shipmentId required | A shipment identifier used for selecting items in a specific inbound shipment. | string |
| Query | MarketplaceId optional | Deprecated. Do not use. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentItemsResponse |
| 400 | Request 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 |
| 401 | The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentItemsResponse |
| 403 | Indicates 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 |
| 404 | The 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 |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentItemsResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentItemsResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : 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 |
|---|---|
| 2 | 30 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | LastUpdatedAfter 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) |
| Query | LastUpdatedBefore 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) |
| Query | QueryType 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) |
| Query | NextToken optional | A string token returned in the response to your previous request. | string |
| Query | MarketplaceId required | A marketplace identifier. Specifies the marketplace where the product would be stored. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentItemsResponse |
| 400 | Request 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 |
| 401 | The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentItemsResponse |
| 403 | Indicates 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 |
| 404 | The 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 |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentItemsResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentItemsResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentItemsResponse |
Definitions
Error
Error response returned when the request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| 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
ASINPrepInstructions
Item preparation instructions to help with item sourcing decisions.
| Name | Description | Schema |
|---|---|---|
| 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
Specific details to identify a place.
| Name | Description | Schema |
|---|---|---|
| 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.
| Name | Description | Schema |
|---|---|---|
| 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.
| Name | Description | Schema |
|---|---|---|
| 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
| Value | Description |
|---|---|
| RequiresFNSKULabel | Indicates that a scannable FBA product label must be applied to the item. Cover any original bar codes on the item. |
| CanUseOriginalBarcode | Indicates that the item does not require a scannable FBA product label. The original manufacturer's bar code can be used. |
| MustProvideSellerSKU | Amazon is unable to return labeling requirements. To get labeling requirements for items, call the getPrepInstructions operation. |
BigDecimalType
Number format that supports decimal.
Type : number (double)
BoxContentsFeeDetails
The manual processing fee per unit and total fee for a shipment.
BoxContentsSource
Where the seller provided box contents information for a shipment.
Type : enum
| Value | Description |
|---|---|
| NONE | There is no box contents information for this shipment. Amazon will manually process the box contents information. This may incur a fee. |
| FEED | Box contents information is provided through the POST_FBA_INBOUND_CARTON_CONTENTS feed. |
| 2D_BARCODE | Box contents information is provided by a barcode on the shipment. For more information, see Using 2D barcodes for box content information on Seller Central. |
| INTERACTIVE | Box contents information is provided by an interactive source, such as a web tool. |
CurrencyCode
The currency code.
Type : enum
| Value | Description |
|---|---|
| USD | United States Dollar. |
| GBP | British pound sterling. |
DateStringType
Type containing date in string format
Type : string (date)
ErrorReason
The reason that the ASIN is invalid.
Type : enum
| Value | Description |
|---|---|
| DoesNotExist | Indicates that the ASIN is not included in the Amazon product catalog for any of the marketplaces that the seller participates in. |
| InvalidASIN | The ASIN is invalid. |
GetBillOfLadingResponse
The response schema for the getBillOfLading operation.
| Name | Description | Schema |
|---|---|---|
| payload optional | The payload for the getBillOfLading operation. | BillOfLadingDownloadURL |
| errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
LabelDownloadURL
Download URL for a label
| Name | Description | Schema |
|---|---|---|
| DownloadURL optional | URL to download the label for the package. Note: The URL will only be valid for 15 seconds | string |
BillOfLadingDownloadURL
Download URL for the bill of lading.
| Name | Description | Schema |
|---|---|---|
| DownloadURL optional | URL to download the bill of lading for the package. Note: The URL will only be valid for 15 seconds | string |
GetLabelsResponse
The response schema for the getLabels operation.
| Name | Description | Schema |
|---|---|---|
| payload optional | The payload for the getLabels operation. | LabelDownloadURL |
| errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
GetPrepInstructionsResult
Result for the get prep instructions operation
| Name | Description | Schema |
|---|---|---|
| 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.
| Name | Description | Schema |
|---|---|---|
| payload optional | The payload for the getPrepInstructions operation. | GetPrepInstructionsResult |
| errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
InboundShipmentInfo
Information about the seller's inbound shipments. Returned by the listInboundShipments operation.
| Name | Description | Schema |
|---|---|---|
| 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.
| Name | Description | Schema |
|---|---|---|
| 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
InvalidASIN
Contains details about an invalid ASIN
| Name | Description | Schema |
|---|---|---|
| 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
Contains detail about an invalid SKU
| Name | Description | Schema |
|---|---|---|
| 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
LabelPrepType
The type of label preparation that is required for the inbound shipment.
Type : enum
| Value | Description |
|---|---|
| NO_LABEL | No label preparation is required. All items in this shipment will be handled as stickerless, commingled inventory. |
| SELLER_LABEL | Label preparation by the seller is required. |
| AMAZON_LABEL | Label preparation by Amazon is required. Note: AMAZON_LABEL is available only if you are enrolled in the FBA Label Service. For more information about the FBA Label Service, see the Seller Central Help for your marketplace. |
GetShipmentItemsResult
Result for the get shipment items operation
| Name | Description | Schema |
|---|---|---|
| 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.
| Name | Description | Schema |
|---|---|---|
| payload optional | The payload for the getShipmentItems operation. | GetShipmentItemsResult |
| errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
GetShipmentsResult
Result for the get shipments operation
| Name | Description | Schema |
|---|---|---|
| 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.
| Name | Description | Schema |
|---|---|---|
| payload optional | The payload for the getShipments operation. | GetShipmentsResult |
| errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
PrepDetails
Preparation instructions and who is responsible for the preparation.
| Name | Description | Schema |
|---|---|---|
| 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
| Value | Description |
|---|---|
| ConsultHelpDocuments | Indicates that Amazon is currently unable to determine the preparation instructions for this item. Amazon might be able to provide guidance at a future date, after evaluating the item. |
| NoAdditionalPrepRequired | Indicates that the item does not require preparation in addition to any item labeling that might be required. |
| SeePrepInstructionsList | Indicates that the item requires preparation in addition to any item labeling that might be required. See the PrepInstructionList 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
| Value | Description |
|---|---|
| Polybagging | Indicates that polybagging is required. |
| BubbleWrapping | Indicates that bubble wrapping is required. |
| Taping | Indicates that taping is required. |
| BlackShrinkWrapping | Indicates that black shrink wrapping is required. |
| Labeling | Indicates that the FNSKU label should be applied to the item. |
| HangGarment | Indicates that the item should be placed on a hanger. |
| SetCreation | Units that are sets must be labeled as sets on their packaging. The barcodes on the individual items must 1) not face outward and 2) not require covering. |
| Boxing | Products may require overboxing when there are safety concerns over sharp items, fragile items, hazardous liquids, and vinyl records. For items over 4.5 kg, use double-wall corrugated boxes. |
| RemoveFromHanger | Indicates that the item cannot be shipped on a hanger. |
| Debundle | Indicates requiring taking apart a set of items labeled for individual sale. Remove tape or shrink wrap that groups multiple inventory units together. |
| SuffocationStickering | Poly bags with an opening of 12 cm or larger (measured when flat) must have a suffocation warning. This warning must be printed on the bag or attached as a label. |
| CapSealing | To prevent leakage, product needs to have a secondary seal in one of the following types: Induction seal, safety ring, clips, heat shrink plastic band, or boxing. |
| SetStickering | Products that are sets (for example, a set of six unique toy cars that is sold as one unit) must be marked as sets on their packaging. Add a label to the unit that clearly states that the products are to be received and sold as a single unit. |
| BlankStickering | Indicates applying a blank sticker to obscure a bad barcode that cannot be covered by another sticker. |
| ShipsInProductPackaging | Indicates that item ships in its original product packaging. |
| NoPrep | Indicates that the item does not require any prep. |
PrepInstructionList
A list of preparation instructions to help with item sourcing decisions.
Type : < PrepInstruction > array
PrepOwner
Indicates who will prepare the item.
Type : enum
| Value | Description |
|---|---|
| AMAZON | Indicates Amazon will prepare the item. |
| SELLER | Indicates the seller will prepare the item. |
Quantity
The item quantity.
Type : integer (int32)
SKUPrepInstructions
Labeling requirements and item preparation instructions to help you prepare items for shipment to Amazon's fulfillment network.
| Name | Description | Schema |
|---|---|---|
| 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
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
| Value | Description |
|---|---|
| WORKING | The shipment was created by the seller, but has not yet shipped. |
| SHIPPED | The shipment was picked up by the carrier. |
| RECEIVING | The shipment has arrived at the fulfillment center, but not all items have been marked as received. |
| CANCELLED | The shipment was cancelled by the seller after the shipment was sent to the fulfillment center. |
| DELETED | The shipment was cancelled by the seller before the shipment was sent to the fulfillment center. |
| CLOSED | The shipment has arrived at the fulfillment center and all items have been marked as received. |
| ERROR | There was an error with the shipment and it was not processed by Amazon. |
| IN_TRANSIT | The carrier has notified the fulfillment center that it is aware of the shipment. |
| DELIVERED | The shipment was delivered by the carrier to the fulfillment center. |
| CHECKED_IN | The shipment was checked-in at the receiving dock of the fulfillment center. |
LabelType
The type of labels requested.
Type : enum
| Value | Description |
|---|---|
| BARCODE_2D | This 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. |
| UNIQUE | Document data for printing unique shipping labels and carrier labels for an inbound shipment. |
| PALLET | Document data for printing pallet labels for a Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. |
ShipmentStatusList
Type : enum
| Value | Description |
|---|---|
| WORKING | The shipment was created by the seller, but has not yet shipped. |
| READY_TO_SHIP | The seller has printed box labels (for Small parcel shipments) or pallet labels (for Less Than Truckload shipments). |
| SHIPPED | The shipment was picked up by the carrier. |
| RECEIVING | The shipment has arrived at the fulfillment center, but not all items have been marked as received. |
| CANCELLED | The shipment was cancelled by the seller after the shipment was sent to the fulfillment center. |
| DELETED | The shipment was cancelled by the seller before the shipment was sent to the fulfillment center. |
| CLOSED | The shipment has arrived at the fulfillment center and all items have been marked as received. |
| ERROR | There was an error with the shipment and it was not processed by Amazon. |
| IN_TRANSIT | The carrier has notified the fulfillment center that it is aware of the shipment. |
| DELIVERED | The shipment was delivered by the carrier to the fulfillment center. |
| CHECKED_IN | The 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
| Value | Description |
|---|---|
| PackageLabel_Letter_2 | Two 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_4 | Four 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 | Six 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_CarrierLeft | PackageLabel_Letter_6_CarrierLeft |
| PackageLabel_A4_2 | Two labels per A4 label sheet. |
| PackageLabel_A4_4 | Four labels per A4 label sheet. |
| PackageLabel_Plain_Paper | One label per sheet of US Letter paper. Only for non-Amazon-partnered shipments. |
| PackageLabel_Plain_Paper_CarrierBottom | PackageLabel_Plain_Paper_CarrierBottom |
| PackageLabel_Thermal | For use of a thermal printer. Supports Amazon-partnered shipments with UPS. |
| PackageLabel_Thermal_Unified | For use of a thermal printer. Supports shipments with ATS. |
| PackageLabel_Thermal_NonPCP | For use of a thermal printer. Supports non-Amazon-partnered shipments. |
| PackageLabel_Thermal_No_Carrier_Rotation | For 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.
| Value | Description |
|---|---|
| SHIPMENT | Returns shipments based on the shipment information provided by the ShipmentStatusList or ShipmentIdList parameters. |
| DATE_RANGE | Returns shipments based on the date range information provided by the LastUpdatedAfter and LastUpdatedBefore parameters. |
| NEXT_TOKEN | Returns 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.
| Value | Description |
|---|---|
| DATE_RANGE | Returns items based on the date range information provided by the LastUpdatedAfter and LastUpdatedBefore parameters. |
| NEXT_TOKEN | Returns items by using NextToken to continue returning items specified in a previous request. |
Updated about 18 hours ago