Back to Collection Items
#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttpW http;
bool success;
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "is_return_label": true,
// "rma_number": "123456789",
// "shipment": {
// "service_code": "usps_priority_mail",
// "ship_from": {
// "name": "Amanda Miller",
// "address_line1": "525 S Winchester Blvd",
// "city_locality": "San Jose",
// "state_province": "CA",
// "postal_code": "95128",
// "country_code": "US"
// },
// "ship_to": {
// "company_name": "Example Corp.",
// "address_line1": "4009 Marathon Blvd",
// "city_locality": "Austin",
// "state_province": "TX",
// "postal_code": "78756",
// "country_code": "US",
// "phone": "512-555-5555"
// },
// "packages": [
// {
// "weight": {
// "value": 17,
// "unit": "pound"
// },
// "dimensions": {
// "length": 36,
// "width": 12,
// "height": 24,
// "unit": "inch"
// }
// }
// ]
// }
// }
CkJsonObjectW json;
json.UpdateBool(L"is_return_label",true);
json.UpdateString(L"rma_number",L"123456789");
json.UpdateString(L"shipment.service_code",L"usps_priority_mail");
json.UpdateString(L"shipment.ship_from.name",L"Amanda Miller");
json.UpdateString(L"shipment.ship_from.address_line1",L"525 S Winchester Blvd");
json.UpdateString(L"shipment.ship_from.city_locality",L"San Jose");
json.UpdateString(L"shipment.ship_from.state_province",L"CA");
json.UpdateString(L"shipment.ship_from.postal_code",L"95128");
json.UpdateString(L"shipment.ship_from.country_code",L"US");
json.UpdateString(L"shipment.ship_to.company_name",L"Example Corp.");
json.UpdateString(L"shipment.ship_to.address_line1",L"4009 Marathon Blvd");
json.UpdateString(L"shipment.ship_to.city_locality",L"Austin");
json.UpdateString(L"shipment.ship_to.state_province",L"TX");
json.UpdateString(L"shipment.ship_to.postal_code",L"78756");
json.UpdateString(L"shipment.ship_to.country_code",L"US");
json.UpdateString(L"shipment.ship_to.phone",L"512-555-5555");
json.UpdateInt(L"shipment.packages[0].weight.value",17);
json.UpdateString(L"shipment.packages[0].weight.unit",L"pound");
json.UpdateInt(L"shipment.packages[0].dimensions.length",36);
json.UpdateInt(L"shipment.packages[0].dimensions.width",12);
json.UpdateInt(L"shipment.packages[0].dimensions.height",24);
json.UpdateString(L"shipment.packages[0].dimensions.unit",L"inch");
http.SetRequestHeader(L"API-Key",L"{{API_KEY}}");
http.SetRequestHeader(L"Content-Type",L"application/json");
CkHttpResponseW *resp = http.PostJson3(L"https://api.shipengine.com/v1/labels",L"application/json",json);
if (http.get_LastMethodSuccess() == false) {
wprintf(L"%s\n",http.lastErrorText());
return;
}
CkStringBuilderW sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonObjectW jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",jResp.emit());
int respStatusCode = resp->get_StatusCode();
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",resp->header());
wprintf(L"Failed.\n");
delete resp;
return;
}
delete resp;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "label_id": "se-1382827",
// "status": "completed",
// "shipment_id": "se-4151872",
// "ship_date": "2019-09-18T00:00:00Z",
// "created_at": "2019-09-18T13:55:37.0247767Z",
// "shipment_cost": {
// "currency": "usd",
// "amount": 98.14
// },
// "insurance_cost": {
// "currency": "usd",
// "amount": 0
// },
// "tracking_number": "9405511899564298878259",
// "is_return_label": true,
// "rma_number": "123456789",
// "is_international": false,
// "batch_id": "",
// "carrier_id": "se-121861",
// "service_code": "usps_priority_mail",
// "package_code": "package",
// "voided": false,
// "voided_at": null,
// "label_format": "pdf",
// "label_layout": "4x6",
// "trackable": true,
// "carrier_code": "stamps_com",
// "tracking_status": "in_transit",
// "label_download": {
// "pdf": "https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.pdf",
// "png": "https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.png",
// "zpl": "https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.zpl",
// "href": "https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.pdf"
// },
// "form_download": null,
// "insurance_claim": null,
// "packages": [
// {
// "package_code": "package",
// "weight": {
// "value": 17,
// "unit": "pound"
// },
// "dimensions": {
// "unit": "inch",
// "length": 36,
// "width": 12,
// "height": 24
// },
// "insured_value": {
// "currency": "usd",
// "amount": 0
// },
// "tracking_number": "9405511899564298878259",
// "label_messages": {
// "reference1": null,
// "reference2": null,
// "reference3": null
// },
// "external_package_id": null
// }
// ]
// }
// 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.
int Value;
const wchar_t *Unit = 0;
const wchar_t *dimensionsUnit = 0;
int Length;
int Width;
int Height;
const wchar_t *insured_valueCurrency = 0;
int insured_valueAmount;
const wchar_t *Reference1 = 0;
const wchar_t *Reference2 = 0;
const wchar_t *Reference3 = 0;
const wchar_t *external_package_id = 0;
const wchar_t *label_id = jResp.stringOf(L"label_id");
const wchar_t *status = jResp.stringOf(L"status");
const wchar_t *shipment_id = jResp.stringOf(L"shipment_id");
const wchar_t *ship_date = jResp.stringOf(L"ship_date");
const wchar_t *created_at = jResp.stringOf(L"created_at");
const wchar_t *v_Currency = jResp.stringOf(L"shipment_cost.currency");
const wchar_t *Amount = jResp.stringOf(L"shipment_cost.amount");
const wchar_t *insurance_costCurrency = jResp.stringOf(L"insurance_cost.currency");
int insurance_costAmount = jResp.IntOf(L"insurance_cost.amount");
const wchar_t *tracking_number = jResp.stringOf(L"tracking_number");
bool is_return_label = jResp.BoolOf(L"is_return_label");
const wchar_t *rma_number = jResp.stringOf(L"rma_number");
bool is_international = jResp.BoolOf(L"is_international");
const wchar_t *batch_id = jResp.stringOf(L"batch_id");
const wchar_t *carrier_id = jResp.stringOf(L"carrier_id");
const wchar_t *service_code = jResp.stringOf(L"service_code");
const wchar_t *package_code = jResp.stringOf(L"package_code");
bool voided = jResp.BoolOf(L"voided");
const wchar_t *voided_at = jResp.stringOf(L"voided_at");
const wchar_t *label_format = jResp.stringOf(L"label_format");
const wchar_t *label_layout = jResp.stringOf(L"label_layout");
bool trackable = jResp.BoolOf(L"trackable");
const wchar_t *carrier_code = jResp.stringOf(L"carrier_code");
const wchar_t *tracking_status = jResp.stringOf(L"tracking_status");
const wchar_t *v_Pdf = jResp.stringOf(L"label_download.pdf");
const wchar_t *Png = jResp.stringOf(L"label_download.png");
const wchar_t *Zpl = jResp.stringOf(L"label_download.zpl");
const wchar_t *Href = jResp.stringOf(L"label_download.href");
const wchar_t *form_download = jResp.stringOf(L"form_download");
const wchar_t *insurance_claim = jResp.stringOf(L"insurance_claim");
int i = 0;
int count_i = jResp.SizeOfArray(L"packages");
while (i < count_i) {
jResp.put_I(i);
package_code = jResp.stringOf(L"packages[i].package_code");
Value = jResp.IntOf(L"packages[i].weight.value");
Unit = jResp.stringOf(L"packages[i].weight.unit");
dimensionsUnit = jResp.stringOf(L"packages[i].dimensions.unit");
Length = jResp.IntOf(L"packages[i].dimensions.length");
Width = jResp.IntOf(L"packages[i].dimensions.width");
Height = jResp.IntOf(L"packages[i].dimensions.height");
insured_valueCurrency = jResp.stringOf(L"packages[i].insured_value.currency");
insured_valueAmount = jResp.IntOf(L"packages[i].insured_value.amount");
tracking_number = jResp.stringOf(L"packages[i].tracking_number");
Reference1 = jResp.stringOf(L"packages[i].label_messages.reference1");
Reference2 = jResp.stringOf(L"packages[i].label_messages.reference2");
Reference3 = jResp.stringOf(L"packages[i].label_messages.reference3");
external_package_id = jResp.stringOf(L"packages[i].external_package_id");
i = i + 1;
}
}
Curl Command
curl -X POST
-H "API-Key: {{API_KEY}}"
-H "Content-Type: application/json"
-d '{
"is_return_label": true,
"rma_number": "123456789",
"shipment": {
"service_code": "usps_priority_mail",
"ship_from": {
"name": "Amanda Miller",
"address_line1": "525 S Winchester Blvd",
"city_locality": "San Jose",
"state_province": "CA",
"postal_code": "95128",
"country_code": "US"
},
"ship_to": {
"company_name": "Example Corp.",
"address_line1": "4009 Marathon Blvd",
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"phone": "512-555-5555"
},
"packages": [
{
"weight": {
"value": 17,
"unit": "pound"
},
"dimensions": {
"length": 36,
"width": 12,
"height": 24,
"unit": "inch"
}
}
]
}
}'
https://api.shipengine.com/v1/labels
Postman Collection Item JSON
{
"name": "Create a return label",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"is_return_label\": true,\n\t\"rma_number\": \"123456789\",\n\t\"shipment\": {\n\t\t\"service_code\": \"usps_priority_mail\",\n\t\t\"ship_from\": {\n\t\t\t\"name\": \"Amanda Miller\",\n\t\t\t\"address_line1\": \"525 S Winchester Blvd\",\n\t\t\t\"city_locality\": \"San Jose\",\n\t\t\t\"state_province\": \"CA\",\n\t\t\t\"postal_code\": \"95128\",\n\t\t\t\"country_code\": \"US\"\n\t\t},\n\t\t\"ship_to\": {\n\t\t\t\"company_name\": \"Example Corp.\",\n\t\t\t\"address_line1\": \"4009 Marathon Blvd\",\n\t\t\t\"city_locality\": \"Austin\",\n\t\t\t\"state_province\": \"TX\",\n\t\t\t\"postal_code\": \"78756\",\n\t\t\t\"country_code\": \"US\",\n\t\t\t\"phone\": \"512-555-5555\"\n\t\t},\n\t\t\"packages\": [\n\t\t\t{\n\t\t\t\t\"weight\": {\n\t\t\t\t\t\"value\": 17,\n\t\t\t\t\t\"unit\": \"pound\"\n\t\t\t\t},\n\t\t\t\t\"dimensions\": {\n\t\t\t\t\t\"length\": 36,\n\t\t\t\t\t\"width\": 12,\n\t\t\t\t\t\"height\": 24,\n\t\t\t\t\t\"unit\": \"inch\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n}"
},
"url": {
"raw": "https://api.shipengine.com/v1/labels",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"labels"
]
},
"description": "Return labels are created just like outgoing labels, but with an additional `is_return_label` flag. You can also optionally specify an `rma_number` (Return Merchandise Authorization)"
},
"response": [
{
"name": "Create a return label",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"is_return_label\": true,\n\t\"rma_number\": \"123456789\",\n\t\"shipment\": {\n\t\t\"service_code\": \"usps_priority_mail\",\n\t\t\"ship_from\": {\n\t\t\t\"name\": \"Amanda Miller\",\n\t\t\t\"address_line1\": \"525 S Winchester Blvd\",\n\t\t\t\"city_locality\": \"San Jose\",\n\t\t\t\"state_province\": \"CA\",\n\t\t\t\"postal_code\": \"95128\",\n\t\t\t\"country_code\": \"US\"\n\t\t},\n\t\t\"ship_to\": {\n\t\t\t\"company_name\": \"Example Corp.\",\n\t\t\t\"address_line1\": \"4009 Marathon Blvd\",\n\t\t\t\"city_locality\": \"Austin\",\n\t\t\t\"state_province\": \"TX\",\n\t\t\t\"postal_code\": \"78756\",\n\t\t\t\"country_code\": \"US\",\n\t\t\t\"phone\": \"512-555-5555\"\n\t\t},\n\t\t\"packages\": [\n\t\t\t{\n\t\t\t\t\"weight\": {\n\t\t\t\t\t\"value\": 17,\n\t\t\t\t\t\"unit\": \"pound\"\n\t\t\t\t},\n\t\t\t\t\"dimensions\": {\n\t\t\t\t\t\"length\": 36,\n\t\t\t\t\t\"width\": 12,\n\t\t\t\t\t\"height\": 24,\n\t\t\t\t\t\"unit\": \"inch\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.shipengine.com/v1/labels",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"labels"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 18 Sep 2019 13:55:37 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "1826"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "e876812b-185e-432d-ac30-f65a3ff3b3ef"
}
],
"cookie": [
],
"body": "{\n \"label_id\": \"se-1382827\",\n \"status\": \"completed\",\n \"shipment_id\": \"se-4151872\",\n \"ship_date\": \"2019-09-18T00:00:00Z\",\n \"created_at\": \"2019-09-18T13:55:37.0247767Z\",\n \"shipment_cost\": {\n \"currency\": \"usd\",\n \"amount\": 98.14\n },\n \"insurance_cost\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"tracking_number\": \"9405511899564298878259\",\n \"is_return_label\": true,\n \"rma_number\": \"123456789\",\n \"is_international\": false,\n \"batch_id\": \"\",\n \"carrier_id\": \"se-121861\",\n \"service_code\": \"usps_priority_mail\",\n \"package_code\": \"package\",\n \"voided\": false,\n \"voided_at\": null,\n \"label_format\": \"pdf\",\n \"label_layout\": \"4x6\",\n \"trackable\": true,\n \"carrier_code\": \"stamps_com\",\n \"tracking_status\": \"in_transit\",\n \"label_download\": {\n \"pdf\": \"https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.pdf\",\n \"png\": \"https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.png\",\n \"zpl\": \"https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.zpl\",\n \"href\": \"https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.pdf\"\n },\n \"form_download\": null,\n \"insurance_claim\": null,\n \"packages\": [\n {\n \"package_code\": \"package\",\n \"weight\": {\n \"value\": 17,\n \"unit\": \"pound\"\n },\n \"dimensions\": {\n \"unit\": \"inch\",\n \"length\": 36,\n \"width\": 12,\n \"height\": 24\n },\n \"insured_value\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"tracking_number\": \"9405511899564298878259\",\n \"label_messages\": {\n \"reference1\": null,\n \"reference2\": null,\n \"reference3\": null\n },\n \"external_package_id\": null\n }\n ]\n}"
}
]
}
