(C) 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 C/C++ Library Downloads
MS Visual C/C++ Linux/CentOS C/C++ Alpine Linux C/C++ MAC OS X C/C++	armhf/aarch64 C/C++ C++ Builder iOS C/C++ Android C/C++	Solaris C/C++ MinGW C/C++

#include <C_CkAuthAws.h>
#include <C_CkJsonObject.h>
#include <C_CkRest.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    const char *orderId;
    HCkAuthAws authAws;
    HCkJsonObject jsonLwaToken;
    BOOL success;
    HCkRest rest;
    const char *lwa_token;
    HCkStringBuilder sbPath;
    HCkJsonObject jsonRc;
    HCkStringBuilder sbRequest;
    HCkStringBuilder sbResponse;
    const char *uri;
    int statusCode;
    HCkJsonObject jsonResp;
    const char *restrictedDataToken;
    HCkJsonObject json;
    const char *strVal;
    const char *AmazonOrderId;
    const char *PurchaseDate;
    const char *LastUpdateDate;
    const char *OrderStatus;
    const char *FulfillmentChannel;
    const char *SalesChannel;
    const char *ShipServiceLevel;
    const char *CurrencyCode;
    const char *Amount;
    int NumberOfItemsShipped;
    int NumberOfItemsUnshipped;
    const char *PaymentMethod;
    BOOL IsReplacementOrder;
    const char *MarketplaceId;
    const char *ShipmentServiceLevelCategory;
    const char *OrderType;
    const char *EarliestShipDate;
    const char *LatestShipDate;
    const char *EarliestDeliveryDate;
    const char *LatestDeliveryDate;
    BOOL IsBusinessOrder;
    BOOL IsPrime;
    BOOL IsGlobalExpressEnabled;
    BOOL IsPremiumOrder;
    BOOL IsSoldByAB;
    BOOL IsIBA;
    const char *Name;
    const char *AddressLine1;
    const char *City;
    const char *StateOrRegion;
    const char *PostalCode;
    const char *CountryCode;
    const char *Phone;
    const char *AddressType;
    const char *FulfillmentSupplySourceId;
    BOOL IsISPU;
    BOOL IsAccessPointOrder;
    BOOL HasAutomatedShippingSettings;
    const char *EasyShipShipmentStatus;
    const char *ElectronicInvoiceStatus;
    int i;
    int count_i;

    // 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
    orderId = "TEST_CASE_200";

    authAws = CkAuthAws_Create();
    CkAuthAws_putAccessKey(authAws,"AWS_ACCESS_KEY");
    CkAuthAws_putSecretKey(authAws,"AWS_SECRET_KEY");
    CkAuthAws_putServiceName(authAws,"execute-api");
    // Use the region that is correct for your needs.
    CkAuthAws_putRegion(authAws,"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
    jsonLwaToken = CkJsonObject_Create();
    success = CkJsonObject_LoadFile(jsonLwaToken,"qa_data/tokens/sp_api_lwa_token.json");
    if (success == FALSE) {
        printf("Failed to load LWA access token.\n");
        CkAuthAws_Dispose(authAws);
        CkJsonObject_Dispose(jsonLwaToken);
        return;
    }

    // Must use the non-sandbox domain for getting the RDT.
    rest = CkRest_Create();
    success = CkRest_Connect(rest,"sellingpartnerapi-eu.amazon.com",443,TRUE,TRUE);
    if (success == FALSE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkAuthAws_Dispose(authAws);
        CkJsonObject_Dispose(jsonLwaToken);
        CkRest_Dispose(rest);
        return;
    }

    success = CkRest_SetAuthAws(rest,authAws);

    // Add the x-amz-access-token request header.
    lwa_token = CkJsonObject_stringOf(jsonLwaToken,"access_token");
    CkRest_ClearAllHeaders(rest);
    CkRest_AddHeader(rest,"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"]
    //     }
    //   ]
    // }

    sbPath = CkStringBuilder_Create();
    CkStringBuilder_Append(sbPath,"/orders/v0/orders/");
    CkStringBuilder_Append(sbPath,orderId);

    jsonRc = CkJsonObject_Create();
    CkJsonObject_UpdateString(jsonRc,"restrictedResources[0].method","GET");
    CkJsonObject_UpdateString(jsonRc,"restrictedResources[0].path",CkStringBuilder_getAsString(sbPath));
    CkJsonObject_UpdateString(jsonRc,"restrictedResources[0].dataElements[0]","buyerInfo");
    CkJsonObject_UpdateString(jsonRc,"restrictedResources[0].dataElements[1]","shippingAddress");

    sbRequest = CkStringBuilder_Create();
    CkJsonObject_EmitSb(jsonRc,sbRequest);

    sbResponse = CkStringBuilder_Create();
    uri = "/tokens/2021-03-01/restrictedDataToken";
    success = CkRest_FullRequestSb(rest,"POST",uri,sbRequest,sbResponse);
    if (success == FALSE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkAuthAws_Dispose(authAws);
        CkJsonObject_Dispose(jsonLwaToken);
        CkRest_Dispose(rest);
        CkStringBuilder_Dispose(sbPath);
        CkJsonObject_Dispose(jsonRc);
        CkStringBuilder_Dispose(sbRequest);
        CkStringBuilder_Dispose(sbResponse);
        return;
    }

    // Examine the response status.
    statusCode = CkRest_getResponseStatusCode(rest);
    if (statusCode != 200) {
        printf("Response status code: %d\n",statusCode);
        printf("Response status text: %s\n",CkRest_responseStatusText(rest));
        printf("Response body: \n");
        printf("%s\n",CkStringBuilder_getAsString(sbResponse));
        printf("Failed.\n");
        CkAuthAws_Dispose(authAws);
        CkJsonObject_Dispose(jsonLwaToken);
        CkRest_Dispose(rest);
        CkStringBuilder_Dispose(sbPath);
        CkJsonObject_Dispose(jsonRc);
        CkStringBuilder_Dispose(sbRequest);
        CkStringBuilder_Dispose(sbResponse);
        return;
    }

    // Get the restricted data token.
    jsonResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jsonResp,sbResponse);
    restrictedDataToken = CkJsonObject_stringOf(jsonResp,"restrictedDataToken");
    printf("Restricted Data Token: %s\n",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.)
    CkRest_Disconnect(rest,100);

    success = CkRest_Connect(rest,"sandbox.sellingpartnerapi-eu.amazon.com",443,TRUE,TRUE);
    if (success == FALSE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkAuthAws_Dispose(authAws);
        CkJsonObject_Dispose(jsonLwaToken);
        CkRest_Dispose(rest);
        CkStringBuilder_Dispose(sbPath);
        CkJsonObject_Dispose(jsonRc);
        CkStringBuilder_Dispose(sbRequest);
        CkStringBuilder_Dispose(sbResponse);
        CkJsonObject_Dispose(jsonResp);
        return;
    }

    success = CkRest_SetAuthAws(rest,authAws);

    CkRest_ClearAllHeaders(rest);
    CkRest_AddHeader(rest,"x-amz-access-token",restrictedDataToken);

    CkRest_ClearAllQueryParams(rest);
    CkRest_AddQueryParam(rest,"MarketplaceIds","ATVPDKIKX0DER");

    CkRest_ClearAllPathParams(rest);
    CkRest_AddPathParam(rest,"{orderId}",orderId);

    uri = "/orders/v0/orders/{orderId}";
    success = CkRest_FullRequestNoBodySb(rest,"GET",uri,sbResponse);
    if (success == FALSE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkAuthAws_Dispose(authAws);
        CkJsonObject_Dispose(jsonLwaToken);
        CkRest_Dispose(rest);
        CkStringBuilder_Dispose(sbPath);
        CkJsonObject_Dispose(jsonRc);
        CkStringBuilder_Dispose(sbRequest);
        CkStringBuilder_Dispose(sbResponse);
        CkJsonObject_Dispose(jsonResp);
        return;
    }

    // Examine the response status.
    statusCode = CkRest_getResponseStatusCode(rest);
    if (statusCode != 200) {
        printf("Response status text: %s\n",CkRest_responseStatusText(rest));
        printf("Response body: \n");
        printf("%s\n",CkStringBuilder_getAsString(sbResponse));
        printf("Failed.\n");
        CkAuthAws_Dispose(authAws);
        CkJsonObject_Dispose(jsonLwaToken);
        CkRest_Dispose(rest);
        CkStringBuilder_Dispose(sbPath);
        CkJsonObject_Dispose(jsonRc);
        CkStringBuilder_Dispose(sbRequest);
        CkStringBuilder_Dispose(sbResponse);
        CkJsonObject_Dispose(jsonResp);
        return;
    }

    printf("%s\n",CkStringBuilder_getAsString(sbResponse));

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

    json = CkJsonObject_Create();

    CkJsonObject_LoadSb(json,sbResponse);

    AmazonOrderId = CkJsonObject_stringOf(json,"payload.AmazonOrderId");
    PurchaseDate = CkJsonObject_stringOf(json,"payload.PurchaseDate");
    LastUpdateDate = CkJsonObject_stringOf(json,"payload.LastUpdateDate");
    OrderStatus = CkJsonObject_stringOf(json,"payload.OrderStatus");
    FulfillmentChannel = CkJsonObject_stringOf(json,"payload.FulfillmentChannel");
    SalesChannel = CkJsonObject_stringOf(json,"payload.SalesChannel");
    ShipServiceLevel = CkJsonObject_stringOf(json,"payload.ShipServiceLevel");
    CurrencyCode = CkJsonObject_stringOf(json,"payload.OrderTotal.CurrencyCode");
    Amount = CkJsonObject_stringOf(json,"payload.OrderTotal.Amount");
    NumberOfItemsShipped = CkJsonObject_IntOf(json,"payload.NumberOfItemsShipped");
    NumberOfItemsUnshipped = CkJsonObject_IntOf(json,"payload.NumberOfItemsUnshipped");
    PaymentMethod = CkJsonObject_stringOf(json,"payload.PaymentMethod");
    IsReplacementOrder = CkJsonObject_BoolOf(json,"payload.IsReplacementOrder");
    MarketplaceId = CkJsonObject_stringOf(json,"payload.MarketplaceId");
    ShipmentServiceLevelCategory = CkJsonObject_stringOf(json,"payload.ShipmentServiceLevelCategory");
    OrderType = CkJsonObject_stringOf(json,"payload.OrderType");
    EarliestShipDate = CkJsonObject_stringOf(json,"payload.EarliestShipDate");
    LatestShipDate = CkJsonObject_stringOf(json,"payload.LatestShipDate");
    EarliestDeliveryDate = CkJsonObject_stringOf(json,"payload.EarliestDeliveryDate");
    LatestDeliveryDate = CkJsonObject_stringOf(json,"payload.LatestDeliveryDate");
    IsBusinessOrder = CkJsonObject_BoolOf(json,"payload.IsBusinessOrder");
    IsPrime = CkJsonObject_BoolOf(json,"payload.IsPrime");
    IsGlobalExpressEnabled = CkJsonObject_BoolOf(json,"payload.IsGlobalExpressEnabled");
    IsPremiumOrder = CkJsonObject_BoolOf(json,"payload.IsPremiumOrder");
    IsSoldByAB = CkJsonObject_BoolOf(json,"payload.IsSoldByAB");
    IsIBA = CkJsonObject_BoolOf(json,"payload.IsIBA");
    Name = CkJsonObject_stringOf(json,"payload.DefaultShipFromLocationAddress.Name");
    AddressLine1 = CkJsonObject_stringOf(json,"payload.DefaultShipFromLocationAddress.AddressLine1");
    City = CkJsonObject_stringOf(json,"payload.DefaultShipFromLocationAddress.City");
    StateOrRegion = CkJsonObject_stringOf(json,"payload.DefaultShipFromLocationAddress.StateOrRegion");
    PostalCode = CkJsonObject_stringOf(json,"payload.DefaultShipFromLocationAddress.PostalCode");
    CountryCode = CkJsonObject_stringOf(json,"payload.DefaultShipFromLocationAddress.CountryCode");
    Phone = CkJsonObject_stringOf(json,"payload.DefaultShipFromLocationAddress.Phone");
    AddressType = CkJsonObject_stringOf(json,"payload.DefaultShipFromLocationAddress.AddressType");
    FulfillmentSupplySourceId = CkJsonObject_stringOf(json,"payload.FulfillmentInstruction.FulfillmentSupplySourceId");
    IsISPU = CkJsonObject_BoolOf(json,"payload.IsISPU");
    IsAccessPointOrder = CkJsonObject_BoolOf(json,"payload.IsAccessPointOrder");
    HasAutomatedShippingSettings = CkJsonObject_BoolOf(json,"payload.AutomatedShippingSettings.HasAutomatedShippingSettings");
    EasyShipShipmentStatus = CkJsonObject_stringOf(json,"payload.EasyShipShipmentStatus");
    ElectronicInvoiceStatus = CkJsonObject_stringOf(json,"payload.ElectronicInvoiceStatus");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(json,"payload.PaymentMethodDetails");
    while (i < count_i) {
        CkJsonObject_putI(json,i);
        strVal = CkJsonObject_stringOf(json,"payload.PaymentMethodDetails[i]");
        i = i + 1;
    }

    printf("Success!\n");


    CkAuthAws_Dispose(authAws);
    CkJsonObject_Dispose(jsonLwaToken);
    CkRest_Dispose(rest);
    CkStringBuilder_Dispose(sbPath);
    CkJsonObject_Dispose(jsonRc);
    CkStringBuilder_Dispose(sbRequest);
    CkStringBuilder_Dispose(sbResponse);
    CkJsonObject_Dispose(jsonResp);
    CkJsonObject_Dispose(json);

    }