(Lianja) Amazon SP-API Get Order Items

See more Amazon SP-API Examples

Returns detailed order item information for the order that you specify.

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

Chilkat Lianja Extension Download Chilkat Lianja Extension

// 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("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}/orderItems",
//       "dataElements": ["buyerInfo"]
//     }
//   ]
// }

loSbPath = createobject("CkStringBuilder")
loSbPath.Append("/orders/v0/orders/")
loSbPath.Append(lcOrderId)
loSbPath.Append("/orderItems")

loJsonRc = createobject("CkJsonObject")
loJsonRc.UpdateString("restrictedResources[0].method","GET")
loJsonRc.UpdateString("restrictedResources[0].path",loSbPath.GetAsString())
loJsonRc.UpdateString("restrictedResources[0].dataElements[0]","buyerInfo")

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}/orderItems"
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

// 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("CkJsonObject")

loJson.LoadSb(loSbResponse)
loJson.EmitCompact = .F.
? 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")
    llIsGift = loJson.BoolOf("payload.OrderItems[i].IsGift")
    lcConditionId = loJson.StringOf("payload.OrderItems[i].ConditionId")
    lcConditionSubtypeId = loJson.StringOf("payload.OrderItems[i].ConditionSubtypeId")
    llIsTransparency = loJson.BoolOf("payload.OrderItems[i].IsTransparency")
    llSerialNumberRequired = 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")
    llIsBuyerRequestedCancel = 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