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

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

...

procedure TForm1.Button1Click(Sender: TObject);
var
orderId: WideString;
authAws: TChilkatAuthAws;
jsonLwaToken: TChilkatJsonObject;
success: Integer;
rest: TChilkatRest;
lwa_token: WideString;
sbPath: TChilkatStringBuilder;
jsonRc: TChilkatJsonObject;
sbRequest: TChilkatStringBuilder;
sbResponse: TChilkatStringBuilder;
uri: WideString;
statusCode: Integer;
jsonResp: TChilkatJsonObject;
restrictedDataToken: WideString;
json: TChilkatJsonObject;
strVal: WideString;
AmazonOrderId: WideString;
PurchaseDate: WideString;
LastUpdateDate: WideString;
OrderStatus: WideString;
FulfillmentChannel: WideString;
SalesChannel: WideString;
ShipServiceLevel: WideString;
CurrencyCode: WideString;
Amount: WideString;
NumberOfItemsShipped: Integer;
NumberOfItemsUnshipped: Integer;
PaymentMethod: WideString;
IsReplacementOrder: Integer;
MarketplaceId: WideString;
ShipmentServiceLevelCategory: WideString;
OrderType: WideString;
EarliestShipDate: WideString;
LatestShipDate: WideString;
EarliestDeliveryDate: WideString;
LatestDeliveryDate: WideString;
IsBusinessOrder: Integer;
IsPrime: Integer;
IsGlobalExpressEnabled: Integer;
IsPremiumOrder: Integer;
IsSoldByAB: Integer;
IsIBA: Integer;
Name: WideString;
AddressLine1: WideString;
City: WideString;
StateOrRegion: WideString;
PostalCode: WideString;
CountryCode: WideString;
Phone: WideString;
AddressType: WideString;
FulfillmentSupplySourceId: WideString;
IsISPU: Integer;
IsAccessPointOrder: Integer;
HasAutomatedShippingSettings: Integer;
EasyShipShipmentStatus: WideString;
ElectronicInvoiceStatus: WideString;
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 := TChilkatAuthAws.Create(Self);
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
jsonLwaToken := TChilkatJsonObject.Create(Self);
success := jsonLwaToken.LoadFile('qa_data/tokens/sp_api_lwa_token.json');
if (success = 0) then
  begin
    Memo1.Lines.Add('Failed to load LWA access token.');
    Exit;
  end;

// Must use the non-sandbox domain for getting the RDT.
rest := TChilkatRest.Create(Self);
success := rest.Connect('sellingpartnerapi-eu.amazon.com',443,1,1);
if (success = 0) then
  begin
    Memo1.Lines.Add(rest.LastErrorText);
    Exit;
  end;

success := rest.SetAuthAws(authAws.ControlInterface);

// Add the x-amz-access-token request header.
lwa_token := 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"]
//     }
//   ]
// }

sbPath := TChilkatStringBuilder.Create(Self);
sbPath.Append('/orders/v0/orders/');
sbPath.Append(orderId);

jsonRc := TChilkatJsonObject.Create(Self);
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');

sbRequest := TChilkatStringBuilder.Create(Self);
jsonRc.EmitSb(sbRequest.ControlInterface);

sbResponse := TChilkatStringBuilder.Create(Self);
uri := '/tokens/2021-03-01/restrictedDataToken';
success := rest.FullRequestSb('POST',uri,sbRequest.ControlInterface,sbResponse.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(rest.LastErrorText);
    Exit;
  end;

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

// Get the restricted data token.
jsonResp := TChilkatJsonObject.Create(Self);
jsonResp.LoadSb(sbResponse.ControlInterface);
restrictedDataToken := jsonResp.StringOf('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.)
rest.Disconnect(100);

success := rest.Connect('sandbox.sellingpartnerapi-eu.amazon.com',443,1,1);
if (success = 0) then
  begin
    Memo1.Lines.Add(rest.LastErrorText);
    Exit;
  end;

success := rest.SetAuthAws(authAws.ControlInterface);

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.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(rest.LastErrorText);
    Exit;
  end;

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

Memo1.Lines.Add(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

json := TChilkatJsonObject.Create(Self);

json.LoadSb(sbResponse.ControlInterface);

AmazonOrderId := json.StringOf('payload.AmazonOrderId');
PurchaseDate := json.StringOf('payload.PurchaseDate');
LastUpdateDate := json.StringOf('payload.LastUpdateDate');
OrderStatus := json.StringOf('payload.OrderStatus');
FulfillmentChannel := json.StringOf('payload.FulfillmentChannel');
SalesChannel := json.StringOf('payload.SalesChannel');
ShipServiceLevel := json.StringOf('payload.ShipServiceLevel');
CurrencyCode := json.StringOf('payload.OrderTotal.CurrencyCode');
Amount := json.StringOf('payload.OrderTotal.Amount');
NumberOfItemsShipped := json.IntOf('payload.NumberOfItemsShipped');
NumberOfItemsUnshipped := json.IntOf('payload.NumberOfItemsUnshipped');
PaymentMethod := json.StringOf('payload.PaymentMethod');
IsReplacementOrder := json.BoolOf('payload.IsReplacementOrder');
MarketplaceId := json.StringOf('payload.MarketplaceId');
ShipmentServiceLevelCategory := json.StringOf('payload.ShipmentServiceLevelCategory');
OrderType := json.StringOf('payload.OrderType');
EarliestShipDate := json.StringOf('payload.EarliestShipDate');
LatestShipDate := json.StringOf('payload.LatestShipDate');
EarliestDeliveryDate := json.StringOf('payload.EarliestDeliveryDate');
LatestDeliveryDate := json.StringOf('payload.LatestDeliveryDate');
IsBusinessOrder := json.BoolOf('payload.IsBusinessOrder');
IsPrime := json.BoolOf('payload.IsPrime');
IsGlobalExpressEnabled := json.BoolOf('payload.IsGlobalExpressEnabled');
IsPremiumOrder := json.BoolOf('payload.IsPremiumOrder');
IsSoldByAB := json.BoolOf('payload.IsSoldByAB');
IsIBA := json.BoolOf('payload.IsIBA');
Name := json.StringOf('payload.DefaultShipFromLocationAddress.Name');
AddressLine1 := json.StringOf('payload.DefaultShipFromLocationAddress.AddressLine1');
City := json.StringOf('payload.DefaultShipFromLocationAddress.City');
StateOrRegion := json.StringOf('payload.DefaultShipFromLocationAddress.StateOrRegion');
PostalCode := json.StringOf('payload.DefaultShipFromLocationAddress.PostalCode');
CountryCode := json.StringOf('payload.DefaultShipFromLocationAddress.CountryCode');
Phone := json.StringOf('payload.DefaultShipFromLocationAddress.Phone');
AddressType := json.StringOf('payload.DefaultShipFromLocationAddress.AddressType');
FulfillmentSupplySourceId := json.StringOf('payload.FulfillmentInstruction.FulfillmentSupplySourceId');
IsISPU := json.BoolOf('payload.IsISPU');
IsAccessPointOrder := json.BoolOf('payload.IsAccessPointOrder');
HasAutomatedShippingSettings := json.BoolOf('payload.AutomatedShippingSettings.HasAutomatedShippingSettings');
EasyShipShipmentStatus := json.StringOf('payload.EasyShipShipmentStatus');
ElectronicInvoiceStatus := json.StringOf('payload.ElectronicInvoiceStatus');
i := 0;
count_i := json.SizeOfArray('payload.PaymentMethodDetails');
while i < count_i do
  begin
    json.I := i;
    strVal := json.StringOf('payload.PaymentMethodDetails[i]');
    i := i + 1;
  end;

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