Chilkat Online Tools

C# / ShipEngine Walkthrough / Create a label from a rate

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;

http.SetRequestHeader("API-Key","{{API_KEY}}");

Chilkat.HttpResponse resp = http.QuickRequest("POST","https://api.shipengine.com/v1/labels/rates/se-123456");
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-1376002",
//   "status": "completed",
//   "shipment_id": "se-4140067",
//   "ship_date": "2019-09-17T00:00:00Z",
//   "created_at": "2019-09-17T21:07:37.0913064Z",
//   "shipment_cost": {
//     "currency": "usd",
//     "amount": 65.58
//   },
//   "insurance_cost": {
//     "currency": "usd",
//     "amount": 0
//   },
//   "tracking_number": "1Z63R0960303407845",
//   "is_return_label": false,
//   "rma_number": null,
//   "is_international": false,
//   "batch_id": "",
//   "carrier_id": "se-121862",
//   "service_code": "ups_ground",
//   "package_code": "package",
//   "voided": false,
//   "voided_at": null,
//   "label_format": "pdf",
//   "label_layout": "4x6",
//   "trackable": true,
//   "carrier_code": "ups",
//   "tracking_status": "in_transit",
//   "label_download": {
//     "pdf": "https://api.shipengine.com/v1/downloads/10/0NfRdimr3kWpLpIbWI8K_w/label-1376002.pdf",
//     "png": "https://api.shipengine.com/v1/downloads/10/0NfRdimr3kWpLpIbWI8K_w/label-1376002.png",
//     "zpl": "https://api.shipengine.com/v1/downloads/10/0NfRdimr3kWpLpIbWI8K_w/label-1376002.zpl",
//     "href": "https://api.shipengine.com/v1/downloads/10/0NfRdimr3kWpLpIbWI8K_w/label-1376002.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": "1Z63R0960303407845",
//       "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

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}}"
https://api.shipengine.com/v1/labels/rates/se-123456

Postman Collection Item JSON

{
  "name": "Create a label from a rate",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
    ],
    "url": {
      "raw": "https://api.shipengine.com/v1/labels/rates/{{rate_id}}",
      "protocol": "https",
      "host": [
        "api",
        "shipengine",
        "com"
      ],
      "path": [
        "v1",
        "labels",
        "rates",
        "{{rate_id}}"
      ]
    },
    "description": "If you've previously gotten a rate quote from ShipEngine, then you can create a label from that rate quote without having to specify any of the shipment details again."
  },
  "response": [
    {
      "name": "Create a label from a rate",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "url": {
          "raw": "https://api.shipengine.com/v1/labels/rates/{{rate_id}}",
          "protocol": "https",
          "host": [
            "api",
            "shipengine",
            "com"
          ],
          "path": [
            "v1",
            "labels",
            "rates",
            "{{rate_id}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Tue, 17 Sep 2019 21:07:38 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "1797"
        },
        {
          "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/GC0HAV1fQ0sxF0VSXwcXVHpSAAMPNVkWUDBZTFEQH1UXUQFRCltQAhtQSFMBBwJVUFAFHRpXSBMPdlVXJicCVQhafA8EdnVWG01XAF8RAWs="
        },
        {
          "key": "x-powered-by",
          "value": "ASP.NET"
        },
        {
          "key": "x-shipengine-environment",
          "value": "j"
        },
        {
          "key": "x-shipengine-requestid",
          "value": "06d99646-25fc-4c4b-921a-b237e46e2913"
        },
        {
          "key": "x-shipengine-server",
          "value": "SS-J-WEB03"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"label_id\": \"se-1376002\",\n    \"status\": \"completed\",\n    \"shipment_id\": \"se-4140067\",\n    \"ship_date\": \"2019-09-17T00:00:00Z\",\n    \"created_at\": \"2019-09-17T21:07:37.0913064Z\",\n    \"shipment_cost\": {\n        \"currency\": \"usd\",\n        \"amount\": 65.58\n    },\n    \"insurance_cost\": {\n        \"currency\": \"usd\",\n        \"amount\": 0\n    },\n    \"tracking_number\": \"1Z63R0960303407845\",\n    \"is_return_label\": false,\n    \"rma_number\": null,\n    \"is_international\": false,\n    \"batch_id\": \"\",\n    \"carrier_id\": \"se-121862\",\n    \"service_code\": \"ups_ground\",\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\": \"ups\",\n    \"tracking_status\": \"in_transit\",\n    \"label_download\": {\n        \"pdf\": \"https://api.shipengine.com/v1/downloads/10/0NfRdimr3kWpLpIbWI8K_w/label-1376002.pdf\",\n        \"png\": \"https://api.shipengine.com/v1/downloads/10/0NfRdimr3kWpLpIbWI8K_w/label-1376002.png\",\n        \"zpl\": \"https://api.shipengine.com/v1/downloads/10/0NfRdimr3kWpLpIbWI8K_w/label-1376002.zpl\",\n        \"href\": \"https://api.shipengine.com/v1/downloads/10/0NfRdimr3kWpLpIbWI8K_w/label-1376002.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\": \"1Z63R0960303407845\",\n            \"label_messages\": {\n                \"reference1\": null,\n                \"reference2\": null,\n                \"reference3\": null\n            },\n            \"external_package_id\": null\n        }\n    ]\n}"
    }
  ]
}