listInboundShipments

Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters.

Usage Plan:

Rate (requests per second)	Burst
1	1

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

Query Params

sortBy

enum<string>

optional

Field to sort results by. By default, the response will be sorted by UPDATED_AT.

Allowed values:

UPDATED_ATCREATED_AT

sortOrder

enum<string>

optional

Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order.

Allowed values:

ASCENDINGDESCENDING

Example:

ASCENDING

shipmentStatus

enum<string>

optional

Filter by inbound shipment status.

Allowed values:

CREATEDSHIPPEDIN_TRANSITRECEIVINGDELIVEREDCLOSEDCANCELLED

Example:

CREATED

updatedAfter

string <date-time>

optional

List the inbound shipments that were updated after a certain time (inclusive). The date must be in ISO 8601 format.

Example:

2023-01-12T10:00:00.000Z

updatedBefore

string <date-time>

optional

List the inbound shipments that were updated before a certain time (inclusive). The date must be in ISO 8601 format.

Example:

2023-01-12T10:00:00.000Z

maxResults

integer <int32>

optional

Maximum number of results to return.

>= 1<= 200

Default:

Example:

nextToken

string

optional

Token to retrieve the next set of paginated results.

Example:

SampleToken

Responses

🟢200OK

application/json

The 200 response for listInboundShipments.

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

A list of inbound shipment summaries filtered by the attributes specified in the request.

nextToken

string

optional

Token to retrieve the next set of paginated results.

Example:

SampleToken

shipments

array[object (InboundShipmentSummary) {6}]

optional

List of inbound shipment summaries.

createdAt

string <date-time>

optional

Timestamp when the shipment was created.

externalReferenceId

string

optional

Optional client-provided reference ID that can be used to correlate this shipment with 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

shipmentId

string

required

A unique shipment ID.

>= 1 characters

shipmentStatus

enum<string>

required

Possible shipment statuses used by shipments.

Allowed values:

CREATEDSHIPPEDIN_TRANSITRECEIVINGDELIVEREDCLOSEDCANCELLED

updatedAt

string <date-time>

optional

Timestamp when the shipment was updated.

Example

{
    "nextToken": "SampleToken",
    "shipments": [
        {
            "createdAt": "2019-08-24T14:15:22Z",
            "externalReferenceId": "TestReferenceId",
            "orderId": "string",
            "shipmentId": "string",
            "shipmentStatus": "CREATED",
            "updatedAt": "2019-08-24T14:15:22Z"
        }
    ]
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request samples

Responses