Sign in

v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB
Amazon Warehousing and Distribution v2024-05-09

getInboundShipment

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

❗️ To view the response

The response to this operation cannot be displayed in this reference because of technical issues. For this operation's response schema, refer to getInboundShipment.

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

Path parameters

shipmentIdstring required

ID for the shipment. A shipment contains the cases being inbounded.

Query parameters

skuQuantities'SHOW' | 'HIDE'

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

Response

The 200 response for getInboundShipment.

createdAtstring date-time

Timestamp when the shipment was created. The date is returned in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

externalReferenceIdstring

Client-provided reference ID that can correlate this shipment to client resources. For example, to map this shipment to an internal bookkeeping order record.

orderIdstring required

The AWD inbound order ID that this inbound shipment belongs to.

shipBystring date-time

Timestamp when the shipment will be shipped.

shipmentIdstring required

Unique shipment ID.

destinationRegionstring

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, us-southcentral, us-southeast]

shipmentStatus'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED' required

Possible shipment statuses used by shipments.

trackingIdstring

Carrier-unique tracking ID for this shipment.

updatedAtstring date-time

Timestamp when the shipment was updated. The date is returned in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

warehouseReferenceIdstring

An AWD-provided reference ID that you can use to interact with the warehouse. For example, a carrier appointment booking.

Example response

{
  "carrierCode": {
    "carrierCodeType": "SCAC",
    "carrierCodeValue": "TestCarrierCode"
  },
  "externalReferenceId": "TestReferenceId",
  "shipmentContainerQuantities": [
    {
      "count": 1,
      "distributionPackage": {
        "contents": {
          "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": 1,
            "length": 1,
            "unitOfMeasurement": "INCHES",
            "width": 1
          },
          "volume": {
            "unitOfMeasurement": "CUIN",
            "volume": 1
          },
          "weight": {
            "unitOfMeasurement": "POUNDS",
            "weight": 1
          }
        },
        "type": "CASE"
      }
    }
  ],
  "destinationRegion": "us-west",
  "warehouseReferenceId": "TestWarehouseReferenceId"
}