Sample code for 30+ languages & platforms
Xbase++

Amazon SP-API Get Orders

See more Amazon SP-API Examples

Demonstrates Amazon SP-API Sellers API -- get orders. Returns orders created or updated during the time frame indicated by the specified parameters.

Chilkat Xbase++ Downloads

Xbase++
LOCAL nSuccess
LOCAL oAuthAws
LOCAL oRest
LOCAL nBTls
LOCAL nPort
LOCAL nBAutoReconnect
LOCAL oJsonToken
LOCAL cRdt_token
LOCAL oSbResponse
LOCAL cUri
LOCAL nStatusCode
LOCAL oJson
LOCAL cAmazonOrderId
LOCAL cPurchaseDate
LOCAL cLastUpdateDate
LOCAL cOrderStatus
LOCAL cFulfillmentChannel
LOCAL cSalesChannel
LOCAL cShipServiceLevel
LOCAL cCurrencyCode
LOCAL cAmount
LOCAL nNumberOfItemsShipped
LOCAL nNumberOfItemsUnshipped
LOCAL cPaymentMethod
LOCAL nIsReplacementOrder
LOCAL cMarketplaceId
LOCAL cShipmentServiceLevelCategory
LOCAL cOrderType
LOCAL cEarliestShipDate
LOCAL cLatestShipDate
LOCAL cEarliestDeliveryDate
LOCAL cLatestDeliveryDate
LOCAL nIsBusinessOrder
LOCAL nIsPrime
LOCAL nIsGlobalExpressEnabled
LOCAL nIsPremiumOrder
LOCAL nIsSoldByAB
LOCAL nIsIBA
LOCAL cName
LOCAL cAddressLine1
LOCAL cCity
LOCAL cStateOrRegion
LOCAL cPostalCode
LOCAL cCountryCode
LOCAL cPhone
LOCAL cAddressType
LOCAL cFulfillmentSupplySourceId
LOCAL nIsISPU
LOCAL nIsAccessPointOrder
LOCAL nHasAutomatedShippingSettings
LOCAL cEasyShipShipmentStatus
LOCAL cElectronicInvoiceStatus
LOCAL j
LOCAL nCount_j
LOCAL cStrVal
LOCAL cCreatedBefore
LOCAL i
LOCAL nCount_i

nSuccess := 0

//  This example requires the Chilkat API to have been previously unlocked.
//  See Global Unlock Sample for sample code.

//  IMPORTANT:
//  You'll need to make changes to use values specific to your own region and account.
//  
//  Here is a list of values you'll need to change or provide:
//  
//  1) The access key. Change AWS_ACCESS_KEY to your actual access key.
//  2) The secret key. Change AWS_SECRET_KEY to your actual access key.
//  3) Your region.  Change "ew-west-1" to your region.
//  4) The domain to which you connect.  Change sandbox.sellingpartnerapi-eu.amazon.com to non-sandbox by removing the "sandbox." 
//     and change the "-eu" part of the domain to your region. See https://developer-docs.amazon.com/sp-api/docs/sp-api-endpoints
//  5) Use the restricted data token (RDT) obtained from your code that previously obtained the RDT.
//  	If you saved the RDT to a file, update the relative file path "qa_data/tokens/sp_api_rdt_token.json" to your actual file path.
//  6) Update your Marketplace ID(s), such as ATVPDKIKX0DER
//  7) If using the non-sandbox, change the CreatedAfter from "TEST_CASE_200" to an actual date, such as "2022-12-25"

oAuthAws := CreateObject("Chilkat.AuthAws")
oAuthAws:AccessKey := "AWS_ACCESS_KEY"
oAuthAws:SecretKey := "AWS_SECRET_KEY"
oAuthAws:ServiceName := "execute-api"
//  Use the region that is correct for your needs.
oAuthAws:Region := "eu-west-1"

oRest := CreateObject("Chilkat.Rest")
nBTls := 1
nPort := 443
nBAutoReconnect := 1
//  Make sure to use the correct domain.
//  This example is using the sandbox
nSuccess := oRest:Connect("sandbox.sellingpartnerapi-eu.amazon.com", nPort, nBTls, nBAutoReconnect)
IF (nSuccess == 0)
    ? oRest:LastErrorText
    oAuthAws:destroy()
    oRest:destroy()
    RETURN
ENDIF

nSuccess := oRest:SetAuthAws(oAuthAws)

//  Here's the example to get the RDT access token: Get SP-API Restricted Data Token

//  Load the previously obtained RDT access token.
//  See Fetch SP-API RDT Access Token
oJsonToken := CreateObject("Chilkat.JsonObject")
nSuccess := oJsonToken:LoadFile("qa_data/tokens/sp_api_rdt_token.json")
IF (nSuccess == 0)
    ? "Failed to load RDT access token."
    oAuthAws:destroy()
    oRest:destroy()
    oJsonToken:destroy()
    RETURN
ENDIF

//  Add the x-amz-access-token request header.
cRdt_token := oJsonToken:StringOf("restrictedDataToken")
oRest:ClearAllHeaders()
oRest:AddHeader("x-amz-access-token", cRdt_token)

//  Indicate the marketplace IDs.  Use the marketplace ID for your needs. See https://developer-docs.amazon.com/sp-api/docs/marketplace-ids
oRest:ClearAllQueryParams()
//  When using the sandbox, use these params literally and exactly has shown here:
oRest:AddQueryParam("MarketplaceIds", "ATVPDKIKX0DER")
oRest:AddQueryParam("CreatedAfter", "TEST_CASE_200")

oSbResponse := CreateObject("Chilkat.StringBuilder")
cUri := "/orders/v0/orders"
nSuccess := oRest:FullRequestNoBodySb("GET", cUri, oSbResponse)
IF (nSuccess == 0)
    ? oRest:LastErrorText
    oAuthAws:destroy()
    oRest:destroy()
    oJsonToken:destroy()
    oSbResponse:destroy()
    RETURN
ENDIF

//  Examine the response status.
nStatusCode := oRest:ResponseStatusCode
IF (nStatusCode != 200)
    ? "Response status text: " + oRest:ResponseStatusText
    ? "Response body: "
    ? oSbResponse:GetAsString()
    ? "Failed."
    oAuthAws:destroy()
    oRest:destroy()
    oJsonToken:destroy()
    oSbResponse:destroy()
    RETURN
ENDIF

? oSbResponse:GetAsString()

//  If successful, gets a JSON response such as the following:

//  {
//    "payload": {
//      "CreatedBefore": "1.569521782042E9",
//      "Orders": [
//        {
//          "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"
//        },
//        {
//          "AmazonOrderId": "902-8745147-1934268",
//          "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,
//          "IsAccessPointOrder": false,
//          "IsGlobalExpressEnabled": false,
//          "IsPremiumOrder": false,
//          "IsSoldByAB": false,
//          "IsIBA": false,
//          "EasyShipShipmentStatus": "PendingPickUp",
//          "ElectronicInvoiceStatus": "NotRequired"
//        }
//      ]
//    }
//  }

//  Use this online tool to generate parsing code from sample JSON: 
//  Generate Parsing Code from JSON

oJson := CreateObject("Chilkat.JsonObject")

oJson:LoadSb(oSbResponse)

cCreatedBefore := oJson:StringOf("payload.CreatedBefore")
i := 0
nCount_i := oJson:SizeOfArray("payload.Orders")
DO WHILE i < nCount_i
    oJson:I := i
    cAmazonOrderId := oJson:StringOf("payload.Orders[i].AmazonOrderId")
    cPurchaseDate := oJson:StringOf("payload.Orders[i].PurchaseDate")
    cLastUpdateDate := oJson:StringOf("payload.Orders[i].LastUpdateDate")
    cOrderStatus := oJson:StringOf("payload.Orders[i].OrderStatus")
    cFulfillmentChannel := oJson:StringOf("payload.Orders[i].FulfillmentChannel")
    cSalesChannel := oJson:StringOf("payload.Orders[i].SalesChannel")
    cShipServiceLevel := oJson:StringOf("payload.Orders[i].ShipServiceLevel")
    cCurrencyCode := oJson:StringOf("payload.Orders[i].OrderTotal.CurrencyCode")
    cAmount := oJson:StringOf("payload.Orders[i].OrderTotal.Amount")
    nNumberOfItemsShipped := oJson:IntOf("payload.Orders[i].NumberOfItemsShipped")
    nNumberOfItemsUnshipped := oJson:IntOf("payload.Orders[i].NumberOfItemsUnshipped")
    cPaymentMethod := oJson:StringOf("payload.Orders[i].PaymentMethod")
    nIsReplacementOrder := oJson:BoolOf("payload.Orders[i].IsReplacementOrder")
    cMarketplaceId := oJson:StringOf("payload.Orders[i].MarketplaceId")
    cShipmentServiceLevelCategory := oJson:StringOf("payload.Orders[i].ShipmentServiceLevelCategory")
    cOrderType := oJson:StringOf("payload.Orders[i].OrderType")
    cEarliestShipDate := oJson:StringOf("payload.Orders[i].EarliestShipDate")
    cLatestShipDate := oJson:StringOf("payload.Orders[i].LatestShipDate")
    cEarliestDeliveryDate := oJson:StringOf("payload.Orders[i].EarliestDeliveryDate")
    cLatestDeliveryDate := oJson:StringOf("payload.Orders[i].LatestDeliveryDate")
    nIsBusinessOrder := oJson:BoolOf("payload.Orders[i].IsBusinessOrder")
    nIsPrime := oJson:BoolOf("payload.Orders[i].IsPrime")
    nIsGlobalExpressEnabled := oJson:BoolOf("payload.Orders[i].IsGlobalExpressEnabled")
    nIsPremiumOrder := oJson:BoolOf("payload.Orders[i].IsPremiumOrder")
    nIsSoldByAB := oJson:BoolOf("payload.Orders[i].IsSoldByAB")
    nIsIBA := oJson:BoolOf("payload.Orders[i].IsIBA")
    cName := oJson:StringOf("payload.Orders[i].DefaultShipFromLocationAddress.Name")
    cAddressLine1 := oJson:StringOf("payload.Orders[i].DefaultShipFromLocationAddress.AddressLine1")
    cCity := oJson:StringOf("payload.Orders[i].DefaultShipFromLocationAddress.City")
    cStateOrRegion := oJson:StringOf("payload.Orders[i].DefaultShipFromLocationAddress.StateOrRegion")
    cPostalCode := oJson:StringOf("payload.Orders[i].DefaultShipFromLocationAddress.PostalCode")
    cCountryCode := oJson:StringOf("payload.Orders[i].DefaultShipFromLocationAddress.CountryCode")
    cPhone := oJson:StringOf("payload.Orders[i].DefaultShipFromLocationAddress.Phone")
    cAddressType := oJson:StringOf("payload.Orders[i].DefaultShipFromLocationAddress.AddressType")
    cFulfillmentSupplySourceId := oJson:StringOf("payload.Orders[i].FulfillmentInstruction.FulfillmentSupplySourceId")
    nIsISPU := oJson:BoolOf("payload.Orders[i].IsISPU")
    nIsAccessPointOrder := oJson:BoolOf("payload.Orders[i].IsAccessPointOrder")
    nHasAutomatedShippingSettings := oJson:BoolOf("payload.Orders[i].AutomatedShippingSettings.HasAutomatedShippingSettings")
    cEasyShipShipmentStatus := oJson:StringOf("payload.Orders[i].EasyShipShipmentStatus")
    cElectronicInvoiceStatus := oJson:StringOf("payload.Orders[i].ElectronicInvoiceStatus")
    j := 0
    nCount_j := oJson:SizeOfArray("payload.Orders[i].PaymentMethodDetails")
    DO WHILE j < nCount_j
        oJson:J := j
        cStrVal := oJson:StringOf("payload.Orders[i].PaymentMethodDetails[j]")
        j := j + 1
    ENDDO
    i := i + 1
ENDDO

? "Success!"

oAuthAws:destroy()
oRest:destroy()
oJsonToken:destroy()
oSbResponse:destroy()
oJson:destroy()