searchOrders

Returns orders that are created or updated during the time period that you specify. You can filter the response for specific types of orders.

Query Params
date-time

The response includes orders created at or after this time. The date must be in ISO 8601 format.

Note: You must provide exactly one of createdAfter and lastUpdatedAfter in your request. If createdAfter is provided, neither lastUpdatedAfter nor lastUpdatedBefore may be provided.

date-time

The response includes orders created at or before this time. The date must be in ISO 8601 format.

Note: If you include createdAfter in the request, createdBefore is optional, and if provided must be equal to or after the createdAfter date and at least two minutes before the time of the request. If createdBefore is provided, neither lastUpdatedAfter nor lastUpdatedBefore may be provided.

date-time

The response includes orders updated at or after this time. An update is defined as any change made by Amazon or by the seller, including an update to the order status. The date must be in ISO 8601 format.

Note: You must provide exactly one of createdAfter and lastUpdatedAfter. If lastUpdatedAfter is provided, neither createdAfter nor createdBefore may be provided.

date-time

The response includes orders updated at or before this time. An update is defined as any change made by Amazon or by the seller, including an update to the order status. The date must be in ISO 8601 format.

Note: If you include lastUpdatedAfter in the request, lastUpdatedBefore is optional, and if provided must be equal to or after the lastUpdatedAfter date and at least two minutes before the time of the request. If lastUpdatedBefore is provided, neither createdAfter nor createdBefore may be provided.

fulfillmentStatuses
array of strings

A list of FulfillmentStatus values you can use to filter the results.

Show Details
PENDING_AVAILABILITYThis status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future. The order is not ready for shipment.
PENDINGThe order has been placed but is not ready for shipment. For standard orders, the initial order status is `PENDING`. For pre-orders, the initial order status is `PENDING_AVAILABILITY`, and the order passes into the `PENDING` status when payment authorization begins.
UNSHIPPEDThe order is ready for shipment, but no items in the order have been shipped.
PARTIALLY_SHIPPEDAt least one, but not all, items in the order have been shipped.
SHIPPEDAll items have been shipped to the customer.
CANCELLEDThe order has been canceled and will not be fulfilled.
UNFULFILLABLEThe order cannot be fulfilled. This state only applies to Amazon-fulfilled orders that were not placed on Amazon's retail web site.
fulfillmentStatuses
marketplaceIds
array of strings
length ≤ 50

The response includes orders that were placed in marketplaces you include in this list.

Refer to Marketplace IDs for a complete list of marketplaceId values.

marketplaceIds
fulfilledBy
array of strings

The response includes orders that are fulfilled by the parties that you include in this list.

Show Details
MERCHANTFulfilled by the merchant
AMAZONFulfilled by Amazon
fulfilledBy
integer

The maximum number of orders that can be returned per page. The value must be between 1 and 100. Default: 100.

string

Pagination occurs when a request produces a response that exceeds the maxResultsPerPage. This means that the response is divided into individual pages. To retrieve the next page, you must pass the nextToken value as the paginationToken query parameter in the next request. You will not receive a nextToken value on the last page.

includedData
array of strings

A list of datasets to include in the response.

Show Details
BUYERInformation about the buyer who purchased the order.
RECIPIENTInformation about the recipient to whom the order is delivered.
PROCEEDSThe revenue and financial breakdown for the order and order items.
EXPENSEThe cost information about the order and order items.
PROMOTIONThe discount and promotional offer details applied to the order and order items.
CANCELLATIONCancellation information applied to the order and order items.
FULFILLMENTInformation about how the order and order items are processed and shipped.
PACKAGESInformation about shipping packages and tracking.
includedData
Responses

Language
Response
Choose an example:
application/json