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
-- 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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'API-Key', '{{API_KEY}}'
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.shipengine.com/v1/labels/se-123456/track', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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 @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "tracking_number": "9405511899564298877610",
-- "status_code": "NY",
-- "status_description": "Not Yet In System",
-- "carrier_status_code": "-2147219283",
-- "carrier_status_description": "A status update is not yet available for this tracking number. More information will become available when USPS receives the tracking information, or when the package is received by USPS.",
-- "ship_date": null,
-- "estimated_delivery_date": null,
-- "actual_delivery_date": null,
-- "exception_description": null,
-- "events": null
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @tracking_number nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @tracking_number OUT, 'tracking_number'
DECLARE @status_code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @status_code OUT, 'status_code'
DECLARE @status_description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @status_description OUT, 'status_description'
DECLARE @carrier_status_code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @carrier_status_code OUT, 'carrier_status_code'
DECLARE @carrier_status_description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @carrier_status_description OUT, 'carrier_status_description'
DECLARE @ship_date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ship_date OUT, 'ship_date'
DECLARE @estimated_delivery_date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @estimated_delivery_date OUT, 'estimated_delivery_date'
DECLARE @actual_delivery_date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @actual_delivery_date OUT, 'actual_delivery_date'
DECLARE @exception_description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @exception_description OUT, 'exception_description'
DECLARE @events nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @events OUT, 'events'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X GET
-H "API-Key: {{API_KEY}}"
https://api.shipengine.com/v1/labels/se-123456/track
Postman Collection Item JSON
{
"name": "Track using a label ID",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/labels/{{label_id}}/track",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"labels",
"{{label_id}}",
"track"
]
},
"description": "If you created the shipping label using ShipEngine, then tracking a package is even easier. No need to specify the `carrier_code` and `tracking_number`. All you need is the `label_id`."
},
"response": [
{
"name": "Track using a label ID",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/labels/{{label_id}}/track",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"labels",
"{{label_id}}",
"track"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 18 Sep 2019 18:53:59 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "531"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "853bc684-6123-43aa-91ab-5ce1a8da908b"
}
],
"cookie": [
],
"body": "{\n \"tracking_number\": \"9405511899564298877610\",\n \"status_code\": \"NY\",\n \"status_description\": \"Not Yet In System\",\n \"carrier_status_code\": \"-2147219283\",\n \"carrier_status_description\": \"A status update is not yet available for this tracking number. More information will become available when USPS receives the tracking information, or when the package is received by USPS.\",\n \"ship_date\": null,\n \"estimated_delivery_date\": null,\n \"actual_delivery_date\": null,\n \"exception_description\": null,\n \"events\": null\n}"
}
]
}
