Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// 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"
// }
// }
// ]
// }
// }
loJson = createobject("CkJsonObject")
loJson.UpdateBool("is_return_label",.T.)
loJson.UpdateString("rma_number","123456789")
loJson.UpdateString("shipment.service_code","usps_priority_mail")
loJson.UpdateString("shipment.ship_from.name","Amanda Miller")
loJson.UpdateString("shipment.ship_from.address_line1","525 S Winchester Blvd")
loJson.UpdateString("shipment.ship_from.city_locality","San Jose")
loJson.UpdateString("shipment.ship_from.state_province","CA")
loJson.UpdateString("shipment.ship_from.postal_code","95128")
loJson.UpdateString("shipment.ship_from.country_code","US")
loJson.UpdateString("shipment.ship_to.company_name","Example Corp.")
loJson.UpdateString("shipment.ship_to.address_line1","4009 Marathon Blvd")
loJson.UpdateString("shipment.ship_to.city_locality","Austin")
loJson.UpdateString("shipment.ship_to.state_province","TX")
loJson.UpdateString("shipment.ship_to.postal_code","78756")
loJson.UpdateString("shipment.ship_to.country_code","US")
loJson.UpdateString("shipment.ship_to.phone","512-555-5555")
loJson.UpdateInt("shipment.packages[0].weight.value",17)
loJson.UpdateString("shipment.packages[0].weight.unit","pound")
loJson.UpdateInt("shipment.packages[0].dimensions.length",36)
loJson.UpdateInt("shipment.packages[0].dimensions.width",12)
loJson.UpdateInt("shipment.packages[0].dimensions.height",24)
loJson.UpdateString("shipment.packages[0].dimensions.unit","inch")
loHttp.SetRequestHeader("API-Key","{{API_KEY}}")
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.PostJson3("https://api.shipengine.com/v1/labels","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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
lcLabel_id = loJResp.StringOf("label_id")
lcStatus = loJResp.StringOf("status")
lcShipment_id = loJResp.StringOf("shipment_id")
lcShip_date = loJResp.StringOf("ship_date")
lcCreated_at = loJResp.StringOf("created_at")
lcV_Currency = loJResp.StringOf("shipment_cost.currency")
lcAmount = loJResp.StringOf("shipment_cost.amount")
lcInsurance_costCurrency = loJResp.StringOf("insurance_cost.currency")
lnInsurance_costAmount = loJResp.IntOf("insurance_cost.amount")
lcTracking_number = loJResp.StringOf("tracking_number")
llIs_return_label = loJResp.BoolOf("is_return_label")
lcRma_number = loJResp.StringOf("rma_number")
llIs_international = loJResp.BoolOf("is_international")
lcBatch_id = loJResp.StringOf("batch_id")
lcCarrier_id = loJResp.StringOf("carrier_id")
lcService_code = loJResp.StringOf("service_code")
lcPackage_code = loJResp.StringOf("package_code")
llVoided = loJResp.BoolOf("voided")
lcVoided_at = loJResp.StringOf("voided_at")
lcLabel_format = loJResp.StringOf("label_format")
lcLabel_layout = loJResp.StringOf("label_layout")
llTrackable = loJResp.BoolOf("trackable")
lcCarrier_code = loJResp.StringOf("carrier_code")
lcTracking_status = loJResp.StringOf("tracking_status")
lcV_Pdf = loJResp.StringOf("label_download.pdf")
lcPng = loJResp.StringOf("label_download.png")
lcZpl = loJResp.StringOf("label_download.zpl")
lcHref = loJResp.StringOf("label_download.href")
lcForm_download = loJResp.StringOf("form_download")
lcInsurance_claim = loJResp.StringOf("insurance_claim")
i = 0
lnCount_i = loJResp.SizeOfArray("packages")
do while i < lnCount_i
loJResp.I = i
lcPackage_code = loJResp.StringOf("packages[i].package_code")
lnValue = loJResp.IntOf("packages[i].weight.value")
lcUnit = loJResp.StringOf("packages[i].weight.unit")
lcDimensionsUnit = loJResp.StringOf("packages[i].dimensions.unit")
lnLength = loJResp.IntOf("packages[i].dimensions.length")
lnWidth = loJResp.IntOf("packages[i].dimensions.width")
lnHeight = loJResp.IntOf("packages[i].dimensions.height")
lcInsured_valueCurrency = loJResp.StringOf("packages[i].insured_value.currency")
lnInsured_valueAmount = loJResp.IntOf("packages[i].insured_value.amount")
lcTracking_number = loJResp.StringOf("packages[i].tracking_number")
lcReference1 = loJResp.StringOf("packages[i].label_messages.reference1")
lcReference2 = loJResp.StringOf("packages[i].label_messages.reference2")
lcReference3 = loJResp.StringOf("packages[i].label_messages.reference3")
lcExternal_package_id = loJResp.StringOf("packages[i].external_package_id")
i = i + 1
enddo
release loHttp
release loJson
release loSbResponseBody
release loJResp
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}"
}
]
}
