Amazon Warehousing and Distribution API v2024-05-09 Reference

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

createInbound
getInbound
updateInbound
cancelInbound
confirmInbound
getInboundShipment
getInboundShipmentLabels
updateInboundShipmentTransportDetails
checkInboundEligibility
listInboundShipments
listInventory

Paths

POST /awd/2024-05-09/inboundOrders

Operation: createInbound

Description

Creates a draft AWD inbound order with a list of packages for inbound shipment. The operation creates one shipment per order.

Usage Plan:

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have 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

Responses

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

Consumes

• application/json

Produces

• application/json

Example HTTP request

Request body

{
  "externalReferenceId" : "TestReferenceId",
  "originAddress" : {
    "addressLine1" : "address_1",
    "addressLine2" : "address_2",
    "addressLine3" : "address_3",
    "city" : "City1",
    "countryCode" : "CC",
    "district" : "District1",
    "name" : "address_name",
    "postalCode" : "123456",
    "stateOrRegion" : "State1"
  },
  "packagesToInbound" : [ {
    "count" : 1,
    "distributionPackage" : {
      "contents" : {
        "products" : [ {
          "quantity" : 1,
          "sku" : "testPen"
        } ]
      },
      "measurements" : {
        "dimensions" : {
          "height" : 1,
          "length" : 1,
          "unitOfMeasurement" : "INCHES",
          "width" : 1
        },
        "volume" : {
          "unitOfMeasurement" : "CUIN",
          "volume" : 1
        },
        "weight" : {
          "unitOfMeasurement" : "POUNDS",
          "weight" : 1
        }
      },
      "type" : "CASE"
    }
  } ],
  "preferences" : {
    "destinationRegion" : "us-west"
  }
}

GET /awd/2024-05-09/inboundOrders/{orderId}

Operation: getInbound

Description

Retrieves an AWD inbound order.

Usage Plan:

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have 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

Responses

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

Produces

• application/json

Example HTTP response

Response 200

{
  "destinationDetails" : {
    "destinationAddress" : {
      "addressLine1" : "address_1",
      "addressLine2" : "address_2",
      "addressLine3" : "address_3",
      "city" : "Seattle",
      "countryCode" : "US",
      "county" : "Washington",
      "district" : "District1",
      "name" : "address_name",
      "phoneNumber" : "+14155552671",
      "postalCode" : "123456",
      "stateOrRegion" : "Washington"
    },
    "destinationRegion" : "us-east",
    "shipmentId" : "TestShipmentId"
  },
  "createdAt" : "2023-06-07T12:12:09.061Z",
  "externalReferenceId" : "TestReferenceId",
  "orderId" : "TestOrderId",
  "orderStatus" : "DRAFT",
  "originAddress" : {
    "addressLine1" : "address_1",
    "addressLine2" : "address_2",
    "addressLine3" : "address_3",
    "city" : "Seattle",
    "countryCode" : "US",
    "county" : "Washington",
    "district" : "District1",
    "name" : "address_name",
    "phoneNumber" : "+14155552671",
    "postalCode" : "123456",
    "stateOrRegion" : "Washington"
  },
  "packagesToInbound" : [ {
    "count" : 1,
    "distributionPackage" : {
      "contents" : {
        "packages" : [ ],
        "products" : [ {
          "quantity" : 1,
          "sku" : "testPen",
          "expiration" : "2025-06-07T12:12:09.061Z",
          "prepDetails" : {
            "prepCategory" : "PERFORATED",
            "prepOwner" : "AMAZON",
            "labelOwner" : "SELF",
            "prepInstructions" : [ {
              "prepType" : "ITEM_POLYBAGGING",
              "prepOwner" : "AMAZON"
            } ]
          }
        } ]
      },
      "measurements" : {
        "dimensions" : {
          "height" : 2.54,
          "length" : 2.54,
          "unitOfMeasurement" : "CENTIMETERS",
          "width" : 2.54
        },
        "weight" : {
          "unitOfMeasurement" : "KILOGRAMS",
          "weight" : 0.453592
        }
      },
      "type" : "CASE"
    }
  } ],
  "updatedAt" : "2023-06-07T12:12:09.061Z",
  "preferences" : {
    "destinationRegion" : "us-west"
  }
}

PUT /awd/2024-05-09/inboundOrders/{orderId}

Operation: updateInbound

Description

Updates an AWD inbound order that is in DRAFT status and not yet confirmed. Use this operation to update the packagesToInbound, originAddress and preferences attributes.

Usage Plan:

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have 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

Responses

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

Consumes

• application/json

Produces

• application/json

Example HTTP request

Request body

{
  "destinationDetails" : {
    "destinationAddress" : {
      "addressLine1" : "address_1",
      "addressLine2" : "address_2",
      "addressLine3" : "address_3",
      "city" : "Seattle",
      "countryCode" : "US",
      "county" : "Washington",
      "district" : "District1",
      "name" : "address_name",
      "phoneNumber" : "+14155552671",
      "postalCode" : "123456",
      "stateOrRegion" : "Washington"
    },
    "destinationRegion" : "us-east",
    "shipmentId" : "TestShipmentId"
  },
  "createdAt" : "2023-06-07T12:12:09.061Z",
  "externalReferenceId" : "TestReferenceId",
  "orderId" : "TestOrderId",
  "orderStatus" : "DRAFT",
  "originAddress" : {
    "addressLine1" : "address_1",
    "addressLine2" : "address_2",
    "addressLine3" : "address_3",
    "city" : "Seattle",
    "countryCode" : "US",
    "county" : "Washington",
    "district" : "District1",
    "name" : "address_name",
    "phoneNumber" : "+14155552671",
    "postalCode" : "123456",
    "stateOrRegion" : "Washington"
  },
  "packagesToInbound" : [ {
    "count" : 1,
    "distributionPackage" : {
      "contents" : {
        "packages" : [ ],
        "products" : [ {
          "quantity" : 1,
          "sku" : "testPen",
          "expiration" : "2025-06-07T12:12:09.061Z",
          "prepDetails" : {
            "prepCategory" : "PERFORATED",
            "prepOwner" : "AMAZON",
            "labelOwner" : "SELF",
            "prepInstructions" : [ {
              "prepType" : "ITEM_POLYBAGGING",
              "prepOwner" : "AMAZON"
            } ]
          }
        } ]
      },
      "measurements" : {
        "dimensions" : {
          "height" : 2.54,
          "length" : 2.54,
          "unitOfMeasurement" : "CENTIMETERS",
          "width" : 2.54
        },
        "weight" : {
          "unitOfMeasurement" : "KILOGRAMS",
          "weight" : 0.453592
        }
      },
      "type" : "CASE"
    }
  } ],
  "updatedAt" : "2023-06-07T12:12:09.061Z",
  "preferences" : {
    "destinationRegion" : "us-west"
  }
}

POST /awd/2024-05-09/inboundOrders/{orderId}/cancellation

Operation: cancelInbound

Description

Cancels an AWD Inbound order and its associated shipment.

Usage Plan:

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have 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

Responses

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

Produces

• application/json

POST /awd/2024-05-09/inboundOrders/{orderId}/confirmation

Operation: confirmInbound

Description

Confirms an AWD inbound order in DRAFT status.

Usage Plan:

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

Responses

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

Produces

• application/json

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

Operation: getInboundShipment

Description

Retrieves an AWD inbound shipment.

Usage Plan:

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

Responses

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

Produces

• application/json

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

Operation: getInboundShipmentLabels

Description

Retrieves the box labels for a shipment ID that you specify. This is an asynchronous operation. If the label status is GENERATED, then the label URL is available.

Usage Plan:

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have 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

Responses

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

Produces

• application/json

PUT /awd/2024-05-09/inboundShipments/{shipmentId}/transport

Operation: updateInboundShipmentTransportDetails

Description

Updates transport details for an AWD shipment.

Usage Plan:

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

Responses

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

Consumes

• application/json

Produces

• application/json

Example HTTP request

Request body

{
  "trackingDetails" : [ {
    "carrierCode" : {
      "carrierCodeType" : "SCAC"
    },
    "bookingId" : "TRACKING_ID"
  } ]
}

POST /awd/2024-05-09/inboundEligibility

Operation: checkInboundEligibility

Description

Determines if the packages you specify are eligible for an AWD inbound order and contains error details for ineligible packages.

Usage Plan:

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have 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

Responses

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

Consumes

• application/json

Produces

• application/json

Example HTTP request

Request body

{
  "packagesToInbound" : [ {
    "count" : 1,
    "distributionPackage" : {
      "contents" : {
        "products" : [ {
          "quantity" : 1,
          "sku" : "testPen"
        } ]
      },
      "measurements" : {
        "dimensions" : {
          "height" : 1,
          "length" : 1,
          "unitOfMeasurement" : "INCHES",
          "width" : 1
        },
        "volume" : {
          "unitOfMeasurement" : "CUIN",
          "volume" : 1
        },
        "weight" : {
          "unitOfMeasurement" : "POUNDS",
          "weight" : 1
        }
      },
      "type" : "CASE"
    }
  } ]
}

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:

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

Responses

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:

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

Responses

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.

Definitions

Address

Shipping address that represents the origin or destination location.

CarrierCode

Identifies the carrier that will deliver the shipment.

CarrierCodeType

Denotes the type for the carrier.

Type : enum

DestinationDetails

Destination details of an inbound order based on the assigned region and DC for the order.

DimensionUnitOfMeasurement

Unit of measurement for package dimensions.

Type : enum

DistributionPackage

Represents an AWD distribution package.

DistributionPackageContents

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

DistributionPackageQuantity

Represents a distribution package with its respective quantity.

DistributionPackageType

Type of distribution packages.

Type : enum

Error

Error response returned when the request is unsuccessful.

ErrorList

This exception is thrown when client inputs are invalid.

InboundEligibility

Represents the eligibility status of the inbound packages.

InboundEligibilityStatus

Enum denoting the package inbound eligibility.

Type : enum

InboundOrder

Represents an AWD inbound order.

InboundOrderCreationData

Payload for creating an inbound order.

InboundOrderReference

A response that contains the reference identifiers for the newly created or updated inbound order. Consists of an order ID and version.

InboundPackages

Represents the packages to inbound.

InboundPreferences

Preferences that can be passed in context of an inbound order

InboundShipment

Represents an AWD inbound shipment.

InboundShipmentStatus

Possible shipment statuses used by shipments.

Type : enum

InboundShipmentSummary

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

InboundStatus

The supported statuses for an inbound order.

Type : enum

ExpirationDetails

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

InventoryDetails

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

InventoryListing

AWD inventory payload.

InventoryQuantity

Quantity of inventory with an associated measurement unit context.

InventorySummary

Summary of inventory per SKU.

InventoryUnitOfMeasurement

Unit of measurement for the inventory.

Type : enum

LabelOwner

The entity that labels the products.

Type : enum

LabelStatus

The status of your label.

Type : enum

MeasurementData

Package weight and dimension.

OrderIneligibilityReason

Represents one ineligibility reason for the order (there can be multiple reasons).

PackageDimensions

Dimensions of the package.

PackageVolume

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

PackageWeight

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

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.

PrepCategory

The preparation category for shipping an item to Amazon's fulfillment network.

Type : enum

PrepInstruction

Information pertaining to the preparation of inbound products.

PrepOwner

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

Type : enum

ProductAttribute

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

ProductQuantity

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

ShipmentLabels

Shipment labels.

ShipmentListing

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

SkuEligibility

Represents eligibility of one SKU.

SkuIneligibilityReason

Represents the ineligibility reason for one SKU.

SkuQuantity

Quantity details for a SKU as part of a shipment

TrackingDetails

Tracking details for the shipment. If using SPD transportation, this can be for each case. If not using SPD transportation, this is a single tracking entry for the entire shipment.

TransportationDetails

Transportation details for the shipment.

VolumeUnitOfMeasurement

Unit of measurement for the package volume.

Type : enum

WeightUnitOfMeasurement

Unit of measurement for the package weight.

Type : enum

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

Details

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

Type : enum

ShipmentStatus

Filter by inbound shipment status.

Type : enum

SortBy

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

Type : enum

PageType

Page type for the generated labels. The default is PLAIN_PAPER.

Type : enum

FormatType

The format type of the output file that contains your labels. The default format type is PDF.

Type : enum

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.

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