| Name | Description | Type | Additional information |
|---|---|---|---|
| CreatedAfter |
A date used for selecting orders created after (or at) a specified time. Required if LastUpdatedAfter is not specified. Specifying both CreatedAfter and LastUpdatedAfter returns an error. Must be no later than two minutes before the time that the request was submitted. |
date |
None. |
| CreatedBefore |
A date used for selecting orders created before (or at) a specified time. Must be later than CreatedAfter. Must be no later than two minutes before the time that the request was submitted. Default: Now minus two minutes |
date |
None. |
| LastUpdatedAfter |
A date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. Required if CreatedAfter is not specified. Specifying both CreatedAfter and LastUpdatedAfter returns an error. If LastUpdatedAfter is specified, then BuyerEmail and SellerOrderId cannot be specified. Must be no later than two minutes before the time that the request was submitted. |
date |
None. |
| LastUpdatedBefore |
A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. Must be later than LastUpdatedAfter. Must be no later than two minutes before the time that the request was submitted. Default: Now minus two minutes |
date |
None. |
| OrderStatus |
A list of OrderStatus values. Used to select orders with a current status that matches one of the status values that you specify. OrderStatus values: PendingAvailability - This 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. Note that Preorder is a possible OrderType value in Japan (JP) only. Pending - The order has been placed but payment has not been authorized. The order is not ready for shipment. Note that for orders with OrderType = Standard, the initial order status is Pending. For orders with OrderType = Preorder (available in JP only), the initial order status is PendingAvailability, and the order passes into the Pending status when the payment authorization process begins. Unshipped - Payment has been authorized and order is ready for shipment, but no items in the order have been shipped. PartiallyShipped - One or more (but not all) items in the order have been shipped. Shipped - All items in the order have been shipped. InvoiceUnconfirmed - All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer. Note: This value is available only in China (CN). Canceled - The order was canceled. Unfulfillable - The order cannot be fulfilled. This state applies only to Amazon-fulfilled orders that were not placed on Amazon's retail web site. Unshipped and PartiallyShipped must be used together in this version of the Orders API section. Using one and not the other returns an error. Default: All |
Collection of string |
None. |
| FulfillmentChannel |
A list that indicates how an order was fulfilled. FulfillmentChannel values: AFN - Fulfilled by Amazon MFN - Fulfilled by the seller Default: All |
Collection of string |
None. |
| PaymentMethod |
A list of PaymentMethod values. Used to select orders paid for with the payment methods that you specify. PaymentMethod values: COD - Cash on delivery CVS - Convenience store payment Other - Any payment method other than COD or CVS Note: COD and CVS values are valid only in Japan (JP). Default: All |
Collection of string |
None. |
| BuyerEmail |
The e-mail address of a buyer. Used to select only the orders that contain the specified e-mail address. If BuyerEmail is specified, then FulfillmentChannel, OrderStatus, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and SellerOrderId cannot be specified. The e-mail address that you provide in your request can be anonymized (by Amazon), or non-anonymized. Default: All |
string |
None. |
| SellerOrderId |
An order identifier that is specified by the seller. Not an Amazon order identifier. Used to select only the orders that match a seller-specified order identifier. If SellerOrderId is specified, then FulfillmentChannel, OrderStatus, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified. Default: All |
string |
None. |
| MaxResultsPerPage |
A number that indicates the maximum number of orders that can be returned per page Value must be 1 - 100. Default: 100 |
decimal number |
None. |
| TFMShipmentStatus |
A list of TFMShipmentStatus values. Used to select Amazon Transportation for Merchants (TFM) orders with a current status that matches one of the status values that you specify. If TFMShipmentStatus is specified, only TFM orders are returned. Note: The TFMShipmentStatus request parameter is available only in China (CN). TFMShipmentStatus values: PendingPickUp - Amazon has not yet picked up the package from the seller. LabelCanceled - The seller canceled the pickup. PickedUp - Amazon has picked up the package from the seller. AtDestinationFC - Package has arrived at the Amazon fulfillment center. Delivered - Package has been delivered to the buyer. RejectedByBuyer - Package has been rejected by the buyer. Undeliverable - The package cannot be delivered. ReturnedToSeller - The package was not delivered to the customer and was returned to the seller. Lost - Package was lost by the carrier. |
Collection of string |
None. |