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.

❗️

Important

The CREATED status is deprecated. Effective June 30, 2026, the initial status for Merchant Fulfillment Network (MFN) shipments, including Easy Ship, Self Ship, and Self Delivery shipments, changed from CREATED to ACCEPTED. New shipments are available in ACCEPTED status when they are created. For more information, refer to Merchant Fulfillment Network shipment status update for External Fulfillment API.

If your application calls getShipments with a status value of CREATED to find new shipments, update it to use ACCEPTED.

Shipment statuses

The possible status values for a shipment are as follows:

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: