.NET Core C# / ShipEngine Walkthrough / Label messages (reference fields)
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Chilkat.Http http = new Chilkat.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"
// }
// }
// ]
// }
// }
Chilkat.JsonObject json = new Chilkat.JsonObject();
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");
Chilkat.HttpResponse resp = http.PostJson3("https://api.shipengine.com/v1/labels","application/json",json);
if (http.LastMethodSuccess == false) {
Debug.WriteLine(http.LastErrorText);
return;
}
Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());
int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
Debug.WriteLine("Response Header:");
Debug.WriteLine(resp.Header);
Debug.WriteLine("Failed.");
return;
}
// 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
int Value;
string Unit;
string dimensionsUnit;
int Length;
int Width;
int Height;
string insured_valueCurrency;
int insured_valueAmount;
string Reference1;
string Reference2;
string Reference3;
string external_package_id;
string label_id = jResp.StringOf("label_id");
string status = jResp.StringOf("status");
string shipment_id = jResp.StringOf("shipment_id");
string ship_date = jResp.StringOf("ship_date");
string created_at = jResp.StringOf("created_at");
string v_Currency = jResp.StringOf("shipment_cost.currency");
string Amount = jResp.StringOf("shipment_cost.amount");
string insurance_costCurrency = jResp.StringOf("insurance_cost.currency");
int insurance_costAmount = jResp.IntOf("insurance_cost.amount");
string tracking_number = jResp.StringOf("tracking_number");
bool is_return_label = jResp.BoolOf("is_return_label");
string rma_number = jResp.StringOf("rma_number");
bool is_international = jResp.BoolOf("is_international");
string batch_id = jResp.StringOf("batch_id");
string carrier_id = jResp.StringOf("carrier_id");
string service_code = jResp.StringOf("service_code");
string package_code = jResp.StringOf("package_code");
bool voided = jResp.BoolOf("voided");
string voided_at = jResp.StringOf("voided_at");
string label_format = jResp.StringOf("label_format");
string label_layout = jResp.StringOf("label_layout");
bool trackable = jResp.BoolOf("trackable");
string carrier_code = jResp.StringOf("carrier_code");
string tracking_status = jResp.StringOf("tracking_status");
string v_Pdf = jResp.StringOf("label_download.pdf");
string Png = jResp.StringOf("label_download.png");
string Zpl = jResp.StringOf("label_download.zpl");
string Href = jResp.StringOf("label_download.href");
string form_download = jResp.StringOf("form_download");
string insurance_claim = jResp.StringOf("insurance_claim");
int i = 0;
int count_i = jResp.SizeOfArray("packages");
while (i < count_i) {
jResp.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}"
}
]
}
