Swift
Swift
Amazon SP-API Get Order Items
See more Amazon SP-API Examples
Returns detailed order item information for the order that you specify.Chilkat Swift Downloads
func chilkatTest() {
var success: Bool = false
// 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
var orderId: String? = "TEST_CASE_200"
let authAws = CkoAuthAws()!
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
let jsonLwaToken = CkoJsonObject()!
success = jsonLwaToken.loadFile(path: "qa_data/tokens/sp_api_lwa_token.json")
if success == false {
print("Failed to load LWA access token.")
return
}
// Must use the non-sandbox domain for getting the RDT.
let rest = CkoRest()!
success = rest.connect(hostname: "sellingpartnerapi-eu.amazon.com", port: 443, tls: true, autoReconnect: true)
if success == false {
print("\(rest.lastErrorText!)")
return
}
success = rest.setAuthAws(authProvider: authAws)
// Add the x-amz-access-token request header.
var lwa_token: String? = jsonLwaToken.string(of: "access_token")
rest.clearAllHeaders()
rest.addHeader(name: "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}/orderItems",
// "dataElements": ["buyerInfo"]
// }
// ]
// }
let sbPath = CkoStringBuilder()!
sbPath.append(value: "/orders/v0/orders/")
sbPath.append(value: orderId)
sbPath.append(value: "/orderItems")
let jsonRc = CkoJsonObject()!
jsonRc.updateString(jsonPath: "restrictedResources[0].method", value: "GET")
jsonRc.updateString(jsonPath: "restrictedResources[0].path", value: sbPath.getAsString())
jsonRc.updateString(jsonPath: "restrictedResources[0].dataElements[0]", value: "buyerInfo")
let sbRequest = CkoStringBuilder()!
jsonRc.emitSb(sb: sbRequest)
let sbResponse = CkoStringBuilder()!
var uri: String? = "/tokens/2021-03-01/restrictedDataToken"
success = rest.fullRequestSb(httpVerb: "POST", uriPath: uri, requestBody: sbRequest, responseBody: sbResponse)
if success == false {
print("\(rest.lastErrorText!)")
return
}
// Examine the response status.
var statusCode: Int = rest.responseStatusCode.intValue
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.
let jsonResp = CkoJsonObject()!
jsonResp.loadSb(sb: sbResponse)
var restrictedDataToken: String? = jsonResp.string(of: "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(maxWaitMs: 100)
success = rest.connect(hostname: "sandbox.sellingpartnerapi-eu.amazon.com", port: 443, tls: true, autoReconnect: true)
if success == false {
print("\(rest.lastErrorText!)")
return
}
success = rest.setAuthAws(authProvider: authAws)
rest.clearAllHeaders()
rest.addHeader(name: "x-amz-access-token", value: restrictedDataToken)
rest.clearAllQueryParams()
rest.addQueryParam(name: "MarketplaceIds", value: "ATVPDKIKX0DER")
rest.clearAllPathParams()
rest.addPathParam(name: "{orderId}", value: orderId)
uri = "/orders/v0/orders/{orderId}/orderItems"
success = rest.fullRequestNoBodySb(httpVerb: "GET", uriPath: uri, sb: sbResponse)
if success == false {
print("\(rest.lastErrorText!)")
return
}
// Examine the response status.
statusCode = rest.responseStatusCode.intValue
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
let json = CkoJsonObject()!
json.loadSb(sb: sbResponse)
json.emitCompact = false
print("\(json.emit()!)")
var ASIN: String?
var OrderItemId: String?
var SellerSKU: String?
var Title: String?
var QuantityOrdered: Int
var QuantityShipped: Int
var NumberOfItems: Int
var CurrencyCode: String?
var Amount: String?
var ItemTaxCurrencyCode: String?
var ItemTaxAmount: String?
var PromotionDiscountCurrencyCode: String?
var PromotionDiscountAmount: String?
var IsGift: Bool
var ConditionId: String?
var ConditionSubtypeId: String?
var IsTransparency: Bool
var SerialNumberRequired: Bool
var IossNumber: String?
var DeemedResellerCategory: String?
var StoreChainStoreId: String?
var IsBuyerRequestedCancel: Bool
var BuyerCancelReason: String?
var AmazonOrderId: String? = json.string(of: "payload.AmazonOrderId")
var i: Int = 0
var count_i: Int = json.size(ofArray: "payload.OrderItems").intValue
while i < count_i {
json.i = i
ASIN = json.string(of: "payload.OrderItems[i].ASIN")
OrderItemId = json.string(of: "payload.OrderItems[i].OrderItemId")
SellerSKU = json.string(of: "payload.OrderItems[i].SellerSKU")
Title = json.string(of: "payload.OrderItems[i].Title")
QuantityOrdered = json.int(of: "payload.OrderItems[i].QuantityOrdered").intValue
QuantityShipped = json.int(of: "payload.OrderItems[i].QuantityShipped").intValue
NumberOfItems = json.int(of: "payload.OrderItems[i].ProductInfo.NumberOfItems").intValue
CurrencyCode = json.string(of: "payload.OrderItems[i].ItemPrice.CurrencyCode")
Amount = json.string(of: "payload.OrderItems[i].ItemPrice.Amount")
ItemTaxCurrencyCode = json.string(of: "payload.OrderItems[i].ItemTax.CurrencyCode")
ItemTaxAmount = json.string(of: "payload.OrderItems[i].ItemTax.Amount")
PromotionDiscountCurrencyCode = json.string(of: "payload.OrderItems[i].PromotionDiscount.CurrencyCode")
PromotionDiscountAmount = json.string(of: "payload.OrderItems[i].PromotionDiscount.Amount")
IsGift = json.bool(of: "payload.OrderItems[i].IsGift")
ConditionId = json.string(of: "payload.OrderItems[i].ConditionId")
ConditionSubtypeId = json.string(of: "payload.OrderItems[i].ConditionSubtypeId")
IsTransparency = json.bool(of: "payload.OrderItems[i].IsTransparency")
SerialNumberRequired = json.bool(of: "payload.OrderItems[i].SerialNumberRequired")
IossNumber = json.string(of: "payload.OrderItems[i].IossNumber")
DeemedResellerCategory = json.string(of: "payload.OrderItems[i].DeemedResellerCategory")
StoreChainStoreId = json.string(of: "payload.OrderItems[i].StoreChainStoreId")
IsBuyerRequestedCancel = json.bool(of: "payload.OrderItems[i].BuyerRequestedCancel.IsBuyerRequestedCancel")
BuyerCancelReason = json.string(of: "payload.OrderItems[i].BuyerRequestedCancel.BuyerCancelReason")
i = i + 1
}
print("Success!")
}