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)Inventory and Order Tracking
getShipment
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Inventory and Order Tracking
processShipment
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Inventory and Order Tracking
createPackages
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Inventory and Order Tracking
updatePackage
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Inventory and Order Tracking
updatePackageStatus
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Inventory and Order Tracking
retrieveShippingOptions
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Inventory and Order Tracking
retrieveInvoice
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Inventory and Order Tracking
generateInvoice
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Inventory and Order Tracking
generateShipLabels
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Inventory and Order Tracking