Chilkat Online Tools

Ruby / ShipEngine Walkthrough / Create a label from a rate

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

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

# resp is a CkHttpResponse
resp = http.QuickRequest("POST","https://api.shipengine.com/v1/labels/rates/se-123456")
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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

label_id = jResp.stringOf("label_id")
status = jResp.stringOf("status")
shipment_id = jResp.stringOf("shipment_id")
ship_date = jResp.stringOf("ship_date")
created_at = jResp.stringOf("created_at")
v_Currency = jResp.stringOf("shipment_cost.currency")
Amount = jResp.stringOf("shipment_cost.amount")
insurance_costCurrency = jResp.stringOf("insurance_cost.currency")
insurance_costAmount = jResp.IntOf("insurance_cost.amount")
tracking_number = jResp.stringOf("tracking_number")
is_return_label = jResp.BoolOf("is_return_label")
rma_number = jResp.stringOf("rma_number")
is_international = jResp.BoolOf("is_international")
batch_id = jResp.stringOf("batch_id")
carrier_id = jResp.stringOf("carrier_id")
service_code = jResp.stringOf("service_code")
package_code = jResp.stringOf("package_code")
voided = jResp.BoolOf("voided")
voided_at = jResp.stringOf("voided_at")
label_format = jResp.stringOf("label_format")
label_layout = jResp.stringOf("label_layout")
trackable = jResp.BoolOf("trackable")
carrier_code = jResp.stringOf("carrier_code")
tracking_status = jResp.stringOf("tracking_status")
v_Pdf = jResp.stringOf("label_download.pdf")
Png = jResp.stringOf("label_download.png")
Zpl = jResp.stringOf("label_download.zpl")
Href = jResp.stringOf("label_download.href")
form_download = jResp.stringOf("form_download")
insurance_claim = jResp.stringOf("insurance_claim")
i = 0
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
end

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}"
    }
  ]
}