Objective-C
Objective-C
Amazon SP-API Get Specific Order
See more Amazon SP-API Examples
Get a specific Amazon Seller order.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 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
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}",
// "dataElements": ["buyerInfo", "shippingAddress"]
// }
// ]
// }
CkoStringBuilder *sbPath = [[CkoStringBuilder alloc] init];
[sbPath Append: @"/orders/v0/orders/"];
[sbPath Append: orderId];
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"];
[jsonRc UpdateString: @"restrictedResources[0].dataElements[1]" value: @"shippingAddress"];
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}";
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;
}
NSLog(@"%@",[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
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json LoadSb: sbResponse];
NSString *strVal = 0;
NSString *AmazonOrderId = [json StringOf: @"payload.AmazonOrderId"];
NSString *PurchaseDate = [json StringOf: @"payload.PurchaseDate"];
NSString *LastUpdateDate = [json StringOf: @"payload.LastUpdateDate"];
NSString *OrderStatus = [json StringOf: @"payload.OrderStatus"];
NSString *FulfillmentChannel = [json StringOf: @"payload.FulfillmentChannel"];
NSString *SalesChannel = [json StringOf: @"payload.SalesChannel"];
NSString *ShipServiceLevel = [json StringOf: @"payload.ShipServiceLevel"];
NSString *CurrencyCode = [json StringOf: @"payload.OrderTotal.CurrencyCode"];
NSString *Amount = [json StringOf: @"payload.OrderTotal.Amount"];
int NumberOfItemsShipped = [[json IntOf: @"payload.NumberOfItemsShipped"] intValue];
int NumberOfItemsUnshipped = [[json IntOf: @"payload.NumberOfItemsUnshipped"] intValue];
NSString *PaymentMethod = [json StringOf: @"payload.PaymentMethod"];
BOOL IsReplacementOrder = [json BoolOf: @"payload.IsReplacementOrder"];
NSString *MarketplaceId = [json StringOf: @"payload.MarketplaceId"];
NSString *ShipmentServiceLevelCategory = [json StringOf: @"payload.ShipmentServiceLevelCategory"];
NSString *OrderType = [json StringOf: @"payload.OrderType"];
NSString *EarliestShipDate = [json StringOf: @"payload.EarliestShipDate"];
NSString *LatestShipDate = [json StringOf: @"payload.LatestShipDate"];
NSString *EarliestDeliveryDate = [json StringOf: @"payload.EarliestDeliveryDate"];
NSString *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"];
NSString *Name = [json StringOf: @"payload.DefaultShipFromLocationAddress.Name"];
NSString *AddressLine1 = [json StringOf: @"payload.DefaultShipFromLocationAddress.AddressLine1"];
NSString *City = [json StringOf: @"payload.DefaultShipFromLocationAddress.City"];
NSString *StateOrRegion = [json StringOf: @"payload.DefaultShipFromLocationAddress.StateOrRegion"];
NSString *PostalCode = [json StringOf: @"payload.DefaultShipFromLocationAddress.PostalCode"];
NSString *CountryCode = [json StringOf: @"payload.DefaultShipFromLocationAddress.CountryCode"];
NSString *Phone = [json StringOf: @"payload.DefaultShipFromLocationAddress.Phone"];
NSString *AddressType = [json StringOf: @"payload.DefaultShipFromLocationAddress.AddressType"];
NSString *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"];
NSString *EasyShipShipmentStatus = [json StringOf: @"payload.EasyShipShipmentStatus"];
NSString *ElectronicInvoiceStatus = [json StringOf: @"payload.ElectronicInvoiceStatus"];
int i = 0;
int count_i = [[json SizeOfArray: @"payload.PaymentMethodDetails"] intValue];
while (i < count_i) {
json.I = [NSNumber numberWithInt: i];
strVal = [json StringOf: @"payload.PaymentMethodDetails[i]"];
i = i + 1;
}
NSLog(@"%@",@"Success!");