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.
; {
; "label_format": "png",
; "label_layout": "4x6",
; "label_download_type": "inline",
; "shipment": {
; "service_code": "usps_priority_mail",
; "ship_from": {
; "name": "John Doe",
; "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"
; },
; "ship_to": {
; "name": "Amanda Miller",
; "address_line1": "525 S Winchester Blvd",
; "city_locality": "San Jose",
; "state_province": "CA",
; "postal_code": "95128",
; "country_code": "US"
; },
; "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::ckUpdateString(json,"label_format","png")
CkJsonObject::ckUpdateString(json,"label_layout","4x6")
CkJsonObject::ckUpdateString(json,"label_download_type","inline")
CkJsonObject::ckUpdateString(json,"shipment.service_code","usps_priority_mail")
CkJsonObject::ckUpdateString(json,"shipment.ship_from.name","John Doe")
CkJsonObject::ckUpdateString(json,"shipment.ship_from.company_name","Example Corp.")
CkJsonObject::ckUpdateString(json,"shipment.ship_from.address_line1","4009 Marathon Blvd")
CkJsonObject::ckUpdateString(json,"shipment.ship_from.city_locality","Austin")
CkJsonObject::ckUpdateString(json,"shipment.ship_from.state_province","TX")
CkJsonObject::ckUpdateString(json,"shipment.ship_from.postal_code","78756")
CkJsonObject::ckUpdateString(json,"shipment.ship_from.country_code","US")
CkJsonObject::ckUpdateString(json,"shipment.ship_from.phone","512-555-5555")
CkJsonObject::ckUpdateString(json,"shipment.ship_to.name","Amanda Miller")
CkJsonObject::ckUpdateString(json,"shipment.ship_to.address_line1","525 S Winchester Blvd")
CkJsonObject::ckUpdateString(json,"shipment.ship_to.city_locality","San Jose")
CkJsonObject::ckUpdateString(json,"shipment.ship_to.state_province","CA")
CkJsonObject::ckUpdateString(json,"shipment.ship_to.postal_code","95128")
CkJsonObject::ckUpdateString(json,"shipment.ship_to.country_code","US")
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-1376213",
; "status": "completed",
; "shipment_id": "se-4140409",
; "ship_date": "2019-09-17T00:00:00Z",
; "created_at": "2019-09-17T21:24:38.2926571Z",
; "shipment_cost": {
; "currency": "usd",
; "amount": 98.14
; },
; "insurance_cost": {
; "currency": "usd",
; "amount": 0
; },
; "tracking_number": "9405511899564298842779",
; "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": {
; "href": "data:application/pdf;base64,JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9MZW5ndGggNDkvRmlsdGVyL0ZsYXRlRGVjb2RlPj5zdHJlYW0KeJwr5HIK4TI2UzC2NFMISeFyDeEK5CpUMFQwAEIImZyroB+RZqjgkq8QyAUA6zUJ9gplbmRzdHJlYW0KZW5kb2JqCjQgMCBvYmoKPDwvVHlwZS9QYWdlL01lZGlhQm94WzAgMCAyNzQuNDYgNDMyXS9SZXNvdXJjZXM8PC9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUIgL0ltYWdlQyAvSW1hZ2VJXS9YT2JqZWN0PDwvWGYxIDEgMCBSPj4+Pi9Db250ZW50cyAyIDAgUi9QYXJlbnQgMyAwIFI+PgplbmRvYmoKMSAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDEyNTIvUmVzb3VyY2VzPDwvRm9udDw8L0ZhYmMxNyA1IDAgUi9GYWJjNyA2IDAgUi9YaTAgNyAwIFI+Pi9Qcm9jU2V0Wy9QREYvVGV4dC9JbWFnZUIvSW1hZ2VDL0ltYWdlSV0vWE9iamVjdDw8L0lhYmMxOCA4IDAgUi9JYWJjMjUgOSAwIFI+Pj4+L1R5cGUvWE9iamVjdC9TdWJ0eXBlL0Zvcm0vQkJveFswIDAgMjc0LjQ2IDQzMl0vTWF0cml4WzEgMCAwIDEgMCAwXS9Gb3JtVHlwZSAxPj5zdHJlYW0KeJy1WNtS40YQfVeV/2GqUpXKPniY6bnnzQbBegPY2NqETeWFENhla4HFbC6fnzPiJiHNKDFFmbKERuo+3X2658g3RTE9HhU3o0Iygc84HrQidno5KgR3xP7GsV5a7sUryrL6i5ziTmvcKzl5tj4bFatRcTQqSpjr2ISdB6PyyeL64/1Z9IO/aOT8yUg0wJWrb61PiJORnmnyXLs7a9MqmqjWo2Jr9+T3U8eMZtV508EdBskst0aysVacWHVZP3U7Kn5YvGHVZzisar89yVBWpHCT01xbfYf/GfgeQzFTm5jq5GGsBQ8SmVDGcBUSmZA2RtqbC2W4cAaGJPFgW+lYzubLWfWBHUxm+4zGO5MPv5GSQ0mSRnIJGgxEp7kBdYYzZQFvMFW9xm6e7EjHlSEmZeBeRGhYip/1R2RZCHH/TSpwhxobzxXByxk7f3RYtG7ksnVbASbph0XJhW8tWq79w+LdjY1FKbl/XNX15eaqQ0clDSMcrZOWSdXBJJ4lwwMl46FQX0lYBmesTucigEhJv7HpRHrVcZNGZUQjog4qNIBI58ogVyL5rNUgRtKv9Vyky+tko0adCjoMmzQq57lPV9CrRhU6z3rX4FV3NTRq1EEVTC6iELhK+5WCuE0nSwqbY5aUIkctKXUuKky6XKEkOC8pbRy7xRO9usaVyNVKKsoVSyrXCKzbyZq4ycStQ64icahSJm6jG5Og52mbrRh6IxeYtfV5ckRJbFRp32iAXGDogMw8kF42Auv69raBvGc+isZI6AYWdGMmdNMSfC4wEjI35whtkBkLhLmf4RpJlSsJoQ0yk4GIGk3UHe6Y/U+BdZeVzDURYfpnuEZogwzXztlRV8SAvdIqz6TCjTKhYUKUQ/0aBvJG1RrGcedaGub9arFi1XKy/dPscI9919YuHRxIutCaGHYSa+z/hkGxCaOw7MAIWhhmokwLAYY1Bc+8JsdcyMgpaGVs/7hfWcWV13cqCOmPwjtqI4yr+iRe35oBHhzsXGfUooyTXUkVEfD+REsHsnpKSWekKDgEMwY/TWjJZ2FpJYQSUKJSiIFURxYZRXgXoChgN4GC1o817wJRgpz3NIQgsgaKV0P4OqE3yQXyH9VnD4Td5fyAOe+MHUKBXtROBKZc1Pt+AxjYEZXtTYQIW9JtYVDlWRZrISCLFdS0vKcZ+AHBXK/HFvdtnpHJ8+yet/HtLLhEI+VCEn3RvF+xxXxVTfZK9j3bLUv8O5ntDOT3EQnGrdqEZb1QWq9GLQSvAsBjq1AtAL/OD0vmmFVsf8qWk6r8j2nApqTsJiTrTcP29eX05Haxvjg9G/Cv0ayMMFe9T3nPDFbRM1LfTZCBnXmZz/6L/eIFTLdfiw3Iv2K/zA6335arqlyy6f7PO6+MglA+2UKxmhyyd/NVybYnLBgI24EChNq/Tu1qeEXFAEj6N9gsMOia/t/OFvmgX+YRU8co3XJZzX8cCpJLPKIovkRuSjNh2jS7/nSFWXc2EOuLHWMzeua5/Ofk8uuXM7Z9vf7KX9s9dqFn7iGMAzs4WZ98+3R9xaZf/vrjtTEo/RzD5M/bbxdXrDru20qjkISPYuv4QjBvYLcQGHIC0ur5sf71xihL8QdLD/Fq2fjh5GFBa0wYhk1YO0CIDXaw2C/fVJ8bEEVcKaviqPgXoQAZiAplbmRzdHJlYW0KZW5kb2JqCjUgMCBvYmoKPDwvQmFzZUZvbnQvSGVsdmV0aWNhL0VuY29kaW5nL1dpbkFuc2lFbmNvZGluZy9TdWJ0eXBlL1R5cGUxL1R5cGUvRm9udD4+CmVuZG9iago2IDAgb2JqCjw8L0Jhc2VGb250L0hlbHZldGljYS1Cb2xkL0VuY29kaW5nL1dpbkFuc2lFbmNvZGluZy9TdWJ0eXBlL1R5cGUxL1R5cGUvRm9udD4+CmVuZG9iago3IDAgb2JqCjw8L1R5cGUvRm9udC9TdWJ0eXBlL1R5cGUxL0Jhc2VGb250L0hlbHZldGljYS9FbmNvZGluZzw8L1R5cGUvRW5jb2RpbmcvRGlmZmVyZW5jZXNbNjUvQSA2OS9FIDc2L0wvTSA4MC9QIDgzL1NdPj4vRmlyc3RDaGFyIDY1L0xhc3RDaGFyIDgzL1dpZHRoc1s2NjcgMCAwIDAgNjY3IDAgMCAwIDAgMCAwIDU1NiA4MzMgMCAwIDY2NyAwIDAgNjY3XT4+CmVuZG9iago4IDAgb2JqCjw8L0JpdHNQZXJDb21wb25lbnQgOC9Db2xvclNwYWNlL0RldmljZUdyYXkvRmlsdGVyL0ZsYXRlRGVjb2RlL0hlaWdodCA4NS9MZW5ndGggNzQ3L1N1YnR5cGUvSW1hZ2UvVHlwZS9YT2JqZWN0L1dpZHRoIDM3Nj4+c3RyZWFtCnic7dLtSkMxEEVR3/+lKyLlnq/cVvBfd0GsMcnMWZOvL/88Hvrz81n/O63+ruvv5+r6fp157teb1h258qylnfp9zzW/QzNkT3qLnvCEK3Pe4TdtPdxxxx133D/VPfOsOnpvJnRtT3KaqCftHF7Hv5+Tr2nlzjRfs8ybcccdd9xxx/099z2JzL8ENONK132vM91H9pCSKdc79OxV0TvspN5HTxh33HHHHXfcX7vrCU9yErp68oq6lnf4373/5OtVMn/PdJ3PV+aTys62CO6444477ri/636tqqmf6M60rxRzx2vX6t4F+v48sSetk3DzdbfuW6p3c8Ydd9xxxx33v7q32ZbwRLqeZ/L/rdL1M43nzxnnTDS39+Fr/nbSwnVxxx133HHH/d79lKB3ZI/ZuZp0Np9R7umpdm1d9S70Rn8Pa1+/He3vTiTngTvuuOOOO+4t6Te4cVZc/ef5077MmaeywsqVXZ0qr5r5YvKU++j9nhJ33HHHHXfcz+6ePGfhUvfz8MxeNat3qjvv9Ok7+i21fE/Xu8ns6x3hjjvuuOOO+7377lg78Z3Z47qjpTTn9dtlulIrpudDPn2HWq20PoO8v5O2Ku6444477rif3HWXZ0uflrlTdDudXE/aq+u9e97Z/2kWvmPV9Hyvq+KOO+644477cu8ZLJmUc5dMtk/pbLyG39u1U9Bv1877dWjl93a0qO7DHXfccccd9zt3/av70/95197vf+zwqj7btbJegcrk5FRwvwOfblZZqrjjjjvuuOOe7j2Hnc1v0r3Z87rVldeZnI/XyUxtsmu6YKp3lS2aaXHHHXfcccd9u6/O/MQ5Ve6+9nnutb4ydhaff055zXS/mj6zJP3dnSaNO+6444477md3raPOOokl0+7+bVudFffk2/ncba6m65qVVuwpZi+444477rjj/tp9q2iPuZ4p1gQ9eeY/pfGJ5fy9m75xVd6z8wlo523jbwV33HHHHffPdf8GTmHBYAplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwvQml0c1BlckNvbXBvbmVudCA4L0NvbG9yU3BhY2UvRGV2aWNlUkdCL0ZpbHRlci9GbGF0ZURlY29kZS9IZWlnaHQgNDcvTGVuZ3RoIDY0OC9TdWJ0eXBlL0ltYWdlL1R5cGUvWE9iamVjdC9XaWR0aCAxMjU+PnN0cmVhbQp4nO2Y206DMQyD+/4vPe4Q/G2cL27WIVFfNvEh1tgkXi8H4zcsjYsybu0fwa39I7i1N2IEIDvL/uHaYzPiamUxFY+lHjTLg/D6adeyNp/weNeUFvc5A+Qe65xfZF/NKb0BRuVveUnp6jwaQQoXHMdrj0bpvXrkQQsuR1FsPRJ2XFAXMoJuU4o4Fk6rSItqoSy5+hHapbXzE+yjDIwAnGJ7Ld81i2i21H6g/6j5yBoG47JajU/HG2onl9pIHaOWSBUlQa2WepF4YqcUuxHVluYYnKsfjenYrr3Uw5tAqnvEKJ2jH43p6Kt9c58LpnYkQ+leyDpWu5HchnGyuKtakZ1BaI4J1RhGUVXADqOWIGUeRYLVe2fN2UiEhzF0Bg/LnFE2sQ+lSveWpjsZOLGlc+II90vhxx+ovdrDkrIJwyjaFCLLd14FyZBa6LuMHi5eZ/+1cvGN2/lHsOy88RvjfvksAX8CdvRv7QLiJ3Vf9ta+xKOWW/sB3FrO499+GseEdC3iGi78MRVcblYXyC2biByXvo8RJ+rTllyeJA3AR/CWTVRNyX4XcVNN7FdTne/cy0lYQq2lK0GJdITFm2qHUx2mdHU0jWrZyVDSJ1MbqWxXVJK/qytbyujHA9GsRk0phLXTFTkEEg/UTjCzUllIiW70AnD9Uhvcq5QE+qZJvKJSr5Ia1C+VwL1KSaBvmsSgRLV4AWx9cv4+9vPDBZKf1NIVGwa7tZfUIMvT2Ue1jeilRCEHpkSjrvmxmmp5rAeh7J0cLYwJYiS6aok9QO0i8D6WJ4seXn21EzuSwYgd6UOpFlQd0ySEOOsvHWEMkpzoQ6lGcK80CadXa+mKLXxFgLC7i3fiCz2YXQAKZW5kc3RyZWFtCmVuZG9iagozIDAgb2JqCjw8L1R5cGUvUGFnZXMvQ291bnQgMS9LaWRzWzQgMCBSXS9JVFhUKDUuMS4xKT4+CmVuZG9iagoxMCAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMyAwIFI+PgplbmRvYmoKMTEgMCBvYmoKPDwvUHJvZHVjZXIoaVRleHRTaGFycCA1LjEuMSBcKGNcKSAxVDNYVCBCVkJBKS9DcmVhdGlvbkRhdGUoRDoyMDE5MDkxNzE0MjQ0MC0wNycwMCcpL01vZERhdGUoRDoyMDE5MDkxNzE0MjQ0MC0wNycwMCcpPj4KZW5kb2JqCnhyZWYKMCAxMgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAyOTQgMDAwMDAgbiAKMDAwMDAwMDAxNSAwMDAwMCBuIAowMDAwMDAzOTI2IDAwMDAwIG4gCjAwMDAwMDAxMzAgMDAwMDAgbiAKMDAwMDAwMTgyOCAwMDAwMCBuIAowMDAwMDAxOTE2IDAwMDAwIG4gCjAwMDAwMDIwMDkgMDAwMDAgbiAKMDAwMDAwMjIyMiAwMDAwMCBuIAowMDAwMDAzMTI0IDAwMDAwIG4gCjAwMDAwMDM5ODkgMDAwMDAgbiAKMDAwMDAwNDAzNSAwMDAwMCBuIAp0cmFpbGVyCjw8L1NpemUgMTIvUm9vdCAxMCAwIFIvSW5mbyAxMSAwIFIvSUQgWzxjMTQ2ZTU4NzU5ODk0MmZhNjhjOGI4MGUzZDJhZDhkZT48ZGNhNjE2Mzk5NzQ2ODQ2YTNjNjU5OGVjZDk1NzdlZjI+XT4+CnN0YXJ0eHJlZgo0MTcxCiUlRU9GCg=="
; },
; "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": "9405511899564298842779",
; "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")
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 '{
"label_format": "png",
"label_layout": "4x6",
"label_download_type": "inline",
"shipment": {
"service_code": "usps_priority_mail",
"ship_from": {
"name": "John Doe",
"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"
},
"ship_to": {
"name": "Amanda Miller",
"address_line1": "525 S Winchester Blvd",
"city_locality": "San Jose",
"state_province": "CA",
"postal_code": "95128",
"country_code": "US"
},
"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 & download a 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\"label_format\": \"png\",\n\t\"label_layout\": \"4x6\",\n\t\"label_download_type\": \"inline\",\n\t\"shipment\": {\n\t\t\"service_code\": \"usps_priority_mail\",\n\t\t\"ship_from\": {\n\t\t\t\"name\": \"John Doe\",\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\"ship_to\": {\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\"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": "By default, whenever you create a label in ShipEngine we'll give you several URLs to download the label in various file formats. However, this requires a second HTTP request to download a label. You can perform both steps in a single request by specifying `label_download_type: \"inline\"` and specifying your desired `label_format` and `label_layout`."
},
"response": [
{
"name": "Create & download a label",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"label_format\": \"pdf\",\n\t\"label_layout\": \"4x6\",\n\t\"label_download_type\": \"inline\",\n\t\"shipment\": {\n\t\t\"service_code\": \"usps_priority_mail\",\n\t\t\"ship_from\": {\n\t\t\t\"name\": \"John Doe\",\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\"ship_to\": {\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\"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": "Tue, 17 Sep 2019 21:24:40 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "7552"
},
{
"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/GC0HAV1fQ0sxF0VSXwcXVHpSAAMPQBxSFlIUChoDAlABWQZQBE5TDwNNRCUOAQchU1oPCQdfVgN1cFBETwRRDksHZQ=="
},
{
"key": "x-powered-by",
"value": "ASP.NET"
},
{
"key": "x-shipengine-environment",
"value": "j"
},
{
"key": "x-shipengine-requestid",
"value": "43c559d6-09d3-4232-bae6-42f9e582df56"
},
{
"key": "x-shipengine-server",
"value": "SS-J-WEB03"
}
],
"cookie": [
],
"body": "{\n \"label_id\": \"se-1376213\",\n \"status\": \"completed\",\n \"shipment_id\": \"se-4140409\",\n \"ship_date\": \"2019-09-17T00:00:00Z\",\n \"created_at\": \"2019-09-17T21:24:38.2926571Z\",\n \"shipment_cost\": {\n \"currency\": \"usd\",\n \"amount\": 98.14\n },\n \"insurance_cost\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"tracking_number\": \"9405511899564298842779\",\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 \"href\": \"data:application/pdf;base64,JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9MZW5ndGggNDkvRmlsdGVyL0ZsYXRlRGVjb2RlPj5zdHJlYW0KeJwr5HIK4TI2UzC2NFMISeFyDeEK5CpUMFQwAEIImZyroB+RZqjgkq8QyAUA6zUJ9gplbmRzdHJlYW0KZW5kb2JqCjQgMCBvYmoKPDwvVHlwZS9QYWdlL01lZGlhQm94WzAgMCAyNzQuNDYgNDMyXS9SZXNvdXJjZXM8PC9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUIgL0ltYWdlQyAvSW1hZ2VJXS9YT2JqZWN0PDwvWGYxIDEgMCBSPj4+Pi9Db250ZW50cyAyIDAgUi9QYXJlbnQgMyAwIFI+PgplbmRvYmoKMSAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDEyNTIvUmVzb3VyY2VzPDwvRm9udDw8L0ZhYmMxNyA1IDAgUi9GYWJjNyA2IDAgUi9YaTAgNyAwIFI+Pi9Qcm9jU2V0Wy9QREYvVGV4dC9JbWFnZUIvSW1hZ2VDL0ltYWdlSV0vWE9iamVjdDw8L0lhYmMxOCA4IDAgUi9JYWJjMjUgOSAwIFI+Pj4+L1R5cGUvWE9iamVjdC9TdWJ0eXBlL0Zvcm0vQkJveFswIDAgMjc0LjQ2IDQzMl0vTWF0cml4WzEgMCAwIDEgMCAwXS9Gb3JtVHlwZSAxPj5zdHJlYW0KeJy1WNtS40YQfVeV/2GqUpXKPniY6bnnzQbBegPY2NqETeWFENhla4HFbC6fnzPiJiHNKDFFmbKERuo+3X2658g3RTE9HhU3o0Iygc84HrQidno5KgR3xP7GsV5a7sUryrL6i5ziTmvcKzl5tj4bFatRcTQqSpjr2ISdB6PyyeL64/1Z9IO/aOT8yUg0wJWrb61PiJORnmnyXLs7a9MqmqjWo2Jr9+T3U8eMZtV508EdBskst0aysVacWHVZP3U7Kn5YvGHVZzisar89yVBWpHCT01xbfYf/GfgeQzFTm5jq5GGsBQ8SmVDGcBUSmZA2RtqbC2W4cAaGJPFgW+lYzubLWfWBHUxm+4zGO5MPv5GSQ0mSRnIJGgxEp7kBdYYzZQFvMFW9xm6e7EjHlSEmZeBeRGhYip/1R2RZCHH/TSpwhxobzxXByxk7f3RYtG7ksnVbASbph0XJhW8tWq79w+LdjY1FKbl/XNX15eaqQ0clDSMcrZOWSdXBJJ4lwwMl46FQX0lYBmesTucigEhJv7HpRHrVcZNGZUQjog4qNIBI58ogVyL5rNUgRtKv9Vyky+tko0adCjoMmzQq57lPV9CrRhU6z3rX4FV3NTRq1EEVTC6iELhK+5WCuE0nSwqbY5aUIkctKXUuKky6XKEkOC8pbRy7xRO9usaVyNVKKsoVSyrXCKzbyZq4ycStQ64icahSJm6jG5Og52mbrRh6IxeYtfV5ckRJbFRp32iAXGDogMw8kF42Auv69raBvGc+isZI6AYWdGMmdNMSfC4wEjI35whtkBkLhLmf4RpJlSsJoQ0yk4GIGk3UHe6Y/U+BdZeVzDURYfpnuEZogwzXztlRV8SAvdIqz6TCjTKhYUKUQ/0aBvJG1RrGcedaGub9arFi1XKy/dPscI9919YuHRxIutCaGHYSa+z/hkGxCaOw7MAIWhhmokwLAYY1Bc+8JsdcyMgpaGVs/7hfWcWV13cqCOmPwjtqI4yr+iRe35oBHhzsXGfUooyTXUkVEfD+REsHsnpKSWekKDgEMwY/TWjJZ2FpJYQSUKJSiIFURxYZRXgXoChgN4GC1o817wJRgpz3NIQgsgaKV0P4OqE3yQXyH9VnD4Td5fyAOe+MHUKBXtROBKZc1Pt+AxjYEZXtTYQIW9JtYVDlWRZrISCLFdS0vKcZ+AHBXK/HFvdtnpHJ8+yet/HtLLhEI+VCEn3RvF+xxXxVTfZK9j3bLUv8O5ntDOT3EQnGrdqEZb1QWq9GLQSvAsBjq1AtAL/OD0vmmFVsf8qWk6r8j2nApqTsJiTrTcP29eX05Haxvjg9G/Cv0ayMMFe9T3nPDFbRM1LfTZCBnXmZz/6L/eIFTLdfiw3Iv2K/zA6335arqlyy6f7PO6+MglA+2UKxmhyyd/NVybYnLBgI24EChNq/Tu1qeEXFAEj6N9gsMOia/t/OFvmgX+YRU8co3XJZzX8cCpJLPKIovkRuSjNh2jS7/nSFWXc2EOuLHWMzeua5/Ofk8uuXM7Z9vf7KX9s9dqFn7iGMAzs4WZ98+3R9xaZf/vrjtTEo/RzD5M/bbxdXrDru20qjkISPYuv4QjBvYLcQGHIC0ur5sf71xihL8QdLD/Fq2fjh5GFBa0wYhk1YO0CIDXaw2C/fVJ8bEEVcKaviqPgXoQAZiAplbmRzdHJlYW0KZW5kb2JqCjUgMCBvYmoKPDwvQmFzZUZvbnQvSGVsdmV0aWNhL0VuY29kaW5nL1dpbkFuc2lFbmNvZGluZy9TdWJ0eXBlL1R5cGUxL1R5cGUvRm9udD4+CmVuZG9iago2IDAgb2JqCjw8L0Jhc2VGb250L0hlbHZldGljYS1Cb2xkL0VuY29kaW5nL1dpbkFuc2lFbmNvZGluZy9TdWJ0eXBlL1R5cGUxL1R5cGUvRm9udD4+CmVuZG9iago3IDAgb2JqCjw8L1R5cGUvRm9udC9TdWJ0eXBlL1R5cGUxL0Jhc2VGb250L0hlbHZldGljYS9FbmNvZGluZzw8L1R5cGUvRW5jb2RpbmcvRGlmZmVyZW5jZXNbNjUvQSA2OS9FIDc2L0wvTSA4MC9QIDgzL1NdPj4vRmlyc3RDaGFyIDY1L0xhc3RDaGFyIDgzL1dpZHRoc1s2NjcgMCAwIDAgNjY3IDAgMCAwIDAgMCAwIDU1NiA4MzMgMCAwIDY2NyAwIDAgNjY3XT4+CmVuZG9iago4IDAgb2JqCjw8L0JpdHNQZXJDb21wb25lbnQgOC9Db2xvclNwYWNlL0RldmljZUdyYXkvRmlsdGVyL0ZsYXRlRGVjb2RlL0hlaWdodCA4NS9MZW5ndGggNzQ3L1N1YnR5cGUvSW1hZ2UvVHlwZS9YT2JqZWN0L1dpZHRoIDM3Nj4+c3RyZWFtCnic7dLtSkMxEEVR3/+lKyLlnq/cVvBfd0GsMcnMWZOvL/88Hvrz81n/O63+ruvv5+r6fp157teb1h258qylnfp9zzW/QzNkT3qLnvCEK3Pe4TdtPdxxxx133D/VPfOsOnpvJnRtT3KaqCftHF7Hv5+Tr2nlzjRfs8ybcccdd9xxx/099z2JzL8ENONK132vM91H9pCSKdc79OxV0TvspN5HTxh33HHHHXfcX7vrCU9yErp68oq6lnf4373/5OtVMn/PdJ3PV+aTys62CO6444477ri/636tqqmf6M60rxRzx2vX6t4F+v48sSetk3DzdbfuW6p3c8Ydd9xxxx33v7q32ZbwRLqeZ/L/rdL1M43nzxnnTDS39+Fr/nbSwnVxxx133HHH/d79lKB3ZI/ZuZp0Np9R7umpdm1d9S70Rn8Pa1+/He3vTiTngTvuuOOOO+4t6Te4cVZc/ef5077MmaeywsqVXZ0qr5r5YvKU++j9nhJ33HHHHXfcz+6ePGfhUvfz8MxeNat3qjvv9Ok7+i21fE/Xu8ns6x3hjjvuuOOO+7377lg78Z3Z47qjpTTn9dtlulIrpudDPn2HWq20PoO8v5O2Ku6444477rif3HWXZ0uflrlTdDudXE/aq+u9e97Z/2kWvmPV9Hyvq+KOO+644477cu8ZLJmUc5dMtk/pbLyG39u1U9Bv1877dWjl93a0qO7DHXfccccd9zt3/av70/95197vf+zwqj7btbJegcrk5FRwvwOfblZZqrjjjjvuuOOe7j2Hnc1v0r3Z87rVldeZnI/XyUxtsmu6YKp3lS2aaXHHHXfcccd9u6/O/MQ5Ve6+9nnutb4ydhaff055zXS/mj6zJP3dnSaNO+6444477md3raPOOokl0+7+bVudFffk2/ncba6m65qVVuwpZi+444477rjj/tp9q2iPuZ4p1gQ9eeY/pfGJ5fy9m75xVd6z8wlo523jbwV33HHHHffPdf8GTmHBYAplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwvQml0c1BlckNvbXBvbmVudCA4L0NvbG9yU3BhY2UvRGV2aWNlUkdCL0ZpbHRlci9GbGF0ZURlY29kZS9IZWlnaHQgNDcvTGVuZ3RoIDY0OC9TdWJ0eXBlL0ltYWdlL1R5cGUvWE9iamVjdC9XaWR0aCAxMjU+PnN0cmVhbQp4nO2Y206DMQyD+/4vPe4Q/G2cL27WIVFfNvEh1tgkXi8H4zcsjYsybu0fwa39I7i1N2IEIDvL/uHaYzPiamUxFY+lHjTLg/D6adeyNp/weNeUFvc5A+Qe65xfZF/NKb0BRuVveUnp6jwaQQoXHMdrj0bpvXrkQQsuR1FsPRJ2XFAXMoJuU4o4Fk6rSItqoSy5+hHapbXzE+yjDIwAnGJ7Ld81i2i21H6g/6j5yBoG47JajU/HG2onl9pIHaOWSBUlQa2WepF4YqcUuxHVluYYnKsfjenYrr3Uw5tAqnvEKJ2jH43p6Kt9c58LpnYkQ+leyDpWu5HchnGyuKtakZ1BaI4J1RhGUVXADqOWIGUeRYLVe2fN2UiEhzF0Bg/LnFE2sQ+lSveWpjsZOLGlc+II90vhxx+ovdrDkrIJwyjaFCLLd14FyZBa6LuMHi5eZ/+1cvGN2/lHsOy88RvjfvksAX8CdvRv7QLiJ3Vf9ta+xKOWW/sB3FrO499+GseEdC3iGi78MRVcblYXyC2biByXvo8RJ+rTllyeJA3AR/CWTVRNyX4XcVNN7FdTne/cy0lYQq2lK0GJdITFm2qHUx2mdHU0jWrZyVDSJ1MbqWxXVJK/qytbyujHA9GsRk0phLXTFTkEEg/UTjCzUllIiW70AnD9Uhvcq5QE+qZJvKJSr5Ia1C+VwL1KSaBvmsSgRLV4AWx9cv4+9vPDBZKf1NIVGwa7tZfUIMvT2Ue1jeilRCEHpkSjrvmxmmp5rAeh7J0cLYwJYiS6aok9QO0i8D6WJ4seXn21EzuSwYgd6UOpFlQd0ySEOOsvHWEMkpzoQ6lGcK80CadXa+mKLXxFgLC7i3fiCz2YXQAKZW5kc3RyZWFtCmVuZG9iagozIDAgb2JqCjw8L1R5cGUvUGFnZXMvQ291bnQgMS9LaWRzWzQgMCBSXS9JVFhUKDUuMS4xKT4+CmVuZG9iagoxMCAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMyAwIFI+PgplbmRvYmoKMTEgMCBvYmoKPDwvUHJvZHVjZXIoaVRleHRTaGFycCA1LjEuMSBcKGNcKSAxVDNYVCBCVkJBKS9DcmVhdGlvbkRhdGUoRDoyMDE5MDkxNzE0MjQ0MC0wNycwMCcpL01vZERhdGUoRDoyMDE5MDkxNzE0MjQ0MC0wNycwMCcpPj4KZW5kb2JqCnhyZWYKMCAxMgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAyOTQgMDAwMDAgbiAKMDAwMDAwMDAxNSAwMDAwMCBuIAowMDAwMDAzOTI2IDAwMDAwIG4gCjAwMDAwMDAxMzAgMDAwMDAgbiAKMDAwMDAwMTgyOCAwMDAwMCBuIAowMDAwMDAxOTE2IDAwMDAwIG4gCjAwMDAwMDIwMDkgMDAwMDAgbiAKMDAwMDAwMjIyMiAwMDAwMCBuIAowMDAwMDAzMTI0IDAwMDAwIG4gCjAwMDAwMDM5ODkgMDAwMDAgbiAKMDAwMDAwNDAzNSAwMDAwMCBuIAp0cmFpbGVyCjw8L1NpemUgMTIvUm9vdCAxMCAwIFIvSW5mbyAxMSAwIFIvSUQgWzxjMTQ2ZTU4NzU5ODk0MmZhNjhjOGI4MGUzZDJhZDhkZT48ZGNhNjE2Mzk5NzQ2ODQ2YTNjNjU5OGVjZDk1NzdlZjI+XT4+CnN0YXJ0eHJlZgo0MTcxCiUlRU9GCg==\"\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\": \"9405511899564298842779\",\n \"label_messages\": {\n \"reference1\": null,\n \"reference2\": null,\n \"reference3\": null\n },\n \"external_package_id\": null\n }\n ]\n}"
}
]
}
