Orders
Returns orders created or updated during a time frame that you specify.
Note: If you're retrieving personally identifiable information (PII), you must set IncludeRestrictedData to true. When retreiving PII, the OAuth application that you use to authenticate must be granted the Direct-to-consumer-shipping role to query this view. If you authenticated with the embedded OAuth application, you will need to create your own OAuth application with the Direct-to-consumer-shipping role enabled. See Creating a Custom OAuth App for more information about creating an OAuth application.
Select
The add-in will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the add-in.
- AmazonOrderId supports the '=' comparison.
- SellerOrderId supports the '=' comparison.
- PurchaseDate supports the '=', '<', '>', '<=', '>=' comparison.
- LastUpdateDate supports the '=', '<', '>', '<=', '>=' comparison.
- OrderStatus supports the '=', 'IN' comparison.
- FulfillmentChannel supports the '=', 'IN' comparison.
- PaymentMethod supports the '=', 'IN' comparison.
- MarketplaceId supports the '=' comparison.
- BuyerEmail supports the '=' comparison.
- IsISPU supports the '=' comparison.
SELECT * FROM Orders WHERE AmazonOrderId = '249-7638334-8161403'
SELECT * FROM Orders WHERE SellerOrderId = '249-7638334' AND purchasedate > '2010-01-01'
SELECT * FROM Orders WHERE LastUpdateDate >= '2016-12-12'
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12'
SELECT * FROM Orders WHERE MarketplaceId = 'ATVPDKIKX0DER'
SELECT * FROM Orders WHERE BuyerEmail = '[email protected]'
SELECT * FROM Orders WHERE IsISPU = false
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12' AND OrderStatus = 'Canceled'
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12' AND FulfillmentChannel = 'MFN'
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12' AND BuyerEmail = '[email protected]'
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12' AND PaymentMethod = 'Other'
Columns
| Name | Type | References | Description |
| AmazonOrderId [KEY] | String | The Amazon ID of the order. | |
| SellerOrderId | String | The Seller ID of the order. | |
| PurchaseDate | Datetime | The date of the purchase. | |
| LastUpdateDate | Datetime | The last update date. | |
| OrderStatus | String | Status of the order. | |
| FulfillmentChannel | String | The Fulfillment Channel. | |
| SalesChannel | String | The Sales Channel. | |
| OrderChannel | String | The Order Channel. | |
| ShipServiceLevel | String | The level of the Ship Service. | |
| ShippingAddressName | String | The Shipping Address Name. | |
| ShippingAddressAddressLine1 | String | The Shipping Address AddressLine. | |
| ShippingAddressAddressLine2 | String | The Shipping Address AddressLine. | |
| ShippingAddressAddressLine3 | String | The Shipping Address AddressLine. | |
| ShippingAddressCity | String | The Shipping Address City. | |
| ShippingAddressCounty | String | The Shipping Address County. | |
| ShippingAddressDistrict | String | The Shipping Address District. | |
| ShippingAddressStateOrRegion | String | The Shipping Address State Or Region. | |
| ShippingAddressPostalCode | String | The Shipping Address Postal Code. | |
| ShippingAddressCountryCode | String | The Shipping Address Country Code. | |
| ShippingAddressPhone | String | The Shipping Address Phone. | |
| ShippingAddressMunicipality | String | The Shipping Municipality. | |
| ShippingAddress_AddressType | String | The Shipping Address Type. | |
| DefaultShipAddressName | String | The Shipping Address Name. | |
| DefaultShipAddressLine1 | String | Default Ship From Location Address AddressLine. | |
| DefaultShipAddressLine2 | String | Default Ship From Location Address AddressLine. | |
| DefaultShipAddressLine3 | String | Default Ship From Location Address AddressLine. | |
| DefaultShipCity | String | Default Ship From Location Address City. | |
| DefaultShipCounty | String | Default Ship From Location Address County. | |
| DefaultShipDistrict | String | Default Ship From Location Address District. | |
| DefaultShipStateOrRegion | String | Default Ship From Location Address State Or Region. | |
| DefaultShipPostalCode | String | Default Ship From Location Address Postal Code. | |
| DefaultShipCountryCode | String | Default Ship From Location Address Country Code. | |
| DefaultShipPhone | String | Default Ship From Location Address Phone. | |
| DefaultShipMunicipality | String | The Default Ship Municipality. | |
| DefaultShip_AddressType | String | Default Ship From Location Address Type. | |
| OrderTotalCurrencyCode | String | The Order Currency Code. | |
| OrderTotalAmount | Decimal | The Order Amount. | |
| NumberOfItemsShipped | Integer | The Number Of Items Shipped. | |
| NumberOfItemsUnshipped | Integer | The Number Of Items Unshipped. | |
| PaymentExecutionDetail | String | The Payment Execution Detail. | |
| PaymentMethod | String | The Payment Method. | |
| PaymentMethodDetails | String | The Details of payment method. | |
| IsReplacementOrder | Boolean | Boolean specifying if it is a replacement order. | |
| ReplacedOrderId | String | The Replaced OrderId. | |
| MarketplaceId | String | The MarketplaceId. | |
| BuyerEmail | String | The Buyer Email. | |
| BuyerName | String | The Buyer Name. | |
| BuyerCounty | String | The Buyer Country. | |
| BuyerTaxInfo | String | The Buyer Tax Info. | |
| BuyerInvoicePreference | String | Can be individual or business. | |
| ShipmentServiceLevelCategory | String | The Shipment Service Level Category. | |
| ShippedByAmazonTFM | Boolean | The Shipped By Amazon TFM. | |
| TFMShipmentStatus | String | The TFM Shipment Status. | |
| CbaDisplayableShippingLabel | String | The Cba Displayable Shipping Label. | |
| OrderType | String | The Type of Order. | |
| HasAutomatedShippingSettings | Boolean | If true, this order has automated shipping settings generated by Amazon. This order could be identified as an SSA order. | |
| AutomatedCarrier | String | Auto-generated carrier for SSA orders | |
| AutomatedShipMethod | String | Auto-generated ship method for SSA orders. | |
| EarliestShipDate | Datetime | The Earliest Ship Date. | |
| EasyShipShipmentStatus | String | The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders. | |
| HasRegulatedItems | Boolean | Whether the order contains regulated items which may require additional approval steps before being fulfilled. | |
| PromiseResponseDueDate | Datetime | Indicates the date by which the seller must respond to the buyer with an estimated ship date. Returned only for Sourcing on Demand orders. | |
| LatestShipDate | Datetime | The Latest Ship Date. | |
| EarliestDeliveryDate | Datetime | The Earliest Delivery Date . | |
| LatestDeliveryDate | Datetime | The Latest Delivery Date. | |
| IsBusinessOrder | Boolean | Boolean specifying if it is a Business Order. | |
| IsEstimatedShipDateSet | Boolean | When true, the estimated ship date is set for the order. Returned only for Sourcing on Demand orders. | |
| IsSoldByAB | Boolean | When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). | |
| IsIBA | Boolean | When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). | |
| IsISPU | Boolean | When true, this order is marked to be picked up from a store rather than delivered. | |
| IsGlobalExpressEnabled | Boolean | When true, the order is a GlobalExpress order. | |
| PurchaseOrderNumber | String | The Purchase Order Number. | |
| IsPrime | Boolean | Boolean specifying if it is a Prime Order. | |
| IsPremiumOrder | Boolean | Boolean specifying if it is a Premium Order. | |
| CompanyName | String | The company name of the recipient. | |
| ExtendedFields | String | The container for address extended fields. For example, street name or street number. Only available for Brazil shipping addresses. | |
| AmazonPrograms | String | A list of the programs that are associated with the specified order item. |