Tcl
Tcl
Amazon SP-API Get Orders
See more Amazon SP-API Examples
Demonstrates Amazon SP-API Sellers API -- get orders. Returns orders created or updated during the time frame indicated by the specified parameters.Chilkat Tcl Downloads
load ./chilkat.dll
set success 0
# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
# IMPORTANT:
# You'll need to make changes to use values specific to your own region and account.
#
# Here is a list of values you'll need to change or provide:
#
# 1) The access key. Change AWS_ACCESS_KEY to your actual access key.
# 2) The secret key. Change AWS_SECRET_KEY to your actual access key.
# 3) Your region. Change "ew-west-1" to your region.
# 4) The domain to which you connect. Change sandbox.sellingpartnerapi-eu.amazon.com to non-sandbox by removing the "sandbox."
# and change the "-eu" part of the domain to your region. See https://developer-docs.amazon.com/sp-api/docs/sp-api-endpoints
# 5) Use the restricted data token (RDT) obtained from your code that previously obtained the RDT.
# If you saved the RDT to a file, update the relative file path "qa_data/tokens/sp_api_rdt_token.json" to your actual file path.
# 6) Update your Marketplace ID(s), such as ATVPDKIKX0DER
# 7) If using the non-sandbox, change the CreatedAfter from "TEST_CASE_200" to an actual date, such as "2022-12-25"
set authAws [new_CkAuthAws]
CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $authAws "AWS_SECRET_KEY"
CkAuthAws_put_ServiceName $authAws "execute-api"
# Use the region that is correct for your needs.
CkAuthAws_put_Region $authAws "eu-west-1"
set rest [new_CkRest]
set bTls 1
set port 443
set bAutoReconnect 1
# Make sure to use the correct domain.
# This example is using the sandbox
set success [CkRest_Connect $rest "sandbox.sellingpartnerapi-eu.amazon.com" $port $bTls $bAutoReconnect]
if {$success == 0} then {
puts [CkRest_lastErrorText $rest]
delete_CkAuthAws $authAws
delete_CkRest $rest
exit
}
set success [CkRest_SetAuthAws $rest $authAws]
# Here's the example to get the RDT access token: Get SP-API Restricted Data Token
# Load the previously obtained RDT access token.
# See Fetch SP-API RDT Access Token
set jsonToken [new_CkJsonObject]
set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/sp_api_rdt_token.json"]
if {$success == 0} then {
puts "Failed to load RDT access token."
delete_CkAuthAws $authAws
delete_CkRest $rest
delete_CkJsonObject $jsonToken
exit
}
# Add the x-amz-access-token request header.
set rdt_token [CkJsonObject_stringOf $jsonToken "restrictedDataToken"]
CkRest_ClearAllHeaders $rest
CkRest_AddHeader $rest "x-amz-access-token" $rdt_token
# Indicate the marketplace IDs. Use the marketplace ID for your needs. See https://developer-docs.amazon.com/sp-api/docs/marketplace-ids
CkRest_ClearAllQueryParams $rest
# When using the sandbox, use these params literally and exactly has shown here:
CkRest_AddQueryParam $rest "MarketplaceIds" "ATVPDKIKX0DER"
CkRest_AddQueryParam $rest "CreatedAfter" "TEST_CASE_200"
set sbResponse [new_CkStringBuilder]
set uri "/orders/v0/orders"
set success [CkRest_FullRequestNoBodySb $rest "GET" $uri $sbResponse]
if {$success == 0} then {
puts [CkRest_lastErrorText $rest]
delete_CkAuthAws $authAws
delete_CkRest $rest
delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbResponse
exit
}
# Examine the response status.
set statusCode [CkRest_get_ResponseStatusCode $rest]
if {$statusCode != 200} then {
puts "Response status text: [CkRest_responseStatusText $rest]"
puts "Response body: "
puts [CkStringBuilder_getAsString $sbResponse]
puts "Failed."
delete_CkAuthAws $authAws
delete_CkRest $rest
delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbResponse
exit
}
puts [CkStringBuilder_getAsString $sbResponse]
# If successful, gets a JSON response such as the following:
# {
# "payload": {
# "CreatedBefore": "1.569521782042E9",
# "Orders": [
# {
# "AmazonOrderId": "902-1845936-5435065",
# "PurchaseDate": "1970-01-19T03:58:30Z",
# "LastUpdateDate": "1970-01-19T03:58:32Z",
# "OrderStatus": "Unshipped",
# "FulfillmentChannel": "MFN",
# "SalesChannel": "Amazon.com",
# "ShipServiceLevel": "Std US D2D Dom",
# "OrderTotal": {
# "CurrencyCode": "USD",
# "Amount": "11.01"
# },
# "NumberOfItemsShipped": 0,
# "NumberOfItemsUnshipped": 1,
# "PaymentMethod": "Other",
# "PaymentMethodDetails": [
# "Standard"
# ],
# "IsReplacementOrder": false,
# "MarketplaceId": "ATVPDKIKX0DER",
# "ShipmentServiceLevelCategory": "Standard",
# "OrderType": "StandardOrder",
# "EarliestShipDate": "1970-01-19T03:59:27Z",
# "LatestShipDate": "1970-01-19T04:05:13Z",
# "EarliestDeliveryDate": "1970-01-19T04:06:39Z",
# "LatestDeliveryDate": "1970-01-19T04:15:17Z",
# "IsBusinessOrder": false,
# "IsPrime": false,
# "IsGlobalExpressEnabled": false,
# "IsPremiumOrder": false,
# "IsSoldByAB": false,
# "IsIBA": false,
# "DefaultShipFromLocationAddress": {
# "Name": "MFNIntegrationTestMerchant",
# "AddressLine1": "2201 WESTLAKE AVE",
# "City": "SEATTLE",
# "StateOrRegion": "WA",
# "PostalCode": "98121-2778",
# "CountryCode": "US",
# "Phone": "+1 480-386-0930 ext. 73824",
# "AddressType": "Commercial"
# },
# "FulfillmentInstruction": {
# "FulfillmentSupplySourceId": "sampleSupplySourceId"
# },
# "IsISPU": false,
# "IsAccessPointOrder": false,
# "AutomatedShippingSettings": {
# "HasAutomatedShippingSettings": false
# },
# "EasyShipShipmentStatus": "PendingPickUp",
# "ElectronicInvoiceStatus": "NotRequired"
# },
# {
# "AmazonOrderId": "902-8745147-1934268",
# "PurchaseDate": "1970-01-19T03:58:30Z",
# "LastUpdateDate": "1970-01-19T03:58:32Z",
# "OrderStatus": "Unshipped",
# "FulfillmentChannel": "MFN",
# "SalesChannel": "Amazon.com",
# "ShipServiceLevel": "Std US D2D Dom",
# "OrderTotal": {
# "CurrencyCode": "USD",
# "Amount": "11.01"
# },
# "NumberOfItemsShipped": 0,
# "NumberOfItemsUnshipped": 1,
# "PaymentMethod": "Other",
# "PaymentMethodDetails": [
# "Standard"
# ],
# "IsReplacementOrder": false,
# "MarketplaceId": "ATVPDKIKX0DER",
# "ShipmentServiceLevelCategory": "Standard",
# "OrderType": "StandardOrder",
# "EarliestShipDate": "1970-01-19T03:59:27Z",
# "LatestShipDate": "1970-01-19T04:05:13Z",
# "EarliestDeliveryDate": "1970-01-19T04:06:39Z",
# "LatestDeliveryDate": "1970-01-19T04:15:17Z",
# "IsBusinessOrder": false,
# "IsPrime": false,
# "IsAccessPointOrder": false,
# "IsGlobalExpressEnabled": false,
# "IsPremiumOrder": false,
# "IsSoldByAB": false,
# "IsIBA": false,
# "EasyShipShipmentStatus": "PendingPickUp",
# "ElectronicInvoiceStatus": "NotRequired"
# }
# ]
# }
# }
# Use this online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON
set json [new_CkJsonObject]
CkJsonObject_LoadSb $json $sbResponse
set CreatedBefore [CkJsonObject_stringOf $json "payload.CreatedBefore"]
set i 0
set count_i [CkJsonObject_SizeOfArray $json "payload.Orders"]
while {$i < $count_i} {
CkJsonObject_put_I $json $i
set AmazonOrderId [CkJsonObject_stringOf $json "payload.Orders[i].AmazonOrderId"]
set PurchaseDate [CkJsonObject_stringOf $json "payload.Orders[i].PurchaseDate"]
set LastUpdateDate [CkJsonObject_stringOf $json "payload.Orders[i].LastUpdateDate"]
set OrderStatus [CkJsonObject_stringOf $json "payload.Orders[i].OrderStatus"]
set FulfillmentChannel [CkJsonObject_stringOf $json "payload.Orders[i].FulfillmentChannel"]
set SalesChannel [CkJsonObject_stringOf $json "payload.Orders[i].SalesChannel"]
set ShipServiceLevel [CkJsonObject_stringOf $json "payload.Orders[i].ShipServiceLevel"]
set CurrencyCode [CkJsonObject_stringOf $json "payload.Orders[i].OrderTotal.CurrencyCode"]
set Amount [CkJsonObject_stringOf $json "payload.Orders[i].OrderTotal.Amount"]
set NumberOfItemsShipped [CkJsonObject_IntOf $json "payload.Orders[i].NumberOfItemsShipped"]
set NumberOfItemsUnshipped [CkJsonObject_IntOf $json "payload.Orders[i].NumberOfItemsUnshipped"]
set PaymentMethod [CkJsonObject_stringOf $json "payload.Orders[i].PaymentMethod"]
set IsReplacementOrder [CkJsonObject_BoolOf $json "payload.Orders[i].IsReplacementOrder"]
set MarketplaceId [CkJsonObject_stringOf $json "payload.Orders[i].MarketplaceId"]
set ShipmentServiceLevelCategory [CkJsonObject_stringOf $json "payload.Orders[i].ShipmentServiceLevelCategory"]
set OrderType [CkJsonObject_stringOf $json "payload.Orders[i].OrderType"]
set EarliestShipDate [CkJsonObject_stringOf $json "payload.Orders[i].EarliestShipDate"]
set LatestShipDate [CkJsonObject_stringOf $json "payload.Orders[i].LatestShipDate"]
set EarliestDeliveryDate [CkJsonObject_stringOf $json "payload.Orders[i].EarliestDeliveryDate"]
set LatestDeliveryDate [CkJsonObject_stringOf $json "payload.Orders[i].LatestDeliveryDate"]
set IsBusinessOrder [CkJsonObject_BoolOf $json "payload.Orders[i].IsBusinessOrder"]
set IsPrime [CkJsonObject_BoolOf $json "payload.Orders[i].IsPrime"]
set IsGlobalExpressEnabled [CkJsonObject_BoolOf $json "payload.Orders[i].IsGlobalExpressEnabled"]
set IsPremiumOrder [CkJsonObject_BoolOf $json "payload.Orders[i].IsPremiumOrder"]
set IsSoldByAB [CkJsonObject_BoolOf $json "payload.Orders[i].IsSoldByAB"]
set IsIBA [CkJsonObject_BoolOf $json "payload.Orders[i].IsIBA"]
set Name [CkJsonObject_stringOf $json "payload.Orders[i].DefaultShipFromLocationAddress.Name"]
set AddressLine1 [CkJsonObject_stringOf $json "payload.Orders[i].DefaultShipFromLocationAddress.AddressLine1"]
set City [CkJsonObject_stringOf $json "payload.Orders[i].DefaultShipFromLocationAddress.City"]
set StateOrRegion [CkJsonObject_stringOf $json "payload.Orders[i].DefaultShipFromLocationAddress.StateOrRegion"]
set PostalCode [CkJsonObject_stringOf $json "payload.Orders[i].DefaultShipFromLocationAddress.PostalCode"]
set CountryCode [CkJsonObject_stringOf $json "payload.Orders[i].DefaultShipFromLocationAddress.CountryCode"]
set Phone [CkJsonObject_stringOf $json "payload.Orders[i].DefaultShipFromLocationAddress.Phone"]
set AddressType [CkJsonObject_stringOf $json "payload.Orders[i].DefaultShipFromLocationAddress.AddressType"]
set FulfillmentSupplySourceId [CkJsonObject_stringOf $json "payload.Orders[i].FulfillmentInstruction.FulfillmentSupplySourceId"]
set IsISPU [CkJsonObject_BoolOf $json "payload.Orders[i].IsISPU"]
set IsAccessPointOrder [CkJsonObject_BoolOf $json "payload.Orders[i].IsAccessPointOrder"]
set HasAutomatedShippingSettings [CkJsonObject_BoolOf $json "payload.Orders[i].AutomatedShippingSettings.HasAutomatedShippingSettings"]
set EasyShipShipmentStatus [CkJsonObject_stringOf $json "payload.Orders[i].EasyShipShipmentStatus"]
set ElectronicInvoiceStatus [CkJsonObject_stringOf $json "payload.Orders[i].ElectronicInvoiceStatus"]
set j 0
set count_j [CkJsonObject_SizeOfArray $json "payload.Orders[i].PaymentMethodDetails"]
while {$j < $count_j} {
CkJsonObject_put_J $json $j
set strVal [CkJsonObject_stringOf $json "payload.Orders[i].PaymentMethodDetails[j]"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
puts "Success!"
delete_CkAuthAws $authAws
delete_CkRest $rest
delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbResponse
delete_CkJsonObject $json