Lianja
Lianja
Amazon SP-API Get Specific Order
See more Amazon SP-API Examples
Get a specific Amazon Seller order.Chilkat Lianja Downloads
llSuccess = .F.
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// Gets information for this order ID
// The order ID is something like "902-1845936-5435065" and it is the AmazonOrderId returned in the JSON when getting the list of orders. For example:
// {
// "payload": {
// "CreatedBefore": "1.569521782042E9",
// "Orders": [
// {
// "AmazonOrderId": "902-1845936-5435065",
// "PurchaseDate": "1970-01-19T03:58:30Z",
// ...
// However, when using the sandbox, instead use the explicit keyword TEST_CASE_200
lcOrderId = "TEST_CASE_200"
loAuthAws = createobject("CkAuthAws")
loAuthAws.AccessKey = "AWS_ACCESS_KEY"
loAuthAws.SecretKey = "AWS_SECRET_KEY"
loAuthAws.ServiceName = "execute-api"
// Use the region that is correct for your needs.
loAuthAws.Region = "eu-west-1"
// First get a restricted data token for the given order ID.
// This requires an LWA access token which cannot be more than 1 hour old.
// See Fetch SP-API LWA Access Token
loJsonLwaToken = createobject("CkJsonObject")
llSuccess = loJsonLwaToken.LoadFile("qa_data/tokens/sp_api_lwa_token.json")
if (llSuccess = .F.) then
? "Failed to load LWA access token."
release loAuthAws
release loJsonLwaToken
return
endif
// Must use the non-sandbox domain for getting the RDT.
loRest = createobject("CkRest")
llSuccess = loRest.Connect("sellingpartnerapi-eu.amazon.com",443,.T.,.T.)
if (llSuccess = .F.) then
? loRest.LastErrorText
release loAuthAws
release loJsonLwaToken
release loRest
return
endif
llSuccess = loRest.SetAuthAws(loAuthAws)
// Add the x-amz-access-token request header.
lcLwa_token = loJsonLwaToken.StringOf("access_token")
loRest.ClearAllHeaders()
loRest.AddHeader("x-amz-access-token",lcLwa_token)
// We're going to send a POST with the following JSON body:
// {
// "restrictedResources": [
// {
// "method": "GET",
// "path": "/orders/v0/orders/{orderId}",
// "dataElements": ["buyerInfo", "shippingAddress"]
// }
// ]
// }
loSbPath = createobject("CkStringBuilder")
loSbPath.Append("/orders/v0/orders/")
loSbPath.Append(lcOrderId)
loJsonRc = createobject("CkJsonObject")
loJsonRc.UpdateString("restrictedResources[0].method","GET")
loJsonRc.UpdateString("restrictedResources[0].path",loSbPath.GetAsString())
loJsonRc.UpdateString("restrictedResources[0].dataElements[0]","buyerInfo")
loJsonRc.UpdateString("restrictedResources[0].dataElements[1]","shippingAddress")
loSbRequest = createobject("CkStringBuilder")
loJsonRc.EmitSb(loSbRequest)
loSbResponse = createobject("CkStringBuilder")
lcUri = "/tokens/2021-03-01/restrictedDataToken"
llSuccess = loRest.FullRequestSb("POST",lcUri,loSbRequest,loSbResponse)
if (llSuccess = .F.) then
? loRest.LastErrorText
release loAuthAws
release loJsonLwaToken
release loRest
release loSbPath
release loJsonRc
release loSbRequest
release loSbResponse
return
endif
// Examine the response status.
lnStatusCode = loRest.ResponseStatusCode
if (lnStatusCode <> 200) then
? "Response status code: " + str(lnStatusCode)
? "Response status text: " + loRest.ResponseStatusText
? "Response body: "
? loSbResponse.GetAsString()
? "Failed."
release loAuthAws
release loJsonLwaToken
release loRest
release loSbPath
release loJsonRc
release loSbRequest
release loSbResponse
return
endif
// Get the restricted data token.
loJsonResp = createobject("CkJsonObject")
loJsonResp.LoadSb(loSbResponse)
lcRestrictedDataToken = loJsonResp.StringOf("restrictedDataToken")
? "Restricted Data Token: " + lcRestrictedDataToken
// ------------------------------------------------------------------------------------------------------------
// ------------------------------------------------------------------------------------------------------------
// Now that we have the RDT, we can use it to get information about the order.
//
// Yes, the SP-API is horribly tedious and painful. You must use an RDT specifically tailored to each request requiring an RDT,
// the RDT must not be over an hour old, and if you need to get a new RDT you must get it using an LWA token that itself is not
// more than an hour old. If the LWA is more than an hour old, you must get a new one. Ughhh!!!!!
// ------------------------------------------------------------------------------------------------------------
// Disconnect from the non-sandbox domain. This example will use the sandbox.
// (The RDT was obtained using the non-sandbox domain. For some reason, the sandbox domain does not work for getting the RDT.)
loRest.Disconnect(100)
llSuccess = loRest.Connect("sandbox.sellingpartnerapi-eu.amazon.com",443,.T.,.T.)
if (llSuccess = .F.) then
? loRest.LastErrorText
release loAuthAws
release loJsonLwaToken
release loRest
release loSbPath
release loJsonRc
release loSbRequest
release loSbResponse
release loJsonResp
return
endif
llSuccess = loRest.SetAuthAws(loAuthAws)
loRest.ClearAllHeaders()
loRest.AddHeader("x-amz-access-token",lcRestrictedDataToken)
loRest.ClearAllQueryParams()
loRest.AddQueryParam("MarketplaceIds","ATVPDKIKX0DER")
loRest.ClearAllPathParams()
loRest.AddPathParam("{orderId}",lcOrderId)
lcUri = "/orders/v0/orders/{orderId}"
llSuccess = loRest.FullRequestNoBodySb("GET",lcUri,loSbResponse)
if (llSuccess = .F.) then
? loRest.LastErrorText
release loAuthAws
release loJsonLwaToken
release loRest
release loSbPath
release loJsonRc
release loSbRequest
release loSbResponse
release loJsonResp
return
endif
// Examine the response status.
lnStatusCode = loRest.ResponseStatusCode
if (lnStatusCode <> 200) then
? "Response status text: " + loRest.ResponseStatusText
? "Response body: "
? loSbResponse.GetAsString()
? "Failed."
release loAuthAws
release loJsonLwaToken
release loRest
release loSbPath
release loJsonRc
release loSbRequest
release loSbResponse
release loJsonResp
return
endif
? loSbResponse.GetAsString()
// If successful, gets a JSON response such as the following:
// {
// "payload": {
// "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"
// }
// }
// Use this online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
loJson = createobject("CkJsonObject")
loJson.LoadSb(loSbResponse)
lcAmazonOrderId = loJson.StringOf("payload.AmazonOrderId")
lcPurchaseDate = loJson.StringOf("payload.PurchaseDate")
lcLastUpdateDate = loJson.StringOf("payload.LastUpdateDate")
lcOrderStatus = loJson.StringOf("payload.OrderStatus")
lcFulfillmentChannel = loJson.StringOf("payload.FulfillmentChannel")
lcSalesChannel = loJson.StringOf("payload.SalesChannel")
lcShipServiceLevel = loJson.StringOf("payload.ShipServiceLevel")
lcCurrencyCode = loJson.StringOf("payload.OrderTotal.CurrencyCode")
lcAmount = loJson.StringOf("payload.OrderTotal.Amount")
lnNumberOfItemsShipped = loJson.IntOf("payload.NumberOfItemsShipped")
lnNumberOfItemsUnshipped = loJson.IntOf("payload.NumberOfItemsUnshipped")
lcPaymentMethod = loJson.StringOf("payload.PaymentMethod")
llIsReplacementOrder = loJson.BoolOf("payload.IsReplacementOrder")
lcMarketplaceId = loJson.StringOf("payload.MarketplaceId")
lcShipmentServiceLevelCategory = loJson.StringOf("payload.ShipmentServiceLevelCategory")
lcOrderType = loJson.StringOf("payload.OrderType")
lcEarliestShipDate = loJson.StringOf("payload.EarliestShipDate")
lcLatestShipDate = loJson.StringOf("payload.LatestShipDate")
lcEarliestDeliveryDate = loJson.StringOf("payload.EarliestDeliveryDate")
lcLatestDeliveryDate = loJson.StringOf("payload.LatestDeliveryDate")
llIsBusinessOrder = loJson.BoolOf("payload.IsBusinessOrder")
llIsPrime = loJson.BoolOf("payload.IsPrime")
llIsGlobalExpressEnabled = loJson.BoolOf("payload.IsGlobalExpressEnabled")
llIsPremiumOrder = loJson.BoolOf("payload.IsPremiumOrder")
llIsSoldByAB = loJson.BoolOf("payload.IsSoldByAB")
llIsIBA = loJson.BoolOf("payload.IsIBA")
lcName = loJson.StringOf("payload.DefaultShipFromLocationAddress.Name")
lcAddressLine1 = loJson.StringOf("payload.DefaultShipFromLocationAddress.AddressLine1")
lcCity = loJson.StringOf("payload.DefaultShipFromLocationAddress.City")
lcStateOrRegion = loJson.StringOf("payload.DefaultShipFromLocationAddress.StateOrRegion")
lcPostalCode = loJson.StringOf("payload.DefaultShipFromLocationAddress.PostalCode")
lcCountryCode = loJson.StringOf("payload.DefaultShipFromLocationAddress.CountryCode")
lcPhone = loJson.StringOf("payload.DefaultShipFromLocationAddress.Phone")
lcAddressType = loJson.StringOf("payload.DefaultShipFromLocationAddress.AddressType")
lcFulfillmentSupplySourceId = loJson.StringOf("payload.FulfillmentInstruction.FulfillmentSupplySourceId")
llIsISPU = loJson.BoolOf("payload.IsISPU")
llIsAccessPointOrder = loJson.BoolOf("payload.IsAccessPointOrder")
llHasAutomatedShippingSettings = loJson.BoolOf("payload.AutomatedShippingSettings.HasAutomatedShippingSettings")
lcEasyShipShipmentStatus = loJson.StringOf("payload.EasyShipShipmentStatus")
lcElectronicInvoiceStatus = loJson.StringOf("payload.ElectronicInvoiceStatus")
i = 0
lnCount_i = loJson.SizeOfArray("payload.PaymentMethodDetails")
do while i < lnCount_i
loJson.I = i
lcStrVal = loJson.StringOf("payload.PaymentMethodDetails[i]")
i = i + 1
enddo
? "Success!"
release loAuthAws
release loJsonLwaToken
release loRest
release loSbPath
release loJsonRc
release loSbRequest
release loSbResponse
release loJsonResp
release loJson