Objective-C
Objective-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 Objective-C Downloads
#import <NSString.h>
#import <CkoAuthAws.h>
#import <CkoJsonObject.h>
#import <CkoRest.h>
#import <CkoStringBuilder.h>
BOOL success = NO;
// 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
NSString *orderId = @"TEST_CASE_200";
CkoAuthAws *authAws = [[CkoAuthAws alloc] init];
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
CkoJsonObject *jsonLwaToken = [[CkoJsonObject alloc] init];
success = [jsonLwaToken LoadFile: @"qa_data/tokens/sp_api_lwa_token.json"];
if (success == NO) {
NSLog(@"%@",@"Failed to load LWA access token.");
return;
}
// Must use the non-sandbox domain for getting the RDT.
CkoRest *rest = [[CkoRest alloc] init];
success = [rest Connect: @"sellingpartnerapi-eu.amazon.com" port: [NSNumber numberWithInt: 443] tls: YES autoReconnect: YES];
if (success == NO) {
NSLog(@"%@",rest.LastErrorText);
return;
}
success = [rest SetAuthAws: authAws];
// Add the x-amz-access-token request header.
NSString *lwa_token = [jsonLwaToken StringOf: @"access_token"];
[rest ClearAllHeaders];
[rest AddHeader: @"x-amz-access-token" value: 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"]
// }
// ]
// }
CkoStringBuilder *sbPath = [[CkoStringBuilder alloc] init];
[sbPath Append: @"/orders/v0/orders/"];
[sbPath Append: orderId];
[sbPath Append: @"/orderItems"];
CkoJsonObject *jsonRc = [[CkoJsonObject alloc] init];
[jsonRc UpdateString: @"restrictedResources[0].method" value: @"GET"];
[jsonRc UpdateString: @"restrictedResources[0].path" value: [sbPath GetAsString]];
[jsonRc UpdateString: @"restrictedResources[0].dataElements[0]" value: @"buyerInfo"];
CkoStringBuilder *sbRequest = [[CkoStringBuilder alloc] init];
[jsonRc EmitSb: sbRequest];
CkoStringBuilder *sbResponse = [[CkoStringBuilder alloc] init];
NSString *uri = @"/tokens/2021-03-01/restrictedDataToken";
success = [rest FullRequestSb: @"POST" uriPath: uri requestBody: sbRequest responseBody: sbResponse];
if (success == NO) {
NSLog(@"%@",rest.LastErrorText);
return;
}
// Examine the response status.
int statusCode = [rest.ResponseStatusCode intValue];
if (statusCode != 200) {
NSLog(@"%@%d",@"Response status code: ",statusCode);
NSLog(@"%@%@",@"Response status text: ",rest.ResponseStatusText);
NSLog(@"%@",@"Response body: ");
NSLog(@"%@",[sbResponse GetAsString]);
NSLog(@"%@",@"Failed.");
return;
}
// Get the restricted data token.
CkoJsonObject *jsonResp = [[CkoJsonObject alloc] init];
[jsonResp LoadSb: sbResponse];
NSString *restrictedDataToken = [jsonResp StringOf: @"restrictedDataToken"];
NSLog(@"%@%@",@"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: [NSNumber numberWithInt: 100]];
success = [rest Connect: @"sandbox.sellingpartnerapi-eu.amazon.com" port: [NSNumber numberWithInt: 443] tls: YES autoReconnect: YES];
if (success == NO) {
NSLog(@"%@",rest.LastErrorText);
return;
}
success = [rest SetAuthAws: authAws];
[rest ClearAllHeaders];
[rest AddHeader: @"x-amz-access-token" value: restrictedDataToken];
[rest ClearAllQueryParams];
[rest AddQueryParam: @"MarketplaceIds" value: @"ATVPDKIKX0DER"];
[rest ClearAllPathParams];
[rest AddPathParam: @"{orderId}" value: orderId];
uri = @"/orders/v0/orders/{orderId}/orderItems";
success = [rest FullRequestNoBodySb: @"GET" uriPath: uri sb: sbResponse];
if (success == NO) {
NSLog(@"%@",rest.LastErrorText);
return;
}
// Examine the response status.
statusCode = [rest.ResponseStatusCode intValue];
if (statusCode != 200) {
NSLog(@"%@%@",@"Response status text: ",rest.ResponseStatusText);
NSLog(@"%@",@"Response body: ");
NSLog(@"%@",[sbResponse GetAsString]);
NSLog(@"%@",@"Failed.");
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
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json LoadSb: sbResponse];
json.EmitCompact = NO;
NSLog(@"%@",[json Emit]);
NSString *ASIN = 0;
NSString *OrderItemId = 0;
NSString *SellerSKU = 0;
NSString *Title = 0;
int QuantityOrdered;
int QuantityShipped;
int NumberOfItems;
NSString *CurrencyCode = 0;
NSString *Amount = 0;
NSString *ItemTaxCurrencyCode = 0;
NSString *ItemTaxAmount = 0;
NSString *PromotionDiscountCurrencyCode = 0;
NSString *PromotionDiscountAmount = 0;
BOOL IsGift;
NSString *ConditionId = 0;
NSString *ConditionSubtypeId = 0;
BOOL IsTransparency;
BOOL SerialNumberRequired;
NSString *IossNumber = 0;
NSString *DeemedResellerCategory = 0;
NSString *StoreChainStoreId = 0;
BOOL IsBuyerRequestedCancel;
NSString *BuyerCancelReason = 0;
NSString *AmazonOrderId = [json StringOf: @"payload.AmazonOrderId"];
int i = 0;
int count_i = [[json SizeOfArray: @"payload.OrderItems"] intValue];
while (i < count_i) {
json.I = [NSNumber numberWithInt: i];
ASIN = [json StringOf: @"payload.OrderItems[i].ASIN"];
OrderItemId = [json StringOf: @"payload.OrderItems[i].OrderItemId"];
SellerSKU = [json StringOf: @"payload.OrderItems[i].SellerSKU"];
Title = [json StringOf: @"payload.OrderItems[i].Title"];
QuantityOrdered = [[json IntOf: @"payload.OrderItems[i].QuantityOrdered"] intValue];
QuantityShipped = [[json IntOf: @"payload.OrderItems[i].QuantityShipped"] intValue];
NumberOfItems = [[json IntOf: @"payload.OrderItems[i].ProductInfo.NumberOfItems"] intValue];
CurrencyCode = [json StringOf: @"payload.OrderItems[i].ItemPrice.CurrencyCode"];
Amount = [json StringOf: @"payload.OrderItems[i].ItemPrice.Amount"];
ItemTaxCurrencyCode = [json StringOf: @"payload.OrderItems[i].ItemTax.CurrencyCode"];
ItemTaxAmount = [json StringOf: @"payload.OrderItems[i].ItemTax.Amount"];
PromotionDiscountCurrencyCode = [json StringOf: @"payload.OrderItems[i].PromotionDiscount.CurrencyCode"];
PromotionDiscountAmount = [json StringOf: @"payload.OrderItems[i].PromotionDiscount.Amount"];
IsGift = [json BoolOf: @"payload.OrderItems[i].IsGift"];
ConditionId = [json StringOf: @"payload.OrderItems[i].ConditionId"];
ConditionSubtypeId = [json StringOf: @"payload.OrderItems[i].ConditionSubtypeId"];
IsTransparency = [json BoolOf: @"payload.OrderItems[i].IsTransparency"];
SerialNumberRequired = [json BoolOf: @"payload.OrderItems[i].SerialNumberRequired"];
IossNumber = [json StringOf: @"payload.OrderItems[i].IossNumber"];
DeemedResellerCategory = [json StringOf: @"payload.OrderItems[i].DeemedResellerCategory"];
StoreChainStoreId = [json StringOf: @"payload.OrderItems[i].StoreChainStoreId"];
IsBuyerRequestedCancel = [json BoolOf: @"payload.OrderItems[i].BuyerRequestedCancel.IsBuyerRequestedCancel"];
BuyerCancelReason = [json StringOf: @"payload.OrderItems[i].BuyerRequestedCancel.BuyerCancelReason"];
i = i + 1;
}
NSLog(@"%@",@"Success!");