Chilkat Online Tools

C++ / ShipEngine Walkthrough / Label messages (reference fields)

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp 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.

    // {
    //   "shipment": {
    //     "service_code": "usps_priority_mail",
    //     "ship_from": {
    //       "name": "John Doe",
    //       "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"
    //     },
    //     "ship_to": {
    //       "name": "Amanda Miller",
    //       "address_line1": "525 S Winchester Blvd",
    //       "city_locality": "San Jose",
    //       "state_province": "CA",
    //       "postal_code": "95128",
    //       "country_code": "US"
    //     },
    //     "packages": [
    //       {
    //         "weight": {
    //           "value": 17,
    //           "unit": "pound"
    //         },
    //         "dimensions": {
    //           "length": 36,
    //           "width": 12,
    //           "height": 24,
    //           "unit": "inch"
    //         },
    //         "label_messages": {
    //           "reference1": "AAAAAAAAAAAAAAA",
    //           "reference2": "BBBBBBBBBBBBBBB",
    //           "reference3": "CCCCCCCCCCCCCCC"
    //         }
    //       }
    //     ]
    //   }
    // }

    CkJsonObject json;
    json.UpdateString("shipment.service_code","usps_priority_mail");
    json.UpdateString("shipment.ship_from.name","John Doe");
    json.UpdateString("shipment.ship_from.company_name","Example Corp.");
    json.UpdateString("shipment.ship_from.address_line1","4009 Marathon Blvd");
    json.UpdateString("shipment.ship_from.city_locality","Austin");
    json.UpdateString("shipment.ship_from.state_province","TX");
    json.UpdateString("shipment.ship_from.postal_code","78756");
    json.UpdateString("shipment.ship_from.country_code","US");
    json.UpdateString("shipment.ship_from.phone","512-555-5555");
    json.UpdateString("shipment.ship_to.name","Amanda Miller");
    json.UpdateString("shipment.ship_to.address_line1","525 S Winchester Blvd");
    json.UpdateString("shipment.ship_to.city_locality","San Jose");
    json.UpdateString("shipment.ship_to.state_province","CA");
    json.UpdateString("shipment.ship_to.postal_code","95128");
    json.UpdateString("shipment.ship_to.country_code","US");
    json.UpdateInt("shipment.packages[0].weight.value",17);
    json.UpdateString("shipment.packages[0].weight.unit","pound");
    json.UpdateInt("shipment.packages[0].dimensions.length",36);
    json.UpdateInt("shipment.packages[0].dimensions.width",12);
    json.UpdateInt("shipment.packages[0].dimensions.height",24);
    json.UpdateString("shipment.packages[0].dimensions.unit","inch");
    json.UpdateString("shipment.packages[0].label_messages.reference1","AAAAAAAAAAAAAAA");
    json.UpdateString("shipment.packages[0].label_messages.reference2","BBBBBBBBBBBBBBB");
    json.UpdateString("shipment.packages[0].label_messages.reference3","CCCCCCCCCCCCCCC");

    http.SetRequestHeader("API-Key","{{API_KEY}}");
    http.SetRequestHeader("Content-Type","application/json");

    CkHttpResponse *resp = http.PostJson3("https://api.shipengine.com/v1/labels","application/json",json);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "label_id": "se-1387921",
    //   "status": "completed",
    //   "shipment_id": "se-4159604",
    //   "ship_date": "2019-09-18T00:00:00Z",
    //   "created_at": "2019-09-18T15:56:29.2745108Z",
    //   "shipment_cost": {
    //     "currency": "usd",
    //     "amount": 98.14
    //   },
    //   "insurance_cost": {
    //     "currency": "usd",
    //     "amount": 0
    //   },
    //   "tracking_number": "9405511899564298877610",
    //   "is_return_label": false,
    //   "rma_number": null,
    //   "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/J963EZk9hkGqG4aN3JQ3bw/label-1387921.pdf",
    //     "png": "https://api.shipengine.com/v1/downloads/10/J963EZk9hkGqG4aN3JQ3bw/label-1387921.png",
    //     "zpl": "https://api.shipengine.com/v1/downloads/10/J963EZk9hkGqG4aN3JQ3bw/label-1387921.zpl",
    //     "href": "https://api.shipengine.com/v1/downloads/10/J963EZk9hkGqG4aN3JQ3bw/label-1387921.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": "9405511899564298877610",
    //       "label_messages": {
    //         "reference1": "AAAAAAAAAAAAAAA",
    //         "reference2": "BBBBBBBBBBBBBBB",
    //         "reference3": "CCCCCCCCCCCCCCC"
    //       },
    //       "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 char *Unit = 0;
    const char *dimensionsUnit = 0;
    int Length;
    int Width;
    int Height;
    const char *insured_valueCurrency = 0;
    int insured_valueAmount;
    const char *Reference1 = 0;
    const char *Reference2 = 0;
    const char *Reference3 = 0;
    const char *external_package_id = 0;

    const char *label_id = jResp.stringOf("label_id");
    const char *status = jResp.stringOf("status");
    const char *shipment_id = jResp.stringOf("shipment_id");
    const char *ship_date = jResp.stringOf("ship_date");
    const char *created_at = jResp.stringOf("created_at");
    const char *v_Currency = jResp.stringOf("shipment_cost.currency");
    const char *Amount = jResp.stringOf("shipment_cost.amount");
    const char *insurance_costCurrency = jResp.stringOf("insurance_cost.currency");
    int insurance_costAmount = jResp.IntOf("insurance_cost.amount");
    const char *tracking_number = jResp.stringOf("tracking_number");
    bool is_return_label = jResp.BoolOf("is_return_label");
    const char *rma_number = jResp.stringOf("rma_number");
    bool is_international = jResp.BoolOf("is_international");
    const char *batch_id = jResp.stringOf("batch_id");
    const char *carrier_id = jResp.stringOf("carrier_id");
    const char *service_code = jResp.stringOf("service_code");
    const char *package_code = jResp.stringOf("package_code");
    bool voided = jResp.BoolOf("voided");
    const char *voided_at = jResp.stringOf("voided_at");
    const char *label_format = jResp.stringOf("label_format");
    const char *label_layout = jResp.stringOf("label_layout");
    bool trackable = jResp.BoolOf("trackable");
    const char *carrier_code = jResp.stringOf("carrier_code");
    const char *tracking_status = jResp.stringOf("tracking_status");
    const char *v_Pdf = jResp.stringOf("label_download.pdf");
    const char *Png = jResp.stringOf("label_download.png");
    const char *Zpl = jResp.stringOf("label_download.zpl");
    const char *Href = jResp.stringOf("label_download.href");
    const char *form_download = jResp.stringOf("form_download");
    const char *insurance_claim = jResp.stringOf("insurance_claim");
    int i = 0;
    int count_i = jResp.SizeOfArray("packages");
    while (i < count_i) {
        jResp.put_I(i);
        package_code = jResp.stringOf("packages[i].package_code");
        Value = jResp.IntOf("packages[i].weight.value");
        Unit = jResp.stringOf("packages[i].weight.unit");
        dimensionsUnit = jResp.stringOf("packages[i].dimensions.unit");
        Length = jResp.IntOf("packages[i].dimensions.length");
        Width = jResp.IntOf("packages[i].dimensions.width");
        Height = jResp.IntOf("packages[i].dimensions.height");
        insured_valueCurrency = jResp.stringOf("packages[i].insured_value.currency");
        insured_valueAmount = jResp.IntOf("packages[i].insured_value.amount");
        tracking_number = jResp.stringOf("packages[i].tracking_number");
        Reference1 = jResp.stringOf("packages[i].label_messages.reference1");
        Reference2 = jResp.stringOf("packages[i].label_messages.reference2");
        Reference3 = jResp.stringOf("packages[i].label_messages.reference3");
        external_package_id = jResp.stringOf("packages[i].external_package_id");
        i = i + 1;
    }
    }

Curl Command

curl -X POST
	-H "API-Key: {{API_KEY}}"
	-H "Content-Type: application/json"
	-d '{
	"shipment": {
		"service_code": "usps_priority_mail",
		"ship_from": {
			"name": "John Doe",
			"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"
		},
		"ship_to": {
			"name": "Amanda Miller",
			"address_line1": "525 S Winchester Blvd",
			"city_locality": "San Jose",
			"state_province": "CA",
			"postal_code": "95128",
			"country_code": "US"
		},
		"packages": [
			{
				"weight": {
					"value": 17,
					"unit": "pound"
				},
				"dimensions": {
					"length": 36,
					"width": 12,
					"height": 24,
					"unit": "inch"
				},
				"label_messages": {
					"reference1": "AAAAAAAAAAAAAAA",
					"reference2": "BBBBBBBBBBBBBBB",
					"reference3": "CCCCCCCCCCCCCCC"
				}
			}
		]
	}
}'
https://api.shipengine.com/v1/labels

Postman Collection Item JSON

{
  "name": "Label messages (reference fields)",
  "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\"shipment\": {\n\t\t\"service_code\": \"usps_priority_mail\",\n\t\t\"ship_from\": {\n\t\t\t\"name\": \"John Doe\",\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\"ship_to\": {\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\"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\t\"label_messages\": {\n\t\t\t\t\t\"reference1\": \"AAAAAAAAAAAAAAA\",\n\t\t\t\t\t\"reference2\": \"BBBBBBBBBBBBBBB\",\n\t\t\t\t\t\"reference3\": \"CCCCCCCCCCCCCCC\"\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": "Label messages can be used for a number of reasons; but, primarily are used for reference numbers or internal tracking messages. You can add separate label messages to each package in a shipment."
  },
  "response": [
    {
      "name": "Label messages (reference fields)",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "type": "text",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n\t\"shipment\": {\n\t\t\"service_code\": \"usps_priority_mail\",\n\t\t\"ship_from\": {\n\t\t\t\"name\": \"John Doe\",\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\"ship_to\": {\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\"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\t\"label_messages\": {\n\t\t\t\t\t\"reference1\": \"AAAAAAAAAAAAAAA\",\n\t\t\t\t\t\"reference2\": \"BBBBBBBBBBBBBBB\",\n\t\t\t\t\t\"reference3\": \"CCCCCCCCCCCCCCC\"\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 15:56:30 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "1859"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "https://www.shipengine.com"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "server",
          "value": "Microsoft-IIS/8.0"
        },
        {
          "key": "x-newrelic-app-data",
          "value": "PxQGVFZXCgITVVZbAwMCV1YGFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GC0HAV1fQ0sxF0VSXwcXVHpSAAMPQBxSFlIUCRoDB1MKVQhYAk5cAAZNRCd5A3NXUVMEc3FVUQBzdVtETwRRDksHZQ=="
        },
        {
          "key": "x-powered-by",
          "value": "ASP.NET"
        },
        {
          "key": "x-shipengine-environment",
          "value": "j"
        },
        {
          "key": "x-shipengine-requestid",
          "value": "3be69b3d-c0d6-49e8-8628-2c0c1ffe93e7"
        },
        {
          "key": "x-shipengine-server",
          "value": "SS-J-WEB03"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"label_id\": \"se-1387921\",\n    \"status\": \"completed\",\n    \"shipment_id\": \"se-4159604\",\n    \"ship_date\": \"2019-09-18T00:00:00Z\",\n    \"created_at\": \"2019-09-18T15:56:29.2745108Z\",\n    \"shipment_cost\": {\n        \"currency\": \"usd\",\n        \"amount\": 98.14\n    },\n    \"insurance_cost\": {\n        \"currency\": \"usd\",\n        \"amount\": 0\n    },\n    \"tracking_number\": \"9405511899564298877610\",\n    \"is_return_label\": false,\n    \"rma_number\": null,\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/J963EZk9hkGqG4aN3JQ3bw/label-1387921.pdf\",\n        \"png\": \"https://api.shipengine.com/v1/downloads/10/J963EZk9hkGqG4aN3JQ3bw/label-1387921.png\",\n        \"zpl\": \"https://api.shipengine.com/v1/downloads/10/J963EZk9hkGqG4aN3JQ3bw/label-1387921.zpl\",\n        \"href\": \"https://api.shipengine.com/v1/downloads/10/J963EZk9hkGqG4aN3JQ3bw/label-1387921.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\": \"9405511899564298877610\",\n            \"label_messages\": {\n                \"reference1\": \"AAAAAAAAAAAAAAA\",\n                \"reference2\": \"BBBBBBBBBBBBBBB\",\n                \"reference3\": \"CCCCCCCCCCCCCCC\"\n            },\n            \"external_package_id\": null\n        }\n    ]\n}"
    }
  ]
}