Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateInt("page",1)
$oQueryParams.UpdateInt("page_size",10)
$oQueryParams.UpdateString("sort_by","created_at")
$oQueryParams.UpdateString("sort_dir","desc")
$oHttp.SetRequestHeader "API-Key","{{API_KEY}}"
Local $oResp = $oHttp.QuickRequestParams("GET","https://api.shipengine.com/v1/labels",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sLabel_id
Local $status
Local $shipment_id
Local $ship_date
Local $sCreated_at
Local $sV_Currency
Local $sAmount
Local $sInsurance_costCurrency
Local $insurance_costAmount
Local $sTracking_number
Local $bIs_return_label
Local $sRma_number
Local $bIs_international
Local $sBatch_id
Local $sCarrier_id
Local $service_code
Local $sPackage_code
Local $bVoided
Local $sVoided_at
Local $sLabel_format
Local $sLabel_layout
Local $bTrackable
Local $sCarrier_code
Local $sTracking_status
Local $sV_Pdf
Local $sPng
Local $sZpl
Local $sLabel_downloadHref
Local $sForm_download
Local $sInsurance_claim
Local $iJ
Local $iCount_j
Local $iValue
Local $sUnit
Local $sDimensionsUnit
Local $iLength
Local $iWidth
Local $iHeight
Local $sInsured_valueCurrency
Local $insured_valueAmount
Local $sReference1
Local $sReference2
Local $sReference3
Local $sExternal_package_id
Local $iTotal = $oJResp.IntOf("total")
Local $iPage = $oJResp.IntOf("page")
Local $iPages = $oJResp.IntOf("pages")
Local $sHref = $oJResp.StringOf("links.first.href")
Local $sLastHref = $oJResp.StringOf("links.last.href")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("labels")
While $i < $iCount_i
$oJResp.I = $i
$sLabel_id = $oJResp.StringOf("labels[i].label_id")
$status = $oJResp.StringOf("labels[i].status")
$shipment_id = $oJResp.StringOf("labels[i].shipment_id")
$ship_date = $oJResp.StringOf("labels[i].ship_date")
$sCreated_at = $oJResp.StringOf("labels[i].created_at")
$sV_Currency = $oJResp.StringOf("labels[i].shipment_cost.currency")
$sAmount = $oJResp.StringOf("labels[i].shipment_cost.amount")
$sInsurance_costCurrency = $oJResp.StringOf("labels[i].insurance_cost.currency")
$insurance_costAmount = $oJResp.IntOf("labels[i].insurance_cost.amount")
$sTracking_number = $oJResp.StringOf("labels[i].tracking_number")
$bIs_return_label = $oJResp.BoolOf("labels[i].is_return_label")
$sRma_number = $oJResp.StringOf("labels[i].rma_number")
$bIs_international = $oJResp.BoolOf("labels[i].is_international")
$sBatch_id = $oJResp.StringOf("labels[i].batch_id")
$sCarrier_id = $oJResp.StringOf("labels[i].carrier_id")
$service_code = $oJResp.StringOf("labels[i].service_code")
$sPackage_code = $oJResp.StringOf("labels[i].package_code")
$bVoided = $oJResp.BoolOf("labels[i].voided")
$sVoided_at = $oJResp.StringOf("labels[i].voided_at")
$sLabel_format = $oJResp.StringOf("labels[i].label_format")
$sLabel_layout = $oJResp.StringOf("labels[i].label_layout")
$bTrackable = $oJResp.BoolOf("labels[i].trackable")
$sCarrier_code = $oJResp.StringOf("labels[i].carrier_code")
$sTracking_status = $oJResp.StringOf("labels[i].tracking_status")
$sV_Pdf = $oJResp.StringOf("labels[i].label_download.pdf")
$sPng = $oJResp.StringOf("labels[i].label_download.png")
$sZpl = $oJResp.StringOf("labels[i].label_download.zpl")
$sLabel_downloadHref = $oJResp.StringOf("labels[i].label_download.href")
$sForm_download = $oJResp.StringOf("labels[i].form_download")
$sInsurance_claim = $oJResp.StringOf("labels[i].insurance_claim")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("labels[i].packages")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sPackage_code = $oJResp.StringOf("labels[i].packages[j].package_code")
$iValue = $oJResp.IntOf("labels[i].packages[j].weight.value")
$sUnit = $oJResp.StringOf("labels[i].packages[j].weight.unit")
$sDimensionsUnit = $oJResp.StringOf("labels[i].packages[j].dimensions.unit")
$iLength = $oJResp.IntOf("labels[i].packages[j].dimensions.length")
$iWidth = $oJResp.IntOf("labels[i].packages[j].dimensions.width")
$iHeight = $oJResp.IntOf("labels[i].packages[j].dimensions.height")
$sInsured_valueCurrency = $oJResp.StringOf("labels[i].packages[j].insured_value.currency")
$insured_valueAmount = $oJResp.IntOf("labels[i].packages[j].insured_value.amount")
$sTracking_number = $oJResp.StringOf("labels[i].packages[j].tracking_number")
$sReference1 = $oJResp.StringOf("labels[i].packages[j].label_messages.reference1")
$sReference2 = $oJResp.StringOf("labels[i].packages[j].label_messages.reference2")
$sReference3 = $oJResp.StringOf("labels[i].packages[j].label_messages.reference3")
$sExternal_package_id = $oJResp.StringOf("labels[i].packages[j].external_package_id")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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}"
}
]
}
