Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *orderItemId;
int j;
int count_j;
const wchar_t *strVal;
const wchar_t *Length;
const wchar_t *Width;
const wchar_t *Height;
const wchar_t *Unit;
const wchar_t *Identifier;
const wchar_t *SlotId;
const wchar_t *StartTime;
const wchar_t *EndTime;
const wchar_t *HandoverMethod;
const wchar_t *Value;
const wchar_t *packageWeightUnit;
const wchar_t *AmazonOrderId;
const wchar_t *PackageId;
const wchar_t *packageIdentifier;
const wchar_t *InvoiceNumber;
const wchar_t *InvoiceDate;
const wchar_t *packageStatus;
const wchar_t *TrackingId;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(queryParams,L"amazonOrderId",L"nisi non tempor minim");
CkJsonObjectW_UpdateString(queryParams,L"marketplaceId",L"nisi non tempor minim");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://sellingpartnerapi-na.amazon.com/easyShip/2022-03-23/package",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "packageDimensions": {
// "length": 92908506.38751999,
// "width": 69740717.24177761,
// "height": 55703784.11292852,
// "unit": "Cm",
// "identifier": "velit elit incididunt"
// },
// "packageTimeSlot": {
// "slotId": "id sit ut elit",
// "startTime": "2015-08-10T18:15:47.176Z",
// "endTime": "1974-01-15T04:04:16.651Z",
// "handoverMethod": "Dropoff"
// },
// "packageWeight": {
// "value": 22615253.265217148,
// "unit": "Grams"
// },
// "scheduledPackageId": {
// "amazonOrderId": "eu ex pariatur mollit",
// "packageId": "la"
// },
// "packageItems": [
// {
// "orderItemId": "irure in",
// "orderItemSerialNumbers": [
// "est qui magna dolor in",
// "do sint consequat"
// ]
// },
// {
// "orderItemId": "incididunt proident",
// "orderItemSerialNumbers": [
// "amet",
// "ex"
// ]
// }
// ],
// "packageIdentifier": "Lorem",
// "invoice": {
// "invoiceNumber": "esse non",
// "invoiceDate": "2020-10-09T01:25:28.191Z"
// },
// "packageStatus": "AtDestinationFC",
// "trackingDetails": {
// "trackingId": "dolor est aute"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
Length = CkJsonObjectW_stringOf(jResp,L"packageDimensions.length");
Width = CkJsonObjectW_stringOf(jResp,L"packageDimensions.width");
Height = CkJsonObjectW_stringOf(jResp,L"packageDimensions.height");
Unit = CkJsonObjectW_stringOf(jResp,L"packageDimensions.unit");
Identifier = CkJsonObjectW_stringOf(jResp,L"packageDimensions.identifier");
SlotId = CkJsonObjectW_stringOf(jResp,L"packageTimeSlot.slotId");
StartTime = CkJsonObjectW_stringOf(jResp,L"packageTimeSlot.startTime");
EndTime = CkJsonObjectW_stringOf(jResp,L"packageTimeSlot.endTime");
HandoverMethod = CkJsonObjectW_stringOf(jResp,L"packageTimeSlot.handoverMethod");
Value = CkJsonObjectW_stringOf(jResp,L"packageWeight.value");
packageWeightUnit = CkJsonObjectW_stringOf(jResp,L"packageWeight.unit");
AmazonOrderId = CkJsonObjectW_stringOf(jResp,L"scheduledPackageId.amazonOrderId");
PackageId = CkJsonObjectW_stringOf(jResp,L"scheduledPackageId.packageId");
packageIdentifier = CkJsonObjectW_stringOf(jResp,L"packageIdentifier");
InvoiceNumber = CkJsonObjectW_stringOf(jResp,L"invoice.invoiceNumber");
InvoiceDate = CkJsonObjectW_stringOf(jResp,L"invoice.invoiceDate");
packageStatus = CkJsonObjectW_stringOf(jResp,L"packageStatus");
TrackingId = CkJsonObjectW_stringOf(jResp,L"trackingDetails.trackingId");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"packageItems");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
orderItemId = CkJsonObjectW_stringOf(jResp,L"packageItems[i].orderItemId");
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"packageItems[i].orderItemSerialNumbers");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
strVal = CkJsonObjectW_stringOf(jResp,L"packageItems[i].orderItemSerialNumbers[j]");
j = j + 1;
}
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -G -d "amazonOrderId=nisi%20non%20tempor%20minim"
-d "marketplaceId=nisi%20non%20tempor%20minim"
-H "Accept: application/json"
https://sellingpartnerapi-na.amazon.com/easyShip/2022-03-23/package
Postman Collection Item JSON
{
"name": "get Scheduled Package",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/package?amazonOrderId=nisi non tempor minim&marketplaceId=nisi non tempor minim",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"package"
],
"query": [
{
"key": "amazonOrderId",
"value": "nisi non tempor minim",
"description": "(Required) An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship."
},
{
"key": "marketplaceId",
"value": "nisi non tempor minim",
"description": "(Required) An identifier for the marketplace in which the seller is selling."
}
]
},
"description": "Returns information about a package, including dimensions, weight, time slot information for handover, invoice and item information, and status.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 5 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api)."
},
"response": [
{
"name": "Success.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/package?amazonOrderId=nisi non tempor minim&marketplaceId=nisi non tempor minim",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"package"
],
"query": [
{
"key": "amazonOrderId",
"value": "nisi non tempor minim"
},
{
"key": "marketplaceId",
"value": "nisi non tempor minim"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RateLimit-Limit",
"value": "do anim",
"description": "Your rate limit (requests per second) for this operation."
},
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"packageDimensions\": {\n \"length\": 92908506.38751999,\n \"width\": 69740717.24177761,\n \"height\": 55703784.11292852,\n \"unit\": \"Cm\",\n \"identifier\": \"velit elit incididunt\"\n },\n \"packageTimeSlot\": {\n \"slotId\": \"id sit ut elit\",\n \"startTime\": \"2015-08-10T18:15:47.176Z\",\n \"endTime\": \"1974-01-15T04:04:16.651Z\",\n \"handoverMethod\": \"Dropoff\"\n },\n \"packageWeight\": {\n \"value\": 22615253.265217148,\n \"unit\": \"Grams\"\n },\n \"scheduledPackageId\": {\n \"amazonOrderId\": \"eu ex pariatur mollit\",\n \"packageId\": \"la\"\n },\n \"packageItems\": [\n {\n \"orderItemId\": \"irure in\",\n \"orderItemSerialNumbers\": [\n \"est qui magna dolor in\",\n \"do sint consequat\"\n ]\n },\n {\n \"orderItemId\": \"incididunt proident\",\n \"orderItemSerialNumbers\": [\n \"amet\",\n \"ex\"\n ]\n }\n ],\n \"packageIdentifier\": \"Lorem\",\n \"invoice\": {\n \"invoiceNumber\": \"esse non\",\n \"invoiceDate\": \"2020-10-09T01:25:28.191Z\"\n },\n \"packageStatus\": \"AtDestinationFC\",\n \"trackingDetails\": {\n \"trackingId\": \"dolor est aute\"\n }\n}"
},
{
"name": "Request has missing or invalid parameters and cannot be parsed.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/package?amazonOrderId=nisi non tempor minim&marketplaceId=nisi non tempor minim",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"package"
],
"query": [
{
"key": "amazonOrderId",
"value": "nisi non tempor minim"
},
{
"key": "marketplaceId",
"value": "nisi non tempor minim"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RateLimit-Limit",
"value": "do anim",
"description": "Your rate limit (requests per second) for this operation."
},
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"minim nisi sint\",\n \"message\": \"irure sed dolor\",\n \"details\": \"officia consectetur Excepteur\"\n },\n {\n \"code\": \"Ut do\",\n \"message\": \"non nisi ipsum\",\n \"details\": \"Ut\"\n }\n ]\n}"
},
{
"name": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/package?amazonOrderId=nisi non tempor minim&marketplaceId=nisi non tempor minim",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"package"
],
"query": [
{
"key": "amazonOrderId",
"value": "nisi non tempor minim"
},
{
"key": "marketplaceId",
"value": "nisi non tempor minim"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RateLimit-Limit",
"value": "do anim",
"description": "Your rate limit (requests per second) for this operation."
},
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"minim nisi sint\",\n \"message\": \"irure sed dolor\",\n \"details\": \"officia consectetur Excepteur\"\n },\n {\n \"code\": \"Ut do\",\n \"message\": \"non nisi ipsum\",\n \"details\": \"Ut\"\n }\n ]\n}"
},
{
"name": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/package?amazonOrderId=nisi non tempor minim&marketplaceId=nisi non tempor minim",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"package"
],
"query": [
{
"key": "amazonOrderId",
"value": "nisi non tempor minim"
},
{
"key": "marketplaceId",
"value": "nisi non tempor minim"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"minim nisi sint\",\n \"message\": \"irure sed dolor\",\n \"details\": \"officia consectetur Excepteur\"\n },\n {\n \"code\": \"Ut do\",\n \"message\": \"non nisi ipsum\",\n \"details\": \"Ut\"\n }\n ]\n}"
},
{
"name": "The specified resource does not exist.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/package?amazonOrderId=nisi non tempor minim&marketplaceId=nisi non tempor minim",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"package"
],
"query": [
{
"key": "amazonOrderId",
"value": "nisi non tempor minim"
},
{
"key": "marketplaceId",
"value": "nisi non tempor minim"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RateLimit-Limit",
"value": "do anim",
"description": "Your rate limit (requests per second) for this operation."
},
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"minim nisi sint\",\n \"message\": \"irure sed dolor\",\n \"details\": \"officia consectetur Excepteur\"\n },\n {\n \"code\": \"Ut do\",\n \"message\": \"non nisi ipsum\",\n \"details\": \"Ut\"\n }\n ]\n}"
},
{
"name": "The request payload is in an unsupported format.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/package?amazonOrderId=nisi non tempor minim&marketplaceId=nisi non tempor minim",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"package"
],
"query": [
{
"key": "amazonOrderId",
"value": "nisi non tempor minim"
},
{
"key": "marketplaceId",
"value": "nisi non tempor minim"
}
]
}
},
"status": "Unsupported Media Type",
"code": 415,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"minim nisi sint\",\n \"message\": \"irure sed dolor\",\n \"details\": \"officia consectetur Excepteur\"\n },\n {\n \"code\": \"Ut do\",\n \"message\": \"non nisi ipsum\",\n \"details\": \"Ut\"\n }\n ]\n}"
},
{
"name": "The frequency of requests was greater than allowed.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/package?amazonOrderId=nisi non tempor minim&marketplaceId=nisi non tempor minim",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"package"
],
"query": [
{
"key": "amazonOrderId",
"value": "nisi non tempor minim"
},
{
"key": "marketplaceId",
"value": "nisi non tempor minim"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"minim nisi sint\",\n \"message\": \"irure sed dolor\",\n \"details\": \"officia consectetur Excepteur\"\n },\n {\n \"code\": \"Ut do\",\n \"message\": \"non nisi ipsum\",\n \"details\": \"Ut\"\n }\n ]\n}"
},
{
"name": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/package?amazonOrderId=nisi non tempor minim&marketplaceId=nisi non tempor minim",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"package"
],
"query": [
{
"key": "amazonOrderId",
"value": "nisi non tempor minim"
},
{
"key": "marketplaceId",
"value": "nisi non tempor minim"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"minim nisi sint\",\n \"message\": \"irure sed dolor\",\n \"details\": \"officia consectetur Excepteur\"\n },\n {\n \"code\": \"Ut do\",\n \"message\": \"non nisi ipsum\",\n \"details\": \"Ut\"\n }\n ]\n}"
},
{
"name": "Temporary overloading or maintenance of the server.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/easyShip/2022-03-23/package?amazonOrderId=nisi non tempor minim&marketplaceId=nisi non tempor minim",
"host": [
"{{baseUrl}}"
],
"path": [
"easyShip",
"2022-03-23",
"package"
],
"query": [
{
"key": "amazonOrderId",
"value": "nisi non tempor minim"
},
{
"key": "marketplaceId",
"value": "nisi non tempor minim"
}
]
}
},
"status": "Service Unavailable",
"code": 503,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RequestId",
"value": "do anim",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"minim nisi sint\",\n \"message\": \"irure sed dolor\",\n \"details\": \"officia consectetur Excepteur\"\n },\n {\n \"code\": \"Ut do\",\n \"message\": \"non nisi ipsum\",\n \"details\": \"Ut\"\n }\n ]\n}"
}
]
}
