B4X
B4X
Amazon SP-API Get Specific Order
See more Amazon SP-API Examples
Get a specific Amazon Seller order.Chilkat B4X Downloads
Dim success As Boolean = False
' 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 = "TEST_CASE_200"
Dim authAws As ChilkatAuthAws
authAws.Initialize
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 ChilkatJsonObject
jsonLwaToken.Initialize
success = jsonLwaToken.LoadFile("qa_data/tokens/sp_api_lwa_token.json")
If success = False Then
Log("Failed to load LWA access token.")
Return
End If
' Must use the non-sandbox domain for getting the RDT.
Dim rest As ChilkatRest
rest.Initialize("rest")
success = rest.Connect("sellingpartnerapi-eu.amazon.com", 443, True, True)
If success = False Then
Log(rest.LastErrorText)
Return
End If
success = rest.SetAuthAws(authAws)
' Add the x-amz-access-token request header.
Dim lwa_token As String = jsonLwaToken.StringOf("access_token")
rest.ClearAllHeaders
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 ChilkatStringBuilder
sbPath.Initialize
sbPath.Append("/orders/v0/orders/")
sbPath.Append(orderId)
Dim jsonRc As ChilkatJsonObject
jsonRc.Initialize
jsonRc.UpdateString("restrictedResources[0].method", "GET")
jsonRc.UpdateString("restrictedResources[0].path", sbPath.GetAsString)
jsonRc.UpdateString("restrictedResources[0].dataElements[0]", "buyerInfo")
jsonRc.UpdateString("restrictedResources[0].dataElements[1]", "shippingAddress")
Dim sbRequest As ChilkatStringBuilder
sbRequest.Initialize
jsonRc.EmitSb(sbRequest)
Dim sbResponse As ChilkatStringBuilder
sbResponse.Initialize
Dim uri As String = "/tokens/2021-03-01/restrictedDataToken"
success = rest.FullRequestSb("POST", uri, sbRequest, sbResponse)
If success = False Then
Log(rest.LastErrorText)
Return
End If
' Examine the response status.
Dim statusCode As Int = rest.ResponseStatusCode
If statusCode <> 200 Then
Log("Response status code: " & statusCode)
Log("Response status text: " & rest.ResponseStatusText)
Log("Response body: ")
Log(sbResponse.GetAsString)
Log("Failed.")
Return
End If
' Get the restricted data token.
Dim jsonResp As ChilkatJsonObject
jsonResp.Initialize
jsonResp.LoadSb(sbResponse)
Dim restrictedDataToken As String = jsonResp.StringOf("restrictedDataToken")
Log("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.)
rest.Disconnect(100)
success = rest.Connect("sandbox.sellingpartnerapi-eu.amazon.com", 443, True, True)
If success = False Then
Log(rest.LastErrorText)
Return
End If
success = rest.SetAuthAws(authAws)
rest.ClearAllHeaders
rest.AddHeader("x-amz-access-token", restrictedDataToken)
rest.ClearAllQueryParams
rest.AddQueryParam("MarketplaceIds", "ATVPDKIKX0DER")
rest.ClearAllPathParams
rest.AddPathParam("{orderId}", orderId)
uri = "/orders/v0/orders/{orderId}"
success = rest.FullRequestNoBodySb("GET", uri, sbResponse)
If success = False Then
Log(rest.LastErrorText)
Return
End If
' Examine the response status.
statusCode = rest.ResponseStatusCode
If statusCode <> 200 Then
Log("Response status text: " & rest.ResponseStatusText)
Log("Response body: ")
Log(sbResponse.GetAsString)
Log("Failed.")
Return
End If
Log(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 ChilkatJsonObject
json.Initialize
json.LoadSb(sbResponse)
Dim strVal As String
Dim AmazonOrderId As String = json.StringOf("payload.AmazonOrderId")
Dim PurchaseDate As String = json.StringOf("payload.PurchaseDate")
Dim LastUpdateDate As String = json.StringOf("payload.LastUpdateDate")
Dim OrderStatus As String = json.StringOf("payload.OrderStatus")
Dim FulfillmentChannel As String = json.StringOf("payload.FulfillmentChannel")
Dim SalesChannel As String = json.StringOf("payload.SalesChannel")
Dim ShipServiceLevel As String = json.StringOf("payload.ShipServiceLevel")
Dim CurrencyCode As String = json.StringOf("payload.OrderTotal.CurrencyCode")
Dim Amount As String = json.StringOf("payload.OrderTotal.Amount")
Dim NumberOfItemsShipped As Int = json.IntOf("payload.NumberOfItemsShipped")
Dim NumberOfItemsUnshipped As Int = json.IntOf("payload.NumberOfItemsUnshipped")
Dim PaymentMethod As String = json.StringOf("payload.PaymentMethod")
Dim IsReplacementOrder As Boolean = json.BoolOf("payload.IsReplacementOrder")
Dim MarketplaceId As String = json.StringOf("payload.MarketplaceId")
Dim ShipmentServiceLevelCategory As String = json.StringOf("payload.ShipmentServiceLevelCategory")
Dim OrderType As String = json.StringOf("payload.OrderType")
Dim EarliestShipDate As String = json.StringOf("payload.EarliestShipDate")
Dim LatestShipDate As String = json.StringOf("payload.LatestShipDate")
Dim EarliestDeliveryDate As String = json.StringOf("payload.EarliestDeliveryDate")
Dim LatestDeliveryDate As String = json.StringOf("payload.LatestDeliveryDate")
Dim IsBusinessOrder As Boolean = json.BoolOf("payload.IsBusinessOrder")
Dim IsPrime As Boolean = json.BoolOf("payload.IsPrime")
Dim IsGlobalExpressEnabled As Boolean = json.BoolOf("payload.IsGlobalExpressEnabled")
Dim IsPremiumOrder As Boolean = json.BoolOf("payload.IsPremiumOrder")
Dim IsSoldByAB As Boolean = json.BoolOf("payload.IsSoldByAB")
Dim IsIBA As Boolean = json.BoolOf("payload.IsIBA")
Dim Name As String = json.StringOf("payload.DefaultShipFromLocationAddress.Name")
Dim AddressLine1 As String = json.StringOf("payload.DefaultShipFromLocationAddress.AddressLine1")
Dim City As String = json.StringOf("payload.DefaultShipFromLocationAddress.City")
Dim StateOrRegion As String = json.StringOf("payload.DefaultShipFromLocationAddress.StateOrRegion")
Dim PostalCode As String = json.StringOf("payload.DefaultShipFromLocationAddress.PostalCode")
Dim CountryCode As String = json.StringOf("payload.DefaultShipFromLocationAddress.CountryCode")
Dim Phone As String = json.StringOf("payload.DefaultShipFromLocationAddress.Phone")
Dim AddressType As String = json.StringOf("payload.DefaultShipFromLocationAddress.AddressType")
Dim FulfillmentSupplySourceId As String = json.StringOf("payload.FulfillmentInstruction.FulfillmentSupplySourceId")
Dim IsISPU As Boolean = json.BoolOf("payload.IsISPU")
Dim IsAccessPointOrder As Boolean = json.BoolOf("payload.IsAccessPointOrder")
Dim HasAutomatedShippingSettings As Boolean = json.BoolOf("payload.AutomatedShippingSettings.HasAutomatedShippingSettings")
Dim EasyShipShipmentStatus As String = json.StringOf("payload.EasyShipShipmentStatus")
Dim ElectronicInvoiceStatus As String = json.StringOf("payload.ElectronicInvoiceStatus")
Dim i As Int = 0
Dim count_i As Int = json.SizeOfArray("payload.PaymentMethodDetails")
Do While i < count_i
json.I = i
strVal = json.StringOf("payload.PaymentMethodDetails[i]")
i = i + 1
Loop
Log("Success!")