Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.SetRequestHeader "API-Key","{{API_KEY}}"
Local $oResp = $oHttp.QuickRequest("POST","https://api.shipengine.com/v1/labels/rates/se-123456")
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $iValue
Local $sUnit
Local $sDimensionsUnit
Local $iLength
Local $iWidth
Local $iHeight
Local $sInsured_valueCurrency
Local $insured_valueAmount
Local $sReference1
Local $sReference2
Local $sReference3
Local $sExternal_package_id
Local $sLabel_id = $oJResp.StringOf("label_id")
Local $status = $oJResp.StringOf("status")
Local $shipment_id = $oJResp.StringOf("shipment_id")
Local $ship_date = $oJResp.StringOf("ship_date")
Local $sCreated_at = $oJResp.StringOf("created_at")
Local $sV_Currency = $oJResp.StringOf("shipment_cost.currency")
Local $sAmount = $oJResp.StringOf("shipment_cost.amount")
Local $sInsurance_costCurrency = $oJResp.StringOf("insurance_cost.currency")
Local $insurance_costAmount = $oJResp.IntOf("insurance_cost.amount")
Local $sTracking_number = $oJResp.StringOf("tracking_number")
Local $bIs_return_label = $oJResp.BoolOf("is_return_label")
Local $sRma_number = $oJResp.StringOf("rma_number")
Local $bIs_international = $oJResp.BoolOf("is_international")
Local $sBatch_id = $oJResp.StringOf("batch_id")
Local $sCarrier_id = $oJResp.StringOf("carrier_id")
Local $service_code = $oJResp.StringOf("service_code")
Local $sPackage_code = $oJResp.StringOf("package_code")
Local $bVoided = $oJResp.BoolOf("voided")
Local $sVoided_at = $oJResp.StringOf("voided_at")
Local $sLabel_format = $oJResp.StringOf("label_format")
Local $sLabel_layout = $oJResp.StringOf("label_layout")
Local $bTrackable = $oJResp.BoolOf("trackable")
Local $sCarrier_code = $oJResp.StringOf("carrier_code")
Local $sTracking_status = $oJResp.StringOf("tracking_status")
Local $sV_Pdf = $oJResp.StringOf("label_download.pdf")
Local $sPng = $oJResp.StringOf("label_download.png")
Local $sZpl = $oJResp.StringOf("label_download.zpl")
Local $sHref = $oJResp.StringOf("label_download.href")
Local $sForm_download = $oJResp.StringOf("form_download")
Local $sInsurance_claim = $oJResp.StringOf("insurance_claim")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("packages")
While $i < $iCount_i
$oJResp.I = $i
$sPackage_code = $oJResp.StringOf("packages[i].package_code")
$iValue = $oJResp.IntOf("packages[i].weight.value")
$sUnit = $oJResp.StringOf("packages[i].weight.unit")
$sDimensionsUnit = $oJResp.StringOf("packages[i].dimensions.unit")
$iLength = $oJResp.IntOf("packages[i].dimensions.length")
$iWidth = $oJResp.IntOf("packages[i].dimensions.width")
$iHeight = $oJResp.IntOf("packages[i].dimensions.height")
$sInsured_valueCurrency = $oJResp.StringOf("packages[i].insured_value.currency")
$insured_valueAmount = $oJResp.IntOf("packages[i].insured_value.amount")
$sTracking_number = $oJResp.StringOf("packages[i].tracking_number")
$sReference1 = $oJResp.StringOf("packages[i].label_messages.reference1")
$sReference2 = $oJResp.StringOf("packages[i].label_messages.reference2")
$sReference3 = $oJResp.StringOf("packages[i].label_messages.reference3")
$sExternal_package_id = $oJResp.StringOf("packages[i].external_package_id")
$i = $i + 1
Wend
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}"
}
]
}
