Amazon Warehousing and Distribution API Use Case Guide
How to work with Amazon Warehousing and Distribution (AWD) orders using the Amazon Warehousing and Distribution API.
API Version: 2024-05-09
What is the Amazon Warehousing and Distribution API?
You can use the Selling Partner API for Amazon Warehousing and Distribution (AWD) to develop applications that retrieve and track AWD inbound shipments that contain items that are or were planned to be inbounded to a distribution center. You can also request lists of inbound shipments across orders that pertain to a merchant or seller based on criteria you specify. After the distribution center receives your inventory, AWD can automatically or manually replenish your inventory in Prime-ready fulfillment centers. You can track the real-time inventory status of units stored in an AWD distribution center, and units that are reserved by a replenishment order to ship out to a fulfillment center. For details about API operations and associated data types and schemas, refer to the Amazon Warehousing and Distribution API reference.
What is in this guide?
This guide describes how to use the AWD API to:
- Track inventory inside AWD distribution centers.
- Track shipments going into AWD distribution centers.
Key features
- List all inbound shipments: To get the details of all the historical shipments, use
GEToperations to retrieve all inbound shipments across orders with optional filters. - Retrieve details about inbound shipments: The AWD API accepts
GEToperations to return detailed information about an existing shipment. - Track AWD inventory: AWD inventory API accepts
GEToperations to return detailed information about the real-time inventory status of units stored in an AWD distribution center and units that are reserved by a replenishment order. - Interoperability: To access inbound orders created with Amazon's Send to Amazon Warehousing and Distribution UI, use the AWD API operations.
Terminology
- Inbound order: Inbound orders instruct the movement of inventory from an arbitrary location to an AWD distribution center. An inbound order has one or more inbound shipments. Each inbound shipment represents a trackable movement provided by an underlying transportation carrier.
- Inbound shipments: Inbound shipments include a list of items that are contained within the shipment, and other details, such as: tracking number, carrier information, quantities received, and your item label preparation preferences.
- Inventory listing: An inventory listing contains SKU-level quantities for all inventory in an AWD distribution center. You can retrieve quantitative information about inventory that can be replenished to a downstream channel and inventory reserved by a replenishment order.
Tutorial: Retrieve a list of inbound shipments
This tutorial demonstrates how to get a list of AWD inbound orders for a specific date-time.
Prerequisites
To complete this tutorial, you need:
- Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API Applications.
- The Amazon Warehousing and Distribution role assigned to your developer profile.
- The Amazon Warehousing and Distribution role selected in the app registration page for your application.
Step 1. Get a list of all inbound orders
Call the listInboundShipments operation by passing the following parameters:
Query parameters
| Name | Description | Required |
|---|---|---|
sortBy | Field to sort results by. Required if sortOrder is provided. Type: enum ( SortBy) | No |
sortOrder | Sort the response in ASCENDING or DESCENDING order. Type: enum ( SortOrder) | No |
shipmentStatus | Filter by inbound shipment status. Type: enum ( InboundShipmentStatus) | No |
updatedAfter | List the inbound shipments that were updated after a certain time (inclusive). The date must be in ISO 8601 format. Type: string (date-time) | No |
updatedBefore | List the inbound shipments that were updated before a certain time (inclusive). The date must be in ISO 8601 format. Type: string (date-time) | No |
maxResults | Maximum number of results to return. Minimum: 1 Maximum: 200 Type: integer (int32) | No |
nextToken | Token to retrieve the next set of paginated results. Type: string | No |
Request example
GET "https://sellingpartnerapi-na.amazon.com/awd/2024-05-09/inboundShipments?sortBy=UPDATED_AT&sortOrder=ASCENDING&updatedAfter=2022-12-25T15:45:03.33Z&updatedBefore=2022-12-28T15:45:03.33Z&maxResults=5"
Response
| HTTP code | Description | Schema |
|---|---|---|
| 200 | The 200 response for listInboundShipments. | ShipmentListing |
Headers
x-amzn-RateLimit-Limit(string): Your rate limit (requests per second) for this operation.x-amzn-RequestId(string): Unique request reference identifier.
For error status codes, descriptions, and schemas, refer to Error responses and schemas.
Response properties
| Name | Description | Required |
|---|---|---|
nextToken | Token to retrieve the next set of paginated results. Type: string | No |
shipments | List of inbound shipment summaries. Type: < InboundShipmentSummary > array | No |
InboundShipmentSummary
| Name | Description | Required |
|---|---|---|
createdAt | Timestamp when the shipment was created. The date is returned in ISO 8601 format. Type: string (date-time) | No |
externalReferenceId | Client-provided reference ID that can correlate this shipment to client resources. For example, to map this shipment to an internal bookkeeping order record. Type: string | No |
orderId | The AWD inbound order ID that this inbound shipment belongs to. Type: string | Yes |
shipmentId | Unique shipment ID. Type: string | Yes |
shipmentStatus | Current status of this shipment. Type: enum ( InboundShipmentStatus) | Yes |
updatedAt | Timestamp when the shipment was updated. The date is returned in ISO 8601 format. Type: string (date-time) | No |
Response example
{
"nextToken": "eyJhbGciOiJIUzUxMiJ9.eyJqdGkiOiJkYjlhMTcyMi00MWE5LTQyNTUtODRjYy0zMWMwMzY3YmU0MTQiLCJpYXQiOjE3MTc1NTkxMDYsInN1YiI6IntcImRkYkxhc3RFdmFsdWF0ZWRLZXlcIjpcImV5SnNZWE4wUlhaaGJIVmhkR1ZrUzJWNUlqcDdJbTkzYm1WeUlqcDdJbk1pT2lKN1hDSjBlWEJsWENJNlhDSkJiV0Y2YjI1TlEwbEVYQ0lzWENKcFpGd2lPbHdpUVRJelEwWk1OMWxWVWpkSVRqTmNJaXhjSW0xaGNtdGxkRkJzWVdObFNXUmNJanBjSWpGY0luMGlMQ0p1SWpwdWRXeHNMQ0ppSWpwdWRXeHNMQ0p0SWpwdWRXeHNMQ0pzSWpwdWRXeHNMQ0p6Y3lJNmJuVnNiQ3dpYm5NaU9tNTFiR3dzSW1KeklqcHVkV3hzTENKdWRXeHNJanB1ZFd4c0xDSmliMjlzSWpwdWRXeHNmU3dpZFhCa1lYUmxWR2x0WlNJNmV5SnpJanB1ZFd4c0xDSnVJam9pTVRjeE56VXpNekk1TURBd05TSXNJbUlpT201MWJHd3NJbTBpT201MWJHd3NJbXdpT201MWJHd3NJbk56SWpwdWRXeHNMQ0p1Y3lJNmJuVnNiQ3dpWW5NaU9tNTFiR3dzSW01MWJHd2lPbTUxYkd3c0ltSnZiMndpT201MWJHeDlMQ0pwWkNJNmV5SnpJam9pVTFSQlVpMVVSRlpaUkVwTlZ6VXlXVXBUSWl3aWJpSTZiblZzYkN3aVlpSTZiblZzYkN3aWJTSTZiblZzYkN3aWJDSTZiblZzYkN3aWMzTWlPbTUxYkd3c0ltNXpJanB1ZFd4c0xDSmljeUk2Ym5Wc2JDd2liblZzYkNJNmJuVnNiQ3dpWW05dmJDSTZiblZzYkgxOUxDSjBiM1JoYkVOdmRXNTBJam95TlRreUxDSnNZWE4wUTI5MWJuUWlPalY5XCIsXCJpbnB1dEhhc2hcIjpcIjI1YjExYzdjNjMwZGY2ZDM5NTU3MTMxNDJlY2Y3MTYzYWE2ZWYxNjdhMjRhMTA1ZmQyNGQ3NDM3MWNmMTk2ZDRcIn0iLCJpc3MiOiJEU01TIiwiZXhwIjoxNzE3NjQ1NTA2fQ.Do88Nhr_n9OPVr5TZyx3-ZEoFAmrr_TsEw23h5enVtN6pDFqDrcyJXF0tU5C9OIJEiTVRK-Z3911AxZ1KhyCFw",
"shipments": [
{
"createdAt": "2024-03-06T21:51:53.983Z",
"externalReferenceId": "wf976707c6-6692-4e0a-b108-a1ba917a5cxx",
"orderId": "STAR-W2W4UMHYH6GXX",
"shipmentId": "STAR-RXMJTXWZGU2XX",
"shipmentStatus": "CLOSED",
"updatedAt": "2024-06-04T21:51:55.014Z"
},
{
"createdAt": "2024-03-06T21:17:26.945Z",
"externalReferenceId": "wf885a8eb0-4c20-455b-8687-ffc0eb8507xx",
"orderId": "STAR-QB6Y5BPDNXWXX",
"shipmentId": "STAR-WVEKXEGFHYFXX",
"shipmentStatus": "CLOSED",
"updatedAt": "2024-06-04T21:17:28.020Z"
},
{
"createdAt": "2024-06-04T20:48:46.752Z",
"externalReferenceId": "wfcc55fa04-d090-4b04-a110-a72f74dd82xx",
"orderId": "STAR-R4ZEGJFGWHXXX",
"shipmentId": "STAR-S7YJSYJXSXPXX",
"shipmentStatus": "CANCELLED",
"updatedAt": "2024-06-04T20:49:25.923Z"
},
{
"createdAt": "2024-06-04T20:46:40.866Z",
"externalReferenceId": "wf68f20503-043a-4f9f-b500-d59e257590xx",
"orderId": "STAR-UXBRMX4ENAZXX",
"shipmentId": "STAR-RADCKNCM2XYXX",
"shipmentStatus": "CANCELLED",
"updatedAt": "2024-06-04T20:47:18.686Z"
},
{
"createdAt": "2024-06-04T20:34:15.359Z",
"externalReferenceId": "wf46986b76-5575-467f-84d1-427fd80a78xx",
"orderId": "STAR-VFWFC2WZX6EXX",
"shipmentId": "STAR-TDVYDJMW52YXX",
"shipmentStatus": "CANCELLED",
"updatedAt": "2024-06-04T20:34:50.005Z"
}
]
}
Tutorial: Retrieve a list of inbound shipments
This tutorial demonstrates how to use shipmentStatus to filter the list of AWD inbound orders.
Prerequisites
To complete this tutorial, you need:
- Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API Applications.
- The Amazon Warehousing and Distribution role assigned to your developer profile.
- The Amazon Warehousing and Distribution role selected in the app registration page for your application.
Step 1. Get a list of all inbound orders
Call the listInboundShipments operation by passing the following parameters:
Query parameters
| Name | Description | Required |
|---|---|---|
sortBy | Field to sort results by. Required if sortOrder is provided. Type: enum ( SortBy) | No |
sortOrder | Sort the response in ASCENDING or DESCENDING order. Type: enum ( SortOrder) | No |
shipmentStatus | Filter by inbound shipment status. Type: enum ( InboundShipmentStatus) | No |
updatedAfter | List the inbound shipments that were updated after a certain time (inclusive). The date must be in ISO 8601 format. Type: string (date-time) | No |
updatedBefore | List the inbound shipments that were updated before a certain time (inclusive). The date must be in ISO 8601 format. Type: string (date-time) | No |
maxResults | Maximum number of results to return. Minimum: 1 Maximum: 200 Type: integer (int32) | No |
nextToken | Token to retrieve the next set of paginated results. Type: string | No |
Request example
GET "https://sellingpartnerapi-na.amazon.com/awd/2024-05-09/inboundShipments?sortBy=UPDATED_AT&sortOrder=ASCENDING&shipmentStatus=CREATED&maxResults=5"
Response
| HTTP code | Description | Schema |
|---|---|---|
| 200 | The 200 response for listInboundShipments. | ShipmentListing |
Headers
x-amzn-RateLimit-Limit(string): Your rate limit (requests per second) for this operation.x-amzn-RequestId(string): Unique request reference identifier.
For error status codes, descriptions, and schemas, refer to Error responses and schemas.
Response properties
| Name | Description | Required |
|---|---|---|
nextToken | Token to retrieve the next set of paginated results. Type: string | No |
shipments | List of inbound shipment summaries. Type: < InboundShipmentSummary > array | No |
InboundShipmentSummary
| Name | Description | Required |
|---|---|---|
createdAt | Timestamp when the shipment was created. The date is returned in ISO 8601 format. Type: string (date-time) | No |
externalReferenceId | Client-provided reference ID that can correlate this shipment to client resources. For example, to map this shipment to an internal bookkeeping order record. Type: string | No |
orderId | The AWD inbound order ID that this inbound shipment belongs to. Type: string | Yes |
shipmentId | Unique shipment ID. Type: string | Yes |
shipmentStatus | Current status of this shipment. Type: enum ( InboundShipmentStatus) | Yes |
updatedAt | Timestamp when the shipment was updated. The date is returned in ISO 8601 format. Type: string (date-time) | No |
Response example
{
"nextToken": "eyJhbGciOiJIUzUxMiJ9.eyJqdGkiOiIwZmQxODcxNS1lZGE2LTRhOTUtYWFlMS1mNmY0MTIzMjRkNmIiLCJpYXQiOjE3MTc1NTkxNDYsInN1YiI6IntcImRkYkxhc3RFdmFsdWF0ZWRLZXlcIjpcImV5SnNZWE4wUlhaaGJIVmhkR1ZrUzJWNUlqcDdJbTkzYm1WeUlqcDdJbk1pT2lKN1hDSjBlWEJsWENJNlhDSkJiV0Y2YjI1TlEwbEVYQ0lzWENKcFpGd2lPbHdpUVRJelEwWk1OMWxWVWpkSVRqTmNJaXhjSW0xaGNtdGxkRkJzWVdObFNXUmNJanBjSWpGY0luMGlMQ0p1SWpwdWRXeHNMQ0ppSWpwdWRXeHNMQ0p0SWpwdWRXeHNMQ0pzSWpwdWRXeHNMQ0p6Y3lJNmJuVnNiQ3dpYm5NaU9tNTFiR3dzSW1KeklqcHVkV3hzTENKdWRXeHNJanB1ZFd4c0xDSmliMjlzSWpwdWRXeHNmU3dpZFhCa1lYUmxWR2x0WlNJNmV5SnpJanB1ZFd4c0xDSnVJam9pTVRjeE56UXlOakV6TURnMk5TSXNJbUlpT201MWJHd3NJbTBpT201MWJHd3NJbXdpT201MWJHd3NJbk56SWpwdWRXeHNMQ0p1Y3lJNmJuVnNiQ3dpWW5NaU9tNTFiR3dzSW01MWJHd2lPbTUxYkd3c0ltSnZiMndpT201MWJHeDlMQ0pwWkNJNmV5SnpJam9pVTFSQlVpMVJSRVJVVjBkS1VWTkJRakl5SWl3aWJpSTZiblZzYkN3aVlpSTZiblZzYkN3aWJTSTZiblZzYkN3aWJDSTZiblZzYkN3aWMzTWlPbTUxYkd3c0ltNXpJanB1ZFd4c0xDSmljeUk2Ym5Wc2JDd2liblZzYkNJNmJuVnNiQ3dpWW05dmJDSTZiblZzYkgxOUxDSjBiM1JoYkVOdmRXNTBJam95TlRRc0lteGhjM1JEYjNWdWRDSTZOWDA9XCIsXCJpbnB1dEhhc2hcIjpcIjVmNmU2ZWI0YmUxNGVjNjE4ODIzMzUzZTIyNmY2ZTI3ZGMyMzk2ZWE0NmVkYWFjZjQyYzhjZjFhZGIzZWRiZmVcIn0iLCJpc3MiOiJEU01TIiwiZXhwIjoxNzE3NjQ1NTQ2fQ.HHTW2r2bRmLMYn4UXEreS9isboysYf7bhDD5rOkU9WbiBGKbe3_6py7dXGbgPVjX39E_1dEYYN9P_xfdUtWKOQ",
"shipments": [
{
"createdAt": "2024-06-04T18:42:40.262Z",
"externalReferenceId": "wf0d65f26a-0e30-46b1-8633-b75ebf832cyy",
"orderId": "STAR-SDKNUYRRSRKYY",
"shipmentId": "STAR-UWQJPM3BERJYY",
"shipmentStatus": "CREATED",
"updatedAt": "2024-06-04T18:43:13.251Z"
},
{
"createdAt": "2024-06-04T05:38:52.343Z",
"externalReferenceId": "wf6b9e237b-c898-4961-9891-5507a2d4ddyy",
"orderId": "STAR-V4PH26YS5FTYY",
"shipmentId": "STAR-XMAX23B44SPYY",
"shipmentStatus": "CREATED",
"updatedAt": "2024-06-04T05:39:24.750Z"
},
{
"createdAt": "2024-06-04T05:32:38.387Z",
"externalReferenceId": "wfb1402c90-3089-44ca-9f2c-35d056436cyy",
"orderId": "STAR-W3B5KXMWWPXYY",
"shipmentId": "STAR-XQR3Q3BENW5YY",
"shipmentStatus": "CREATED",
"updatedAt": "2024-06-04T05:33:39.022Z"
},
{
"createdAt": "2024-06-03T18:18:35.278Z",
"externalReferenceId": "wfb45e0961-4ae9-43f9-9516-43e1ad98b0yy",
"orderId": "STAR-RGKE7NYCPKWYY",
"shipmentId": "STAR-TWPBZWMM2XWYY",
"shipmentStatus": "CREATED",
"updatedAt": "2024-06-03T18:19:05.389Z"
},
{
"createdAt": "2024-06-03T14:48:15.235Z",
"externalReferenceId": "wf4872e1d6-ad5e-4989-97f5-41cdae9f63yy",
"orderId": "STAR-SRGD7GVD6GUYY",
"shipmentId": "STAR-QDDTWGJQSABYY",
"shipmentStatus": "CREATED",
"updatedAt": "2024-06-03T14:48:50.865Z"
}
]
}
Tutorial: Track an inbound shipment
This tutorial demonstrates how to retrieve a particular AWD inbound shipment which contains items that are planned to be inbounded into a distribution center.
Prerequisites
To complete this tutorial, you need:
- Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API Applications.
- The Amazon Warehousing and Distribution role assigned to your developer profile.
- The Amazon Warehousing and Distribution role selected in the app registration page for your application.
Step 1. Get inbound shipment details based on a shipmentId
Call the getInboundShipment operation by passing the following parameters:
Path parameters
| Name | Description | Required |
|---|---|---|
shipmentId | Unique shipment ID. Type: string | Yes |
Request example
GET "https://sellingpartnerapi-na.amazon.com/awd/2024-05-09/inboundShipments/STAR-RT6G6UWYQ4SDX"
Response
| HTTP code | Description | Schema |
|---|---|---|
| 200 | The 200 response for GetInboundShipment. | InboundShipment |
Headers
x-amzn-RateLimit-Limit(string): Your rate limit (requests per second) for this operation.x-amzn-RequestId(string): Unique request reference identifier.
For error status codes, descriptions, and schemas, refer to Error responses and schemas.
Response properties
| Name | Description | Required |
|---|---|---|
carrierCode | The shipment carrier code. Type: CarrierCode | No |
createdAt | Timestamp when the shipment was created. The date is returned in ISO 8601 format. Type: string (date-time) | No |
destinationAddress | Destination address for this shipment. Type: Address | Yes |
externalReferenceId | Client-provided reference ID that can correlate this shipment to client resources. For example, to map this shipment to an internal bookkeeping order record. Type: string | No |
orderId | The AWD inbound order ID that this inbound shipment belongs to. minLength: 1 Type: string | Yes |
originAddress | Origin address for this shipment. Type: Address | Yes |
receivedQuantity | Quantity received (at the receiving end) as part of this shipment. Type: < InventoryQuantity > array | No |
shipBy | Timestamp when the shipment will be shipped. Type: string (date-time) | No |
shipmentContainerQuantities | Packages that are part of this shipment. Type: < DistributionPackageQuantity > array | Yes |
shipmentId | Unique shipment ID. Type: string | Yes |
shipmentStatus | Current status of this shipment. Type: enum ( InboundShipmentStatus) | Yes |
trackingId | Carrier-unique tracking ID for this shipment. minLength : 1 Type: string | No |
updatedAt | Timestamp when the shipment was updated. The date is returned in ISO 8601 format. Type: string (date-time) | No |
warehouseReferenceId | An AWD-provided reference ID that you can use to interact with the warehouse. For example, a carrier appointment booking. Type: string | No |
Response example
{
"createdAt": "2023-07-27T12:23:49.324Z",
"destinationAddress": {
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"city": "string",
"countryCode": "string",
"district": "string",
"name": "string",
"postalCode": "string",
"stateOrRegion": "string"
},
"orderId": "STAR-SKFFWD6G6FMXX",
"originAddress": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"countryCode": "string",
"district": "string",
"name": "string",
"postalCode": "string",
"stateOrRegion": "string"
},
"receivedQuantity": [
{
"quantity": 0,
"unitOfMeasurement": "CASES"
}
],
"shipBy": "2024-06-30T18:29:59.000Z",
"shipmentContainerQuantities": [
{
"count": 2,
"distributionPackage": {
"contents": {
"packages": [],
"products": [
{
"attributes": [
{
"name": "asin",
"value": "B001CRVUXX"
},
{
"name": "glProductGroupType",
"value": "gl_office_product"
}
],
"quantity": 3,
"sku": "SKU1"
}
]
},
"measurements": {
"dimensions": {
"height": 5.08,
"length": 25.4,
"unitOfMeasurement": "CENTIMETERS",
"width": 12.7
},
"weight": {
"unitOfMeasurement": "KILOGRAMS",
"weight": 9.07184
}
},
"type": "CASE"
}
}
],
"shipmentId": "STAR-RT6G6UWYQ4SXX",
"shipmentStatus": "CREATED",
"updatedAt": "2024-06-04T18:43:13.251Z",
"warehouseReferenceId": "5MEK9YYY"
}
Tutorial: Get all available inventory summaries with detail
This tutorial demonstrates how to use the AWD Inventory API to return all the inventory summaries with detail.
Prerequisites
To complete this tutorial, you need:
- Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API Applications.
- The Amazon Warehousing and Distribution role assigned to your developer profile.
- The Amazon Warehousing and Distribution role selected in the app registration page for your application.
Step 1. Get AWD inventory summaries
Call the listInventory operation by passing the following parameters:
Query parameters
| Name | Description | Required |
|---|---|---|
sku | Filter by seller or merchant SKU for the item. Type: string | No |
sortOrder | Sort the response in ASCENDING or DESCENDING order. Type: enum ( SortOrder) | No |
details | Set to SHOW to return summaries with additional inventory details. Defaults to HIDE, which returns only inventory summary totals. Type: enum ( Details) | No |
maxResults | Maximum number of results to return. Minimum: 1 Maximum: 200 Type: integer (int32) | No |
nextToken | Token to retrieve the next set of paginated results. Type: string | No |
Request example
GET "https://sellingpartnerapi-na.amazon.com/awd/2024-05-09/inventory?details=SHOW"
Response
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | The 200 response for ListInventory. | InventoryListing |
Headers
x-amzn-RateLimit-Limit(string): Your rate limit (requests per second) for this operation.x-amzn-RequestId(string): Unique request reference identifier.
For error status codes, descriptions, and schemas, refer to Error responses and schemas
Response properties
InventoryListing
| Name | Description | Required |
|---|---|---|
inventory | List of inventory summaries. Type: < InventorySummary > array | Yes |
nextToken | Token to retrieve the next set of paginated results. Type: string | No |
InventorySummary
| Name | Description | Required |
|---|---|---|
inventoryDetails | Additional inventory details. This object will not appear if the details parameter in the request is false. Type: < InventoryDetails > array | No |
sku | The seller or merchant SKU. Type: string | Yes |
totalOnhandQuantity | Total quantity that is present in AWD distribution centers. Type: integer (int64) | No |
InventoryDetails
| Name | Description | Required |
|---|---|---|
availableDistributableQuantity | Quantity that is available for downstream channel replenishment. Type: integer(int64) | No |
reservedDistributableQuantity | Quantity that is reserved for a downstream channel replenishment order that is being prepared for shipment. Type: integer(int64) | No |
Response example
{
"inventory": [
{
"inventoryDetails": {
"availableDistributableQuantity": 300,
"reservedDistributableQuantity": 300
},
"sku": "SKU_1",
"totalOnhandQuantity": 600
},
{
"inventoryDetails": {
"availableDistributableQuantity": 200,
"reservedDistributableQuantity": 0
},
"sku": "SKU_2",
"totalOnhandQuantity": 200
}
],
"nextToken": "eyJhdmFpbGFibGVRdWFudGl0eSI6MCwiY2hhbm5lbElkIjoiYWZuLXVzIiwic2t1VmFsdWUiOiJHQVRFV0FZX1RFU1RfU0tVXzMiLCJza3VUeXBlIjoiTVNLVSJ9"
}
Tutorial: Get inventory summaries for the seller specified SKUs
This tutorial demonstrates how to use the AWD Inventory API to return the inventory summaries for a particular SKU.
Prerequisites
To complete this tutorial, you need:
- Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API Applications.
- The Amazon Warehousing and Distribution role assigned to your developer profile.
- The Amazon Warehousing and Distribution role selected in the app registration page for your application.
Step 1. Get AWD inventory summaries
Call the listInventory operation by passing the following parameters:
Query parameters
| Name | Description | Required |
|---|---|---|
sku | Filter by seller or merchant SKU for the item. Type: string | No |
sortOrder | Sort the response in ASCENDING or DESCENDING order. Type: enum ( SortOrder) | No |
details | Set to SHOW to return summaries with additional inventory details. Defaults to HIDE, which returns only inventory summary totals. Type: enum ( Details) | No |
maxResults | Maximum number of results to return. Minimum: 1 Maximum: 200 Type: integer (int32) | No |
nextToken | Token to retrieve the next set of paginated results. Type: string | No |
Request example
GET "https://sellingpartnerapi-na.amazon.com/awd/2024-05-09/inventory?sku=GATEWAY_TEST_SKU_2&details=SHOW"
Response
| HTTP code | Description | Schema |
|---|---|---|
| 200 | The 200 response for ListInventory. | InventoryListing |
Headers
x-amzn-RateLimit-Limit(string): Your rate limit (requests per second) for this operation.x-amzn-RequestId(string): Unique request reference identifier.
For error status codes, descriptions, and schemas, refer to Error responses and schemas.
Response properties
InventoryListing
| Name | Description | Required |
|---|---|---|
inventory | List of inventory summaries. Type: < InventorySummary > array | Yes |
nextToken | Token to retrieve the next set of paginated results. Type: string | No |
InventorySummary
| Name | Description | Required |
|---|---|---|
inventoryDetails | Additional inventory details. This object will not appear if the details parameter in the request is false. Type: < InventoryDetails > array | No |
sku | The seller or merchant SKU. Type: string | Yes |
totalOnhandQuantity | Total quantity that is present in AWD distribution centers. Type: integer (int64) | No |
InventoryDetails
| Name | Description | Required |
|---|---|---|
availableDistributableQuantity | Quantity that is available to be replenished to a downstream channel. Type: integer(int64) | No |
reservedDistributableQuantity | Quantity that is reserved by a replenishment order and is preparing to ship out to a downstream channel. Type: integer(int64) | No |
Response example
{
"inventory": [
{
"inventoryDetails": {
"availableDistributableQuantity": 200,
"reservedDistributableQuantity": 0
},
"sku": "SKU_2",
"totalOnhandQuantity": 200
}
]
}
Updated 22 days ago