Orders API

Learn how to use the Orders API.

You use the Orders API to retrieve order information. You can develop custom applications that facilitate order synchronization and order research.

Version migration

The Orders API v0 is deprecated. Learn how to migrate to the Orders API v2026-01-01 in the Orders API Migration Guide.

Current versionLegacy versionsAvailabilitySandbox
v2026-01-01 (Reference | Model)v0Sellers onlyStatic
Release notes

To learn more about the terms that are used in this guide, refer to Terminology.

📘

Note

Orders more than two years old don't show in the API response, except for the SG, JP, and AU marketplaces, which support orders from 2016 onwards.

Use cases

The following use case examples are available for the Orders API:

Roles for the Orders API v0

confirmShipment
AttributeValue
Regions NA, EU, FE
Required roles (need at least one) Inventory and Order Tracking
 Direct to Consumer Shipping (Restricted)
getOrder
getOrderAddress
getOrderBuyerInfo
getOrderItems
getOrderItemsBuyerInfo
getOrderRegulatedInfo
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Direct to Consumer Shipping (Restricted)
getOrders
updateShipmentStatus
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Inventory and Order Tracking
updateVerificationStatus
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Direct to Consumer Shipping (Restricted)

Roles for the Orders API v2026-01-01

searchOrders
getOrder