getInboundShipment

Retrieves an AWD inbound shipment.

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 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

Request

Path Params

shipmentId

string

required

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

>= 1 characters

Query Params

skuQuantities

enum<string>

optional

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

Allowed values:

SHOWHIDE

Example:

SHOW

Responses

🟢200OK

application/json

The 200 response for getInboundShipment.

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

Represents an AWD inbound shipment.

carrierCode

object (CarrierCode)

optional

Identifies the carrier that will deliver the shipment.

Example:

{"carrierCodeType":"SCAC","carrierCodeValue":"TestCarrierCode"}

carrierCodeType

enum<string>

optional

Denotes the type for the carrier.

Allowed value:

SCAC

Example:

SCAC

carrierCodeValue

string

optional

Value of the carrier code.

Example:

TestCarrierCode

createdAt

string <date-time>

optional

Timestamp when the shipment was created. The date is returned in ISO 8601 format.

destinationAddress

object (Address)

required

Shipping address that represents the origin or destination location.

Example:

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

addressLine1

string

required

First line of the address text.

addressLine2

string

optional

Optional second line of the address text.

addressLine3

string

optional

Optional third line of the address text.

city

string

optional

Optional city where this address is located.

countryCode

string

required

Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.

county

string

optional

Optional county where this address is located.

Example:

Washington

district

string

optional

Optional district where this address is located.

name

string

required

Name of the person, business, or institution at this address.

phoneNumber

string

optional

Optional E.164-formatted phone number for an available contact at this address.

Example:

+14155552671

postalCode

string

optional

Optional postal code where this address is located.

stateOrRegion

string

required

State or region where this address is located. Note that this is contextual to the specified country code.

externalReferenceId

string

optional

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

Example:

TestReferenceId

orderId

string

required

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

>= 1 characters

originAddress

object (Address)

required

Shipping address that represents the origin or destination location.

Example:

receivedQuantity

array[object (InventoryQuantity) {2}]

optional

Quantity received (at the receiving end) as part of this shipment.

quantity

number

required

Quantity of the respective inventory.

unitOfMeasurement

enum<string>

required

Unit of measurement for the inventory.

Allowed values:

PRODUCT_UNITSCASESPALLETS

shipBy

string <date-time>

optional

Timestamp when the shipment will be shipped.

shipmentContainerQuantities

array[object (DistributionPackageQuantity) {2}]

required

Packages that are part of this shipment.

count

integer <int32>

required

Number of cases or pallets with the same package configuration.

distributionPackage

object (DistributionPackage)

required

Represents an AWD distribution package.

Example:

{"contents":{"products":[{"quantity":1,"sku":"testPen"}]},"measurements":{"dimensions":{"height":1,"length":1,"unitOfMeasurement":"INCHES","width":1},"volume":{"unitOfMeasurement":"CUIN","volume":1},"weight":{"unitOfMeasurement":"POUNDS","weight":1}},"type":"CASE"}

shipmentId

string

required

Unique shipment ID.

>= 1 characters

shipmentSkuQuantities

array[object (SkuQuantity) {3}]

optional

Quantity details at SKU level for the shipment. This attribute will only appear if the skuQuantities parameter in the request is set to SHOW.

expectedQuantity

object (InventoryQuantity)

required

Quantity of inventory with an associated measurement unit context.

receivedQuantity

object (InventoryQuantity)

optional

Quantity of inventory with an associated measurement unit context.

sku

string

required

The merchant stock keeping unit

shipmentStatus

enum<string>

required

Possible shipment statuses used by shipments.

Allowed values:

CREATEDSHIPPEDIN_TRANSITRECEIVINGDELIVEREDCLOSEDCANCELLED

trackingId

string

optional

Carrier-unique tracking ID for this shipment.

>= 1 characters

updatedAt

string <date-time>

optional

Timestamp when the shipment was updated. The date is returned in ISO 8601 format.

warehouseReferenceId

string

optional

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

Example:

TestWarehouseReferenceId

Example

{
    "carrierCode": {
        "carrierCodeType": "SCAC",
        "carrierCodeValue": "TestCarrierCode"
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "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"
    },
    "externalReferenceId": "TestReferenceId",
    "orderId": "string",
    "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"
    },
    "receivedQuantity": [
        {
            "quantity": 0,
            "unitOfMeasurement": "PRODUCT_UNITS"
        }
    ],
    "shipBy": "2019-08-24T14:15:22Z",
    "shipmentContainerQuantities": [
        {
            "count": 1,
            "distributionPackage": {
                "contents": {
                    "products": [
                        {
                            "quantity": 1,
                            "sku": "testPen"
                        }
                    ]
                },
                "measurements": {
                    "dimensions": {
                        "height": 1,
                        "length": 1,
                        "unitOfMeasurement": "INCHES",
                        "width": 1
                    },
                    "volume": {
                        "unitOfMeasurement": "CUIN",
                        "volume": 1
                    },
                    "weight": {
                        "unitOfMeasurement": "POUNDS",
                        "weight": 1
                    }
                },
                "type": "CASE"
            }
        }
    ],
    "shipmentId": "string",
    "shipmentSkuQuantities": [
        {
            "expectedQuantity": {
                "quantity": 0,
                "unitOfMeasurement": "PRODUCT_UNITS"
            },
            "receivedQuantity": {
                "quantity": 0,
                "unitOfMeasurement": "PRODUCT_UNITS"
            },
            "sku": "string"
        }
    ],
    "shipmentStatus": "CREATED",
    "trackingId": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "warehouseReferenceId": "TestWarehouseReferenceId"
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request samples

Responses