Visual FoxPro
Visual FoxPro
Amazon SP-API Get Order Items
See more Amazon SP-API Examples
Returns detailed order item information for the order that you specify.Chilkat Visual FoxPro Downloads
LOCAL lnSuccess
LOCAL lcOrderId
LOCAL loAuthAws
LOCAL loJsonLwaToken
LOCAL loRest
LOCAL lcLwa_token
LOCAL loSbPath
LOCAL loJsonRc
LOCAL loSbRequest
LOCAL loSbResponse
LOCAL lcUri
LOCAL lnStatusCode
LOCAL loJsonResp
LOCAL lcRestrictedDataToken
LOCAL loJson
LOCAL lcASIN
LOCAL lcOrderItemId
LOCAL lcSellerSKU
LOCAL lcTitle
LOCAL lnQuantityOrdered
LOCAL lnQuantityShipped
LOCAL lnNumberOfItems
LOCAL lcCurrencyCode
LOCAL lcAmount
LOCAL lcItemTaxCurrencyCode
LOCAL lcItemTaxAmount
LOCAL lcPromotionDiscountCurrencyCode
LOCAL lcPromotionDiscountAmount
LOCAL lnIsGift
LOCAL lcConditionId
LOCAL lcConditionSubtypeId
LOCAL lnIsTransparency
LOCAL lnSerialNumberRequired
LOCAL lcIossNumber
LOCAL lcDeemedResellerCategory
LOCAL lcStoreChainStoreId
LOCAL lnIsBuyerRequestedCancel
LOCAL lcBuyerCancelReason
LOCAL lcAmazonOrderId
LOCAL i
LOCAL lnCount_i
lnSuccess = 0
* This example requires the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* Gets detailed order item information for a specified 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('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
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.
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}/orderItems",
* "dataElements": ["buyerInfo"]
* }
* ]
* }
loSbPath = CreateObject('Chilkat.StringBuilder')
loSbPath.Append("/orders/v0/orders/")
loSbPath.Append(lcOrderId)
loSbPath.Append("/orderItems")
loJsonRc = CreateObject('Chilkat.JsonObject')
loJsonRc.UpdateString("restrictedResources[0].method","GET")
loJsonRc.UpdateString("restrictedResources[0].path",loSbPath.GetAsString())
loJsonRc.UpdateString("restrictedResources[0].dataElements[0]","buyerInfo")
loSbRequest = CreateObject('Chilkat.StringBuilder')
loJsonRc.EmitSb(loSbRequest)
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.
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}/orderItems"
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
* If successful, gets a JSON response such as the following:
* {
* "payload": {
* "AmazonOrderId": "902-1845936-5435065",
* "OrderItems": [
* {
* "ASIN": "B00551Q3CS",
* "OrderItemId": "05015851154158",
* "SellerSKU": "NABetaASINB00551Q3CS",
* "Title": "B00551Q3CS [Card Book]",
* "QuantityOrdered": 1,
* "QuantityShipped": 0,
* "ProductInfo": {
* "NumberOfItems": 1
* },
* "ItemPrice": {
* "CurrencyCode": "USD",
* "Amount": "10.00"
* },
* "ItemTax": {
* "CurrencyCode": "USD",
* "Amount": "1.01"
* },
* "PromotionDiscount": {
* "CurrencyCode": "USD",
* "Amount": "0.00"
* },
* "IsGift": false,
* "ConditionId": "New",
* "ConditionSubtypeId": "New",
* "IsTransparency": false,
* "SerialNumberRequired": false,
* "IossNumber": "",
* "DeemedResellerCategory": "IOSS",
* "StoreChainStoreId": "ISPU_StoreId",
* "BuyerRequestedCancel": {
* "IsBuyerRequestedCancel": true,
* "BuyerCancelReason": "Found cheaper somewhere else."
* }
* }
* ]
* }
* }
* Use this online tool to generate parsing code from sample JSON:
* Generate Parsing Code from JSON
loJson = CreateObject('Chilkat.JsonObject')
loJson.LoadSb(loSbResponse)
loJson.EmitCompact = 0
? loJson.Emit()
lcAmazonOrderId = loJson.StringOf("payload.AmazonOrderId")
i = 0
lnCount_i = loJson.SizeOfArray("payload.OrderItems")
DO WHILE i < lnCount_i
loJson.I = i
lcASIN = loJson.StringOf("payload.OrderItems[i].ASIN")
lcOrderItemId = loJson.StringOf("payload.OrderItems[i].OrderItemId")
lcSellerSKU = loJson.StringOf("payload.OrderItems[i].SellerSKU")
lcTitle = loJson.StringOf("payload.OrderItems[i].Title")
lnQuantityOrdered = loJson.IntOf("payload.OrderItems[i].QuantityOrdered")
lnQuantityShipped = loJson.IntOf("payload.OrderItems[i].QuantityShipped")
lnNumberOfItems = loJson.IntOf("payload.OrderItems[i].ProductInfo.NumberOfItems")
lcCurrencyCode = loJson.StringOf("payload.OrderItems[i].ItemPrice.CurrencyCode")
lcAmount = loJson.StringOf("payload.OrderItems[i].ItemPrice.Amount")
lcItemTaxCurrencyCode = loJson.StringOf("payload.OrderItems[i].ItemTax.CurrencyCode")
lcItemTaxAmount = loJson.StringOf("payload.OrderItems[i].ItemTax.Amount")
lcPromotionDiscountCurrencyCode = loJson.StringOf("payload.OrderItems[i].PromotionDiscount.CurrencyCode")
lcPromotionDiscountAmount = loJson.StringOf("payload.OrderItems[i].PromotionDiscount.Amount")
lnIsGift = loJson.BoolOf("payload.OrderItems[i].IsGift")
lcConditionId = loJson.StringOf("payload.OrderItems[i].ConditionId")
lcConditionSubtypeId = loJson.StringOf("payload.OrderItems[i].ConditionSubtypeId")
lnIsTransparency = loJson.BoolOf("payload.OrderItems[i].IsTransparency")
lnSerialNumberRequired = loJson.BoolOf("payload.OrderItems[i].SerialNumberRequired")
lcIossNumber = loJson.StringOf("payload.OrderItems[i].IossNumber")
lcDeemedResellerCategory = loJson.StringOf("payload.OrderItems[i].DeemedResellerCategory")
lcStoreChainStoreId = loJson.StringOf("payload.OrderItems[i].StoreChainStoreId")
lnIsBuyerRequestedCancel = loJson.BoolOf("payload.OrderItems[i].BuyerRequestedCancel.IsBuyerRequestedCancel")
lcBuyerCancelReason = loJson.StringOf("payload.OrderItems[i].BuyerRequestedCancel.BuyerCancelReason")
i = i + 1
ENDDO
? "Success!"
RELEASE loAuthAws
RELEASE loJsonLwaToken
RELEASE loRest
RELEASE loSbPath
RELEASE loJsonRc
RELEASE loSbRequest
RELEASE loSbResponse
RELEASE loJsonResp
RELEASE loJson