(Visual FoxPro) Amazon SP-API Get Specific Order

See more Amazon SP-API Examples

Get a specific Amazon Seller order.

For more information, see https://developer-docs.amazon.com/sp-api/docs/orders-api-v0-reference#getorders

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL lcOrderId
LOCAL loAuthAws
LOCAL loJsonLwaToken
LOCAL lnSuccess
LOCAL loRest
LOCAL lcLwa_token
LOCAL loSbPath
LOCAL loJsonRc
LOCAL loSbRequest
LOCAL loSbResponse
LOCAL lcUri
LOCAL lnStatusCode
LOCAL loJsonResp
LOCAL lcRestrictedDataToken
LOCAL loJson
LOCAL lcStrVal
LOCAL lcAmazonOrderId
LOCAL lcPurchaseDate
LOCAL lcLastUpdateDate
LOCAL lcOrderStatus
LOCAL lcFulfillmentChannel
LOCAL lcSalesChannel
LOCAL lcShipServiceLevel
LOCAL lcCurrencyCode
LOCAL lcAmount
LOCAL lnNumberOfItemsShipped
LOCAL lnNumberOfItemsUnshipped
LOCAL lcPaymentMethod
LOCAL lnIsReplacementOrder
LOCAL lcMarketplaceId
LOCAL lcShipmentServiceLevelCategory
LOCAL lcOrderType
LOCAL lcEarliestShipDate
LOCAL lcLatestShipDate
LOCAL lcEarliestDeliveryDate
LOCAL lcLatestDeliveryDate
LOCAL lnIsBusinessOrder
LOCAL lnIsPrime
LOCAL lnIsGlobalExpressEnabled
LOCAL lnIsPremiumOrder
LOCAL lnIsSoldByAB
LOCAL lnIsIBA
LOCAL lcName
LOCAL lcAddressLine1
LOCAL lcCity
LOCAL lcStateOrRegion
LOCAL lcPostalCode
LOCAL lcCountryCode
LOCAL lcPhone
LOCAL lcAddressType
LOCAL lcFulfillmentSupplySourceId
LOCAL lnIsISPU
LOCAL lnIsAccessPointOrder
LOCAL lnHasAutomatedShippingSettings
LOCAL lcEasyShipShipmentStatus
LOCAL lcElectronicInvoiceStatus
LOCAL i
LOCAL lnCount_i

* 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"

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.AuthAws')
loAuthAws = CreateObject('Chilkat.AuthAws')
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
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonLwaToken = CreateObject('Chilkat.JsonObject')
lnSuccess = loJsonLwaToken.LoadFile("qa_data/tokens/sp_api_lwa_token.json")
IF (lnSuccess = 0) THEN
    ? "Failed to load LWA access token."
    RELEASE loAuthAws
    RELEASE loJsonLwaToken
    CANCEL
ENDIF

* Must use the non-sandbox domain for getting the RDT.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Rest')
loRest = CreateObject('Chilkat.Rest')
lnSuccess = loRest.Connect("sellingpartnerapi-eu.amazon.com",443,1,1)
IF (lnSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loAuthAws
    RELEASE loJsonLwaToken
    RELEASE loRest
    CANCEL
ENDIF

lnSuccess = 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"]
*     }
*   ]
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbPath = CreateObject('Chilkat.StringBuilder')
loSbPath.Append("/orders/v0/orders/")
loSbPath.Append(lcOrderId)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonRc = CreateObject('Chilkat.JsonObject')
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")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequest = CreateObject('Chilkat.StringBuilder')
loJsonRc.EmitSb(loSbRequest)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponse = CreateObject('Chilkat.StringBuilder')
lcUri = "/tokens/2021-03-01/restrictedDataToken"
lnSuccess = loRest.FullRequestSb("POST",lcUri,loSbRequest,loSbResponse)
IF (lnSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loAuthAws
    RELEASE loJsonLwaToken
    RELEASE loRest
    RELEASE loSbPath
    RELEASE loJsonRc
    RELEASE loSbRequest
    RELEASE loSbResponse
    CANCEL
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
    CANCEL
ENDIF

* Get the restricted data token.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonResp = CreateObject('Chilkat.JsonObject')
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)

lnSuccess = loRest.Connect("sandbox.sellingpartnerapi-eu.amazon.com",443,1,1)
IF (lnSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loAuthAws
    RELEASE loJsonLwaToken
    RELEASE loRest
    RELEASE loSbPath
    RELEASE loJsonRc
    RELEASE loSbRequest
    RELEASE loSbResponse
    RELEASE loJsonResp
    CANCEL
ENDIF

lnSuccess = 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}"
lnSuccess = loRest.FullRequestNoBodySb("GET",lcUri,loSbResponse)
IF (lnSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loAuthAws
    RELEASE loJsonLwaToken
    RELEASE loRest
    RELEASE loSbPath
    RELEASE loJsonRc
    RELEASE loSbRequest
    RELEASE loSbResponse
    RELEASE loJsonResp
    CANCEL
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
    CANCEL
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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')

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")
lnIsReplacementOrder = 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")
lnIsBusinessOrder = loJson.BoolOf("payload.IsBusinessOrder")
lnIsPrime = loJson.BoolOf("payload.IsPrime")
lnIsGlobalExpressEnabled = loJson.BoolOf("payload.IsGlobalExpressEnabled")
lnIsPremiumOrder = loJson.BoolOf("payload.IsPremiumOrder")
lnIsSoldByAB = loJson.BoolOf("payload.IsSoldByAB")
lnIsIBA = 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")
lnIsISPU = loJson.BoolOf("payload.IsISPU")
lnIsAccessPointOrder = loJson.BoolOf("payload.IsAccessPointOrder")
lnHasAutomatedShippingSettings = 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