Java
Chilkat2 Java
Amazon SP-API Get Order Items
See more Amazon SP-API Examples
Returns detailed order item information for the order that you specify.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 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
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}/orderItems",
// "dataElements": ["buyerInfo"]
// }
// ]
// }
StringBuilder sbPath = new StringBuilder();
sbPath.append("/orders/v0/orders/");
sbPath.append(orderId);
sbPath.append("/orderItems");
JsonObject jsonRc = new JsonObject();
jsonRc.updateString("restrictedResources[0].method", "GET");
jsonRc.updateString("restrictedResources[0].path", sbPath.getAsString());
jsonRc.updateString("restrictedResources[0].dataElements[0]", "buyerInfo");
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}/orderItems";
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;
}
// 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
JsonObject json = new JsonObject();
json.loadSb(sbResponse);
json.setEmitCompact(false);
System.out.println(json.emit());
String ASIN = "";
String OrderItemId = "";
String SellerSKU = "";
String Title = "";
int QuantityOrdered = 0;
int QuantityShipped = 0;
int NumberOfItems = 0;
String CurrencyCode = "";
String Amount = "";
String ItemTaxCurrencyCode = "";
String ItemTaxAmount = "";
String PromotionDiscountCurrencyCode = "";
String PromotionDiscountAmount = "";
boolean IsGift = false;
String ConditionId = "";
String ConditionSubtypeId = "";
boolean IsTransparency = false;
boolean SerialNumberRequired = false;
String IossNumber = "";
String DeemedResellerCategory = "";
String StoreChainStoreId = "";
boolean IsBuyerRequestedCancel = false;
String BuyerCancelReason = "";
String AmazonOrderId = json.stringOf("payload.AmazonOrderId");
int i = 0;
int count_i = json.sizeOfArray("payload.OrderItems");
while (i < count_i) {
json.setI(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");
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;
}
System.out.println("Success!");
}
}