Chilkat Online Tools

VBScript / ShipEngine Walkthrough / Create a label from a shipment

Back to Collection Items

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

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

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")

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

' resp is a Chilkat.HttpResponse
Set resp = http.QuickRequest("POST","https://api.shipengine.com/v1/labels/shipment/se-123456")
If (http.LastMethodSuccess = 0) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())

respStatusCode = resp.StatusCode
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    outFile.WriteLine("Response Header:")
    outFile.WriteLine(resp.Header)
    outFile.WriteLine("Failed.")

    WScript.Quit
End If

' 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

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")
Do While i < count_i
    jResp.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
Loop

outFile.Close

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