Amazon Warehousing and Distribution API
Learn how to work with Amazon Warehousing and Distribution (AWD) orders using the Amazon Warehousing and Distribution API.
<api_overview_awd>
Note
This API is available in the US marketplace.
<api_table_awd />
To learn more about the terms that are used on this page, refer to Terminology.
Use cases
Key tasks that you can perform with the Amazon Warehousing and Distribution API include:
- Verify AWD inbound eligibility and create inbound orders with a region preference.
- Update one or more individual attributes for an inbound order, such as the
packagesToInbound
,originAddress
, andpreferences
attributes. - Cancel an inbound order.
- Retrieve all inbound shipments across orders with optional filters.
- Retrieve inbound shipments with optional filters and access shipment details with SKU-specific attributes.
- Retrieve box labels for confirmed inbound shipments.
- Update transport information for an AWD inbound shipment.
- Return real-time information, such as expiration dates, about the inventory within an AWD distribution center and units that are reserved by a replenishment order. Return quantity information for units that are in transit to AWD or from AWD to a Fulfillment by Amazon (FBA) facility.
- Access inbound orders that you create with Amazon's Send to Amazon Warehousing and Distribution UI.
The following use case examples are available for the Amazon Warehousing and Distribution API v2024-05-09:
- Create an inbound order for shipment: Create, update, and confirm inbound labels and general box labels for tracking.
- Retrieve and filter inbound shipments: Retrieve and filter a list of inbound shipments for a specific time.
- Track an inbound shipment with expected and received SKU details: Retrieve a particular AWD inbound shipment which contains items that are planned to be inbounded to a distribution center. For each SKU, you can also retrieve expiration dates and prep details.
- Get inventory summaries: Get all available inventory summaries for a specific SKU.
AWD inbound shipment workflow
The following diagram shows the steps to ship inventory to an AWD distribution center. This is an illustrative example and does not include all of the optional operations.
Roles
getInboundShipment
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Amazon Warehousing and Distribution |
listInboundShipments
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Amazon Warehousing and Distribution |
listInventory
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Amazon Warehousing and Distribution |
createInbound
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Amazon Warehousing and Distribution |
getInbound
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Amazon Warehousing and Distribution |
updateInbound
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Amazon Warehousing and Distribution |
cancelInbound
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Amazon Warehousing and Distribution |
confirmInbound
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Amazon Warehousing and Distribution |
getInboundShipmentLabels
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Amazon Warehousing and Distribution |
updateInboundShipmentTransportDetails
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Amazon Warehousing and Distribution |
checkInboundEligibility
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Amazon Warehousing and Distribution |
Updated about 24 hours ago