C
C
Amazon SP-API Get Order Items
See more Amazon SP-API Examples
Returns detailed order item information for the order that you specify.Chilkat C Downloads
#include <C_CkAuthAws.h>
#include <C_CkJsonObject.h>
#include <C_CkRest.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
BOOL success;
const char *orderId;
HCkAuthAws authAws;
HCkJsonObject jsonLwaToken;
HCkRest rest;
const char *lwa_token;
HCkStringBuilder sbPath;
HCkJsonObject jsonRc;
HCkStringBuilder sbRequest;
HCkStringBuilder sbResponse;
const char *uri;
int statusCode;
HCkJsonObject jsonResp;
const char *restrictedDataToken;
HCkJsonObject json;
const char *ASIN;
const char *OrderItemId;
const char *SellerSKU;
const char *Title;
int QuantityOrdered;
int QuantityShipped;
int NumberOfItems;
const char *CurrencyCode;
const char *Amount;
const char *ItemTaxCurrencyCode;
const char *ItemTaxAmount;
const char *PromotionDiscountCurrencyCode;
const char *PromotionDiscountAmount;
BOOL IsGift;
const char *ConditionId;
const char *ConditionSubtypeId;
BOOL IsTransparency;
BOOL SerialNumberRequired;
const char *IossNumber;
const char *DeemedResellerCategory;
const char *StoreChainStoreId;
BOOL IsBuyerRequestedCancel;
const char *BuyerCancelReason;
const char *AmazonOrderId;
int i;
int count_i;
success = FALSE;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// Gets detailed order item information for a specified 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) {
printf("Failed to load LWA access token.\n");
CkAuthAws_Dispose(authAws);
CkJsonObject_Dispose(jsonLwaToken);
return;
}
// 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) {
printf("%s\n",CkRest_lastErrorText(rest));
CkAuthAws_Dispose(authAws);
CkJsonObject_Dispose(jsonLwaToken);
CkRest_Dispose(rest);
return;
}
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}/orderItems",
// "dataElements": ["buyerInfo"]
// }
// ]
// }
sbPath = CkStringBuilder_Create();
CkStringBuilder_Append(sbPath,"/orders/v0/orders/");
CkStringBuilder_Append(sbPath,orderId);
CkStringBuilder_Append(sbPath,"/orderItems");
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");
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) {
printf("%s\n",CkRest_lastErrorText(rest));
CkAuthAws_Dispose(authAws);
CkJsonObject_Dispose(jsonLwaToken);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbPath);
CkJsonObject_Dispose(jsonRc);
CkStringBuilder_Dispose(sbRequest);
CkStringBuilder_Dispose(sbResponse);
return;
}
// Examine the response status.
statusCode = CkRest_getResponseStatusCode(rest);
if (statusCode != 200) {
printf("Response status code: %d\n",statusCode);
printf("Response status text: %s\n",CkRest_responseStatusText(rest));
printf("Response body: \n");
printf("%s\n",CkStringBuilder_getAsString(sbResponse));
printf("Failed.\n");
CkAuthAws_Dispose(authAws);
CkJsonObject_Dispose(jsonLwaToken);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbPath);
CkJsonObject_Dispose(jsonRc);
CkStringBuilder_Dispose(sbRequest);
CkStringBuilder_Dispose(sbResponse);
return;
}
// Get the restricted data token.
jsonResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jsonResp,sbResponse);
restrictedDataToken = CkJsonObject_stringOf(jsonResp,"restrictedDataToken");
printf("Restricted Data Token: %s\n",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) {
printf("%s\n",CkRest_lastErrorText(rest));
CkAuthAws_Dispose(authAws);
CkJsonObject_Dispose(jsonLwaToken);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbPath);
CkJsonObject_Dispose(jsonRc);
CkStringBuilder_Dispose(sbRequest);
CkStringBuilder_Dispose(sbResponse);
CkJsonObject_Dispose(jsonResp);
return;
}
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}/orderItems";
success = CkRest_FullRequestNoBodySb(rest,"GET",uri,sbResponse);
if (success == FALSE) {
printf("%s\n",CkRest_lastErrorText(rest));
CkAuthAws_Dispose(authAws);
CkJsonObject_Dispose(jsonLwaToken);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbPath);
CkJsonObject_Dispose(jsonRc);
CkStringBuilder_Dispose(sbRequest);
CkStringBuilder_Dispose(sbResponse);
CkJsonObject_Dispose(jsonResp);
return;
}
// Examine the response status.
statusCode = CkRest_getResponseStatusCode(rest);
if (statusCode != 200) {
printf("Response status text: %s\n",CkRest_responseStatusText(rest));
printf("Response body: \n");
printf("%s\n",CkStringBuilder_getAsString(sbResponse));
printf("Failed.\n");
CkAuthAws_Dispose(authAws);
CkJsonObject_Dispose(jsonLwaToken);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbPath);
CkJsonObject_Dispose(jsonRc);
CkStringBuilder_Dispose(sbRequest);
CkStringBuilder_Dispose(sbResponse);
CkJsonObject_Dispose(jsonResp);
return;
}
// If successful, gets a JSON response such as the following:
// {
// "payload": {
// "AmazonOrderId": "902-1845936-5435065",
// "OrderItems": [
// {
// "ASIN": "B00551Q3CS",
// "OrderItemId": "05015851154158",
// "SellerSKU": "NABetaASINB00551Q3CS",
// "Title": "B00551Q3CS [Card Book]",
// "QuantityOrdered": 1,
// "QuantityShipped": 0,
// "ProductInfo": {
// "NumberOfItems": 1
// },
// "ItemPrice": {
// "CurrencyCode": "USD",
// "Amount": "10.00"
// },
// "ItemTax": {
// "CurrencyCode": "USD",
// "Amount": "1.01"
// },
// "PromotionDiscount": {
// "CurrencyCode": "USD",
// "Amount": "0.00"
// },
// "IsGift": false,
// "ConditionId": "New",
// "ConditionSubtypeId": "New",
// "IsTransparency": false,
// "SerialNumberRequired": false,
// "IossNumber": "",
// "DeemedResellerCategory": "IOSS",
// "StoreChainStoreId": "ISPU_StoreId",
// "BuyerRequestedCancel": {
// "IsBuyerRequestedCancel": true,
// "BuyerCancelReason": "Found cheaper somewhere else."
// }
// }
// ]
// }
// }
// Use this online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
json = CkJsonObject_Create();
CkJsonObject_LoadSb(json,sbResponse);
CkJsonObject_putEmitCompact(json,FALSE);
printf("%s\n",CkJsonObject_emit(json));
AmazonOrderId = CkJsonObject_stringOf(json,"payload.AmazonOrderId");
i = 0;
count_i = CkJsonObject_SizeOfArray(json,"payload.OrderItems");
while (i < count_i) {
CkJsonObject_putI(json,i);
ASIN = CkJsonObject_stringOf(json,"payload.OrderItems[i].ASIN");
OrderItemId = CkJsonObject_stringOf(json,"payload.OrderItems[i].OrderItemId");
SellerSKU = CkJsonObject_stringOf(json,"payload.OrderItems[i].SellerSKU");
Title = CkJsonObject_stringOf(json,"payload.OrderItems[i].Title");
QuantityOrdered = CkJsonObject_IntOf(json,"payload.OrderItems[i].QuantityOrdered");
QuantityShipped = CkJsonObject_IntOf(json,"payload.OrderItems[i].QuantityShipped");
NumberOfItems = CkJsonObject_IntOf(json,"payload.OrderItems[i].ProductInfo.NumberOfItems");
CurrencyCode = CkJsonObject_stringOf(json,"payload.OrderItems[i].ItemPrice.CurrencyCode");
Amount = CkJsonObject_stringOf(json,"payload.OrderItems[i].ItemPrice.Amount");
ItemTaxCurrencyCode = CkJsonObject_stringOf(json,"payload.OrderItems[i].ItemTax.CurrencyCode");
ItemTaxAmount = CkJsonObject_stringOf(json,"payload.OrderItems[i].ItemTax.Amount");
PromotionDiscountCurrencyCode = CkJsonObject_stringOf(json,"payload.OrderItems[i].PromotionDiscount.CurrencyCode");
PromotionDiscountAmount = CkJsonObject_stringOf(json,"payload.OrderItems[i].PromotionDiscount.Amount");
IsGift = CkJsonObject_BoolOf(json,"payload.OrderItems[i].IsGift");
ConditionId = CkJsonObject_stringOf(json,"payload.OrderItems[i].ConditionId");
ConditionSubtypeId = CkJsonObject_stringOf(json,"payload.OrderItems[i].ConditionSubtypeId");
IsTransparency = CkJsonObject_BoolOf(json,"payload.OrderItems[i].IsTransparency");
SerialNumberRequired = CkJsonObject_BoolOf(json,"payload.OrderItems[i].SerialNumberRequired");
IossNumber = CkJsonObject_stringOf(json,"payload.OrderItems[i].IossNumber");
DeemedResellerCategory = CkJsonObject_stringOf(json,"payload.OrderItems[i].DeemedResellerCategory");
StoreChainStoreId = CkJsonObject_stringOf(json,"payload.OrderItems[i].StoreChainStoreId");
IsBuyerRequestedCancel = CkJsonObject_BoolOf(json,"payload.OrderItems[i].BuyerRequestedCancel.IsBuyerRequestedCancel");
BuyerCancelReason = CkJsonObject_stringOf(json,"payload.OrderItems[i].BuyerRequestedCancel.BuyerCancelReason");
i = i + 1;
}
printf("Success!\n");
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);
}