Selling Partner API for Orders
Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop fast, flexible, and custom applications to…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop fast, flexible, and custom applications to manage order synchronization, perform order research, and create demand-based decision support tools.
_Note:_ For the JP, AU, and SG marketplaces, the Orders API supports orders from 2016 onward. For all other marketplaces, the Orders API supports orders for the last two years (orders older than this don't show up in the response).
Endpoints 10
ordersV0
- GETgetOrders
/orders/v0/orders?CreatedAfter=string&CreatedBefore=string&LastUpdatedAfter=string&LastUpdatedBefore=string&OrderStatuses=string&MarketplaceIds=string&FulfillmentChannels=string&PaymentMethods=string&BuyerEmail=string&SellerOrderId=string&MaxResultsPerPage=0&EasyShipShipmentStatuses=string&ElectronicInvoiceStatuses=string&NextToken=string&AmazonOrderIds=string&ActualFulfillmentSupplySourceId=string&IsISPU=true&StoreChainStoreId=string&EarliestDeliveryDateBefore=string&EarliestDeliveryDateAfter=string&LatestDeliveryDateBefore=string&LatestDeliveryDateAfter=stringDeprecated. Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters… - GETgetOrder
/orders/v0/orders/:orderIdDeprecated. Returns the order that you specify. Usage Plan: The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation,… - GETgetOrderBuyerInfo
/orders/v0/orders/:orderId/buyerInfoDeprecated. Returns buyer information for the order that you specify. Usage Plan: The x-amzn-RateLimit-Limit response header contains the usage plan rate… - GETgetOrderAddress
/orders/v0/orders/:orderId/addressDeprecated. Returns the shipping address for the order that you specify. Usage Plan: The x-amzn-RateLimit-Limit response header contains the usage plan rate… - GETgetOrderItems
/orders/v0/orders/:orderId/orderItems?NextToken=stringDeprecated. Returns detailed order item information for the order that you specify. If NextToken is provided, it's used to retrieve the next page of order… - GETgetOrderItemsBuyerInfo
/orders/v0/orders/:orderId/orderItems/buyerInfo?NextToken=stringDeprecated. Returns buyer information for the order items in the order that you specify. Usage Plan: The x-amzn-RateLimit-Limit response header contains the… - GETgetOrderRegulatedInfo
/orders/v0/orders/:orderId/regulatedInfoReturns regulated information for the order that you specify. Usage Plan: The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for… - PATCHupdateVerificationStatus
/orders/v0/orders/:orderId/regulatedInfoUpdates (approves or rejects) the verification status of an order containing regulated products. Usage Plan: The x-amzn-RateLimit-Limit response header… - POSTconfirmShipment
/orders/v0/orders/:orderId/shipmentConfirmationUpdates the shipment confirmation status for a specified order. Usage Plan: The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for…
shipment
- POSTupdateShipmentStatus
/orders/v0/orders/:orderId/shipmentUpdate the shipment status for an order that you specify. Usage Plan: The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the…
API details
- Base URL
https://sellingpartnerapi-na.amazon.com- Authentication
- None declared in the description
- Operations
- 10 operations on 9 pathsGET 7POST 2PATCH 1
6 marked deprecated - Main resources
- ordersV0 9shipment 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
v0 - Links
- OpenAPI document · Support
- Listed from
- Amazon Selling Partner's published OpenAPI description (amzn/selling-partner-api-models) (Apache-2.0)
How to test the Selling Partner API for Orders in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Selling Partner API for Orders collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “getOrders” (GET /orders/v0/orders?CreatedAfter=string&CreatedBefore=string&LastUpdatedAfter=string&LastUpdatedBefore=string&OrderStatuses=string&MarketplaceIds=string&FulfillmentChannels=string&PaymentMethods=string&BuyerEmail=string&SellerOrderId=string&MaxResultsPerPage=0&EasyShipShipmentStatuses=string&ElectronicInvoiceStatuses=string&NextToken=string&AmazonOrderIds=string&ActualFulfillmentSupplySourceId=string&IsISPU=true&StoreChainStoreId=string&EarliestDeliveryDateBefore=string&EarliestDeliveryDateAfter=string&LatestDeliveryDateBefore=string&LatestDeliveryDateAfter=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Selling Partner API for Orders?
Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop fast, flexible, and custom applications to… It is listed under E-commerce and has 10 endpoints.
Who publishes the Selling Partner API for Orders?
It is listed from Amazon Selling Partner's public API description (an OpenAPI document), not published by Amazon Selling Partner on Swastik Codes. Anyone who controls sellingpartnerapi.amazon.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Selling Partner API for Orders?
Requests go to https://sellingpartnerapi-na.amazon.com. Endpoint paths are added to this base URL.
How do I authenticate with the Selling Partner API for Orders?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Selling Partner API for Orders have?
10 operations on 9 paths (7 GET, 2 POST, 1 PATCH). The largest groups are ordersV0, shipment.
Is forking the Selling Partner API for Orders free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.