Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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"
; }
; }
; ]
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateBool(json,"is_return_label",1)
CkJsonObject::ckUpdateString(json,"rma_number","123456789")
CkJsonObject::ckUpdateString(json,"shipment.service_code","usps_priority_mail")
CkJsonObject::ckUpdateString(json,"shipment.ship_from.name","Amanda Miller")
CkJsonObject::ckUpdateString(json,"shipment.ship_from.address_line1","525 S Winchester Blvd")
CkJsonObject::ckUpdateString(json,"shipment.ship_from.city_locality","San Jose")
CkJsonObject::ckUpdateString(json,"shipment.ship_from.state_province","CA")
CkJsonObject::ckUpdateString(json,"shipment.ship_from.postal_code","95128")
CkJsonObject::ckUpdateString(json,"shipment.ship_from.country_code","US")
CkJsonObject::ckUpdateString(json,"shipment.ship_to.company_name","Example Corp.")
CkJsonObject::ckUpdateString(json,"shipment.ship_to.address_line1","4009 Marathon Blvd")
CkJsonObject::ckUpdateString(json,"shipment.ship_to.city_locality","Austin")
CkJsonObject::ckUpdateString(json,"shipment.ship_to.state_province","TX")
CkJsonObject::ckUpdateString(json,"shipment.ship_to.postal_code","78756")
CkJsonObject::ckUpdateString(json,"shipment.ship_to.country_code","US")
CkJsonObject::ckUpdateString(json,"shipment.ship_to.phone","512-555-5555")
CkJsonObject::ckUpdateInt(json,"shipment.packages[0].weight.value",17)
CkJsonObject::ckUpdateString(json,"shipment.packages[0].weight.unit","pound")
CkJsonObject::ckUpdateInt(json,"shipment.packages[0].dimensions.length",36)
CkJsonObject::ckUpdateInt(json,"shipment.packages[0].dimensions.width",12)
CkJsonObject::ckUpdateInt(json,"shipment.packages[0].dimensions.height",24)
CkJsonObject::ckUpdateString(json,"shipment.packages[0].dimensions.unit","inch")
CkHttp::ckSetRequestHeader(http,"API-Key","{{API_KEY}}")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://api.shipengine.com/v1/labels","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
Value.i
Unit.s
dimensionsUnit.s
Length.i
Width.i
Height.i
insured_valueCurrency.s
insured_valueAmount.i
Reference1.s
Reference2.s
Reference3.s
external_package_id.s
label_id.s = CkJsonObject::ckStringOf(jResp,"label_id")
status.s = CkJsonObject::ckStringOf(jResp,"status")
shipment_id.s = CkJsonObject::ckStringOf(jResp,"shipment_id")
ship_date.s = CkJsonObject::ckStringOf(jResp,"ship_date")
created_at.s = CkJsonObject::ckStringOf(jResp,"created_at")
v_Currency.s = CkJsonObject::ckStringOf(jResp,"shipment_cost.currency")
Amount.s = CkJsonObject::ckStringOf(jResp,"shipment_cost.amount")
insurance_costCurrency.s = CkJsonObject::ckStringOf(jResp,"insurance_cost.currency")
insurance_costAmount.i = CkJsonObject::ckIntOf(jResp,"insurance_cost.amount")
tracking_number.s = CkJsonObject::ckStringOf(jResp,"tracking_number")
is_return_label.i = CkJsonObject::ckBoolOf(jResp,"is_return_label")
rma_number.s = CkJsonObject::ckStringOf(jResp,"rma_number")
is_international.i = CkJsonObject::ckBoolOf(jResp,"is_international")
batch_id.s = CkJsonObject::ckStringOf(jResp,"batch_id")
carrier_id.s = CkJsonObject::ckStringOf(jResp,"carrier_id")
service_code.s = CkJsonObject::ckStringOf(jResp,"service_code")
package_code.s = CkJsonObject::ckStringOf(jResp,"package_code")
voided.i = CkJsonObject::ckBoolOf(jResp,"voided")
voided_at.s = CkJsonObject::ckStringOf(jResp,"voided_at")
label_format.s = CkJsonObject::ckStringOf(jResp,"label_format")
label_layout.s = CkJsonObject::ckStringOf(jResp,"label_layout")
trackable.i = CkJsonObject::ckBoolOf(jResp,"trackable")
carrier_code.s = CkJsonObject::ckStringOf(jResp,"carrier_code")
tracking_status.s = CkJsonObject::ckStringOf(jResp,"tracking_status")
v_Pdf.s = CkJsonObject::ckStringOf(jResp,"label_download.pdf")
Png.s = CkJsonObject::ckStringOf(jResp,"label_download.png")
Zpl.s = CkJsonObject::ckStringOf(jResp,"label_download.zpl")
Href.s = CkJsonObject::ckStringOf(jResp,"label_download.href")
form_download.s = CkJsonObject::ckStringOf(jResp,"form_download")
insurance_claim.s = CkJsonObject::ckStringOf(jResp,"insurance_claim")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"packages")
While i < count_i
CkJsonObject::setCkI(jResp, i)
package_code = CkJsonObject::ckStringOf(jResp,"packages[i].package_code")
Value = CkJsonObject::ckIntOf(jResp,"packages[i].weight.value")
Unit = CkJsonObject::ckStringOf(jResp,"packages[i].weight.unit")
dimensionsUnit = CkJsonObject::ckStringOf(jResp,"packages[i].dimensions.unit")
Length = CkJsonObject::ckIntOf(jResp,"packages[i].dimensions.length")
Width = CkJsonObject::ckIntOf(jResp,"packages[i].dimensions.width")
Height = CkJsonObject::ckIntOf(jResp,"packages[i].dimensions.height")
insured_valueCurrency = CkJsonObject::ckStringOf(jResp,"packages[i].insured_value.currency")
insured_valueAmount = CkJsonObject::ckIntOf(jResp,"packages[i].insured_value.amount")
tracking_number = CkJsonObject::ckStringOf(jResp,"packages[i].tracking_number")
Reference1 = CkJsonObject::ckStringOf(jResp,"packages[i].label_messages.reference1")
Reference2 = CkJsonObject::ckStringOf(jResp,"packages[i].label_messages.reference2")
Reference3 = CkJsonObject::ckStringOf(jResp,"packages[i].label_messages.reference3")
external_package_id = CkJsonObject::ckStringOf(jResp,"packages[i].external_package_id")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
