(Xojo Plugin) 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 Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// 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
Dim orderId As String
orderId = "TEST_CASE_200"

Dim authAws As New Chilkat.AuthAws
authAws.AccessKey = "AWS_ACCESS_KEY"
authAws.SecretKey = "AWS_SECRET_KEY"
authAws.ServiceName = "execute-api"
// Use the region that is correct for your needs.
authAws.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
Dim jsonLwaToken As New Chilkat.JsonObject
Dim success As Boolean
success = jsonLwaToken.LoadFile("qa_data/tokens/sp_api_lwa_token.json")
If (success = False) Then
    System.DebugLog("Failed to load LWA access token.")
    Return
End If

// Must use the non-sandbox domain for getting the RDT.
Dim rest As New Chilkat.Rest
success = rest.Connect("sellingpartnerapi-eu.amazon.com",443,True,True)
If (success = False) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

success = rest.SetAuthAws(authAws)

// Add the x-amz-access-token request header.
Dim lwa_token As String
lwa_token = jsonLwaToken.StringOf("access_token")
success = rest.ClearAllHeaders()
success = rest.AddHeader("x-amz-access-token",lwa_token)

// We're going to send a POST with the following JSON body:

// {
//   "restrictedResources": [
//     {
//       "method": "GET",
//       "path": "/orders/v0/orders/{orderId}/orderItems",
//       "dataElements": ["buyerInfo"]
//     }
//   ]
// }

Dim sbPath As New Chilkat.StringBuilder
success = sbPath.Append("/orders/v0/orders/")
success = sbPath.Append(orderId)
success = sbPath.Append("/orderItems")

Dim jsonRc As New Chilkat.JsonObject
success = jsonRc.UpdateString("restrictedResources[0].method","GET")
success = jsonRc.UpdateString("restrictedResources[0].path",sbPath.GetAsString())
success = jsonRc.UpdateString("restrictedResources[0].dataElements[0]","buyerInfo")

Dim sbRequest As New Chilkat.StringBuilder
success = jsonRc.EmitSb(sbRequest)

Dim sbResponse As New Chilkat.StringBuilder
Dim uri As String
uri = "/tokens/2021-03-01/restrictedDataToken"
success = rest.FullRequestSb("POST",uri,sbRequest,sbResponse)
If (success = False) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// Examine the response status.
Dim statusCode As Int32
statusCode = rest.ResponseStatusCode
If (statusCode <> 200) Then
    System.DebugLog("Response status code: " + Str(statusCode))
    System.DebugLog("Response status text: " + rest.ResponseStatusText)
    System.DebugLog("Response body: ")
    System.DebugLog(sbResponse.GetAsString())
    System.DebugLog("Failed.")
    Return
End If

// Get the restricted data token.
Dim jsonResp As New Chilkat.JsonObject
success = jsonResp.LoadSb(sbResponse)
Dim restrictedDataToken As String
restrictedDataToken = jsonResp.StringOf("restrictedDataToken")
System.DebugLog("Restricted Data Token: " + restrictedDataToken)

// ------------------------------------------------------------------------------------------------------------
// ------------------------------------------------------------------------------------------------------------
// 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.)
success = rest.Disconnect(100)

success = rest.Connect("sandbox.sellingpartnerapi-eu.amazon.com",443,True,True)
If (success = False) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

success = rest.SetAuthAws(authAws)

success = rest.ClearAllHeaders()
success = rest.AddHeader("x-amz-access-token",restrictedDataToken)

success = rest.ClearAllQueryParams()
success = rest.AddQueryParam("MarketplaceIds","ATVPDKIKX0DER")

success = rest.ClearAllPathParams()
success = rest.AddPathParam("{orderId}",orderId)

uri = "/orders/v0/orders/{orderId}/orderItems"
success = rest.FullRequestNoBodySb("GET",uri,sbResponse)
If (success = False) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// Examine the response status.
statusCode = rest.ResponseStatusCode
If (statusCode <> 200) Then
    System.DebugLog("Response status text: " + rest.ResponseStatusText)
    System.DebugLog("Response body: ")
    System.DebugLog(sbResponse.GetAsString())
    System.DebugLog("Failed.")
    Return
End If

// 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

Dim json As New Chilkat.JsonObject

success = json.LoadSb(sbResponse)
json.EmitCompact = False
System.DebugLog(json.Emit())

Dim ASIN As String
Dim OrderItemId As String
Dim SellerSKU As String
Dim Title As String
Dim QuantityOrdered As Int32
Dim QuantityShipped As Int32
Dim NumberOfItems As Int32
Dim CurrencyCode As String
Dim Amount As String
Dim ItemTaxCurrencyCode As String
Dim ItemTaxAmount As String
Dim PromotionDiscountCurrencyCode As String
Dim PromotionDiscountAmount As String
Dim IsGift As Boolean
Dim ConditionId As String
Dim ConditionSubtypeId As String
Dim IsTransparency As Boolean
Dim SerialNumberRequired As Boolean
Dim IossNumber As String
Dim DeemedResellerCategory As String
Dim StoreChainStoreId As String
Dim IsBuyerRequestedCancel As Boolean
Dim BuyerCancelReason As String

Dim AmazonOrderId As String
AmazonOrderId = json.StringOf("payload.AmazonOrderId")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = json.SizeOfArray("payload.OrderItems")
While i < count_i
    json.I = i
    ASIN = json.StringOf("payload.OrderItems[i].ASIN")
    OrderItemId = json.StringOf("payload.OrderItems[i].OrderItemId")
    SellerSKU = json.StringOf("payload.OrderItems[i].SellerSKU")
    Title = json.StringOf("payload.OrderItems[i].Title")
    QuantityOrdered = json.IntOf("payload.OrderItems[i].QuantityOrdered")
    QuantityShipped = json.IntOf("payload.OrderItems[i].QuantityShipped")
    NumberOfItems = json.IntOf("payload.OrderItems[i].ProductInfo.NumberOfItems")
    CurrencyCode = json.StringOf("payload.OrderItems[i].ItemPrice.CurrencyCode")
    Amount = json.StringOf("payload.OrderItems[i].ItemPrice.Amount")
    ItemTaxCurrencyCode = json.StringOf("payload.OrderItems[i].ItemTax.CurrencyCode")
    ItemTaxAmount = json.StringOf("payload.OrderItems[i].ItemTax.Amount")
    PromotionDiscountCurrencyCode = json.StringOf("payload.OrderItems[i].PromotionDiscount.CurrencyCode")
    PromotionDiscountAmount = json.StringOf("payload.OrderItems[i].PromotionDiscount.Amount")
    IsGift = json.BoolOf("payload.OrderItems[i].IsGift")
    ConditionId = json.StringOf("payload.OrderItems[i].ConditionId")
    ConditionSubtypeId = json.StringOf("payload.OrderItems[i].ConditionSubtypeId")
    IsTransparency = json.BoolOf("payload.OrderItems[i].IsTransparency")
    SerialNumberRequired = json.BoolOf("payload.OrderItems[i].SerialNumberRequired")
    IossNumber = json.StringOf("payload.OrderItems[i].IossNumber")
    DeemedResellerCategory = json.StringOf("payload.OrderItems[i].DeemedResellerCategory")
    StoreChainStoreId = json.StringOf("payload.OrderItems[i].StoreChainStoreId")
    IsBuyerRequestedCancel = json.BoolOf("payload.OrderItems[i].BuyerRequestedCancel.IsBuyerRequestedCancel")
    BuyerCancelReason = json.StringOf("payload.OrderItems[i].BuyerRequestedCancel.BuyerCancelReason")
    i = i + 1
Wend

System.DebugLog("Success!")