listInboundShipments

get https://sellingpartnerapi-na.amazon.com/awd/2024-05-09/inboundShipments

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.

Query Params

sortBy

string

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

sortOrder

string

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

shipmentStatus

string

Filter by inbound shipment status.

updatedAfter

date-time

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

updatedBefore

date-time

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

maxResults

int32

1 to 200

Defaults to 25

Maximum number of results to return.

nextToken

string

A token that is used to retrieve the next page of results. The response includes nextToken when the number of results exceeds the specified maxResults value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextToken is null. Note that this operation can return empty pages.

Responses

`listInboundShipments`.

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.

xxxxxxxxxx
 
{
  "nextToken": "SampleToken",
  "shipments": [
    {
      "createdAt": "2025-04-01T18:11:01.342Z",
      "externalReferenceId": "TestReferenceId",
      "orderId": "string",
      "shipmentId": "string",
      "shipmentStatus": "CREATED",
      "updatedAt": "2025-04-01T18:11:01.342Z"
    }
  ]
}

CREATED	Shipment is created but has not yet shipped.
SHIPPED	Shipment was picked up by the carrier or was dropped off with the carrier.
IN_TRANSIT	The carrier has notified AWD that the shipment is in transit between origin and destination node.
RECEIVING	The shipment has been partially received.
DELIVERED	The shipment has reached the destination node and has been delivered to the facility yard. The shipment receive process at the warehouse will start soon.
CLOSED	No more actions required on the shipment. This is a final state.
CANCELLED	Shipment has been cancelled. This is a final state.

x-amzn-RateLimit-Limit	Your rate limit (requests per second) for this operation.
x-amzn-RequestId	Unique request reference identifier.

200The 200 response for listInboundShipments.

400Request has missing or invalid parameters and cannot be parsed.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.

`listInboundShipments`.