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.
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
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Direct to Consumer Shipping (Restricted) |
getShipment
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Direct to Consumer Shipping (Restricted) |
processShipment
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Direct to Consumer Shipping (Restricted) |
createPackages
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Direct to Consumer Shipping (Restricted) |
updatePackage
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Direct to Consumer Shipping (Restricted) |
updatePackageStatus
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Direct to Consumer Shipping (Restricted) |
retrieveShippingOptions
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Direct to Consumer Shipping (Restricted) |
retrieveInvoice
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Direct to Consumer Shipping (Restricted) |
generateInvoice
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Direct to Consumer Shipping (Restricted) |
generateShipLabels
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Direct to Consumer Shipping (Restricted) |
Updated about 2 hours ago