getShipments

get

https://sellingpartnerapi-na.amazon.com/externalFulfillment/2024-09-11/shipments

Get a list of shipments created for the seller in the status you specify. Shipments can be further filtered based on the fulfillment node or the time of the shipments' last update.

Query Params

locationId

string

length ≤ 36

The Amazon channel location identifier for the shipments you want to retrieve.

marketplaceId

string

The marketplace ID associated with the location. To find the ID for your marketplace, refer to Marketplace IDs.

channelName

string

length ≤ 10

The channel name associated with the location.

status

string

enum

required

The status of shipment you want to include in the response. To retrieve all new shipments, set this value to ACCEPTED.

lastUpdatedAfter

date-time

The response includes shipments whose latest update is after the specified time. In ISO 8601 date-time format.

lastUpdatedBefore

date-time

The response includes shipments whose latest update is before the specified time. In ISO 8601 date-time format.

maxResults

integer

1 to 100

The maximum number of shipments to include in the response.

paginationToken

string

A token that you use to retrieve the next page of results. The response includes nextToken when there are multiple pages of results. 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

Language

Response

Choose an example:

application/json

200Success. The response contains a list of shipments.

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.

409The resource specified conflicts with the current state

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.