Chilkat Online Tools

VB.NET / ShipEngine Walkthrough / Create a label from a rate

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

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

Dim resp As Chilkat.HttpResponse = http.QuickRequest("POST","https://api.shipengine.com/v1/labels/rates/se-123456")
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

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

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

    Exit Sub
End If



' 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



Dim Value As Integer
Dim Unit As String
Dim dimensionsUnit As String
Dim Length As Integer
Dim Width As Integer
Dim Height As Integer
Dim insured_valueCurrency As String
Dim insured_valueAmount As Integer
Dim Reference1 As String
Dim Reference2 As String
Dim Reference3 As String
Dim external_package_id As String

Dim label_id As String = jResp.StringOf("label_id")
Dim status As String = jResp.StringOf("status")
Dim shipment_id As String = jResp.StringOf("shipment_id")
Dim ship_date As String = jResp.StringOf("ship_date")
Dim created_at As String = jResp.StringOf("created_at")
Dim v_Currency As String = jResp.StringOf("shipment_cost.currency")
Dim Amount As String = jResp.StringOf("shipment_cost.amount")
Dim insurance_costCurrency As String = jResp.StringOf("insurance_cost.currency")
Dim insurance_costAmount As Integer = jResp.IntOf("insurance_cost.amount")
Dim tracking_number As String = jResp.StringOf("tracking_number")
Dim is_return_label As Boolean = jResp.BoolOf("is_return_label")
Dim rma_number As String = jResp.StringOf("rma_number")
Dim is_international As Boolean = jResp.BoolOf("is_international")
Dim batch_id As String = jResp.StringOf("batch_id")
Dim carrier_id As String = jResp.StringOf("carrier_id")
Dim service_code As String = jResp.StringOf("service_code")
Dim package_code As String = jResp.StringOf("package_code")
Dim voided As Boolean = jResp.BoolOf("voided")
Dim voided_at As String = jResp.StringOf("voided_at")
Dim label_format As String = jResp.StringOf("label_format")
Dim label_layout As String = jResp.StringOf("label_layout")
Dim trackable As Boolean = jResp.BoolOf("trackable")
Dim carrier_code As String = jResp.StringOf("carrier_code")
Dim tracking_status As String = jResp.StringOf("tracking_status")
Dim v_Pdf As String = jResp.StringOf("label_download.pdf")
Dim Png As String = jResp.StringOf("label_download.png")
Dim Zpl As String = jResp.StringOf("label_download.zpl")
Dim Href As String = jResp.StringOf("label_download.href")
Dim form_download As String = jResp.StringOf("form_download")
Dim insurance_claim As String = jResp.StringOf("insurance_claim")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("packages")
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
End While

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