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
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateInt(queryParams,"page",1)
CkJsonObject::ckUpdateInt(queryParams,"page_size",10)
CkJsonObject::ckUpdateString(queryParams,"sort_by","created_at")
CkJsonObject::ckUpdateString(queryParams,"sort_dir","desc")
CkHttp::ckSetRequestHeader(http,"API-Key","{{API_KEY}}")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.shipengine.com/v1/labels",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
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(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "labels": [
; {
; "label_id": "se-1376213",
; "status": "voided",
; "shipment_id": "se-4140409",
; "ship_date": "2019-09-17T00:00:00Z",
; "created_at": "2019-09-17T21:24:38.293Z",
; "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": true,
; "voided_at": "2019-09-17T21:28:48.89Z",
; "label_format": "pdf",
; "label_layout": "4x6",
; "trackable": false,
; "carrier_code": "stamps_com",
; "tracking_status": "in_transit",
; "label_download": {
; "pdf": "https://api.shipengine.com/v1/downloads/10/y7wnsDz5f02H4IlaqNO0aw/label-1376213.pdf",
; "png": "https://api.shipengine.com/v1/downloads/10/y7wnsDz5f02H4IlaqNO0aw/label-1376213.png",
; "zpl": "https://api.shipengine.com/v1/downloads/10/y7wnsDz5f02H4IlaqNO0aw/label-1376213.zpl",
; "href": "https://api.shipengine.com/v1/downloads/10/y7wnsDz5f02H4IlaqNO0aw/label-1376213.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": "9405511899564298842779",
; "label_messages": {
; "reference1": null,
; "reference2": null,
; "reference3": null
; },
; "external_package_id": null
; }
; ]
; }
; ],
; "total": 1,
; "page": 1,
; "pages": 1,
; "links": {
; "first": {
; "href": "https://api.shipengine.com/v1/labels?label_status=voided&carrier_id=se-121861&service_code=usps_priority_mail&tracking_number=9405511899564298842779&sort_by=created_at&sort_dir=desc&page=1&page_size=10"
; },
; "last": {
; "href": "https://api.shipengine.com/v1/labels?label_status=voided&carrier_id=se-121861&service_code=usps_priority_mail&tracking_number=9405511899564298842779&sort_by=created_at&sort_dir=desc&page=1&page_size=10"
; },
; "prev": {},
; "next": {}
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
label_id.s
status.s
shipment_id.s
ship_date.s
created_at.s
v_Currency.s
Amount.s
insurance_costCurrency.s
insurance_costAmount.i
tracking_number.s
is_return_label.i
rma_number.s
is_international.i
batch_id.s
carrier_id.s
service_code.s
package_code.s
voided.i
voided_at.s
label_format.s
label_layout.s
trackable.i
carrier_code.s
tracking_status.s
v_Pdf.s
Png.s
Zpl.s
label_downloadHref.s
form_download.s
insurance_claim.s
j.i
count_j.i
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
total.i = CkJsonObject::ckIntOf(jResp,"total")
page.i = CkJsonObject::ckIntOf(jResp,"page")
pages.i = CkJsonObject::ckIntOf(jResp,"pages")
Href.s = CkJsonObject::ckStringOf(jResp,"links.first.href")
LastHref.s = CkJsonObject::ckStringOf(jResp,"links.last.href")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"labels")
While i < count_i
CkJsonObject::setCkI(jResp, i)
label_id = CkJsonObject::ckStringOf(jResp,"labels[i].label_id")
status = CkJsonObject::ckStringOf(jResp,"labels[i].status")
shipment_id = CkJsonObject::ckStringOf(jResp,"labels[i].shipment_id")
ship_date = CkJsonObject::ckStringOf(jResp,"labels[i].ship_date")
created_at = CkJsonObject::ckStringOf(jResp,"labels[i].created_at")
v_Currency = CkJsonObject::ckStringOf(jResp,"labels[i].shipment_cost.currency")
Amount = CkJsonObject::ckStringOf(jResp,"labels[i].shipment_cost.amount")
insurance_costCurrency = CkJsonObject::ckStringOf(jResp,"labels[i].insurance_cost.currency")
insurance_costAmount = CkJsonObject::ckIntOf(jResp,"labels[i].insurance_cost.amount")
tracking_number = CkJsonObject::ckStringOf(jResp,"labels[i].tracking_number")
is_return_label = CkJsonObject::ckBoolOf(jResp,"labels[i].is_return_label")
rma_number = CkJsonObject::ckStringOf(jResp,"labels[i].rma_number")
is_international = CkJsonObject::ckBoolOf(jResp,"labels[i].is_international")
batch_id = CkJsonObject::ckStringOf(jResp,"labels[i].batch_id")
carrier_id = CkJsonObject::ckStringOf(jResp,"labels[i].carrier_id")
service_code = CkJsonObject::ckStringOf(jResp,"labels[i].service_code")
package_code = CkJsonObject::ckStringOf(jResp,"labels[i].package_code")
voided = CkJsonObject::ckBoolOf(jResp,"labels[i].voided")
voided_at = CkJsonObject::ckStringOf(jResp,"labels[i].voided_at")
label_format = CkJsonObject::ckStringOf(jResp,"labels[i].label_format")
label_layout = CkJsonObject::ckStringOf(jResp,"labels[i].label_layout")
trackable = CkJsonObject::ckBoolOf(jResp,"labels[i].trackable")
carrier_code = CkJsonObject::ckStringOf(jResp,"labels[i].carrier_code")
tracking_status = CkJsonObject::ckStringOf(jResp,"labels[i].tracking_status")
v_Pdf = CkJsonObject::ckStringOf(jResp,"labels[i].label_download.pdf")
Png = CkJsonObject::ckStringOf(jResp,"labels[i].label_download.png")
Zpl = CkJsonObject::ckStringOf(jResp,"labels[i].label_download.zpl")
label_downloadHref = CkJsonObject::ckStringOf(jResp,"labels[i].label_download.href")
form_download = CkJsonObject::ckStringOf(jResp,"labels[i].form_download")
insurance_claim = CkJsonObject::ckStringOf(jResp,"labels[i].insurance_claim")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"labels[i].packages")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
package_code = CkJsonObject::ckStringOf(jResp,"labels[i].packages[j].package_code")
Value = CkJsonObject::ckIntOf(jResp,"labels[i].packages[j].weight.value")
Unit = CkJsonObject::ckStringOf(jResp,"labels[i].packages[j].weight.unit")
dimensionsUnit = CkJsonObject::ckStringOf(jResp,"labels[i].packages[j].dimensions.unit")
Length = CkJsonObject::ckIntOf(jResp,"labels[i].packages[j].dimensions.length")
Width = CkJsonObject::ckIntOf(jResp,"labels[i].packages[j].dimensions.width")
Height = CkJsonObject::ckIntOf(jResp,"labels[i].packages[j].dimensions.height")
insured_valueCurrency = CkJsonObject::ckStringOf(jResp,"labels[i].packages[j].insured_value.currency")
insured_valueAmount = CkJsonObject::ckIntOf(jResp,"labels[i].packages[j].insured_value.amount")
tracking_number = CkJsonObject::ckStringOf(jResp,"labels[i].packages[j].tracking_number")
Reference1 = CkJsonObject::ckStringOf(jResp,"labels[i].packages[j].label_messages.reference1")
Reference2 = CkJsonObject::ckStringOf(jResp,"labels[i].packages[j].label_messages.reference2")
Reference3 = CkJsonObject::ckStringOf(jResp,"labels[i].packages[j].label_messages.reference3")
external_package_id = CkJsonObject::ckStringOf(jResp,"labels[i].packages[j].external_package_id")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "page=1"
-d "page_size=10"
-d "sort_by=created_at"
-d "sort_dir=desc"
-H "API-Key: {{API_KEY}}"
https://api.shipengine.com/v1/labels
Postman Collection Item JSON
{
"name": "List your labels",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let response = pm.response.json();",
"",
"if (response.labels.length > 0) {",
" const template = `",
" <link rel=\"stylesheet\" href=\"https://cdnjs.cloudflare.com/ajax/libs/meyer-reset/2.0/reset.min.css\">",
" <link rel=\"stylesheet\" href=\"https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css\">",
" ",
" <h1>Labels</h1>",
" <p class=\"lead\">",
" <span class=\"badge badge-success\">{{total}} labels</span> matched your search criteria <small>({{pages}} pages of results)</small>",
" </p>",
" ",
" <table class=\"table table-hover\">",
" <thead class=\"thead-dark\">",
" <tr>",
" <th>Label ID</th>",
" <th>Carrier</th>",
" <th>Service</th>",
" <th>Cost</th>",
" <th>Status</th>",
" <th>Tracking Number</th>",
" </tr>",
" </thead>",
" <tbody>",
" {{#each labels}}",
" <tr>",
" <td>{{label_id}}</td>",
" <td>",
" <img alt=\"{{carrier_id}}\" style=\"height: 30px\"",
" src=\"https://www.shipengine.com/docs/img/logos/carriers/{{carrier_code}}.svg\">",
" </td>",
" <td>",
" <samp>{{service_code}}</samp>",
" </td>",
" <td>{{shipment_cost.amount}} {{shipment_cost.currency}}</td>",
" <td>{{status}}</td>",
" <td>{{tracking_number}}</td>",
" </tr>",
" {{/each}}",
" </tbody>",
" </table>",
" `;",
" ",
" pm.visualizer.set(template, response);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/labels?page=1&page_size=10&sort_by=created_at&sort_dir=desc",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"labels"
],
"query": [
{
"key": "label_status",
"value": "voided",
"disabled": true
},
{
"key": "carrier_id",
"value": "{{stamps_com}}",
"disabled": true
},
{
"key": "service_code",
"value": "usps_priority_mail",
"disabled": true
},
{
"key": "tracking_number",
"value": "{{tracking_number}}",
"disabled": true
},
{
"key": "page",
"value": "1"
},
{
"key": "page_size",
"value": "10"
},
{
"key": "sort_by",
"value": "created_at"
},
{
"key": "sort_dir",
"value": "desc"
}
]
},
"description": "This request shows how to list labels that match certain criteria, such as the carrier, service, date, warehouse, status, etc."
},
"response": [
{
"name": "List your labels",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/labels?label_status=voided&carrier_id={{stamps_com}}&service_code=usps_priority_mail&tracking_number={{tracking_number}}&page=1&page_size=10&sort_by=created_at&sort_dir=desc",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"labels"
],
"query": [
{
"key": "label_status",
"value": "voided"
},
{
"key": "carrier_id",
"value": "{{stamps_com}}"
},
{
"key": "service_code",
"value": "usps_priority_mail"
},
{
"key": "tracking_number",
"value": "{{tracking_number}}"
},
{
"key": "page",
"value": "1"
},
{
"key": "page_size",
"value": "10"
},
{
"key": "sort_by",
"value": "created_at"
},
{
"key": "sort_dir",
"value": "desc"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Tue, 17 Sep 2019 21:33:29 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "2699"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "b3354fc0-d6c2-4711-861f-03730ee4ad2e"
}
],
"cookie": [
],
"body": "{\n \"labels\": [\n {\n \"label_id\": \"se-1376213\",\n \"status\": \"voided\",\n \"shipment_id\": \"se-4140409\",\n \"ship_date\": \"2019-09-17T00:00:00Z\",\n \"created_at\": \"2019-09-17T21:24:38.293Z\",\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\": true,\n \"voided_at\": \"2019-09-17T21:28:48.89Z\",\n \"label_format\": \"pdf\",\n \"label_layout\": \"4x6\",\n \"trackable\": false,\n \"carrier_code\": \"stamps_com\",\n \"tracking_status\": \"in_transit\",\n \"label_download\": {\n \"pdf\": \"https://api.shipengine.com/v1/downloads/10/y7wnsDz5f02H4IlaqNO0aw/label-1376213.pdf\",\n \"png\": \"https://api.shipengine.com/v1/downloads/10/y7wnsDz5f02H4IlaqNO0aw/label-1376213.png\",\n \"zpl\": \"https://api.shipengine.com/v1/downloads/10/y7wnsDz5f02H4IlaqNO0aw/label-1376213.zpl\",\n \"href\": \"https://api.shipengine.com/v1/downloads/10/y7wnsDz5f02H4IlaqNO0aw/label-1376213.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\": \"9405511899564298842779\",\n \"label_messages\": {\n \"reference1\": null,\n \"reference2\": null,\n \"reference3\": null\n },\n \"external_package_id\": null\n }\n ]\n }\n ],\n \"total\": 1,\n \"page\": 1,\n \"pages\": 1,\n \"links\": {\n \"first\": {\n \"href\": \"https://api.shipengine.com/v1/labels?label_status=voided&carrier_id=se-121861&service_code=usps_priority_mail&tracking_number=9405511899564298842779&sort_by=created_at&sort_dir=desc&page=1&page_size=10\"\n },\n \"last\": {\n \"href\": \"https://api.shipengine.com/v1/labels?label_status=voided&carrier_id=se-121861&service_code=usps_priority_mail&tracking_number=9405511899564298842779&sort_by=created_at&sort_dir=desc&page=1&page_size=10\"\n },\n \"prev\": {},\n \"next\": {}\n }\n}"
}
]
}
