EndPoint Get Order (Single)

Name

get_order

Description

Returns the order information for a specified OrderId [API reference]

Parameters

Parameter	Label	Required	Options	Description
AmazonOrderId	AmazonOrderId	NO		Filters purchase orders based on the specified orderid.

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
AmazonOrderId	`DT_WSTR`	`nvarchar(500)`	500	`False`
PurchaseDate	`DT_DBTIMESTAMP`	`datetime`		`False`
LastUpdateDate	`DT_DBTIMESTAMP`	`datetime`		`False`
OrderStatus	`DT_WSTR`	`nvarchar(100)`	100	`False`
FulfillmentChannel	`DT_WSTR`	`nvarchar(50)`	50	`False`
SalesChannel	`DT_WSTR`	`nvarchar(100)`	100	`False`
ShipServiceLevel	`DT_WSTR`	`nvarchar(500)`	500	`False`
CurrencyCode	`DT_WSTR`	`nvarchar(50)`	50	`False`
Amount	`DT_WSTR`	`nvarchar(50)`	50	`False`
NumberOfItemsShipped	`DT_I4`	`int`		`False`
NumberOfItemsUnshipped	`DT_I4`	`int`		`False`
PaymentMethod	`DT_WSTR`	`nvarchar(50)`	50	`False`
PaymentMethodDetails	`DT_WSTR`	`nvarchar(500)`	500	`False`
IsReplacementOrder	`DT_BOOL`	`bit`		`False`
MarketplaceId	`DT_WSTR`	`nvarchar(500)`	500	`False`
ShipmentServiceLevelCategory	`DT_WSTR`	`nvarchar(100)`	100	`False`
OrderType	`DT_WSTR`	`nvarchar(500)`	500	`False`
EarliestShipDate	`DT_DBTIMESTAMP`	`datetime`		`False`
LatestShipDate	`DT_DBTIMESTAMP`	`datetime`		`False`
EarliestDeliveryDate	`DT_DBTIMESTAMP`	`datetime`		`False`
LatestDeliveryDate	`DT_DBTIMESTAMP`	`datetime`		`False`
IsBusinessOrder	`DT_BOOL`	`bit`		`False`
IsPrime	`DT_BOOL`	`bit`		`False`
IsGlobalExpressEnabled	`DT_BOOL`	`bit`		`False`
IsPremiumOrder	`DT_BOOL`	`bit`		`False`
IsSoldByAB	`DT_BOOL`	`bit`		`False`
IsIBA	`DT_BOOL`	`bit`		`False`
DefaultShipFromName	`DT_WSTR`	`nvarchar(500)`	500	`False`
DefaultShipAddressLine1	`DT_WSTR`	`nvarchar(500)`	500	`False`
DefaultShipFromCity	`DT_WSTR`	`nvarchar(100)`	100	`False`
DefaultShipFromStateOrRegion	`DT_WSTR`	`nvarchar(50)`	50	`False`
DefaultShipFromPostalCode	`DT_WSTR`	`nvarchar(100)`	100	`False`
DefaultShipFromCountryCode	`DT_WSTR`	`nvarchar(50)`	50	`False`
DefaultShipFromPhone	`DT_WSTR`	`nvarchar(500)`	500	`False`
DefaultShipFromAddressType	`DT_WSTR`	`nvarchar(100)`	100	`False`
FulfillmentSupplySourceId	`DT_WSTR`	`nvarchar(500)`	500	`False`
IsISPU	`DT_BOOL`	`bit`		`False`
IsAccessPointOrder	`DT_BOOL`	`bit`		`False`
HasAutomatedShippingSettings	`DT_BOOL`	`bit`		`False`
EasyShipShipmentStatus	`DT_WSTR`	`nvarchar(500)`	500	`False`
ElectronicInvoiceStatus	`DT_WSTR`	`nvarchar(500)`	500	`False`

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 Selling Partner (SP-API) Connector in API Source component to read data or in API Destination component to read/write data:

Get Order (Single) using API Source

Amazon Selling Partner (SP-API)

Get Order (Single)

SSIS API Source - Read from table or endpoint

Get Order (Single) using API Destination

Amazon Selling Partner (SP-API)

Get Order (Single)

SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Sandbox - Read Single Order (Fake data for testing)

Read single order with orderid which has fake values (sandbox data)

SELECT *
FROM get_order
--DONOT try WHERE AmazonOrderId='TEST_CASE_200' (WHERE clause) for sandbox endpoint, it will return empty row. If you try in Live API then should work. 
WITH(
	AmazonOrderId='TEST_CASE_200'
--  AmazonOrderId='TEST_CASE_IBA_200'	
)
CONNECTION(
	ServiceUrl='https://sandbox.sellingpartnerapi-na.amazon.com'
)

SQL Server

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

Sandbox - Read Single Order (Fake data for testing)

Read single order with orderid which has fake values (sandbox data)

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT *
FROM get_order
--DONOT try WHERE AmazonOrderId=''TEST_CASE_200'' (WHERE clause) for sandbox endpoint, it will return empty row. If you try in Live API then should work. 
WITH(
	AmazonOrderId=''TEST_CASE_200''
--  AmazonOrderId=''TEST_CASE_IBA_200''	
)
CONNECTION(
	ServiceUrl=''https://sandbox.sellingpartnerapi-na.amazon.com''
)';

EXEC (@MyQuery) AT [LINKED_SERVER_TO_AMAZON_SELLING_PARTNER_SP_API_IN_DATA_GATEWAY];