Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcLabel_id
LOCAL lcStatus
LOCAL lcShipment_id
LOCAL lcShip_date
LOCAL lcCreated_at
LOCAL lcV_Currency
LOCAL lcAmount
LOCAL lcInsurance_costCurrency
LOCAL lnInsurance_costAmount
LOCAL lcTracking_number
LOCAL lnIs_return_label
LOCAL lcRma_number
LOCAL lnIs_international
LOCAL lcBatch_id
LOCAL lcCarrier_id
LOCAL lcService_code
LOCAL lcPackage_code
LOCAL lnVoided
LOCAL lcVoided_at
LOCAL lcLabel_format
LOCAL lcLabel_layout
LOCAL lnTrackable
LOCAL lcCarrier_code
LOCAL lcTracking_status
LOCAL lcV_Pdf
LOCAL lcPng
LOCAL lcZpl
LOCAL lcLabel_downloadHref
LOCAL lcForm_download
LOCAL lcInsurance_claim
LOCAL j
LOCAL lnCount_j
LOCAL lnValue
LOCAL lcUnit
LOCAL lcDimensionsUnit
LOCAL lnLength
LOCAL lnWidth
LOCAL lnHeight
LOCAL lcInsured_valueCurrency
LOCAL lnInsured_valueAmount
LOCAL lcReference1
LOCAL lcReference2
LOCAL lcReference3
LOCAL lcExternal_package_id
LOCAL lnTotal
LOCAL lnPage
LOCAL lnPages
LOCAL lcHref
LOCAL lcLastHref
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateInt("page",1)
loQueryParams.UpdateInt("page_size",10)
loQueryParams.UpdateString("sort_by","created_at")
loQueryParams.UpdateString("sort_dir","desc")
loHttp.SetRequestHeader("API-Key","{{API_KEY}}")
loResp = loHttp.QuickRequestParams("GET","https://api.shipengine.com/v1/labels",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "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 loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lnTotal = loJResp.IntOf("total")
lnPage = loJResp.IntOf("page")
lnPages = loJResp.IntOf("pages")
lcHref = loJResp.StringOf("links.first.href")
lcLastHref = loJResp.StringOf("links.last.href")
i = 0
lnCount_i = loJResp.SizeOfArray("labels")
DO WHILE i < lnCount_i
loJResp.I = i
lcLabel_id = loJResp.StringOf("labels[i].label_id")
lcStatus = loJResp.StringOf("labels[i].status")
lcShipment_id = loJResp.StringOf("labels[i].shipment_id")
lcShip_date = loJResp.StringOf("labels[i].ship_date")
lcCreated_at = loJResp.StringOf("labels[i].created_at")
lcV_Currency = loJResp.StringOf("labels[i].shipment_cost.currency")
lcAmount = loJResp.StringOf("labels[i].shipment_cost.amount")
lcInsurance_costCurrency = loJResp.StringOf("labels[i].insurance_cost.currency")
lnInsurance_costAmount = loJResp.IntOf("labels[i].insurance_cost.amount")
lcTracking_number = loJResp.StringOf("labels[i].tracking_number")
lnIs_return_label = loJResp.BoolOf("labels[i].is_return_label")
lcRma_number = loJResp.StringOf("labels[i].rma_number")
lnIs_international = loJResp.BoolOf("labels[i].is_international")
lcBatch_id = loJResp.StringOf("labels[i].batch_id")
lcCarrier_id = loJResp.StringOf("labels[i].carrier_id")
lcService_code = loJResp.StringOf("labels[i].service_code")
lcPackage_code = loJResp.StringOf("labels[i].package_code")
lnVoided = loJResp.BoolOf("labels[i].voided")
lcVoided_at = loJResp.StringOf("labels[i].voided_at")
lcLabel_format = loJResp.StringOf("labels[i].label_format")
lcLabel_layout = loJResp.StringOf("labels[i].label_layout")
lnTrackable = loJResp.BoolOf("labels[i].trackable")
lcCarrier_code = loJResp.StringOf("labels[i].carrier_code")
lcTracking_status = loJResp.StringOf("labels[i].tracking_status")
lcV_Pdf = loJResp.StringOf("labels[i].label_download.pdf")
lcPng = loJResp.StringOf("labels[i].label_download.png")
lcZpl = loJResp.StringOf("labels[i].label_download.zpl")
lcLabel_downloadHref = loJResp.StringOf("labels[i].label_download.href")
lcForm_download = loJResp.StringOf("labels[i].form_download")
lcInsurance_claim = loJResp.StringOf("labels[i].insurance_claim")
j = 0
lnCount_j = loJResp.SizeOfArray("labels[i].packages")
DO WHILE j < lnCount_j
loJResp.J = j
lcPackage_code = loJResp.StringOf("labels[i].packages[j].package_code")
lnValue = loJResp.IntOf("labels[i].packages[j].weight.value")
lcUnit = loJResp.StringOf("labels[i].packages[j].weight.unit")
lcDimensionsUnit = loJResp.StringOf("labels[i].packages[j].dimensions.unit")
lnLength = loJResp.IntOf("labels[i].packages[j].dimensions.length")
lnWidth = loJResp.IntOf("labels[i].packages[j].dimensions.width")
lnHeight = loJResp.IntOf("labels[i].packages[j].dimensions.height")
lcInsured_valueCurrency = loJResp.StringOf("labels[i].packages[j].insured_value.currency")
lnInsured_valueAmount = loJResp.IntOf("labels[i].packages[j].insured_value.amount")
lcTracking_number = loJResp.StringOf("labels[i].packages[j].tracking_number")
lcReference1 = loJResp.StringOf("labels[i].packages[j].label_messages.reference1")
lcReference2 = loJResp.StringOf("labels[i].packages[j].label_messages.reference2")
lcReference3 = loJResp.StringOf("labels[i].packages[j].label_messages.reference3")
lcExternal_package_id = loJResp.StringOf("labels[i].packages[j].external_package_id")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
