--- title: "getInbound" method: GET path: "/awd/2024-05-09/inboundOrders/{orderId}" tags: ["Amazon Warehousing and Distribution v2024-05-09"] --- # getInbound `GET /awd/2024-05-09/inboundOrders/{orderId}` 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-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`](https://developer-docs.amazon.com/sp-api/docs/awd_2024-05-09-reference#getinbound). ## Path parameters - `orderId` string, required ## Response `200` The 200 response for `getInbound`. - InboundOrder — Represents an AWD inbound order. - `createdAt` string, date-time, required — Date when this order was created. - `destinationDetails` DestinationDetails — Destination details of an inbound order based on the assigned region and DC for the order. - `destinationAddress` Address — Address of the party. - `name` string, required — The name of the person, business or institution at that address. - `addressLine1` string, required — First line of the address. - `addressLine2` string — Additional street address information, if required. - `addressLine3` string — Additional street address information, if required. - `city` string — The city where the person, business or institution is located. - `county` string — The county where person, business or institution is located. - `district` string — The district where person, business or institution is located. - `stateOrRegion` string — The state or region where person, business or institution is located. - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format. - `phone` string — The phone number of the person, business or institution located at that address. - `destinationRegion` string — 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] - `shipmentId` string — Unique ID of the confirmed shipment being shipped to the assigned destination. This will be available only after an inbound order is confirmed and can be used to track the shipment. - `externalReferenceId` string — Reference ID that can be used to correlate the order with partner resources. - `orderId` string, required — Inbound order ID. - `orderStatus` 'DRAFT' | 'VALIDATING' | 'CONFIRMED' | 'CLOSED' | 'EXPIRED' | 'CANCELLED', required — The supported statuses for an inbound order. - `originAddress` Address, required — Address of the party. - `name` string, required — The name of the person, business or institution at that address. - `addressLine1` string, required — First line of the address. - `addressLine2` string — Additional street address information, if required. - `addressLine3` string — Additional street address information, if required. - `city` string — The city where the person, business or institution is located. - `county` string — The county where person, business or institution is located. - `district` string — The district where person, business or institution is located. - `stateOrRegion` string — The state or region where person, business or institution is located. - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format. - `phone` string — The phone number of the person, business or institution located at that address. - `packagesToInbound` DistributionPackageQuantity[], required — List of packages to be inbounded. - `count` integer, required — Number of cases or pallets with the same package configuration. - `distributionPackage` DistributionPackage, required — Represents an AWD distribution package. - `contents` DistributionPackageContents, required — Represents the contents inside a package, which can be products or a nested package. - `packages` DistributionPackageQuantity[] — This is required only when `DistributionPackageType=PALLET`. - `products` ProductQuantity[] — This is required only when `DistributionPackageType=CASE`. - `attributes` ProductAttribute[] — Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data. - `name` string — Product attribute name. - `value` string — Product attribute value. - `quantity` integer, required — Product quantity. - `sku` string, required — The seller or merchant SKU. - `expiration` string, date-time — The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. - `prepDetails` PrepDetails — Preparation instructions and who is responsible for the preparation. - `PrepInstruction` PrepInstruction, required — Information pertaining to the preparation of inbound goods. - … - `PrepOwner` 'AMAZON' | 'SELLER' | 'NONE', required — The owner of the preparations, if special preparations are required. - `measurements` MeasurementData, required — Package weight and dimension. - `dimensions` PackageDimensions — The dimensions of a package contained in a shipment. - `Length` number, double — A number that represents the given package dimension. - `Width` number, double — A number that represents the given package dimension. - `Height` number, double — A number that represents the given package dimension. - `Unit` 'inches' | 'centimeters' — The unit of length. - `PredefinedPackageDimensions` 'FedEx_Box_10kg' | 'FedEx_Box_25kg' | 'FedEx_Box_Extra_Large_1' | 'FedEx_Box_Extra_Large_2' | 'FedEx_Box_Large_1' | 'FedEx_Box_Large_2' | 'FedEx_Box_Medium_1' | 'FedEx_Box_Medium_2' | 'FedEx_Box_Small_1' | 'FedEx_Box_Small_2' | 'FedEx_Envelope' | 'FedEx_Padded_Pak' | 'FedEx_Pak_1' | 'FedEx_Pak_2' | 'FedEx_Tube' | 'FedEx_XL_Pak' | 'UPS_Box_10kg' | 'UPS_Box_25kg' | 'UPS_Express_Box' | 'UPS_Express_Box_Large' | 'UPS_Express_Box_Medium' | 'UPS_Express_Box_Small' | 'UPS_Express_Envelope' | 'UPS_Express_Hard_Pak' | 'UPS_Express_Legal_Envelope' | 'UPS_Express_Pak' | 'UPS_Express_Tube' | 'UPS_Laboratory_Pak' | 'UPS_Pad_Pak' | 'UPS_Pallet' | 'USPS_Card' | 'USPS_Flat' | 'USPS_FlatRateCardboardEnvelope' | 'USPS_FlatRateEnvelope' | 'USPS_FlatRateGiftCardEnvelope' | 'USPS_FlatRateLegalEnvelope' | 'USPS_FlatRatePaddedEnvelope' | 'USPS_FlatRateWindowEnvelope' | 'USPS_LargeFlatRateBoardGameBox' | 'USPS_LargeFlatRateBox' | 'USPS_Letter' | 'USPS_MediumFlatRateBox1' | 'USPS_MediumFlatRateBox2' | 'USPS_RegionalRateBoxA1' | 'USPS_RegionalRateBoxA2' | 'USPS_RegionalRateBoxB1' | 'USPS_RegionalRateBoxB2' | 'USPS_RegionalRateBoxC' | 'USPS_SmallFlatRateBox' | 'USPS_SmallFlatRateEnvelope' — An enumeration of predefined parcel tokens. If you specify a `PredefinedPackageDimensions` token, you are not obligated to use a branded package from a carrier. For example, if you specify the `FedEx_Box_10kg` token, you do not have to use that particular package from FedEx. You are only obligated to use a box that matches the dimensions specified by the token. Note: Carriers can have restrictions on the type of package allowed for certain ship methods. Check the carrier website for details. Example: Flat rate pricing is available when materials are sent by USPS in a USPS-produced Flat Rate envelope or box. - `volume` PackageVolume — Represents the volume of the package with a unit of measurement. - `unitOfMeasurement` 'CU_IN' | 'CBM' | 'CC', required — Unit of measurement for the package volume. - `volume` number, double, required — The package volume value. - `weight` PackageWeight, required — Represents the weight of the package with a unit of measurement. - `unitOfMeasurement` 'POUNDS' | 'KILOGRAMS', required — Unit of measurement for the package weight. - `weight` number, double, required — The package weight value. - `type` 'CASE' | 'PALLET', required — Type of distribution packages. - `preferences` InboundPreferences — Preferences that can be passed in context of an inbound order - `destinationRegion` string — Pass a preferred region so that the inbound order can be shipped to an AWD warehouse located in that region. This doesn't guarantee the order to be assigned in the specified destination region as it depends on warehouse capacity availability. AWD currently supports following region IDs: [us-west, us-east, us-southcentral, us-southeast] - `updatedAt` string, date-time — Date when this order was last updated. ## Other responses - `400` — Request has missing or invalid parameters and cannot be parsed. - `403` — Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. - `404` — The resource specified does not exist. - `413` — The request size exceeded the maximum accepted size. - `415` — The request payload is in an unsupported format. - `429` — The frequency of requests was greater than allowed. - `500` — An unexpected condition occurred that prevented the server from fulfilling the request. - `503` — Temporary overloading or maintenance of the server. --- [API](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01.md) · [All operations](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws-samples/a-content-management-v2020-11-01/revisions/815a5b6dbaa6/schema)