C++
C++
Amazon SP-API Get Specific Order
See more Amazon SP-API Examples
Get a specific Amazon Seller order.Chilkat C++ Downloads
#include <CkAuthAws.h>
#include <CkJsonObject.h>
#include <CkRest.h>
#include <CkStringBuilder.h>
void ChilkatSample(void)
{
bool 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
const char *orderId = "TEST_CASE_200";
CkAuthAws authAws;
authAws.put_AccessKey("AWS_ACCESS_KEY");
authAws.put_SecretKey("AWS_SECRET_KEY");
authAws.put_ServiceName("execute-api");
// Use the region that is correct for your needs.
authAws.put_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
CkJsonObject jsonLwaToken;
success = jsonLwaToken.LoadFile("qa_data/tokens/sp_api_lwa_token.json");
if (success == false) {
std::cout << "Failed to load LWA access token." << "\r\n";
return;
}
// Must use the non-sandbox domain for getting the RDT.
CkRest rest;
success = rest.Connect("sellingpartnerapi-eu.amazon.com",443,true,true);
if (success == false) {
std::cout << rest.lastErrorText() << "\r\n";
return;
}
success = rest.SetAuthAws(authAws);
// Add the x-amz-access-token request header.
const char *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"]
// }
// ]
// }
CkStringBuilder sbPath;
sbPath.Append("/orders/v0/orders/");
sbPath.Append(orderId);
CkJsonObject jsonRc;
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");
CkStringBuilder sbRequest;
jsonRc.EmitSb(sbRequest);
CkStringBuilder sbResponse;
const char *uri = "/tokens/2021-03-01/restrictedDataToken";
success = rest.FullRequestSb("POST",uri,sbRequest,sbResponse);
if (success == false) {
std::cout << rest.lastErrorText() << "\r\n";
return;
}
// Examine the response status.
int statusCode = rest.get_ResponseStatusCode();
if (statusCode != 200) {
std::cout << "Response status code: " << statusCode << "\r\n";
std::cout << "Response status text: " << rest.responseStatusText() << "\r\n";
std::cout << "Response body: " << "\r\n";
std::cout << sbResponse.getAsString() << "\r\n";
std::cout << "Failed." << "\r\n";
return;
}
// Get the restricted data token.
CkJsonObject jsonResp;
jsonResp.LoadSb(sbResponse);
const char *restrictedDataToken = jsonResp.stringOf("restrictedDataToken");
std::cout << "Restricted Data Token: " << restrictedDataToken << "\r\n";
// ------------------------------------------------------------------------------------------------------------
// ------------------------------------------------------------------------------------------------------------
// 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) {
std::cout << rest.lastErrorText() << "\r\n";
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) {
std::cout << rest.lastErrorText() << "\r\n";
return;
}
// Examine the response status.
statusCode = rest.get_ResponseStatusCode();
if (statusCode != 200) {
std::cout << "Response status text: " << rest.responseStatusText() << "\r\n";
std::cout << "Response body: " << "\r\n";
std::cout << sbResponse.getAsString() << "\r\n";
std::cout << "Failed." << "\r\n";
return;
}
std::cout << sbResponse.getAsString() << "\r\n";
// 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
CkJsonObject json;
json.LoadSb(sbResponse);
const char *strVal = 0;
const char *AmazonOrderId = json.stringOf("payload.AmazonOrderId");
const char *PurchaseDate = json.stringOf("payload.PurchaseDate");
const char *LastUpdateDate = json.stringOf("payload.LastUpdateDate");
const char *OrderStatus = json.stringOf("payload.OrderStatus");
const char *FulfillmentChannel = json.stringOf("payload.FulfillmentChannel");
const char *SalesChannel = json.stringOf("payload.SalesChannel");
const char *ShipServiceLevel = json.stringOf("payload.ShipServiceLevel");
const char *CurrencyCode = json.stringOf("payload.OrderTotal.CurrencyCode");
const char *Amount = json.stringOf("payload.OrderTotal.Amount");
int NumberOfItemsShipped = json.IntOf("payload.NumberOfItemsShipped");
int NumberOfItemsUnshipped = json.IntOf("payload.NumberOfItemsUnshipped");
const char *PaymentMethod = json.stringOf("payload.PaymentMethod");
bool IsReplacementOrder = json.BoolOf("payload.IsReplacementOrder");
const char *MarketplaceId = json.stringOf("payload.MarketplaceId");
const char *ShipmentServiceLevelCategory = json.stringOf("payload.ShipmentServiceLevelCategory");
const char *OrderType = json.stringOf("payload.OrderType");
const char *EarliestShipDate = json.stringOf("payload.EarliestShipDate");
const char *LatestShipDate = json.stringOf("payload.LatestShipDate");
const char *EarliestDeliveryDate = json.stringOf("payload.EarliestDeliveryDate");
const char *LatestDeliveryDate = json.stringOf("payload.LatestDeliveryDate");
bool IsBusinessOrder = json.BoolOf("payload.IsBusinessOrder");
bool IsPrime = json.BoolOf("payload.IsPrime");
bool IsGlobalExpressEnabled = json.BoolOf("payload.IsGlobalExpressEnabled");
bool IsPremiumOrder = json.BoolOf("payload.IsPremiumOrder");
bool IsSoldByAB = json.BoolOf("payload.IsSoldByAB");
bool IsIBA = json.BoolOf("payload.IsIBA");
const char *Name = json.stringOf("payload.DefaultShipFromLocationAddress.Name");
const char *AddressLine1 = json.stringOf("payload.DefaultShipFromLocationAddress.AddressLine1");
const char *City = json.stringOf("payload.DefaultShipFromLocationAddress.City");
const char *StateOrRegion = json.stringOf("payload.DefaultShipFromLocationAddress.StateOrRegion");
const char *PostalCode = json.stringOf("payload.DefaultShipFromLocationAddress.PostalCode");
const char *CountryCode = json.stringOf("payload.DefaultShipFromLocationAddress.CountryCode");
const char *Phone = json.stringOf("payload.DefaultShipFromLocationAddress.Phone");
const char *AddressType = json.stringOf("payload.DefaultShipFromLocationAddress.AddressType");
const char *FulfillmentSupplySourceId = json.stringOf("payload.FulfillmentInstruction.FulfillmentSupplySourceId");
bool IsISPU = json.BoolOf("payload.IsISPU");
bool IsAccessPointOrder = json.BoolOf("payload.IsAccessPointOrder");
bool HasAutomatedShippingSettings = json.BoolOf("payload.AutomatedShippingSettings.HasAutomatedShippingSettings");
const char *EasyShipShipmentStatus = json.stringOf("payload.EasyShipShipmentStatus");
const char *ElectronicInvoiceStatus = json.stringOf("payload.ElectronicInvoiceStatus");
int i = 0;
int count_i = json.SizeOfArray("payload.PaymentMethodDetails");
while (i < count_i) {
json.put_I(i);
strVal = json.stringOf("payload.PaymentMethodDetails[i]");
i = i + 1;
}
std::cout << "Success!" << "\r\n";
}