Node.js
Node.js
Amazon SP-API Get Specific Order
See more Amazon SP-API Examples
Get a specific Amazon Seller order.Chilkat Node.js Downloads
NODEJS_PRELUDE
function chilkatExample() {
var success = false;
// 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
var orderId = "TEST_CASE_200";
var authAws = new chilkat.AuthAws();
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
var jsonLwaToken = new chilkat.JsonObject();
success = jsonLwaToken.LoadFile("qa_data/tokens/sp_api_lwa_token.json");
if (success == false) {
console.log("Failed to load LWA access token.");
return;
}
// Must use the non-sandbox domain for getting the RDT.
var rest = new chilkat.Rest();
success = rest.Connect("sellingpartnerapi-eu.amazon.com",443,true,true);
if (success == false) {
console.log(rest.LastErrorText);
return;
}
success = rest.SetAuthAws(authAws);
// Add the x-amz-access-token request header.
var 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"]
// }
// ]
// }
var sbPath = new chilkat.StringBuilder();
sbPath.Append("/orders/v0/orders/");
sbPath.Append(orderId);
var jsonRc = new chilkat.JsonObject();
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");
var sbRequest = new chilkat.StringBuilder();
jsonRc.EmitSb(sbRequest);
var sbResponse = new chilkat.StringBuilder();
var uri = "/tokens/2021-03-01/restrictedDataToken";
success = rest.FullRequestSb("POST",uri,sbRequest,sbResponse);
if (success == false) {
console.log(rest.LastErrorText);
return;
}
// Examine the response status.
var statusCode = rest.ResponseStatusCode;
if (statusCode !== 200) {
console.log("Response status code: " + statusCode);
console.log("Response status text: " + rest.ResponseStatusText);
console.log("Response body: ");
console.log(sbResponse.GetAsString());
console.log("Failed.");
return;
}
// Get the restricted data token.
var jsonResp = new chilkat.JsonObject();
jsonResp.LoadSb(sbResponse);
var restrictedDataToken = jsonResp.StringOf("restrictedDataToken");
console.log("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,true,true);
if (success == false) {
console.log(rest.LastErrorText);
return;
}
success = rest.SetAuthAws(authAws);
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);
if (success == false) {
console.log(rest.LastErrorText);
return;
}
// Examine the response status.
statusCode = rest.ResponseStatusCode;
if (statusCode !== 200) {
console.log("Response status text: " + rest.ResponseStatusText);
console.log("Response body: ");
console.log(sbResponse.GetAsString());
console.log("Failed.");
return;
}
console.log(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
var json = new chilkat.JsonObject();
json.LoadSb(sbResponse);
var strVal;
var AmazonOrderId = json.StringOf("payload.AmazonOrderId");
var PurchaseDate = json.StringOf("payload.PurchaseDate");
var LastUpdateDate = json.StringOf("payload.LastUpdateDate");
var OrderStatus = json.StringOf("payload.OrderStatus");
var FulfillmentChannel = json.StringOf("payload.FulfillmentChannel");
var SalesChannel = json.StringOf("payload.SalesChannel");
var ShipServiceLevel = json.StringOf("payload.ShipServiceLevel");
var CurrencyCode = json.StringOf("payload.OrderTotal.CurrencyCode");
var Amount = json.StringOf("payload.OrderTotal.Amount");
var NumberOfItemsShipped = json.IntOf("payload.NumberOfItemsShipped");
var NumberOfItemsUnshipped = json.IntOf("payload.NumberOfItemsUnshipped");
var PaymentMethod = json.StringOf("payload.PaymentMethod");
var IsReplacementOrder = json.BoolOf("payload.IsReplacementOrder");
var MarketplaceId = json.StringOf("payload.MarketplaceId");
var ShipmentServiceLevelCategory = json.StringOf("payload.ShipmentServiceLevelCategory");
var OrderType = json.StringOf("payload.OrderType");
var EarliestShipDate = json.StringOf("payload.EarliestShipDate");
var LatestShipDate = json.StringOf("payload.LatestShipDate");
var EarliestDeliveryDate = json.StringOf("payload.EarliestDeliveryDate");
var LatestDeliveryDate = json.StringOf("payload.LatestDeliveryDate");
var IsBusinessOrder = json.BoolOf("payload.IsBusinessOrder");
var IsPrime = json.BoolOf("payload.IsPrime");
var IsGlobalExpressEnabled = json.BoolOf("payload.IsGlobalExpressEnabled");
var IsPremiumOrder = json.BoolOf("payload.IsPremiumOrder");
var IsSoldByAB = json.BoolOf("payload.IsSoldByAB");
var IsIBA = json.BoolOf("payload.IsIBA");
var Name = json.StringOf("payload.DefaultShipFromLocationAddress.Name");
var AddressLine1 = json.StringOf("payload.DefaultShipFromLocationAddress.AddressLine1");
var City = json.StringOf("payload.DefaultShipFromLocationAddress.City");
var StateOrRegion = json.StringOf("payload.DefaultShipFromLocationAddress.StateOrRegion");
var PostalCode = json.StringOf("payload.DefaultShipFromLocationAddress.PostalCode");
var CountryCode = json.StringOf("payload.DefaultShipFromLocationAddress.CountryCode");
var Phone = json.StringOf("payload.DefaultShipFromLocationAddress.Phone");
var AddressType = json.StringOf("payload.DefaultShipFromLocationAddress.AddressType");
var FulfillmentSupplySourceId = json.StringOf("payload.FulfillmentInstruction.FulfillmentSupplySourceId");
var IsISPU = json.BoolOf("payload.IsISPU");
var IsAccessPointOrder = json.BoolOf("payload.IsAccessPointOrder");
var HasAutomatedShippingSettings = json.BoolOf("payload.AutomatedShippingSettings.HasAutomatedShippingSettings");
var EasyShipShipmentStatus = json.StringOf("payload.EasyShipShipmentStatus");
var ElectronicInvoiceStatus = json.StringOf("payload.ElectronicInvoiceStatus");
var i = 0;
var count_i = json.SizeOfArray("payload.PaymentMethodDetails");
while (i < count_i) {
json.I = i;
strVal = json.StringOf("payload.PaymentMethodDetails[i]");
i = i+1;
}
console.log("Success!");
}
chilkatExample();