Chilkat Online Tools

Objective-C / ShipEngine Walkthrough / Label messages (reference fields)

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
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"
//         }
//       }
//     ]
//   }
// }

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

[http SetRequestHeader: @"API-Key" value: @"{{API_KEY}}"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];

CkoHttpResponse *resp = [http PostJson3: @"https://api.shipengine.com/v1/labels" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"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;
NSString *Unit = 0;
NSString *dimensionsUnit = 0;
int Length;
int Width;
int Height;
NSString *insured_valueCurrency = 0;
int insured_valueAmount;
NSString *Reference1 = 0;
NSString *Reference2 = 0;
NSString *Reference3 = 0;
NSString *external_package_id = 0;

NSString *label_id = [jResp StringOf: @"label_id"];
NSString *status = [jResp StringOf: @"status"];
NSString *shipment_id = [jResp StringOf: @"shipment_id"];
NSString *ship_date = [jResp StringOf: @"ship_date"];
NSString *created_at = [jResp StringOf: @"created_at"];
NSString *v_Currency = [jResp StringOf: @"shipment_cost.currency"];
NSString *Amount = [jResp StringOf: @"shipment_cost.amount"];
NSString *insurance_costCurrency = [jResp StringOf: @"insurance_cost.currency"];
int insurance_costAmount = [[jResp IntOf: @"insurance_cost.amount"] intValue];
NSString *tracking_number = [jResp StringOf: @"tracking_number"];
BOOL is_return_label = [jResp BoolOf: @"is_return_label"];
NSString *rma_number = [jResp StringOf: @"rma_number"];
BOOL is_international = [jResp BoolOf: @"is_international"];
NSString *batch_id = [jResp StringOf: @"batch_id"];
NSString *carrier_id = [jResp StringOf: @"carrier_id"];
NSString *service_code = [jResp StringOf: @"service_code"];
NSString *package_code = [jResp StringOf: @"package_code"];
BOOL voided = [jResp BoolOf: @"voided"];
NSString *voided_at = [jResp StringOf: @"voided_at"];
NSString *label_format = [jResp StringOf: @"label_format"];
NSString *label_layout = [jResp StringOf: @"label_layout"];
BOOL trackable = [jResp BoolOf: @"trackable"];
NSString *carrier_code = [jResp StringOf: @"carrier_code"];
NSString *tracking_status = [jResp StringOf: @"tracking_status"];
NSString *v_Pdf = [jResp StringOf: @"label_download.pdf"];
NSString *Png = [jResp StringOf: @"label_download.png"];
NSString *Zpl = [jResp StringOf: @"label_download.zpl"];
NSString *Href = [jResp StringOf: @"label_download.href"];
NSString *form_download = [jResp StringOf: @"form_download"];
NSString *insurance_claim = [jResp StringOf: @"insurance_claim"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"packages"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    package_code = [jResp StringOf: @"packages[i].package_code"];
    Value = [[jResp IntOf: @"packages[i].weight.value"] intValue];
    Unit = [jResp StringOf: @"packages[i].weight.unit"];
    dimensionsUnit = [jResp StringOf: @"packages[i].dimensions.unit"];
    Length = [[jResp IntOf: @"packages[i].dimensions.length"] intValue];
    Width = [[jResp IntOf: @"packages[i].dimensions.width"] intValue];
    Height = [[jResp IntOf: @"packages[i].dimensions.height"] intValue];
    insured_valueCurrency = [jResp StringOf: @"packages[i].insured_value.currency"];
    insured_valueAmount = [[jResp IntOf: @"packages[i].insured_value.amount"] intValue];
    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}"
    }
  ]
}