React Native
React Native
Amazon SP-API Get Specific Order
See more Amazon SP-API Examples
Get a specific Amazon Seller order.Chilkat React Native Downloads
import { AuthAws, JsonObject, Rest, StringBuilder } from '@chilkat/react-native'
async function chilkatExample() {
// 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
const orderId = 'TEST_CASE_200';
const authAws = new 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
const jsonLwaToken = new JsonObject();
try {
jsonLwaToken.loadFile('qa_data/tokens/sp_api_lwa_token.json');
} catch {
console.log('Failed to load LWA access token.');
return;
}
// Must use the non-sandbox domain for getting the RDT.
const rest = new Rest();
try {
await rest.connectAsync('sellingpartnerapi-eu.amazon.com', 443, true, true);
} catch {
console.log(rest.lastErrorText);
return;
}
rest.setAuthAws(authAws);
// Add the x-amz-access-token request header.
const lwaToken = jsonLwaToken.stringOf('access_token');
rest.clearAllHeaders();
rest.addHeader('x-amz-access-token', lwaToken);
// We're going to send a POST with the following JSON body:
// {
// "restrictedResources": [
// {
// "method": "GET",
// "path": "/orders/v0/orders/{orderId}",
// "dataElements": ["buyerInfo", "shippingAddress"]
// }
// ]
// }
const sbPath = new StringBuilder();
sbPath.append('/orders/v0/orders/');
sbPath.append(orderId);
const jsonRc = new 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');
const sbRequest = new StringBuilder();
jsonRc.emitSb(sbRequest);
const sbResponse = new StringBuilder();
let uri = '/tokens/2021-03-01/restrictedDataToken';
try {
await rest.fullRequestSbAsync('POST', uri, sbRequest, sbResponse);
} catch {
console.log(rest.lastErrorText);
return;
}
// Examine the response status.
let 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.
const jsonResp = new JsonObject();
jsonResp.loadSb(sbResponse);
const 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.)
await rest.disconnectAsync(100);
try {
await rest.connectAsync('sandbox.sellingpartnerapi-eu.amazon.com', 443, true, true);
} catch {
console.log(rest.lastErrorText);
return;
}
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}';
try {
await rest.fullRequestNoBodySbAsync('GET', uri, sbResponse);
} catch {
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
const json = new JsonObject();
json.loadSb(sbResponse);
let strVal = '';
const amazonOrderId = json.stringOf('payload.AmazonOrderId');
const purchaseDate = json.stringOf('payload.PurchaseDate');
const lastUpdateDate = json.stringOf('payload.LastUpdateDate');
const orderStatus = json.stringOf('payload.OrderStatus');
const fulfillmentChannel = json.stringOf('payload.FulfillmentChannel');
const salesChannel = json.stringOf('payload.SalesChannel');
const shipServiceLevel = json.stringOf('payload.ShipServiceLevel');
const currencyCode = json.stringOf('payload.OrderTotal.CurrencyCode');
const amount = json.stringOf('payload.OrderTotal.Amount');
const numberOfItemsShipped = json.intOf('payload.NumberOfItemsShipped');
const numberOfItemsUnshipped = json.intOf('payload.NumberOfItemsUnshipped');
const paymentMethod = json.stringOf('payload.PaymentMethod');
const marketplaceId = json.stringOf('payload.MarketplaceId');
const shipmentServiceLevelCategory = json.stringOf('payload.ShipmentServiceLevelCategory');
const orderType = json.stringOf('payload.OrderType');
const earliestShipDate = json.stringOf('payload.EarliestShipDate');
const latestShipDate = json.stringOf('payload.LatestShipDate');
const earliestDeliveryDate = json.stringOf('payload.EarliestDeliveryDate');
const latestDeliveryDate = json.stringOf('payload.LatestDeliveryDate');
const name = json.stringOf('payload.DefaultShipFromLocationAddress.Name');
const addressLine1 = json.stringOf('payload.DefaultShipFromLocationAddress.AddressLine1');
const city = json.stringOf('payload.DefaultShipFromLocationAddress.City');
const stateOrRegion = json.stringOf('payload.DefaultShipFromLocationAddress.StateOrRegion');
const postalCode = json.stringOf('payload.DefaultShipFromLocationAddress.PostalCode');
const countryCode = json.stringOf('payload.DefaultShipFromLocationAddress.CountryCode');
const phone = json.stringOf('payload.DefaultShipFromLocationAddress.Phone');
const addressType = json.stringOf('payload.DefaultShipFromLocationAddress.AddressType');
const fulfillmentSupplySourceId = json.stringOf('payload.FulfillmentInstruction.FulfillmentSupplySourceId');
const easyShipShipmentStatus = json.stringOf('payload.EasyShipShipmentStatus');
const electronicInvoiceStatus = json.stringOf('payload.ElectronicInvoiceStatus');
let i = 0;
const countI = json.sizeOfArray('payload.PaymentMethodDetails');
while (i < countI) {
json.i = i;
strVal = json.stringOf('payload.PaymentMethodDetails[i]');
i++;
}
console.log('Success!');
}