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.
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.
For information about authorization, refer to Authorizing Selling Partner API Applications. For information about regulated orders, refer to the Regulated Orders guide.
Use cases
The following use case examples are available for the Orders API v0:
- Get orders with filtering criteria : The
getOrders
operation of the Orders API returns orders created or updated during the time frame or other filtering criteria indicated by the specified parameters.NextToken
, when provided, overrides other criteria to retrieve orders. - Get order information: The
getOrder
operation of the Orders API returns order information that you specify. - Get order item information: The
getOrderItems
operation of the Orders API returns detailed order item information for the order that you specify. UseNextToken
to retrieve the next page of order items. - Confirm the shipment status: The
confirmShipment
operation of the Orders API confirms the shipment status for a specified order. You can also use this operation to edit shipment details of orders that have been shipped.
Roles
confirmShipment
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Inventory and Order Tracking Direct to Consumer Shipping (Restricted) |
getOrder
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Amazon Fulfillment Buyer Communication Buyer Solicitation Direct to Consumer Shipping (Restricted) Finance and Accounting Inventory and Order Tracking Pricing Product Listing Professional Services (Restricted) Selling Partner Insights |
getOrderAddress
getOrderBuyerInfo
getOrderItems
getOrderItemsBuyerInfo
getOrderRegulatedInfo
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Direct to Consumer Shipping (Restricted) |
getOrders
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Amazon Fulfillment Buyer Communication Buyer Solicitation Finance and Accounting Inventory and Order Tracking Pricing Product Listing Professional Services (Restricted) Selling Partner Insights Direct to Consumer Shipping (Restricted) Tax Invoicing (Restricted) |
updateShipmentStatus
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Inventory and Order Tracking |
updateVerificationStatus
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Direct to Consumer Shipping (Restricted) |
Updated about 17 hours ago