(Delphi DLL) 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 for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, AuthAws, Rest, JsonObject, StringBuilder;

...

procedure TForm1.Button1Click(Sender: TObject);
var
orderId: PWideChar;
authAws: HCkAuthAws;
jsonLwaToken: HCkJsonObject;
success: Boolean;
rest: HCkRest;
lwa_token: PWideChar;
sbPath: HCkStringBuilder;
jsonRc: HCkJsonObject;
sbRequest: HCkStringBuilder;
sbResponse: HCkStringBuilder;
uri: PWideChar;
statusCode: Integer;
jsonResp: HCkJsonObject;
restrictedDataToken: PWideChar;
json: HCkJsonObject;
ASIN: PWideChar;
OrderItemId: PWideChar;
SellerSKU: PWideChar;
Title: PWideChar;
QuantityOrdered: Integer;
QuantityShipped: Integer;
NumberOfItems: Integer;
CurrencyCode: PWideChar;
Amount: PWideChar;
ItemTaxCurrencyCode: PWideChar;
ItemTaxAmount: PWideChar;
PromotionDiscountCurrencyCode: PWideChar;
PromotionDiscountAmount: PWideChar;
IsGift: Boolean;
ConditionId: PWideChar;
ConditionSubtypeId: PWideChar;
IsTransparency: Boolean;
SerialNumberRequired: Boolean;
IossNumber: PWideChar;
DeemedResellerCategory: PWideChar;
StoreChainStoreId: PWideChar;
IsBuyerRequestedCancel: Boolean;
BuyerCancelReason: PWideChar;
AmazonOrderId: PWideChar;
i: Integer;
count_i: Integer;

begin
// 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
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) then
  begin
    Memo1.Lines.Add('Failed to load LWA access token.');
    Exit;
  end;

// 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) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

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}/orderItems",
//       "dataElements": ["buyerInfo"]
//     }
//   ]
// }

sbPath := CkStringBuilder_Create();
CkStringBuilder_Append(sbPath,'/orders/v0/orders/');
CkStringBuilder_Append(sbPath,orderId);
CkStringBuilder_Append(sbPath,'/orderItems');

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');

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) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

// Examine the response status.
statusCode := CkRest_getResponseStatusCode(rest);
if (statusCode <> 200) then
  begin
    Memo1.Lines.Add('Response status code: ' + IntToStr(statusCode));
    Memo1.Lines.Add('Response status text: ' + CkRest__responseStatusText(rest));
    Memo1.Lines.Add('Response body: ');
    Memo1.Lines.Add(CkStringBuilder__getAsString(sbResponse));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// Get the restricted data token.
jsonResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jsonResp,sbResponse);
restrictedDataToken := CkJsonObject__stringOf(jsonResp,'restrictedDataToken');
Memo1.Lines.Add('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.)
CkRest_Disconnect(rest,100);

success := CkRest_Connect(rest,'sandbox.sellingpartnerapi-eu.amazon.com',443,True,True);
if (success = False) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

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}/orderItems';
success := CkRest_FullRequestNoBodySb(rest,'GET',uri,sbResponse);
if (success = False) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

// Examine the response status.
statusCode := CkRest_getResponseStatusCode(rest);
if (statusCode <> 200) then
  begin
    Memo1.Lines.Add('Response status text: ' + CkRest__responseStatusText(rest));
    Memo1.Lines.Add('Response body: ');
    Memo1.Lines.Add(CkStringBuilder__getAsString(sbResponse));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

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

json := CkJsonObject_Create();

CkJsonObject_LoadSb(json,sbResponse);
CkJsonObject_putEmitCompact(json,False);
Memo1.Lines.Add(CkJsonObject__emit(json));

AmazonOrderId := CkJsonObject__stringOf(json,'payload.AmazonOrderId');
i := 0;
count_i := CkJsonObject_SizeOfArray(json,'payload.OrderItems');
while i < count_i do
  begin
    CkJsonObject_putI(json,i);
    ASIN := CkJsonObject__stringOf(json,'payload.OrderItems[i].ASIN');
    OrderItemId := CkJsonObject__stringOf(json,'payload.OrderItems[i].OrderItemId');
    SellerSKU := CkJsonObject__stringOf(json,'payload.OrderItems[i].SellerSKU');
    Title := CkJsonObject__stringOf(json,'payload.OrderItems[i].Title');
    QuantityOrdered := CkJsonObject_IntOf(json,'payload.OrderItems[i].QuantityOrdered');
    QuantityShipped := CkJsonObject_IntOf(json,'payload.OrderItems[i].QuantityShipped');
    NumberOfItems := CkJsonObject_IntOf(json,'payload.OrderItems[i].ProductInfo.NumberOfItems');
    CurrencyCode := CkJsonObject__stringOf(json,'payload.OrderItems[i].ItemPrice.CurrencyCode');
    Amount := CkJsonObject__stringOf(json,'payload.OrderItems[i].ItemPrice.Amount');
    ItemTaxCurrencyCode := CkJsonObject__stringOf(json,'payload.OrderItems[i].ItemTax.CurrencyCode');
    ItemTaxAmount := CkJsonObject__stringOf(json,'payload.OrderItems[i].ItemTax.Amount');
    PromotionDiscountCurrencyCode := CkJsonObject__stringOf(json,'payload.OrderItems[i].PromotionDiscount.CurrencyCode');
    PromotionDiscountAmount := CkJsonObject__stringOf(json,'payload.OrderItems[i].PromotionDiscount.Amount');
    IsGift := CkJsonObject_BoolOf(json,'payload.OrderItems[i].IsGift');
    ConditionId := CkJsonObject__stringOf(json,'payload.OrderItems[i].ConditionId');
    ConditionSubtypeId := CkJsonObject__stringOf(json,'payload.OrderItems[i].ConditionSubtypeId');
    IsTransparency := CkJsonObject_BoolOf(json,'payload.OrderItems[i].IsTransparency');
    SerialNumberRequired := CkJsonObject_BoolOf(json,'payload.OrderItems[i].SerialNumberRequired');
    IossNumber := CkJsonObject__stringOf(json,'payload.OrderItems[i].IossNumber');
    DeemedResellerCategory := CkJsonObject__stringOf(json,'payload.OrderItems[i].DeemedResellerCategory');
    StoreChainStoreId := CkJsonObject__stringOf(json,'payload.OrderItems[i].StoreChainStoreId');
    IsBuyerRequestedCancel := CkJsonObject_BoolOf(json,'payload.OrderItems[i].BuyerRequestedCancel.IsBuyerRequestedCancel');
    BuyerCancelReason := CkJsonObject__stringOf(json,'payload.OrderItems[i].BuyerRequestedCancel.BuyerCancelReason');
    i := i + 1;
  end;

Memo1.Lines.Add('Success!');

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);

end;