v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB
External Fulfillment Shipping v2024-09-11

getShipments

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.

get/externalFulfillment/2024-09-11/shipments

Query parameters

locationIdstring

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

marketplaceIdstring

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

channelNamestring

The channel name associated with the location.

status'CREATED' | 'ACCEPTED' | 'CONFIRMED' | 'PACKAGE_CREATED' | 'PICKUP_SLOT_RETRIEVED' | 'INVOICE_GENERATED' | 'SHIPLABEL_GENERATED' | 'CANCELLED' | 'SHIPPED' | 'DELIVERED' required

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

lastUpdatedAfterstring date-time

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

lastUpdatedBeforestring date-time

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

maxResultsinteger

The maximum number of shipments to include in the response.

paginationTokenstring

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.

Response

Success. The response contains a list of shipments.