Java
Chilkat2 Java
Amazon SP-API Get Specific Order
See more Amazon SP-API Examples
Get a specific Amazon Seller order.Chilkat Java Downloads
import com.chilkatsoft.chilkat2.AuthAws;
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.Rest;
import com.chilkatsoft.chilkat2.StringBuilder;
public class ChilkatExample {
public static void main(String[] args) {
// 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
String orderId = "TEST_CASE_200";
AuthAws authAws = new AuthAws();
authAws.setAccessKey("AWS_ACCESS_KEY");
authAws.setSecretKey("AWS_SECRET_KEY");
authAws.setServiceName("execute-api");
// Use the region that is correct for your needs.
authAws.setRegion("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
JsonObject jsonLwaToken = new JsonObject();
try {
jsonLwaToken.loadFile("qa_data/tokens/sp_api_lwa_token.json");
} catch (ChilkatException e) {
System.out.println("Failed to load LWA access token.");
return;
}
// Must use the non-sandbox domain for getting the RDT.
Rest rest = new Rest();
try {
rest.connect("sellingpartnerapi-eu.amazon.com", 443, true, true);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
rest.setAuthAws(authAws);
// Add the x-amz-access-token request header.
String lwa_token = jsonLwaToken.stringOf("access_token");
rest.clearAllHeaders();
rest.addHeader("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}",
// "dataElements": ["buyerInfo", "shippingAddress"]
// }
// ]
// }
StringBuilder sbPath = new StringBuilder();
sbPath.append("/orders/v0/orders/");
sbPath.append(orderId);
JsonObject jsonRc = new JsonObject();
jsonRc.updateString("restrictedResources[0].method", "GET");
jsonRc.updateString("restrictedResources[0].path", sbPath.getAsString());
jsonRc.updateString("restrictedResources[0].dataElements[0]", "buyerInfo");
jsonRc.updateString("restrictedResources[0].dataElements[1]", "shippingAddress");
StringBuilder sbRequest = new StringBuilder();
jsonRc.emitSb(sbRequest);
StringBuilder sbResponse = new StringBuilder();
String uri = "/tokens/2021-03-01/restrictedDataToken";
try {
rest.fullRequestSb("POST", uri, sbRequest, sbResponse);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
// Examine the response status.
int statusCode = rest.getResponseStatusCode();
if (statusCode != 200) {
System.out.println("Response status code: " + statusCode);
System.out.println("Response status text: " + rest.getResponseStatusText());
System.out.println("Response body: ");
System.out.println(sbResponse.getAsString());
System.out.println("Failed.");
return;
}
// Get the restricted data token.
JsonObject jsonResp = new JsonObject();
jsonResp.loadSb(sbResponse);
String restrictedDataToken = jsonResp.stringOf("restrictedDataToken");
System.out.println("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);
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}";
rest.fullRequestNoBodySb("GET", uri, sbResponse);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
// Examine the response status.
statusCode = rest.getResponseStatusCode();
if (statusCode != 200) {
System.out.println("Response status text: " + rest.getResponseStatusText());
System.out.println("Response body: ");
System.out.println(sbResponse.getAsString());
System.out.println("Failed.");
return;
}
System.out.println(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
JsonObject json = new JsonObject();
json.loadSb(sbResponse);
String strVal = "";
String AmazonOrderId = json.stringOf("payload.AmazonOrderId");
String PurchaseDate = json.stringOf("payload.PurchaseDate");
String LastUpdateDate = json.stringOf("payload.LastUpdateDate");
String OrderStatus = json.stringOf("payload.OrderStatus");
String FulfillmentChannel = json.stringOf("payload.FulfillmentChannel");
String SalesChannel = json.stringOf("payload.SalesChannel");
String ShipServiceLevel = json.stringOf("payload.ShipServiceLevel");
String CurrencyCode = json.stringOf("payload.OrderTotal.CurrencyCode");
String Amount = json.stringOf("payload.OrderTotal.Amount");
int NumberOfItemsShipped = json.intOf("payload.NumberOfItemsShipped");
int NumberOfItemsUnshipped = json.intOf("payload.NumberOfItemsUnshipped");
String PaymentMethod = json.stringOf("payload.PaymentMethod");
boolean IsReplacementOrder = json.boolOf("payload.IsReplacementOrder");
String MarketplaceId = json.stringOf("payload.MarketplaceId");
String ShipmentServiceLevelCategory = json.stringOf("payload.ShipmentServiceLevelCategory");
String OrderType = json.stringOf("payload.OrderType");
String EarliestShipDate = json.stringOf("payload.EarliestShipDate");
String LatestShipDate = json.stringOf("payload.LatestShipDate");
String EarliestDeliveryDate = json.stringOf("payload.EarliestDeliveryDate");
String LatestDeliveryDate = json.stringOf("payload.LatestDeliveryDate");
boolean IsBusinessOrder = json.boolOf("payload.IsBusinessOrder");
boolean IsPrime = json.boolOf("payload.IsPrime");
boolean IsGlobalExpressEnabled = json.boolOf("payload.IsGlobalExpressEnabled");
boolean IsPremiumOrder = json.boolOf("payload.IsPremiumOrder");
boolean IsSoldByAB = json.boolOf("payload.IsSoldByAB");
boolean IsIBA = json.boolOf("payload.IsIBA");
String Name = json.stringOf("payload.DefaultShipFromLocationAddress.Name");
String AddressLine1 = json.stringOf("payload.DefaultShipFromLocationAddress.AddressLine1");
String City = json.stringOf("payload.DefaultShipFromLocationAddress.City");
String StateOrRegion = json.stringOf("payload.DefaultShipFromLocationAddress.StateOrRegion");
String PostalCode = json.stringOf("payload.DefaultShipFromLocationAddress.PostalCode");
String CountryCode = json.stringOf("payload.DefaultShipFromLocationAddress.CountryCode");
String Phone = json.stringOf("payload.DefaultShipFromLocationAddress.Phone");
String AddressType = json.stringOf("payload.DefaultShipFromLocationAddress.AddressType");
String FulfillmentSupplySourceId = json.stringOf("payload.FulfillmentInstruction.FulfillmentSupplySourceId");
boolean IsISPU = json.boolOf("payload.IsISPU");
boolean IsAccessPointOrder = json.boolOf("payload.IsAccessPointOrder");
boolean HasAutomatedShippingSettings = json.boolOf("payload.AutomatedShippingSettings.HasAutomatedShippingSettings");
String EasyShipShipmentStatus = json.stringOf("payload.EasyShipShipmentStatus");
String ElectronicInvoiceStatus = json.stringOf("payload.ElectronicInvoiceStatus");
int i = 0;
int count_i = json.sizeOfArray("payload.PaymentMethodDetails");
while (i < count_i) {
json.setI(i);
strVal = json.stringOf("payload.PaymentMethodDetails[i]");
i = i + 1;
}
System.out.println("Success!");
}
}