Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
integer li_Value
string ls_Unit
string ls_DimensionsUnit
integer li_Length
integer li_Width
integer li_Height
string ls_Insured_valueCurrency
integer li_Insured_valueAmount
string ls_Reference1
string ls_Reference2
string ls_Reference3
string ls_External_package_id
string ls_Label_id
string ls_Status
string ls_Shipment_id
string ls_Ship_date
string ls_Created_at
string ls_V_Currency
string ls_Amount
string ls_Insurance_costCurrency
integer li_Insurance_costAmount
string ls_Tracking_number
integer li_Is_return_label
string ls_Rma_number
integer li_Is_international
string ls_Batch_id
string ls_Carrier_id
string ls_Service_code
string ls_Package_code
integer li_Voided
string ls_Voided_at
string ls_Label_format
string ls_Label_layout
integer li_Trackable
string ls_Carrier_code
string ls_Tracking_status
string ls_V_Pdf
string ls_Png
string ls_Zpl
string ls_Href
string ls_Form_download
string ls_Insurance_claim
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.SetRequestHeader("API-Key","{{API_KEY}}")
loo_Resp = loo_Http.QuickRequest("POST","https://api.shipengine.com/v1/labels/rates/se-123456")
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// 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
ls_Label_id = loo_JResp.StringOf("label_id")
ls_Status = loo_JResp.StringOf("status")
ls_Shipment_id = loo_JResp.StringOf("shipment_id")
ls_Ship_date = loo_JResp.StringOf("ship_date")
ls_Created_at = loo_JResp.StringOf("created_at")
ls_V_Currency = loo_JResp.StringOf("shipment_cost.currency")
ls_Amount = loo_JResp.StringOf("shipment_cost.amount")
ls_Insurance_costCurrency = loo_JResp.StringOf("insurance_cost.currency")
li_Insurance_costAmount = loo_JResp.IntOf("insurance_cost.amount")
ls_Tracking_number = loo_JResp.StringOf("tracking_number")
li_Is_return_label = loo_JResp.BoolOf("is_return_label")
ls_Rma_number = loo_JResp.StringOf("rma_number")
li_Is_international = loo_JResp.BoolOf("is_international")
ls_Batch_id = loo_JResp.StringOf("batch_id")
ls_Carrier_id = loo_JResp.StringOf("carrier_id")
ls_Service_code = loo_JResp.StringOf("service_code")
ls_Package_code = loo_JResp.StringOf("package_code")
li_Voided = loo_JResp.BoolOf("voided")
ls_Voided_at = loo_JResp.StringOf("voided_at")
ls_Label_format = loo_JResp.StringOf("label_format")
ls_Label_layout = loo_JResp.StringOf("label_layout")
li_Trackable = loo_JResp.BoolOf("trackable")
ls_Carrier_code = loo_JResp.StringOf("carrier_code")
ls_Tracking_status = loo_JResp.StringOf("tracking_status")
ls_V_Pdf = loo_JResp.StringOf("label_download.pdf")
ls_Png = loo_JResp.StringOf("label_download.png")
ls_Zpl = loo_JResp.StringOf("label_download.zpl")
ls_Href = loo_JResp.StringOf("label_download.href")
ls_Form_download = loo_JResp.StringOf("form_download")
ls_Insurance_claim = loo_JResp.StringOf("insurance_claim")
i = 0
li_Count_i = loo_JResp.SizeOfArray("packages")
do while i < li_Count_i
loo_JResp.I = i
ls_Package_code = loo_JResp.StringOf("packages[i].package_code")
li_Value = loo_JResp.IntOf("packages[i].weight.value")
ls_Unit = loo_JResp.StringOf("packages[i].weight.unit")
ls_DimensionsUnit = loo_JResp.StringOf("packages[i].dimensions.unit")
li_Length = loo_JResp.IntOf("packages[i].dimensions.length")
li_Width = loo_JResp.IntOf("packages[i].dimensions.width")
li_Height = loo_JResp.IntOf("packages[i].dimensions.height")
ls_Insured_valueCurrency = loo_JResp.StringOf("packages[i].insured_value.currency")
li_Insured_valueAmount = loo_JResp.IntOf("packages[i].insured_value.amount")
ls_Tracking_number = loo_JResp.StringOf("packages[i].tracking_number")
ls_Reference1 = loo_JResp.StringOf("packages[i].label_messages.reference1")
ls_Reference2 = loo_JResp.StringOf("packages[i].label_messages.reference2")
ls_Reference3 = loo_JResp.StringOf("packages[i].label_messages.reference3")
ls_External_package_id = loo_JResp.StringOf("packages[i].external_package_id")
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
