HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
Documentation
Developer HubAPI StatusSupport

Amazon Warehousing and Distribution API v2024-05-09 Reference

Retrieve and track AWD inbound shipments that contain items that are inbound to a distribution center.

The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.

Version information

Version : 2024-05-09

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 : https://www.apache.org/licenses/LICENSE-2.0

URI scheme

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

Consumes

  • application/json

Produces

  • application/json

Operations

getInboundShipment
listInboundShipments
listInventory

Paths

GET /awd/2024-05-09/inboundShipments/{shipmentId}

Operation: getInboundShipment

Description

Retrieves an AWD inbound shipment.

Usage Plan:

Rate (requests per second)Burst
22

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, refer to Usage Plans and Rate Limits in the Selling Partner API

Parameters

TypeNameDescriptionSchema
PathshipmentId
required
ID for the shipment. A shipment contains the cases being inbounded.
minLength : 1
string
QueryskuQuantities
optional
If equal to SHOW, the response includes the shipment SKU quantity details.

Defaults to HIDE, in which case the response does not contain SKU quantities
enum (SkuQuantities)

Responses

HTTP CodeDescriptionSchema
200The 200 response for getInboundShipment.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
InboundShipment

For error status codes, descriptions and schemas, see Error responses and schemas.

Produces

  • application/json

GET /awd/2024-05-09/inboundShipments

Operation: listInboundShipments

Description

Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters.

Usage Plan:

Rate (requests per second)Burst
11

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, refer to Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchemaDefault
QuerysortBy
optional
Field to sort results by. By default, the response will be sorted by UPDATED_AT.enum (SortBy)-
QuerysortOrder
optional
Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order.enum (SortOrder)-
QueryshipmentStatus
optional
Filter by inbound shipment status.enum (ShipmentStatus)-
QueryupdatedAfter
optional
List the inbound shipments that were updated after a certain time (inclusive). The date must be in ISO 8601 format.string (date-time)-
QueryupdatedBefore
optional
List the inbound shipments that were updated before a certain time (inclusive). The date must be in ISO 8601 format.string (date-time)-
QuerymaxResults
optional
Maximum number of results to return.
Minimum : 1
Maximum : 200
integer (int32)25
QuerynextToken
optional
A token that is used to retrieve the next page of results. The response includes nextToken when the number of results exceeds the specified maxResults value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextToken is null. Note that this operation can return empty pages.string-

Responses

HTTP CodeDescriptionSchema
200The 200 response for listInboundShipments.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
ShipmentListing

For error status codes, descriptions and schemas, see Error responses and schemas.

Produces

  • application/json

GET /awd/2024-05-09/inventory

Operation: listInventory

Description

Lists AWD inventory associated with a merchant with the ability to apply optional filters.

Usage Plan:

Rate (requests per second)Burst
22

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, refer to Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchemaDefault
Querysku
optional
Filter by seller or merchant SKU for the item.string-
QuerysortOrder
optional
Sort the response in ASCENDING or DESCENDING order.enum (SortOrder)-
Querydetails
optional
Set to SHOW to return summaries with additional inventory details. Defaults to HIDE, which returns only inventory summary totals.enum (Details)-
QuerynextToken
optional
A token that is used to retrieve the next page of results. The response includes nextToken when the number of results exceeds the specified maxResults value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextToken is null. Note that this operation can return empty pages.string-
QuerymaxResults
optional
Maximum number of results to return.
Minimum : 1
Maximum : 200
integer (int32)25

Responses

HTTP CodeDescriptionSchema
200The 200 response for listInventory.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
InventoryListing

For error status codes, descriptions and schemas, see Error responses and schemas.

Produces

  • application/json

Error Responses and Schemas

This table contains HTTP status codes and associated information for error responses.

HTTP CodeDescriptionSchema
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.
ErrorList
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.
ErrorList
404The resource specified 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.
ErrorList
413The request size exceeded the maximum accepted size.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
415The request payload is in an unsupported format.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
429The frequency of requests was greater than allowed.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
503Temporary overloading or maintenance of the server.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList

Definitions

Address

Shipping address that represents the origin or destination location.

NameDescriptionSchema
addressLine1
required
First line of the address text.string
addressLine2
optional
Optional second line of the address text.string
addressLine3
optional
Optional third line of the address text.string
city
optional
Optional city where this address is located.string
countryCode
required
Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.string
county
optional
Optional county where this address is located.
Example : "Washington"
string
district
optional
Optional district where this address is located.string
name
required
Name of the person, business, or institution at this address.string
phoneNumber
optional
Optional E.164-formatted phone number for an available contact at this address.
Example : "+14155552671"
string
postalCode
optional
Optional postal code where this address is located.string
stateOrRegion
required
State or region where this address is located. Note that this is contextual to the specified country code.string

CarrierCode

Identifies the carrier that will deliver the shipment.

NameDescriptionSchema
carrierCodeType
optional
Denotes the carrier type.CarrierCodeType
carrierCodeValue
optional
Value of the carrier code.
Example : "TestCarrierCode"
string

CarrierCodeType

Denotes the type for the carrier.

Type : enum

ValueDescription
SCACStandard Carrier Alpha Code. Refer to What is a Standard Carrier Alpha Code for more information.

DimensionUnitOfMeasurement

Unit of measurement for package dimensions.

Type : enum

ValueDescription
INCHESDenotes package dimensions in inches.
CENTIMETERSDenotes package dimensions in centimeters.

DistributionPackage

Represents an AWD distribution package.

NameDescriptionSchema
contents
required
The contents appropriate for the type.DistributionPackageContents
measurements
required
Measurements of a package, including weight, volume, and dimensions.MeasurementData
type
required
Type of distribution package.DistributionPackageType

DistributionPackageContents

Represents the contents inside a package, which can be products or a nested package.

NameDescriptionSchema
packages
optional
This is required only when DistributionPackageType=PALLET.< DistributionPackageQuantity > array
products
optional
This is required only when DistributionPackageType=CASE.< ProductQuantity > array

DistributionPackageQuantity

Represents a distribution package with its respective quantity.

NameDescriptionSchema
count
required
Number of cases or pallets with the same package configuration.integer (int32)
distributionPackage
required
Represents an AWD distribution package.DistributionPackage

DistributionPackageType

Type of distribution packages.

Type : enum

ValueDescription
CASEPackage type CASE.
PALLETPackage type PALLET. Currently, the PALLET package type is not supported.

Error

Error response returned when the request is unsuccessful.

NameDescriptionSchema
code
required
An error code that identifies the type of error that occurred.string
details
optional
Additional details that can help the caller understand or fix the issue.string
message
required
A message that describes the error condition.string

ErrorList

This exception is thrown when client inputs are invalid.

NameDescriptionSchema
errors
required
A list of errors describing the failures.< Error > array

InboundShipment

Represents an AWD inbound shipment.

NameDescriptionSchema
carrierCode
optional
The shipment carrier code.CarrierCode
createdAt
optional
Timestamp when the shipment was created. The date is returned in ISO 8601 format.string (date-time)
destinationAddress
required
Destination address for this shipment.Address
externalReferenceId
optional
Client-provided reference ID that can correlate this shipment to client resources. For example, to map this shipment to an internal bookkeeping order record.
Example : "TestReferenceId"
string
orderId
required
The AWD inbound order ID that this inbound shipment belongs to.
minLength : 1
string
originAddress
required
Origin address for this shipment.Address
receivedQuantity
optional
Quantity received (at the receiving end) as part of this shipment.< InventoryQuantity > array
shipBy
optional
Timestamp when the shipment will be shipped.string (date-time)
shipmentContainerQuantities
required
Packages that are part of this shipment.< DistributionPackageQuantity > array
shipmentId
required
Unique shipment ID.
minLength : 1
string
shipmentSkuQuantities
optional
Quantity details at SKU level for the shipment. This attribute will only appear if the skuQuantities parameter in the request is set to SHOW.< SkuQuantity > array
destinationRegion
optional
Assigned region where the order will be shipped. This can differ from what was passed as preference. AWD currently supports following region IDs: [us-west, us-east]
Example : "us-west"
string
shipmentStatus
required
Current status of this shipment.InboundShipmentStatus
trackingId
optional
Carrier-unique tracking ID for this shipment.
minLength : 1
string
updatedAt
optional
Timestamp when the shipment was updated. The date is returned in ISO 8601 format.string (date-time)
warehouseReferenceId
optional
An AWD-provided reference ID that you can use to interact with the warehouse. For example, a carrier appointment booking.
Example : "TestWarehouseReferenceId"
string

InboundShipmentStatus

Possible shipment statuses used by shipments.

Type : enum

ValueDescription
CREATEDShipment is created but has not yet shipped.
SHIPPEDShipment was picked up by the carrier or was dropped off with the carrier.
IN_TRANSITThe carrier has notified AWD that the shipment is in transit between origin and destination node.
RECEIVINGThe shipment has been partially received.
DELIVEREDThe shipment has reached the destination node and has been delivered to the facility yard. The shipment receive process at the warehouse will start soon.
CLOSEDNo more actions required on the shipment. This is a final state.
CANCELLEDShipment has been cancelled. This is a final state.

InboundShipmentSummary

Summary for an AWD inbound shipment containing the shipment ID, which can be used to retrieve the actual shipment.

NameDescriptionSchema
createdAt
optional
Timestamp when the shipment was created.string (date-time)
externalReferenceId
optional
Optional client-provided reference ID that can be used to correlate this shipment with client resources. For example, to map this shipment to an internal bookkeeping order record.
Example : "TestReferenceId"
string
orderId
required
The AWD inbound order ID that this inbound shipment belongs to.
minLength : 1
string
shipmentId
required
A unique shipment ID.
minLength : 1
string
shipmentStatus
required
Possible shipment statuses used by shipments.InboundShipmentStatus
updatedAt
optional
Timestamp when the shipment was updated.string (date-time)

ExpirationDetails

The expiration details of the inventory. This object will only appear if the details parameter in the request is set to SHOW.

NameDescriptionSchema
expiration
optional
The expiration date of the SKU.string (date-time)
onhandQuantity
optional
The quantity that is present in AWD.integer (int64)

InventoryDetails

Additional inventory details. This object is only displayed if the details parameter in the request is set to SHOW.

NameDescriptionSchema
availableDistributableQuantity
optional
Quantity that is available for downstream channel replenishment.integer (int64)
reservedDistributableQuantity
optional
Quantity that is reserved for a downstream channel replenishment order that is being prepared for shipment.integer (int64)

InventoryListing

AWD inventory payload.

NameDescriptionSchema
inventory
required
List of inventory summaries.< InventorySummary > array
nextToken
optional
A token that is used to retrieve the next page of results. The response includes nextToken when the number of results exceeds the specified maxResults value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextToken is null. Note that this operation can return empty pages.
Example : "SampleToken"
string

InventoryQuantity

Quantity of inventory with an associated measurement unit context.

NameDescriptionSchema
quantity
required
Quantity of the respective inventory.number
unitOfMeasurement
required
Unit of measurement for the inventory.InventoryUnitOfMeasurement

InventorySummary

Summary of inventory per SKU.

NameDescriptionSchema
expirationDetails
optional
The expiration details of the inventory. This object will only appear if the details parameter in the request is set to SHOW.< ExpirationDetails > array
inventoryDetails
optional
Additional inventory details. This object is only displayed if the details parameter in the request is set to SHOW.InventoryDetails
sku
required
The seller or merchant SKU.string
totalInboundQuantity
optional
Total quantity that is in-transit from the seller and has not yet been received at an AWD Distribution Centerinteger (int64)
totalOnhandQuantity
optional
Total quantity that is present in AWD distribution centers.integer (int64)

InventoryUnitOfMeasurement

Unit of measurement for the inventory.

Type : enum

ValueDescription
PRODUCT_UNITSMeasures a discrete amount of product units.
CASESMeasures a discrete amount of cases.
PALLETSMeasures a discrete amount of pallets.

LabelOwner

The entity that labels the products.

Type : enum

ValueDescription
AMAZONAmazon labels the products.
SELFThe seller labels the products.

MeasurementData

Package weight and dimension.

NameDescriptionSchema
dimensions
optional
Dimensions of the package. Dimensions are required when creating an inbound or outbound order.PackageDimensions
volume
optional
Volume of the package.PackageVolume
weight
required
Weight of the package.PackageWeight

PackageDimensions

Dimensions of the package.

NameDescriptionSchema
height
required
Height of the package.number (double)
length
required
Length of the package.number (double)
unitOfMeasurement
required
Unit of measurement for package dimensions.DimensionUnitOfMeasurement
width
required
Width of the package.number (double)

PackageVolume

Represents the volume of the package with a unit of measurement.

NameDescriptionSchema
unitOfMeasurement
required
Unit of measurement for the package volume.VolumeUnitOfMeasurement
volume
required
The package volume value.number (double)

PackageWeight

Represents the weight of the package with a unit of measurement.

NameDescriptionSchema
unitOfMeasurement
required
Unit of measurement for the package weight.WeightUnitOfMeasurement
weight
required
The package weight value.number (double)

PrepDetails

The preparation details for a product. This contains the prep category, prep owner, and label owner.
Prep instructions are generated based on the specified category.

NameDescriptionSchema
labelOwner
optional
The entity that labels the products.LabelOwner
prepCategory
optional
The preparation category for shipping an item to Amazon's fulfillment network.string
prepInstructions
optional
Information that pertains to the preparation of inbound products. This is generated based on the specified category.< PrepInstruction > array
prepOwner
optional
The owner of the preparations, if special preparations are required.PrepOwner

PrepInstruction

Information pertaining to the preparation of inbound products.

NameDescriptionSchema
prepOwner
optional
The owner of the preparations, if special preparations are required.PrepOwner
prepType
optional
The type of preparation to be done. For more information about preparing items, refer to Prep guidance on Seller Central.string

PrepOwner

The owner of the preparations, if special preparations are required.

Type : enum

ValueDescription
AMAZONAmazon owns the preparation.
SELFThe seller owns the preparation

ProductAttribute

Product instance attribute that is not described at the SKU level in the catalog.

NameDescriptionSchema
name
optional
Product attribute name.
Example : "TestAttribute"
string
value
optional
Product attribute value.
Example : "TestAttributeValue"
string

ProductQuantity

Represents a product with the SKU details and the corresponding quantity.

NameDescriptionSchema
attributes
optional
Attributes for this instance of the product. For example, already-prepped, or other attributes that distinguish the product beyond the SKU.
Example : {<br> "name" : "TestAttribute",<br> "value" : "TestAttributeValue"<br>}
< ProductAttribute > array
quantity
required
Product quantity.integer (int32)
sku
required
The seller or merchant SKU.string
expiration
optional
The expiration date for the SKU. Values are in ISO 8601 date-time format.string (date-time)
prepDetails
optional
Preparation details of a product which contains the prep category, prep owner and the label owner.
If not passed while creating an inbound order, NO_PREP will be used on the product by-default.
Prep instructions will be generated based on the category passed
PrepDetails

ShipmentListing

A list of inbound shipment summaries filtered by the attributes specified in the request.

NameDescriptionSchema
nextToken
optional
A token that is used to retrieve the next page of results. The response includes nextToken when the number of results exceeds the specified maxResults value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextToken is null. Note that this operation can return empty pages.
Example : "SampleToken"
string
shipments
optional
List of inbound shipment summaries.< InboundShipmentSummary > array

SkuQuantity

Quantity details for a SKU as part of a shipment

NameDescriptionSchema
expectedQuantity
required
Quantity of inventory with an associated measurement unit context.InventoryQuantity
receivedQuantity
optional
Quantity of inventory with an associated measurement unit context.InventoryQuantity
sku
required
The merchant stock keeping unitstring

VolumeUnitOfMeasurement

Unit of measurement for the package volume.

Type : enum

ValueDescription
CU_INDenotes volume measurement in cubic inches.
CBMDenotes volume measurement in cubic meters.
CCDenotes volume measurement in cubic centimeters.

WeightUnitOfMeasurement

Unit of measurement for the package weight.

Type : enum

ValueDescription
POUNDSDenotes weight measurement in pounds.
KILOGRAMSDenotes weight measurement in kilograms.

SkuQuantities

If equal to SHOW, the response includes the shipment SKU quantity details.

Defaults to HIDE, in which case the response does not contain SKU quantities

Type : enum

ValueDescription
SHOWShow the additional SKU quantity details.
HIDEHide the additional SKU quantity details.

Details

Set to SHOW to return summaries with additional inventory details. Defaults to HIDE, which returns only inventory summary totals.

Type : enum

ValueDescription
SHOWShow the additional summarized inventory details.
HIDEHide the additional summarized inventory details.

ShipmentStatus

Filter by inbound shipment status.

Type : enum

ValueDescription
CREATEDShipment is created, but hasn't shipped.
SHIPPEDShipment was picked up by the carrier or was dropped off with the carrier.
IN_TRANSITThe carrier has notified AWD that the shipment is in transit between the origin and destination nodes.
RECEIVINGThe shipment has been partially received.
DELIVEREDThe shipment has reached the destination node and has been delivered to the facility yard. The shipment receive process at the warehouse will start soon.
CLOSEDNo more actions are required for the shipment. This is a final state.
CANCELLEDThe shipment is cancelled. This is a final state.

SortBy

Field to sort results by. By default, the response will be sorted by UPDATED_AT.

Type : enum

ValueDescription
UPDATED_ATSort by the time of update.
CREATED_ATSort by the time of creation.

SortOrder

Type : enum

For use with the operation(s): listInboundShipments
Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order.

ValueDescription
ASCENDINGSorts the collection in ascending order.
DESCENDINGSorts the collection in descending order.

For use with the operation(s): listInventory
Sort the response in ASCENDING or DESCENDING order.

ValueDescription
ASCENDINGSorts the collection in ascending order.
DESCENDINGSorts the collection in descending order.