Dart
Dart
Amazon SP-API Get Order Items
See more Amazon SP-API Examples
Returns detailed order item information for the order that you specify.Chilkat Dart Downloads
import 'package:chilkat/chilkat.dart';
void main() {
// 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
final orderId = 'TEST_CASE_200';
final authAws = CkAuthAws();
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
final jsonLwaToken = CkJsonObject();
try {
jsonLwaToken.loadFile('qa_data/tokens/sp_api_lwa_token.json');
} on ChilkatException {
print('Failed to load LWA access token.');
return;
}
// Must use the non-sandbox domain for getting the RDT.
final rest = CkRest();
try {
rest.connect('sellingpartnerapi-eu.amazon.com', 443, true, true);
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
rest.setAuthAws(authAws);
// Add the x-amz-access-token request header.
final 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}/orderItems",
// "dataElements": ["buyerInfo"]
// }
// ]
// }
final sbPath = CkStringBuilder();
sbPath.append('/orders/v0/orders/');
sbPath.append(orderId);
sbPath.append('/orderItems');
final jsonRc = CkJsonObject();
jsonRc.updateString('restrictedResources[0].method', 'GET');
jsonRc.updateString('restrictedResources[0].path', sbPath.getAsString());
jsonRc.updateString('restrictedResources[0].dataElements[0]', 'buyerInfo');
final sbRequest = CkStringBuilder();
jsonRc.emitSb(sbRequest);
final sbResponse = CkStringBuilder();
var uri = '/tokens/2021-03-01/restrictedDataToken';
try {
rest.fullRequestSb('POST', uri, sbRequest, sbResponse);
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
// Examine the response status.
var statusCode = rest.responseStatusCode;
if (statusCode != 200) {
print('Response status code: $statusCode');
print('Response status text: ${rest.responseStatusText}');
print('Response body: ');
print(sbResponse.getAsString());
print('Failed.');
return;
}
// Get the restricted data token.
final jsonResp = CkJsonObject();
jsonResp.loadSb(sbResponse);
final restrictedDataToken = jsonResp.stringOf('restrictedDataToken');
print('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(100);
try {
rest.connect('sandbox.sellingpartnerapi-eu.amazon.com', 443, true, true);
} on ChilkatException catch (e) {
print(e.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}/orderItems';
try {
rest.fullRequestNoBodySb('GET', uri, sbResponse);
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
// Examine the response status.
statusCode = rest.responseStatusCode;
if (statusCode != 200) {
print('Response status text: ${rest.responseStatusText}');
print('Response body: ');
print(sbResponse.getAsString());
print('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
final json = CkJsonObject();
json.loadSb(sbResponse);
json.emitCompact = false;
print(json.emit());
var asin = '';
var orderItemId = '';
var sellerSKU = '';
var title = '';
var quantityOrdered = 0;
var quantityShipped = 0;
var numberOfItems = 0;
var currencyCode = '';
var amount = '';
var itemTaxCurrencyCode = '';
var itemTaxAmount = '';
var promotionDiscountCurrencyCode = '';
var promotionDiscountAmount = '';
var conditionId = '';
var conditionSubtypeId = '';
var iossNumber = '';
var deemedResellerCategory = '';
var storeChainStoreId = '';
var buyerCancelReason = '';
final amazonOrderId = json.stringOf('payload.AmazonOrderId');
var i = 0;
final countI = json.sizeOfArray('payload.OrderItems');
while (i < countI) {
json.i = 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');
quantityShipped = json.intOf('payload.OrderItems[i].QuantityShipped');
numberOfItems = json.intOf('payload.OrderItems[i].ProductInfo.NumberOfItems');
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');
json.boolOf('payload.OrderItems[i].IsGift');
conditionId = json.stringOf('payload.OrderItems[i].ConditionId');
conditionSubtypeId = json.stringOf('payload.OrderItems[i].ConditionSubtypeId');
json.boolOf('payload.OrderItems[i].IsTransparency');
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');
json.boolOf('payload.OrderItems[i].BuyerRequestedCancel.IsBuyerRequestedCancel');
buyerCancelReason = json.stringOf('payload.OrderItems[i].BuyerRequestedCancel.BuyerCancelReason');
i++;
}
print('Success!');
}