External Fulfillment Shipping API

Learn how to use the External Fulfillment Shipping API

Use the External Fulfillment Shipping API to retrieve and process customer orders.

Current versionLegacy versionsAvailabilitySandbox
v2024-09-11 (Reference | Model)NoneSellers onlyStatic
Release notes

Use cases

The following use case examples are available for the External Fulfillment Shipping API v2024-09-11:

Roles for the External Fulfillment Shipping API v2024-09-11

getShipments
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Direct to Consumer Shipping (Restricted)
getShipment
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Direct to Consumer Shipping (Restricted)
processShipment
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Direct to Consumer Shipping (Restricted)
createPackages
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Direct to Consumer Shipping (Restricted)
updatePackage
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Direct to Consumer Shipping (Restricted)
updatePackageStatus
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Direct to Consumer Shipping (Restricted)
retrieveShippingOptions
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Direct to Consumer Shipping (Restricted)
retrieveInvoice
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Direct to Consumer Shipping (Restricted)
generateInvoice
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Direct to Consumer Shipping (Restricted)
generateShipLabels
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Direct to Consumer Shipping (Restricted)