(Xojo Plugin) 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 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 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
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}",
//       "dataElements": ["buyerInfo", "shippingAddress"]
//     }
//   ]
// }

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

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")
success = jsonRc.UpdateString("restrictedResources[0].dataElements[1]","shippingAddress")

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

System.DebugLog(sbResponse.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

Dim json As New Chilkat.JsonObject

success = json.LoadSb(sbResponse)

Dim strVal As String

Dim AmazonOrderId As String
AmazonOrderId = json.StringOf("payload.AmazonOrderId")
Dim PurchaseDate As String
PurchaseDate = json.StringOf("payload.PurchaseDate")
Dim LastUpdateDate As String
LastUpdateDate = json.StringOf("payload.LastUpdateDate")
Dim OrderStatus As String
OrderStatus = json.StringOf("payload.OrderStatus")
Dim FulfillmentChannel As String
FulfillmentChannel = json.StringOf("payload.FulfillmentChannel")
Dim SalesChannel As String
SalesChannel = json.StringOf("payload.SalesChannel")
Dim ShipServiceLevel As String
ShipServiceLevel = json.StringOf("payload.ShipServiceLevel")
Dim CurrencyCode As String
CurrencyCode = json.StringOf("payload.OrderTotal.CurrencyCode")
Dim Amount As String
Amount = json.StringOf("payload.OrderTotal.Amount")
Dim NumberOfItemsShipped As Int32
NumberOfItemsShipped = json.IntOf("payload.NumberOfItemsShipped")
Dim NumberOfItemsUnshipped As Int32
NumberOfItemsUnshipped = json.IntOf("payload.NumberOfItemsUnshipped")
Dim PaymentMethod As String
PaymentMethod = json.StringOf("payload.PaymentMethod")
Dim IsReplacementOrder As Boolean
IsReplacementOrder = json.BoolOf("payload.IsReplacementOrder")
Dim MarketplaceId As String
MarketplaceId = json.StringOf("payload.MarketplaceId")
Dim ShipmentServiceLevelCategory As String
ShipmentServiceLevelCategory = json.StringOf("payload.ShipmentServiceLevelCategory")
Dim OrderType As String
OrderType = json.StringOf("payload.OrderType")
Dim EarliestShipDate As String
EarliestShipDate = json.StringOf("payload.EarliestShipDate")
Dim LatestShipDate As String
LatestShipDate = json.StringOf("payload.LatestShipDate")
Dim EarliestDeliveryDate As String
EarliestDeliveryDate = json.StringOf("payload.EarliestDeliveryDate")
Dim LatestDeliveryDate As String
LatestDeliveryDate = json.StringOf("payload.LatestDeliveryDate")
Dim IsBusinessOrder As Boolean
IsBusinessOrder = json.BoolOf("payload.IsBusinessOrder")
Dim IsPrime As Boolean
IsPrime = json.BoolOf("payload.IsPrime")
Dim IsGlobalExpressEnabled As Boolean
IsGlobalExpressEnabled = json.BoolOf("payload.IsGlobalExpressEnabled")
Dim IsPremiumOrder As Boolean
IsPremiumOrder = json.BoolOf("payload.IsPremiumOrder")
Dim IsSoldByAB As Boolean
IsSoldByAB = json.BoolOf("payload.IsSoldByAB")
Dim IsIBA As Boolean
IsIBA = json.BoolOf("payload.IsIBA")
Dim Name As String
Name = json.StringOf("payload.DefaultShipFromLocationAddress.Name")
Dim AddressLine1 As String
AddressLine1 = json.StringOf("payload.DefaultShipFromLocationAddress.AddressLine1")
Dim City As String
City = json.StringOf("payload.DefaultShipFromLocationAddress.City")
Dim StateOrRegion As String
StateOrRegion = json.StringOf("payload.DefaultShipFromLocationAddress.StateOrRegion")
Dim PostalCode As String
PostalCode = json.StringOf("payload.DefaultShipFromLocationAddress.PostalCode")
Dim CountryCode As String
CountryCode = json.StringOf("payload.DefaultShipFromLocationAddress.CountryCode")
Dim Phone As String
Phone = json.StringOf("payload.DefaultShipFromLocationAddress.Phone")
Dim AddressType As String
AddressType = json.StringOf("payload.DefaultShipFromLocationAddress.AddressType")
Dim FulfillmentSupplySourceId As String
FulfillmentSupplySourceId = json.StringOf("payload.FulfillmentInstruction.FulfillmentSupplySourceId")
Dim IsISPU As Boolean
IsISPU = json.BoolOf("payload.IsISPU")
Dim IsAccessPointOrder As Boolean
IsAccessPointOrder = json.BoolOf("payload.IsAccessPointOrder")
Dim HasAutomatedShippingSettings As Boolean
HasAutomatedShippingSettings = json.BoolOf("payload.AutomatedShippingSettings.HasAutomatedShippingSettings")
Dim EasyShipShipmentStatus As String
EasyShipShipmentStatus = json.StringOf("payload.EasyShipShipmentStatus")
Dim ElectronicInvoiceStatus As String
ElectronicInvoiceStatus = json.StringOf("payload.ElectronicInvoiceStatus")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = json.SizeOfArray("payload.PaymentMethodDetails")
While i < count_i
    json.I = i
    strVal = json.StringOf("payload.PaymentMethodDetails[i]")
    i = i + 1
Wend

System.DebugLog("Success!")