Dart
Dart
Amazon SP-API Get Orders
See more Amazon SP-API Examples
Demonstrates Amazon SP-API Sellers API -- get orders. Returns orders created or updated during the time frame indicated by the specified parameters.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.
// IMPORTANT:
// You'll need to make changes to use values specific to your own region and account.
//
// Here is a list of values you'll need to change or provide:
//
// 1) The access key. Change AWS_ACCESS_KEY to your actual access key.
// 2) The secret key. Change AWS_SECRET_KEY to your actual access key.
// 3) Your region. Change "ew-west-1" to your region.
// 4) The domain to which you connect. Change sandbox.sellingpartnerapi-eu.amazon.com to non-sandbox by removing the "sandbox."
// and change the "-eu" part of the domain to your region. See https://developer-docs.amazon.com/sp-api/docs/sp-api-endpoints
// 5) Use the restricted data token (RDT) obtained from your code that previously obtained the RDT.
// If you saved the RDT to a file, update the relative file path "qa_data/tokens/sp_api_rdt_token.json" to your actual file path.
// 6) Update your Marketplace ID(s), such as ATVPDKIKX0DER
// 7) If using the non-sandbox, change the CreatedAfter from "TEST_CASE_200" to an actual date, such as "2022-12-25"
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';
final rest = CkRest();
final bTls = true;
final port = 443;
final bAutoReconnect = true;
// Make sure to use the correct domain.
// This example is using the sandbox
try {
rest.connect('sandbox.sellingpartnerapi-eu.amazon.com', port, bTls, bAutoReconnect);
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
rest.setAuthAws(authAws);
// Here's the example to get the RDT access token: Get SP-API Restricted Data Token
// Load the previously obtained RDT access token.
// See Fetch SP-API RDT Access Token
final jsonToken = CkJsonObject();
try {
jsonToken.loadFile('qa_data/tokens/sp_api_rdt_token.json');
} on ChilkatException {
print('Failed to load RDT access token.');
return;
}
// Add the x-amz-access-token request header.
final rdtToken = jsonToken.stringOf('restrictedDataToken');
rest.clearAllHeaders();
rest.addHeader('x-amz-access-token', rdtToken);
// Indicate the marketplace IDs. Use the marketplace ID for your needs. See https://developer-docs.amazon.com/sp-api/docs/marketplace-ids
rest.clearAllQueryParams();
// When using the sandbox, use these params literally and exactly has shown here:
rest.addQueryParam('MarketplaceIds', 'ATVPDKIKX0DER');
rest.addQueryParam('CreatedAfter', 'TEST_CASE_200');
final sbResponse = CkStringBuilder();
final uri = '/orders/v0/orders';
try {
rest.fullRequestNoBodySb('GET', uri, sbResponse);
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
// Examine the response status.
final statusCode = rest.responseStatusCode;
if (statusCode != 200) {
print('Response status text: ${rest.responseStatusText}');
print('Response body: ');
print(sbResponse.getAsString());
print('Failed.');
return;
}
print(sbResponse.getAsString());
// If successful, gets a JSON response such as the following:
// {
// "payload": {
// "CreatedBefore": "1.569521782042E9",
// "Orders": [
// {
// "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"
// },
// {
// "AmazonOrderId": "902-8745147-1934268",
// "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,
// "IsAccessPointOrder": false,
// "IsGlobalExpressEnabled": false,
// "IsPremiumOrder": false,
// "IsSoldByAB": false,
// "IsIBA": false,
// "EasyShipShipmentStatus": "PendingPickUp",
// "ElectronicInvoiceStatus": "NotRequired"
// }
// ]
// }
// }
// Use this online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
final json = CkJsonObject();
json.loadSb(sbResponse);
var amazonOrderId = '';
var purchaseDate = '';
var lastUpdateDate = '';
var orderStatus = '';
var fulfillmentChannel = '';
var salesChannel = '';
var shipServiceLevel = '';
var currencyCode = '';
var amount = '';
var numberOfItemsShipped = 0;
var numberOfItemsUnshipped = 0;
var paymentMethod = '';
var marketplaceId = '';
var shipmentServiceLevelCategory = '';
var orderType = '';
var earliestShipDate = '';
var latestShipDate = '';
var earliestDeliveryDate = '';
var latestDeliveryDate = '';
var name = '';
var addressLine1 = '';
var city = '';
var stateOrRegion = '';
var postalCode = '';
var countryCode = '';
var phone = '';
var addressType = '';
var fulfillmentSupplySourceId = '';
var easyShipShipmentStatus = '';
var electronicInvoiceStatus = '';
var j = 0;
var countJ = 0;
var strVal = '';
final createdBefore = json.stringOf('payload.CreatedBefore');
var i = 0;
final countI = json.sizeOfArray('payload.Orders');
while (i < countI) {
json.i = i;
amazonOrderId = json.stringOf('payload.Orders[i].AmazonOrderId');
purchaseDate = json.stringOf('payload.Orders[i].PurchaseDate');
lastUpdateDate = json.stringOf('payload.Orders[i].LastUpdateDate');
orderStatus = json.stringOf('payload.Orders[i].OrderStatus');
fulfillmentChannel = json.stringOf('payload.Orders[i].FulfillmentChannel');
salesChannel = json.stringOf('payload.Orders[i].SalesChannel');
shipServiceLevel = json.stringOf('payload.Orders[i].ShipServiceLevel');
currencyCode = json.stringOf('payload.Orders[i].OrderTotal.CurrencyCode');
amount = json.stringOf('payload.Orders[i].OrderTotal.Amount');
numberOfItemsShipped = json.intOf('payload.Orders[i].NumberOfItemsShipped');
numberOfItemsUnshipped = json.intOf('payload.Orders[i].NumberOfItemsUnshipped');
paymentMethod = json.stringOf('payload.Orders[i].PaymentMethod');
json.boolOf('payload.Orders[i].IsReplacementOrder');
marketplaceId = json.stringOf('payload.Orders[i].MarketplaceId');
shipmentServiceLevelCategory = json.stringOf('payload.Orders[i].ShipmentServiceLevelCategory');
orderType = json.stringOf('payload.Orders[i].OrderType');
earliestShipDate = json.stringOf('payload.Orders[i].EarliestShipDate');
latestShipDate = json.stringOf('payload.Orders[i].LatestShipDate');
earliestDeliveryDate = json.stringOf('payload.Orders[i].EarliestDeliveryDate');
latestDeliveryDate = json.stringOf('payload.Orders[i].LatestDeliveryDate');
json.boolOf('payload.Orders[i].IsBusinessOrder');
json.boolOf('payload.Orders[i].IsPrime');
json.boolOf('payload.Orders[i].IsGlobalExpressEnabled');
json.boolOf('payload.Orders[i].IsPremiumOrder');
json.boolOf('payload.Orders[i].IsSoldByAB');
json.boolOf('payload.Orders[i].IsIBA');
name = json.stringOf('payload.Orders[i].DefaultShipFromLocationAddress.Name');
addressLine1 = json.stringOf('payload.Orders[i].DefaultShipFromLocationAddress.AddressLine1');
city = json.stringOf('payload.Orders[i].DefaultShipFromLocationAddress.City');
stateOrRegion = json.stringOf('payload.Orders[i].DefaultShipFromLocationAddress.StateOrRegion');
postalCode = json.stringOf('payload.Orders[i].DefaultShipFromLocationAddress.PostalCode');
countryCode = json.stringOf('payload.Orders[i].DefaultShipFromLocationAddress.CountryCode');
phone = json.stringOf('payload.Orders[i].DefaultShipFromLocationAddress.Phone');
addressType = json.stringOf('payload.Orders[i].DefaultShipFromLocationAddress.AddressType');
fulfillmentSupplySourceId = json.stringOf('payload.Orders[i].FulfillmentInstruction.FulfillmentSupplySourceId');
json.boolOf('payload.Orders[i].IsISPU');
json.boolOf('payload.Orders[i].IsAccessPointOrder');
json.boolOf('payload.Orders[i].AutomatedShippingSettings.HasAutomatedShippingSettings');
easyShipShipmentStatus = json.stringOf('payload.Orders[i].EasyShipShipmentStatus');
electronicInvoiceStatus = json.stringOf('payload.Orders[i].ElectronicInvoiceStatus');
j = 0;
countJ = json.sizeOfArray('payload.Orders[i].PaymentMethodDetails');
while (j < countJ) {
json.j = j;
strVal = json.stringOf('payload.Orders[i].PaymentMethodDetails[j]');
j++;
}
i++;
}
print('Success!');
}