(Delphi DLL) 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 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;
strVal: PWideChar;
AmazonOrderId: PWideChar;
PurchaseDate: PWideChar;
LastUpdateDate: PWideChar;
OrderStatus: PWideChar;
FulfillmentChannel: PWideChar;
SalesChannel: PWideChar;
ShipServiceLevel: PWideChar;
CurrencyCode: PWideChar;
Amount: PWideChar;
NumberOfItemsShipped: Integer;
NumberOfItemsUnshipped: Integer;
PaymentMethod: PWideChar;
IsReplacementOrder: Boolean;
MarketplaceId: PWideChar;
ShipmentServiceLevelCategory: PWideChar;
OrderType: PWideChar;
EarliestShipDate: PWideChar;
LatestShipDate: PWideChar;
EarliestDeliveryDate: PWideChar;
LatestDeliveryDate: PWideChar;
IsBusinessOrder: Boolean;
IsPrime: Boolean;
IsGlobalExpressEnabled: Boolean;
IsPremiumOrder: Boolean;
IsSoldByAB: Boolean;
IsIBA: Boolean;
Name: PWideChar;
AddressLine1: PWideChar;
City: PWideChar;
StateOrRegion: PWideChar;
PostalCode: PWideChar;
CountryCode: PWideChar;
Phone: PWideChar;
AddressType: PWideChar;
FulfillmentSupplySourceId: PWideChar;
IsISPU: Boolean;
IsAccessPointOrder: Boolean;
HasAutomatedShippingSettings: Boolean;
EasyShipShipmentStatus: PWideChar;
ElectronicInvoiceStatus: 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 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) 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}",
//       "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) 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}';
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;

Memo1.Lines.Add(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 do
  begin
    CkJsonObject_putI(json,i);
    strVal := CkJsonObject__stringOf(json,'payload.PaymentMethodDetails[i]');
    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;