Retrieve a List of Shipments

Learn how to use the External Fulfillment Shipping API to get information about shipments.

Prerequisites

To complete this tutorial, you need:

Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API applications.
The shipment ID of the shipment you want to process.
Approval for the Direct-to-Consumer Shipping (Restricted) role in your developer profile.
The Direct-to-Consumer Shipping (Restricted) role selected in the App registration page for your application.

Step 1. Retrieve a list of shipments

Call the getShipments operation. Supply the status of shipment you want. Set status equal to ACCEPTED to retrieve all new shipments.

Shipment statuses

The possible status values for a shipment are as follows:

Status	Description
`CREATED`	The order is created with the Amazon External Fulfillment API. Only applicable to MFN channels
`ACCEPTED`	The shipment was assigned available inventory with the Amazon External Fulfillment API.
`CONFIRMED`	The shipment is confirmed with the `processShipment` operation.
`PACKAGE_CREATED`	Package information is provided with the `createPackages` operation.
`PICKUP_SLOT_RETRIEVED`	Pickup slots are retrieved with the `retrieveShippingOptions` operation.
`INVOICE_GENERATED`	The invoice is generated with the `generateInvoice` operation. Not applicable for the Easy Ship channel, except in India.
`SHIPLABEL_GENERATED`	The shipping label is generated with the `generateShipLabels` operation.
`SHIPPED`	The shipment is shipped with the carrier or marked as shipped using `updatePackageStatus`.
`DELIVERED`	The shipment is delivered to the customer.
`CANCELLED`	The shipment is cancelled, either by the seller or the marketplace.

Step 2. Retrieve details of a single shipment

Call the getShipment operation with the shipmentId of the shipment you want to retrieve.

Determine the program

You can determine the program used to transport a shipment using the channelName and shippingType values that getShipments and getShipment return:

Program	`channelName`	`shippingType`
Easy Ship	`MFN`	`MARKETPLACE`
Self Ship	`MFN`	`SELF`
Seller Flex	`FBA`	`MARKETPLACE`