Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_SetRequestHeader $http "API-Key" "{{API_KEY}}"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequest $http "POST" "https://api.shipengine.com/v1/labels/shipment/se-123456"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "label_id": "se-1376111",
# "status": "completed",
# "shipment_id": "se-4140216",
# "ship_date": "2019-09-17T00:00:00Z",
# "created_at": "2019-09-17T21:15:06.1985884Z",
# "shipment_cost": {
# "currency": "usd",
# "amount": 98.14
# },
# "insurance_cost": {
# "currency": "usd",
# "amount": 0
# },
# "tracking_number": "9405511899564298845657",
# "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/pNIA3R8QfEqnWI80_RI8OA/label-1376111.pdf",
# "png": "https://api.shipengine.com/v1/downloads/10/pNIA3R8QfEqnWI80_RI8OA/label-1376111.png",
# "zpl": "https://api.shipengine.com/v1/downloads/10/pNIA3R8QfEqnWI80_RI8OA/label-1376111.zpl",
# "href": "https://api.shipengine.com/v1/downloads/10/pNIA3R8QfEqnWI80_RI8OA/label-1376111.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": "9405511899564298845657",
# "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
set label_id [CkJsonObject_stringOf $jResp "label_id"]
set status [CkJsonObject_stringOf $jResp "status"]
set shipment_id [CkJsonObject_stringOf $jResp "shipment_id"]
set ship_date [CkJsonObject_stringOf $jResp "ship_date"]
set created_at [CkJsonObject_stringOf $jResp "created_at"]
set v_Currency [CkJsonObject_stringOf $jResp "shipment_cost.currency"]
set Amount [CkJsonObject_stringOf $jResp "shipment_cost.amount"]
set insurance_costCurrency [CkJsonObject_stringOf $jResp "insurance_cost.currency"]
set insurance_costAmount [CkJsonObject_IntOf $jResp "insurance_cost.amount"]
set tracking_number [CkJsonObject_stringOf $jResp "tracking_number"]
set is_return_label [CkJsonObject_BoolOf $jResp "is_return_label"]
set rma_number [CkJsonObject_stringOf $jResp "rma_number"]
set is_international [CkJsonObject_BoolOf $jResp "is_international"]
set batch_id [CkJsonObject_stringOf $jResp "batch_id"]
set carrier_id [CkJsonObject_stringOf $jResp "carrier_id"]
set service_code [CkJsonObject_stringOf $jResp "service_code"]
set package_code [CkJsonObject_stringOf $jResp "package_code"]
set voided [CkJsonObject_BoolOf $jResp "voided"]
set voided_at [CkJsonObject_stringOf $jResp "voided_at"]
set label_format [CkJsonObject_stringOf $jResp "label_format"]
set label_layout [CkJsonObject_stringOf $jResp "label_layout"]
set trackable [CkJsonObject_BoolOf $jResp "trackable"]
set carrier_code [CkJsonObject_stringOf $jResp "carrier_code"]
set tracking_status [CkJsonObject_stringOf $jResp "tracking_status"]
set v_Pdf [CkJsonObject_stringOf $jResp "label_download.pdf"]
set Png [CkJsonObject_stringOf $jResp "label_download.png"]
set Zpl [CkJsonObject_stringOf $jResp "label_download.zpl"]
set Href [CkJsonObject_stringOf $jResp "label_download.href"]
set form_download [CkJsonObject_stringOf $jResp "form_download"]
set insurance_claim [CkJsonObject_stringOf $jResp "insurance_claim"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "packages"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set package_code [CkJsonObject_stringOf $jResp "packages[i].package_code"]
set Value [CkJsonObject_IntOf $jResp "packages[i].weight.value"]
set Unit [CkJsonObject_stringOf $jResp "packages[i].weight.unit"]
set dimensionsUnit [CkJsonObject_stringOf $jResp "packages[i].dimensions.unit"]
set Length [CkJsonObject_IntOf $jResp "packages[i].dimensions.length"]
set Width [CkJsonObject_IntOf $jResp "packages[i].dimensions.width"]
set Height [CkJsonObject_IntOf $jResp "packages[i].dimensions.height"]
set insured_valueCurrency [CkJsonObject_stringOf $jResp "packages[i].insured_value.currency"]
set insured_valueAmount [CkJsonObject_IntOf $jResp "packages[i].insured_value.amount"]
set tracking_number [CkJsonObject_stringOf $jResp "packages[i].tracking_number"]
set Reference1 [CkJsonObject_stringOf $jResp "packages[i].label_messages.reference1"]
set Reference2 [CkJsonObject_stringOf $jResp "packages[i].label_messages.reference2"]
set Reference3 [CkJsonObject_stringOf $jResp "packages[i].label_messages.reference3"]
set external_package_id [CkJsonObject_stringOf $jResp "packages[i].external_package_id"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X POST
-H "API-Key: {{API_KEY}}"
https://api.shipengine.com/v1/labels/shipment/se-123456
Postman Collection Item JSON
{
"name": "Create a label from a shipment",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/labels/shipment/{{shipment_id}}",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"labels",
"shipment",
"{{shipment_id}}"
]
},
"description": "If you've previously created a shipment on ShipEngine, then you can create a label from that shipment without having to specify any of the shipment details again."
},
"response": [
{
"name": "Create a label from a shipment",
"originalRequest": {
"method": "POST",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/labels/shipment/{{shipment_id}}",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"labels",
"shipment",
"{{shipment_id}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Tue, 17 Sep 2019 21:15:07 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "1820"
},
{
"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/GC0HAV1fQ0sxF0VSXwcXVHpSAAMPNVkWUDFQUURfVgtNQx1RHVJIBxlQU1EMBAZRVE4aABtEIQgHClUiV1sGVQBTCg12ABFJXwBdElY/"
},
{
"key": "x-powered-by",
"value": "ASP.NET"
},
{
"key": "x-shipengine-environment",
"value": "j"
},
{
"key": "x-shipengine-requestid",
"value": "8ebc06bb-90a3-495b-bc0d-b4bb2ef13073"
},
{
"key": "x-shipengine-server",
"value": "SS-J-WEB03"
}
],
"cookie": [
],
"body": "{\n \"label_id\": \"se-1376111\",\n \"status\": \"completed\",\n \"shipment_id\": \"se-4140216\",\n \"ship_date\": \"2019-09-17T00:00:00Z\",\n \"created_at\": \"2019-09-17T21:15:06.1985884Z\",\n \"shipment_cost\": {\n \"currency\": \"usd\",\n \"amount\": 98.14\n },\n \"insurance_cost\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"tracking_number\": \"9405511899564298845657\",\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/pNIA3R8QfEqnWI80_RI8OA/label-1376111.pdf\",\n \"png\": \"https://api.shipengine.com/v1/downloads/10/pNIA3R8QfEqnWI80_RI8OA/label-1376111.png\",\n \"zpl\": \"https://api.shipengine.com/v1/downloads/10/pNIA3R8QfEqnWI80_RI8OA/label-1376111.zpl\",\n \"href\": \"https://api.shipengine.com/v1/downloads/10/pNIA3R8QfEqnWI80_RI8OA/label-1376111.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\": \"9405511899564298845657\",\n \"label_messages\": {\n \"reference1\": null,\n \"reference2\": null,\n \"reference3\": null\n },\n \"external_package_id\": null\n }\n ]\n}"
}
]
}