v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB

Amazon Warehousing and Distribution v2024-05-09

getInbound

Retrieves an AWD inbound order.

Usage Plan:

Rate (requests per second)	Burst
2	2

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.

❗️ 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 getInbound.

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

Path parameters

orderIdstring required

The ID of the inbound order that you want to retrieve.

Response

The 200 response for getInbound.

createdAtstring date-time required

Date when this order was created.

externalReferenceIdstring

Reference ID that can be used to correlate the order with partner resources.

orderIdstring required

Inbound order ID.

The supported statuses for an inbound order.

updatedAtstring date-time

Date when this order was last updated.

Example response

{
  "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"
  }
}