Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loHttp.SetRequestHeader("API-Key","{{API_KEY}}")
loResp = loHttp.QuickRequest("POST","https://api.shipengine.com/v1/labels/rates/se-123456")
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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
lcLabel_id = loJResp.StringOf("label_id")
lcStatus = loJResp.StringOf("status")
lcShipment_id = loJResp.StringOf("shipment_id")
lcShip_date = loJResp.StringOf("ship_date")
lcCreated_at = loJResp.StringOf("created_at")
lcV_Currency = loJResp.StringOf("shipment_cost.currency")
lcAmount = loJResp.StringOf("shipment_cost.amount")
lcInsurance_costCurrency = loJResp.StringOf("insurance_cost.currency")
lnInsurance_costAmount = loJResp.IntOf("insurance_cost.amount")
lcTracking_number = loJResp.StringOf("tracking_number")
llIs_return_label = loJResp.BoolOf("is_return_label")
lcRma_number = loJResp.StringOf("rma_number")
llIs_international = loJResp.BoolOf("is_international")
lcBatch_id = loJResp.StringOf("batch_id")
lcCarrier_id = loJResp.StringOf("carrier_id")
lcService_code = loJResp.StringOf("service_code")
lcPackage_code = loJResp.StringOf("package_code")
llVoided = loJResp.BoolOf("voided")
lcVoided_at = loJResp.StringOf("voided_at")
lcLabel_format = loJResp.StringOf("label_format")
lcLabel_layout = loJResp.StringOf("label_layout")
llTrackable = loJResp.BoolOf("trackable")
lcCarrier_code = loJResp.StringOf("carrier_code")
lcTracking_status = loJResp.StringOf("tracking_status")
lcV_Pdf = loJResp.StringOf("label_download.pdf")
lcPng = loJResp.StringOf("label_download.png")
lcZpl = loJResp.StringOf("label_download.zpl")
lcHref = loJResp.StringOf("label_download.href")
lcForm_download = loJResp.StringOf("form_download")
lcInsurance_claim = loJResp.StringOf("insurance_claim")
i = 0
lnCount_i = loJResp.SizeOfArray("packages")
do while i < lnCount_i
loJResp.I = i
lcPackage_code = loJResp.StringOf("packages[i].package_code")
lnValue = loJResp.IntOf("packages[i].weight.value")
lcUnit = loJResp.StringOf("packages[i].weight.unit")
lcDimensionsUnit = loJResp.StringOf("packages[i].dimensions.unit")
lnLength = loJResp.IntOf("packages[i].dimensions.length")
lnWidth = loJResp.IntOf("packages[i].dimensions.width")
lnHeight = loJResp.IntOf("packages[i].dimensions.height")
lcInsured_valueCurrency = loJResp.StringOf("packages[i].insured_value.currency")
lnInsured_valueAmount = loJResp.IntOf("packages[i].insured_value.amount")
lcTracking_number = loJResp.StringOf("packages[i].tracking_number")
lcReference1 = loJResp.StringOf("packages[i].label_messages.reference1")
lcReference2 = loJResp.StringOf("packages[i].label_messages.reference2")
lcReference3 = loJResp.StringOf("packages[i].label_messages.reference3")
lcExternal_package_id = loJResp.StringOf("packages[i].external_package_id")
i = i + 1
enddo
release loHttp
release loSbResponseBody
release loJResp
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}"
}
]
}
