Endpoint

Orders: Read Orders

Name

ListOrders

Description

The ListOrders operation returns a list of orders created or updated during a time frame that you specify. You define that time frame using the CreatedAfter parameter or the LastUpdatedAfter parameter. You must use one of these parameters, but not both. You can also apply a range of filtering criteria to narrow the list of orders that is returned. The ListOrders operation includes order information for each order returned, including AmazonOrderId, OrderStatus, FulfillmentChannel, and LastUpdateDate. [API reference]

Parameters

Parameter

Label

Required

Options

Description

MarketplaceIdList

YES

Option	Value
US	ATVPDKIKX0DER
Brazil	A2Q3Y263D00KWC
Canada	A2EUQ1WTGCTBG2
Mexico	A1AM78C64UM0Y8
United Arab Emirates (U.A.E.)	A2VIGQ35RCS4UG
Germany	A1PA6795UKMFR9
Egypt	ARBP9OOSHTCHU
Spain	A1RKKUPIHCS9HS
France	A13V1IB3VIYZZH
UK	A1F83G8C2ARO7P
India	A21TJRUUN4KGV
Italy	APJ6JRA9NG5V4
Netherlands	A1805IZSGTT6HS
Saudi Arabia	A17E79C6D8DWNP
Turkey	A33AVAJ2PDY3EV
Singapore	A19VAU5U5O7RUS
Australia	A39IBJ37TRP1C6
Japan	A1VC38T7YXB528

CreatedAfter

A UTC date used for selecting orders created after (or at) a specified time. Date format must be UTC - ISO 8601 format (e.g. 2017-02-10T12:10:02Z). If LastUpdatedAfter is not specified. Specifying both CreatedAfter and LastUpdatedAfter returns an error.

CreatedBefore

A UTC date used for selecting orders created before (or at) a specified time. Date format must be UTC - ISO 8601 format (e.g. 2017-02-10T12:10:02Z)

LastUpdatedAfter

A UTC 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. Date format must be UTC - ISO 8601 format (e.g. 2017-02-10T12:10:02Z). If CreatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.If LastUpdatedAfter is specified, then BuyerEmail and SellerOrderId cannot be specified.

LastUpdatedBefore

A UTC 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. Date format must be UTC - ISO 8601 format (e.g. 2017-02-10T12:10:02Z)

OrderStatus

Option	Value
Pending	Pending
Unshipped	Unshipped
PartiallyShipped	PartiallyShipped
PendingAvailability	PendingAvailability
Shipped	Shipped
Canceled	Canceled
Unfulfillable	Unfulfillable

A list of OrderStatus values. Used to select orders with a current status that matches one of the status values that you specify.

FulfillmentChannel

Option	Value
Fulfilled by Amazon	AFN
Fulfilled by the seller	MFN

A list that indicates how an order was fulfilled.

PaymentMethod

Option	Value
Cash on delivery	COD
Convenience store payment	CVS
Any payment method other than COD or CVS	Other

A list of PaymentMethod values. Used to select orders paid for with the payment methods that you specify.

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.

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.

EasyShipShipmentStatus

Option	Value
PendingPickUp# Amazon has not yet picked up the package from the seller	PendingPickUp
LabelCanceled# The seller canceled the pickup	LabelCanceled
PickedUp# Amazon has picked up the package from the seller	PickedUp
OutForDelivery# The package is out for delivery	OutForDelivery
Damaged# The package was damaged by the carrier	Damaged
Delivered# Package has been delivered to the buyer.	Delivered
RejectedByBuyer# Package has been rejected by the buyer.	RejectedByBuyer
Undeliverable# The package cannot be delivered.	Undeliverable
ReturnedToSeller# The package was not delivered to the customer and was returned to the seller.	ReturnedToSeller
ReturningToSeller# The package was not delivered to the customer and is being returned to the seller.	ReturningToSeller
Lost# Package was lost by the carrier.	Lost

A list of EasyShipShipmentStatus values. Used to select Easy Ship orders with current statuses that match the status values that you specify. If EasyShipShipmentStatus is specified, only Amazon Easy Ship orders are returned.This parameter is valid only in the India marketplace.

Version

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
AmazonOrderId	`DT_WSTR`	`nvarchar(76)`	76	`False`
OrderTotal_Amount	`DT_NUMERIC`	`decimal(19,5)`		`False`
OrderTotal_CurrencyCode	`DT_WSTR`	`nvarchar(255)`	255	`False`
BuyerName	`DT_WSTR`	`nvarchar(255)`	255	`False`
OrderStatus	`DT_WSTR`	`nvarchar(32)`	32	`False`
OrderType	`DT_WSTR`	`nvarchar(52)`	52	`False`
PurchaseDate	`DT_DBTIMESTAMP`	`datetime`		`False`
LatestShipDate	`DT_DBTIMESTAMP`	`datetime`		`False`
PaymentMethod	`DT_WSTR`	`nvarchar(20)`	20	`False`
ShippingAddress_City	`DT_WSTR`	`nvarchar(255)`	255	`False`
ShippingAddress_PostalCode	`DT_WSTR`	`nvarchar(40)`	40	`False`
ShippingAddress_isAddressSharingConfidential	`DT_WSTR`	`nvarchar(20)`	20	`False`
ShippingAddress_StateOrRegion	`DT_WSTR`	`nvarchar(255)`	255	`False`
ShippingAddress_CountryCode	`DT_WSTR`	`nvarchar(255)`	255	`False`
ShippingAddress_Name	`DT_WSTR`	`nvarchar(255)`	255	`False`
ShippingAddress_AddressLine1	`DT_WSTR`	`nvarchar(255)`	255	`False`
ShippingAddress_AddressLine2	`DT_WSTR`	`nvarchar(255)`	255	`False`
ShippingAddress_County	`DT_WSTR`	`nvarchar(255)`	255	`False`
LastUpdateDate	`DT_DBTIMESTAMP`	`datetime`		`False`
IsReplacementOrder	`DT_WSTR`	`nvarchar(20)`	20	`False`
NumberOfItemsShipped	`DT_I4`	`int`		`False`
ShipServiceLevel	`DT_WSTR`	`nvarchar(36)`	36	`False`
SalesChannel	`DT_WSTR`	`nvarchar(40)`	40	`False`
IsBusinessOrder	`DT_WSTR`	`nvarchar(20)`	20	`False`
NumberOfItemsUnshipped	`DT_I4`	`int`		`False`
PaymentMethodDetails_PaymentMethodDetail	`DT_WSTR`	`nvarchar(32)`	32	`False`
IsGlobalExpressEnabled	`DT_WSTR`	`nvarchar(20)`	20	`False`
IsSoldByAB	`DT_WSTR`	`nvarchar(20)`	20	`False`
IsPremiumOrder	`DT_WSTR`	`nvarchar(20)`	20	`False`
EarliestShipDate	`DT_DBTIMESTAMP`	`datetime`		`False`
MarketplaceId	`DT_WSTR`	`nvarchar(52)`	52	`False`
FulfillmentChannel	`DT_WSTR`	`nvarchar(12)`	12	`False`
IsPrime	`DT_WSTR`	`nvarchar(20)`	20	`False`
SellerOrderId	`DT_WSTR`	`nvarchar(76)`	76	`False`
ShipmentServiceLevelCategory	`DT_WSTR`	`nvarchar(36)`	36	`False`
BuyerEmail	`DT_WSTR`	`nvarchar(255)`	255	`False`

If the column you are looking for is missing, consider customizing Amazon MWS Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Amazon MWS Connector in API Source component to read data or in API Destination component to read/write data:

Orders: Read Orders using API Source

Amazon MWS

Orders: Read Orders

SSIS API Source - Read from table or endpoint

Orders: Read Orders using API Destination

Amazon MWS

Orders: Read Orders

SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Orders: read orders

SELECT * FROM ListOrders

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Orders: read orders

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM ListOrders';

EXEC (@MyQuery) AT [LS_TO_AMAZON_MWS_IN_GATEWAY];