Create an inbound order for shipment

Learn how to create an AWD inbound order for shipment.

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 1a. (Optional) - Determine if the packages that you specify are eligible for an AWD inbound order

Call the checkInboundEligibility operation.

Step 1. Create an AWD inbound order

Call the createInbound operation and pass in the following parameters (Amazon creates a single shipment per order):

The packagesToInbound must contain a list of packages that you want to inbound. ProductQuantity must include the MSKU, quantity, and party that prepares or labels the item. The SKU limit for an inbound order is 150 unique SKUs.

📘

Note

Each item that you ship must conform to Amazon's product packaging requirements. For more information, refer to Packaging and Prep Requirements in Seller Central Help. For more information about Amazon's product packaging requirements for your marketplace, refer to Seller Central URLs.

📘

Note

Currently, AWD inbound API only supports seller managed transportation. If you want to use Partner Carrier Program (PCP), create your inbound shipment in Seller Central. If you want to use AGL, create your inbound shipment with the API and create your AGL order separately. Then, add your AGL tracking number to your AWD inbound shipment with updateInboundShipmentTransportDetails operation.

📘

Note

Amazon does not support multiple expiration dates per SKU on a single inbound order. To send a SKU with multiple expiration dates to the AWD distribution center, you must create multiple inbound orders.

Step 2. Review the inbound order

To review the inbound order details and destination address, call the getInbound operation.

📘

Note

The inbound ShipmentId generates only upon confirmation of the inbound order.

Step 2b. Update the inbound order

The updateInbound operation updates the draft AWD inbound order for the packages that you want to inbound. You can only update AWD inbound orders in DRAFT status and that don't have seller confirmation.

📘

Note

When you update an inbound order, the system re-evaluates the order details. This re-evaluation process might result in the assignment of a different destination address for the inbound shipment.

Call the updateInbound operation.

⭐

Tip

After you update the inbound order, use the getInbound operation to review the inbound order details and confirm the destination address.

Step 3. Confirm the inbound order

With the confirmInbound operation, you can confirm an AWD inbound order in DRAFT status. This confirmation is a requirement for all transportation types and indicates that the order details are ready for further processing. After an order reaches CONFIRMED status, it advances in the inbound workflow and the next steps in the inbound shipping process begin.

📘

Note

Inbound shipments must be confirmed within 90 days after creation. After this period, the inbound order expires.

Step 4. Generate the box labels

Call the getInboundShipmentLabels operation to request unique box labels for your inbound shipments. After you make the call, poll the system regularly to check for a GENERATED labelStatus. When the box labels are ready, affix each box label with its corresponding package in the shipment. The labels indicate the package contents and help the AWD distribution center process your shipment quickly and accurately.

📘

Note

The labels that you generate are valid for 600 seconds and are in a compressed .zip file format.

📘

Note

The shipmentId is created after an inbound shipment has been confirmed. You can call the getInbound operation and shipmentId is included in the response under destinationDetails. Alternatively, you can call the listInboundShipments operation and filter for the shipmentId with the respective orderId.

Step 5. Update the tracking information

You must update the tracking information after you send shipments to AWD distribution centers with non-partnered carriers. The updateInboundShipmentTransportDetails operation requires that you input the shipmentId and transportation information.

For small parcel shipments, you can provide only one booking ID. Amazon uses the booking ID to track and manage incoming inventory.

Call the updateInboundShipmentTransportDetails operation.