Confirm the shipment status

Learn how to use the Orders API to confirm the shipment status. You don't need to confirm the shipment if you purchase a shipping label through the Shipping API or buy-shipping UI. The confirmShipment operation supports all use cases that were supported in the Order Fulfillment Feeds, including supporting multiple tracking IDs per order. To submit multiple package tracking IDs, you must send multiple requests with the same order ID but different package reference IDs.

Example:

The package reference ID supports any positive numerical value and is meant for the purpose of editing a shipment after you have confirmed a shipment. You can submit any numerical value as packageReferenceID. If you need to make an edit to the shipment, submit another confirmShipment operation with the same packageReferenceID. The other shipment details are edited upon successful submission. If you do not put any ID when you submit, Amazon automatically assigns a packageReferenceID.

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 Inventory and Order Tracking role assigned to your developer profile.
• The Inventory and Order Tracking role selected in the app registration page for your application.

If you have been approved for the Direct-to-Consumer Delivery (Restricted) role, you can access the confirmShipmentoperation.

Step 1. Confirm a shipment for one order

Call the confirmShipment operation, passing an orderId in the path and the following parameters in the body:

• packageDetail
• codCollectionMethod
• marketplaceId

confirmShipment request example (shipment confirmation step)

POST https://sellingpartnerapi-eu.amazon.com/orders/v0/orders/205-1725759-9209952/shipmentConfirmation
{
  "marketplaceId": "ATVPDKIKX0DER",
  "codCollectionMethod": "",
  "packageDetail": {
    "packageReferenceId": "123",
    "carrierCode": "UPS",
    "carrierName": "UPS",
    "shippingMethod": "SHIPPING",
    "trackingNumber": "1Z86V8030385598957",
    "shipDate": "2022-11-30T16:15:30Z",
    "shipFromSupplySourceId": "057d3fcc-b750-419f-bbcd-4d340c60c430",
    "orderItems": [
      {
        "orderItemId": "60696125413094",
        "quantity": 1
      }
    ]
  }
}

confirmShipment response (shipment confirmation step)

For error status codes, descriptions and schemas, refer to confirmShipment.

🌟

Tip

To confirm multiple orders, use the Feeds API v2021-06-30 and pass the POST_ORDER_FULFILLMENT_DATA feed type. For more information, refer to Confirm multiple orders through the Order Fulfillment feed.

Step 2. Edit shipping information for one order

After Step 1, a package is created for the order. You can edit the shipping information like Ship date, Carrier, Shipping service (or Ship method), Tracking ID (supplied by the carrier) by calling the confirmShipment operation again.

Parameters that need to be consistent

To ensure that you are editing the same shipment, do not change the following parameters:

• orderId
• packageReferenceId
• orderItemId
• quantity

confirmShipment request example (shipment information editing step)

POST https://sellingpartnerapi-eu.amazon.com/orders/v0/orders/205-1725759-9209952/shipmentConfirmation
{
  "marketplaceId": "ATVPDKIKX0DER",
  "codCollectionMethod": "",
  "packageDetail": {
    "packageReferenceId": "123",
    "carrierCode": "USPS",
    "carrierName": "USPS",
    "shippingMethod": "SHIPPING",
    "trackingNumber": "1Z86V8030385598957",
    "shipDate": "2022-11-30T20:15:30Z",
    "shipFromSupplySourceId": "057d3fcc-b750-419f-bbcd-4d340c60c430",
    "orderItems": [
      {
        "orderItemId": "60696125413094",
        "quantity": 1
      }
    ]
  }
}

confirmShipment response (shipment information editing step)

For error status codes, descriptions, and schemas, refer to confirmShipment.