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 ChilkatHttp
Dim success As Long
' Use this online tool to generate code from sample JSON: Generate Code to Create JSON
' The following JSON is sent in the request body.
' {
' "is_return_label": true,
' "rma_number": "123456789",
' "shipment": {
' "service_code": "usps_priority_mail",
' "ship_from": {
' "name": "Amanda Miller",
' "address_line1": "525 S Winchester Blvd",
' "city_locality": "San Jose",
' "state_province": "CA",
' "postal_code": "95128",
' "country_code": "US"
' },
' "ship_to": {
' "company_name": "Example Corp.",
' "address_line1": "4009 Marathon Blvd",
' "city_locality": "Austin",
' "state_province": "TX",
' "postal_code": "78756",
' "country_code": "US",
' "phone": "512-555-5555"
' },
' "packages": [
' {
' "weight": {
' "value": 17,
' "unit": "pound"
' },
' "dimensions": {
' "length": 36,
' "width": 12,
' "height": 24,
' "unit": "inch"
' }
' }
' ]
' }
' }
Dim json As New ChilkatJsonObject
success = json.UpdateBool("is_return_label",1)
success = json.UpdateString("rma_number","123456789")
success = json.UpdateString("shipment.service_code","usps_priority_mail")
success = json.UpdateString("shipment.ship_from.name","Amanda Miller")
success = json.UpdateString("shipment.ship_from.address_line1","525 S Winchester Blvd")
success = json.UpdateString("shipment.ship_from.city_locality","San Jose")
success = json.UpdateString("shipment.ship_from.state_province","CA")
success = json.UpdateString("shipment.ship_from.postal_code","95128")
success = json.UpdateString("shipment.ship_from.country_code","US")
success = json.UpdateString("shipment.ship_to.company_name","Example Corp.")
success = json.UpdateString("shipment.ship_to.address_line1","4009 Marathon Blvd")
success = json.UpdateString("shipment.ship_to.city_locality","Austin")
success = json.UpdateString("shipment.ship_to.state_province","TX")
success = json.UpdateString("shipment.ship_to.postal_code","78756")
success = json.UpdateString("shipment.ship_to.country_code","US")
success = json.UpdateString("shipment.ship_to.phone","512-555-5555")
success = json.UpdateInt("shipment.packages[0].weight.value",17)
success = json.UpdateString("shipment.packages[0].weight.unit","pound")
success = json.UpdateInt("shipment.packages[0].dimensions.length",36)
success = json.UpdateInt("shipment.packages[0].dimensions.width",12)
success = json.UpdateInt("shipment.packages[0].dimensions.height",24)
success = json.UpdateString("shipment.packages[0].dimensions.unit","inch")
http.SetRequestHeader "API-Key","{{API_KEY}}"
http.SetRequestHeader "Content-Type","application/json"
Dim resp As ChilkatHttpResponse
Set resp = http.PostJson3("https://api.shipengine.com/v1/labels","application/json",json)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "label_id": "se-1382827",
' "status": "completed",
' "shipment_id": "se-4151872",
' "ship_date": "2019-09-18T00:00:00Z",
' "created_at": "2019-09-18T13:55:37.0247767Z",
' "shipment_cost": {
' "currency": "usd",
' "amount": 98.14
' },
' "insurance_cost": {
' "currency": "usd",
' "amount": 0
' },
' "tracking_number": "9405511899564298878259",
' "is_return_label": true,
' "rma_number": "123456789",
' "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/XksbpgC37Um_NGiv4Qf_GA/label-1382827.pdf",
' "png": "https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.png",
' "zpl": "https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.zpl",
' "href": "https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.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": "9405511899564298878259",
' "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 Long
Dim Unit As String
Dim dimensionsUnit As String
Dim Length As Long
Dim Width As Long
Dim Height As Long
Dim insured_valueCurrency As String
Dim insured_valueAmount As Long
Dim Reference1 As String
Dim Reference2 As String
Dim Reference3 As String
Dim external_package_id As String
Dim label_id As String
label_id = jResp.StringOf("label_id")
Dim status As String
status = jResp.StringOf("status")
Dim shipment_id As String
shipment_id = jResp.StringOf("shipment_id")
Dim ship_date As String
ship_date = jResp.StringOf("ship_date")
Dim created_at As String
created_at = jResp.StringOf("created_at")
Dim v_Currency As String
v_Currency = jResp.StringOf("shipment_cost.currency")
Dim Amount As String
Amount = jResp.StringOf("shipment_cost.amount")
Dim insurance_costCurrency As String
insurance_costCurrency = jResp.StringOf("insurance_cost.currency")
Dim insurance_costAmount As Long
insurance_costAmount = jResp.IntOf("insurance_cost.amount")
Dim tracking_number As String
tracking_number = jResp.StringOf("tracking_number")
Dim is_return_label As Long
is_return_label = jResp.BoolOf("is_return_label")
Dim rma_number As String
rma_number = jResp.StringOf("rma_number")
Dim is_international As Long
is_international = jResp.BoolOf("is_international")
Dim batch_id As String
batch_id = jResp.StringOf("batch_id")
Dim carrier_id As String
carrier_id = jResp.StringOf("carrier_id")
Dim service_code As String
service_code = jResp.StringOf("service_code")
Dim package_code As String
package_code = jResp.StringOf("package_code")
Dim voided As Long
voided = jResp.BoolOf("voided")
Dim voided_at As String
voided_at = jResp.StringOf("voided_at")
Dim label_format As String
label_format = jResp.StringOf("label_format")
Dim label_layout As String
label_layout = jResp.StringOf("label_layout")
Dim trackable As Long
trackable = jResp.BoolOf("trackable")
Dim carrier_code As String
carrier_code = jResp.StringOf("carrier_code")
Dim tracking_status As String
tracking_status = jResp.StringOf("tracking_status")
Dim v_Pdf As String
v_Pdf = jResp.StringOf("label_download.pdf")
Dim Png As String
Png = jResp.StringOf("label_download.png")
Dim Zpl As String
Zpl = jResp.StringOf("label_download.zpl")
Dim Href As String
Href = jResp.StringOf("label_download.href")
Dim form_download As String
form_download = jResp.StringOf("form_download")
Dim insurance_claim As String
insurance_claim = jResp.StringOf("insurance_claim")
Dim i As Long
i = 0
Dim count_i As Long
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
Curl Command
curl -X POST
-H "API-Key: {{API_KEY}}"
-H "Content-Type: application/json"
-d '{
"is_return_label": true,
"rma_number": "123456789",
"shipment": {
"service_code": "usps_priority_mail",
"ship_from": {
"name": "Amanda Miller",
"address_line1": "525 S Winchester Blvd",
"city_locality": "San Jose",
"state_province": "CA",
"postal_code": "95128",
"country_code": "US"
},
"ship_to": {
"company_name": "Example Corp.",
"address_line1": "4009 Marathon Blvd",
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"phone": "512-555-5555"
},
"packages": [
{
"weight": {
"value": 17,
"unit": "pound"
},
"dimensions": {
"length": 36,
"width": 12,
"height": 24,
"unit": "inch"
}
}
]
}
}'
https://api.shipengine.com/v1/labels
Postman Collection Item JSON
{
"name": "Create a return label",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"is_return_label\": true,\n\t\"rma_number\": \"123456789\",\n\t\"shipment\": {\n\t\t\"service_code\": \"usps_priority_mail\",\n\t\t\"ship_from\": {\n\t\t\t\"name\": \"Amanda Miller\",\n\t\t\t\"address_line1\": \"525 S Winchester Blvd\",\n\t\t\t\"city_locality\": \"San Jose\",\n\t\t\t\"state_province\": \"CA\",\n\t\t\t\"postal_code\": \"95128\",\n\t\t\t\"country_code\": \"US\"\n\t\t},\n\t\t\"ship_to\": {\n\t\t\t\"company_name\": \"Example Corp.\",\n\t\t\t\"address_line1\": \"4009 Marathon Blvd\",\n\t\t\t\"city_locality\": \"Austin\",\n\t\t\t\"state_province\": \"TX\",\n\t\t\t\"postal_code\": \"78756\",\n\t\t\t\"country_code\": \"US\",\n\t\t\t\"phone\": \"512-555-5555\"\n\t\t},\n\t\t\"packages\": [\n\t\t\t{\n\t\t\t\t\"weight\": {\n\t\t\t\t\t\"value\": 17,\n\t\t\t\t\t\"unit\": \"pound\"\n\t\t\t\t},\n\t\t\t\t\"dimensions\": {\n\t\t\t\t\t\"length\": 36,\n\t\t\t\t\t\"width\": 12,\n\t\t\t\t\t\"height\": 24,\n\t\t\t\t\t\"unit\": \"inch\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n}"
},
"url": {
"raw": "https://api.shipengine.com/v1/labels",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"labels"
]
},
"description": "Return labels are created just like outgoing labels, but with an additional `is_return_label` flag. You can also optionally specify an `rma_number` (Return Merchandise Authorization)"
},
"response": [
{
"name": "Create a return label",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"is_return_label\": true,\n\t\"rma_number\": \"123456789\",\n\t\"shipment\": {\n\t\t\"service_code\": \"usps_priority_mail\",\n\t\t\"ship_from\": {\n\t\t\t\"name\": \"Amanda Miller\",\n\t\t\t\"address_line1\": \"525 S Winchester Blvd\",\n\t\t\t\"city_locality\": \"San Jose\",\n\t\t\t\"state_province\": \"CA\",\n\t\t\t\"postal_code\": \"95128\",\n\t\t\t\"country_code\": \"US\"\n\t\t},\n\t\t\"ship_to\": {\n\t\t\t\"company_name\": \"Example Corp.\",\n\t\t\t\"address_line1\": \"4009 Marathon Blvd\",\n\t\t\t\"city_locality\": \"Austin\",\n\t\t\t\"state_province\": \"TX\",\n\t\t\t\"postal_code\": \"78756\",\n\t\t\t\"country_code\": \"US\",\n\t\t\t\"phone\": \"512-555-5555\"\n\t\t},\n\t\t\"packages\": [\n\t\t\t{\n\t\t\t\t\"weight\": {\n\t\t\t\t\t\"value\": 17,\n\t\t\t\t\t\"unit\": \"pound\"\n\t\t\t\t},\n\t\t\t\t\"dimensions\": {\n\t\t\t\t\t\"length\": 36,\n\t\t\t\t\t\"width\": 12,\n\t\t\t\t\t\"height\": 24,\n\t\t\t\t\t\"unit\": \"inch\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.shipengine.com/v1/labels",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"labels"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 18 Sep 2019 13:55:37 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "1826"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "e876812b-185e-432d-ac30-f65a3ff3b3ef"
}
],
"cookie": [
],
"body": "{\n \"label_id\": \"se-1382827\",\n \"status\": \"completed\",\n \"shipment_id\": \"se-4151872\",\n \"ship_date\": \"2019-09-18T00:00:00Z\",\n \"created_at\": \"2019-09-18T13:55:37.0247767Z\",\n \"shipment_cost\": {\n \"currency\": \"usd\",\n \"amount\": 98.14\n },\n \"insurance_cost\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"tracking_number\": \"9405511899564298878259\",\n \"is_return_label\": true,\n \"rma_number\": \"123456789\",\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/XksbpgC37Um_NGiv4Qf_GA/label-1382827.pdf\",\n \"png\": \"https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.png\",\n \"zpl\": \"https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.zpl\",\n \"href\": \"https://api.shipengine.com/v1/downloads/10/XksbpgC37Um_NGiv4Qf_GA/label-1382827.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\": \"9405511899564298878259\",\n \"label_messages\": {\n \"reference1\": null,\n \"reference2\": null,\n \"reference3\": null\n },\n \"external_package_id\": null\n }\n ]\n}"
}
]
}
