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.
Regulated orders
Amazon classifies some products as regulated to comply with local regulations and to provide a broader selection of regulated items to customers. Because orders that contain regulated items must be validated by skilled professionals before shipment, customers must provide additional information to complete the purchase (for example, upload a prescription). Regulated items include pet pharmacy items, eye contact lenses, and prescription glasses.
You can use the getOrderRegulatedInfo
and updateVerificationStatus
operations in the Orders API to programmatically integrate this validation process into your applications.
Amazon Business orders
An Amazon Business order is an order where the buyer is a verified business buyer. You can use the isBusinessOrder
attribute in the order object to distinguish between business and non-business orders. An Amazon Business order will have the isBusinessOrder
attribute set to true
.
The Orders API is used to retrieve orders created for the selling partner for whom the calls are being made. You can use the getOrders
operation to get all the orders for the selling partner, then get all business orders by filtering with the isBusinessOrder
attribute. You can use getOrderAddress
to retrieve the shipping address and associated delivery preferences.
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 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. - Review if an order contains regulated information: Get the status and regulated information for an order.
- Recognize which orders contain regulated information: After you identify a regulated order, get additional status and regulated information.
- Get an order's regulated information: Get regulated information for an order.
- Approve or reject a regulated order: Approve or reject an order that contains regulated information.
- Provide additional verification details about a regulated order: Provide additional details about the verification of an order that contains regulated information.
- Get all Amazon Business orders: Get orders for a selling partner and identify Amazon Business orders.
- Get order details for an Amazon Business order: Get order details for an order ID and identify if it's an Amazon Business order.
- Get delivery preferences for an Amazon Business order: Get delivery preferences associated with a shipping address for an Amazon Business order.
Roles for the Orders API v0
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
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) Tax Remittance (Restricted) |
getOrderBuyerInfo
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) Tax Remittance (Restricted) |
getOrderItems
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) Tax Remittance (Restricted) |
getOrderItemsBuyerInfo
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) Tax Remittance (Restricted) |
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 33 minutes ago