Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'page', 1
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'page_size', 10
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'sort_by', 'created_at'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'sort_dir', 'desc'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'API-Key', '{{API_KEY}}'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api.shipengine.com/v1/labels', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @label_id nvarchar(4000)
DECLARE @status nvarchar(4000)
DECLARE @shipment_id nvarchar(4000)
DECLARE @ship_date nvarchar(4000)
DECLARE @created_at nvarchar(4000)
DECLARE @v_Currency nvarchar(4000)
DECLARE @Amount nvarchar(4000)
DECLARE @insurance_costCurrency nvarchar(4000)
DECLARE @insurance_costAmount int
DECLARE @tracking_number nvarchar(4000)
DECLARE @is_return_label int
DECLARE @rma_number nvarchar(4000)
DECLARE @is_international int
DECLARE @batch_id nvarchar(4000)
DECLARE @carrier_id nvarchar(4000)
DECLARE @service_code nvarchar(4000)
DECLARE @package_code nvarchar(4000)
DECLARE @voided int
DECLARE @voided_at nvarchar(4000)
DECLARE @label_format nvarchar(4000)
DECLARE @label_layout nvarchar(4000)
DECLARE @trackable int
DECLARE @carrier_code nvarchar(4000)
DECLARE @tracking_status nvarchar(4000)
DECLARE @v_Pdf nvarchar(4000)
DECLARE @Png nvarchar(4000)
DECLARE @Zpl nvarchar(4000)
DECLARE @label_downloadHref nvarchar(4000)
DECLARE @form_download nvarchar(4000)
DECLARE @insurance_claim nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @Value int
DECLARE @Unit nvarchar(4000)
DECLARE @dimensionsUnit nvarchar(4000)
DECLARE @Length int
DECLARE @Width int
DECLARE @Height int
DECLARE @insured_valueCurrency nvarchar(4000)
DECLARE @insured_valueAmount int
DECLARE @Reference1 nvarchar(4000)
DECLARE @Reference2 nvarchar(4000)
DECLARE @Reference3 nvarchar(4000)
DECLARE @external_package_id nvarchar(4000)
DECLARE @total int
EXEC sp_OAMethod @jResp, 'IntOf', @total OUT, 'total'
DECLARE @page int
EXEC sp_OAMethod @jResp, 'IntOf', @page OUT, 'page'
DECLARE @pages int
EXEC sp_OAMethod @jResp, 'IntOf', @pages OUT, 'pages'
DECLARE @Href nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Href OUT, 'links.first.href'
DECLARE @LastHref nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @LastHref OUT, 'links.last.href'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'labels'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @label_id OUT, 'labels[i].label_id'
EXEC sp_OAMethod @jResp, 'StringOf', @status OUT, 'labels[i].status'
EXEC sp_OAMethod @jResp, 'StringOf', @shipment_id OUT, 'labels[i].shipment_id'
EXEC sp_OAMethod @jResp, 'StringOf', @ship_date OUT, 'labels[i].ship_date'
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'labels[i].created_at'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Currency OUT, 'labels[i].shipment_cost.currency'
EXEC sp_OAMethod @jResp, 'StringOf', @Amount OUT, 'labels[i].shipment_cost.amount'
EXEC sp_OAMethod @jResp, 'StringOf', @insurance_costCurrency OUT, 'labels[i].insurance_cost.currency'
EXEC sp_OAMethod @jResp, 'IntOf', @insurance_costAmount OUT, 'labels[i].insurance_cost.amount'
EXEC sp_OAMethod @jResp, 'StringOf', @tracking_number OUT, 'labels[i].tracking_number'
EXEC sp_OAMethod @jResp, 'BoolOf', @is_return_label OUT, 'labels[i].is_return_label'
EXEC sp_OAMethod @jResp, 'StringOf', @rma_number OUT, 'labels[i].rma_number'
EXEC sp_OAMethod @jResp, 'BoolOf', @is_international OUT, 'labels[i].is_international'
EXEC sp_OAMethod @jResp, 'StringOf', @batch_id OUT, 'labels[i].batch_id'
EXEC sp_OAMethod @jResp, 'StringOf', @carrier_id OUT, 'labels[i].carrier_id'
EXEC sp_OAMethod @jResp, 'StringOf', @service_code OUT, 'labels[i].service_code'
EXEC sp_OAMethod @jResp, 'StringOf', @package_code OUT, 'labels[i].package_code'
EXEC sp_OAMethod @jResp, 'BoolOf', @voided OUT, 'labels[i].voided'
EXEC sp_OAMethod @jResp, 'StringOf', @voided_at OUT, 'labels[i].voided_at'
EXEC sp_OAMethod @jResp, 'StringOf', @label_format OUT, 'labels[i].label_format'
EXEC sp_OAMethod @jResp, 'StringOf', @label_layout OUT, 'labels[i].label_layout'
EXEC sp_OAMethod @jResp, 'BoolOf', @trackable OUT, 'labels[i].trackable'
EXEC sp_OAMethod @jResp, 'StringOf', @carrier_code OUT, 'labels[i].carrier_code'
EXEC sp_OAMethod @jResp, 'StringOf', @tracking_status OUT, 'labels[i].tracking_status'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Pdf OUT, 'labels[i].label_download.pdf'
EXEC sp_OAMethod @jResp, 'StringOf', @Png OUT, 'labels[i].label_download.png'
EXEC sp_OAMethod @jResp, 'StringOf', @Zpl OUT, 'labels[i].label_download.zpl'
EXEC sp_OAMethod @jResp, 'StringOf', @label_downloadHref OUT, 'labels[i].label_download.href'
EXEC sp_OAMethod @jResp, 'StringOf', @form_download OUT, 'labels[i].form_download'
EXEC sp_OAMethod @jResp, 'StringOf', @insurance_claim OUT, 'labels[i].insurance_claim'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'labels[i].packages'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @package_code OUT, 'labels[i].packages[j].package_code'
EXEC sp_OAMethod @jResp, 'IntOf', @Value OUT, 'labels[i].packages[j].weight.value'
EXEC sp_OAMethod @jResp, 'StringOf', @Unit OUT, 'labels[i].packages[j].weight.unit'
EXEC sp_OAMethod @jResp, 'StringOf', @dimensionsUnit OUT, 'labels[i].packages[j].dimensions.unit'
EXEC sp_OAMethod @jResp, 'IntOf', @Length OUT, 'labels[i].packages[j].dimensions.length'
EXEC sp_OAMethod @jResp, 'IntOf', @Width OUT, 'labels[i].packages[j].dimensions.width'
EXEC sp_OAMethod @jResp, 'IntOf', @Height OUT, 'labels[i].packages[j].dimensions.height'
EXEC sp_OAMethod @jResp, 'StringOf', @insured_valueCurrency OUT, 'labels[i].packages[j].insured_value.currency'
EXEC sp_OAMethod @jResp, 'IntOf', @insured_valueAmount OUT, 'labels[i].packages[j].insured_value.amount'
EXEC sp_OAMethod @jResp, 'StringOf', @tracking_number OUT, 'labels[i].packages[j].tracking_number'
EXEC sp_OAMethod @jResp, 'StringOf', @Reference1 OUT, 'labels[i].packages[j].label_messages.reference1'
EXEC sp_OAMethod @jResp, 'StringOf', @Reference2 OUT, 'labels[i].packages[j].label_messages.reference2'
EXEC sp_OAMethod @jResp, 'StringOf', @Reference3 OUT, 'labels[i].packages[j].label_messages.reference3'
EXEC sp_OAMethod @jResp, 'StringOf', @external_package_id OUT, 'labels[i].packages[j].external_package_id'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
