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, 'UpdateString', @success OUT, 'carrier_code', 'fedex'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'tracking_number', '555671072708'
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/tracking', @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)
-- {
-- "tracking_number": "789830651142",
-- "status_code": "DE",
-- "status_description": "Delivered",
-- "carrier_status_code": "DL",
-- "carrier_status_description": "Delivered",
-- "ship_date": "2019-09-16T21:55:00Z",
-- "estimated_delivery_date": null,
-- "actual_delivery_date": "2019-09-17T20:02:00Z",
-- "exception_description": null,
-- "events": [
-- {
-- "occurred_at": "2019-09-17T20:02:00Z",
-- "description": "Delivered",
-- "city_locality": "Austin",
-- "state_province": "TX",
-- "postal_code": "78702",
-- "country_code": "US",
-- "company_name": null,
-- "signer": "Signature not required",
-- "event_code": "DL"
-- },
-- {
-- "occurred_at": "2019-09-17T13:13:00Z",
-- "description": "On FedEx vehicle for delivery",
-- "city_locality": "AUSTIN",
-- "state_province": "TX",
-- "postal_code": "78721",
-- "country_code": "US",
-- "company_name": null,
-- "signer": null,
-- "event_code": "OD"
-- },
-- {
-- "occurred_at": "2019-09-17T12:09:00Z",
-- "description": "At local FedEx facility",
-- "city_locality": "AUSTIN",
-- "state_province": "TX",
-- "postal_code": "78721",
-- "country_code": "US",
-- "company_name": null,
-- "signer": null,
-- "event_code": "AR"
-- },
-- {
-- "occurred_at": "2019-09-17T08:05:00Z",
-- "description": "Departed FedEx location",
-- "city_locality": "FORT WORTH",
-- "state_province": "TX",
-- "postal_code": "76177",
-- "country_code": "US",
-- "company_name": null,
-- "signer": null,
-- "event_code": "DP"
-- },
-- {
-- "occurred_at": "2019-09-17T06:22:00Z",
-- "description": "Arrived at FedEx location",
-- "city_locality": "FORT WORTH",
-- "state_province": "TX",
-- "postal_code": "76177",
-- "country_code": "US",
-- "company_name": null,
-- "signer": null,
-- "event_code": "AR"
-- },
-- {
-- "occurred_at": "2019-09-17T03:27:00Z",
-- "description": "Departed FedEx location",
-- "city_locality": "OAKLAND",
-- "state_province": "CA",
-- "postal_code": "94621",
-- "country_code": "US",
-- "company_name": null,
-- "signer": null,
-- "event_code": "DP"
-- },
-- {
-- "occurred_at": "2019-09-17T01:04:00Z",
-- "description": "Arrived at FedEx location",
-- "city_locality": "OAKLAND",
-- "state_province": "CA",
-- "postal_code": "94621",
-- "country_code": "US",
-- "company_name": null,
-- "signer": null,
-- "event_code": "AR"
-- },
-- {
-- "occurred_at": "2019-09-17T00:10:00Z",
-- "description": "Left FedEx origin facility",
-- "city_locality": "PETALUMA",
-- "state_province": "CA",
-- "postal_code": "94954",
-- "country_code": "US",
-- "company_name": null,
-- "signer": null,
-- "event_code": "DP"
-- },
-- {
-- "occurred_at": "2019-09-16T21:55:00Z",
-- "description": "Picked up",
-- "city_locality": "PETALUMA",
-- "state_province": "CA",
-- "postal_code": "94954",
-- "country_code": "US",
-- "company_name": null,
-- "signer": null,
-- "event_code": "PU"
-- },
-- {
-- "occurred_at": "2019-09-16T15:31:38Z",
-- "description": "Shipment information sent to FedEx",
-- "city_locality": null,
-- "state_province": null,
-- "postal_code": null,
-- "country_code": null,
-- "company_name": null,
-- "signer": null,
-- "event_code": "OC"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @occurred_at nvarchar(4000)
DECLARE @description nvarchar(4000)
DECLARE @city_locality nvarchar(4000)
DECLARE @state_province nvarchar(4000)
DECLARE @postal_code nvarchar(4000)
DECLARE @country_code nvarchar(4000)
DECLARE @company_name nvarchar(4000)
DECLARE @signer nvarchar(4000)
DECLARE @event_code nvarchar(4000)
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 @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'events'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @occurred_at OUT, 'events[i].occurred_at'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'events[i].description'
EXEC sp_OAMethod @jResp, 'StringOf', @city_locality OUT, 'events[i].city_locality'
EXEC sp_OAMethod @jResp, 'StringOf', @state_province OUT, 'events[i].state_province'
EXEC sp_OAMethod @jResp, 'StringOf', @postal_code OUT, 'events[i].postal_code'
EXEC sp_OAMethod @jResp, 'StringOf', @country_code OUT, 'events[i].country_code'
EXEC sp_OAMethod @jResp, 'StringOf', @company_name OUT, 'events[i].company_name'
EXEC sp_OAMethod @jResp, 'StringOf', @signer OUT, 'events[i].signer'
EXEC sp_OAMethod @jResp, 'StringOf', @event_code OUT, 'events[i].event_code'
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 "carrier_code=fedex"
-d "tracking_number=555671072708"
-H "API-Key: {{API_KEY}}"
https://api.shipengine.com/v1/tracking
Postman Collection Item JSON
{
"name": "Track a package",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/tracking?carrier_code=fedex&tracking_number=555671072708",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"tracking"
],
"query": [
{
"key": "carrier_code",
"value": "stamps_com",
"disabled": true
},
{
"key": "tracking_number",
"value": "{{tracking_number}}",
"disabled": true
},
{
"key": "carrier_code",
"value": "fedex"
},
{
"key": "tracking_number",
"value": "555671072708"
}
]
},
"description": "This request demonstrates how to get tracking information for a package. The `carrier_code` and `tracking_number` are provided via query parameters."
},
"response": [
{
"name": "Track a package",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/tracking?carrier_code=fedex&tracking_number=789830651142",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"tracking"
],
"query": [
{
"key": "carrier_code",
"value": "fedex"
},
{
"key": "tracking_number",
"value": "789830651142"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 18 Sep 2019 18:50:08 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "3515"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "f4e88104-edb8-4a8f-bd1c-a5d85334bdb1"
}
],
"cookie": [
],
"body": "{\n \"tracking_number\": \"789830651142\",\n \"status_code\": \"DE\",\n \"status_description\": \"Delivered\",\n \"carrier_status_code\": \"DL\",\n \"carrier_status_description\": \"Delivered\",\n \"ship_date\": \"2019-09-16T21:55:00Z\",\n \"estimated_delivery_date\": null,\n \"actual_delivery_date\": \"2019-09-17T20:02:00Z\",\n \"exception_description\": null,\n \"events\": [\n {\n \"occurred_at\": \"2019-09-17T20:02:00Z\",\n \"description\": \"Delivered\",\n \"city_locality\": \"Austin\",\n \"state_province\": \"TX\",\n \"postal_code\": \"78702\",\n \"country_code\": \"US\",\n \"company_name\": null,\n \"signer\": \"Signature not required\",\n \"event_code\": \"DL\"\n },\n {\n \"occurred_at\": \"2019-09-17T13:13:00Z\",\n \"description\": \"On FedEx vehicle for delivery\",\n \"city_locality\": \"AUSTIN\",\n \"state_province\": \"TX\",\n \"postal_code\": \"78721\",\n \"country_code\": \"US\",\n \"company_name\": null,\n \"signer\": null,\n \"event_code\": \"OD\"\n },\n {\n \"occurred_at\": \"2019-09-17T12:09:00Z\",\n \"description\": \"At local FedEx facility\",\n \"city_locality\": \"AUSTIN\",\n \"state_province\": \"TX\",\n \"postal_code\": \"78721\",\n \"country_code\": \"US\",\n \"company_name\": null,\n \"signer\": null,\n \"event_code\": \"AR\"\n },\n {\n \"occurred_at\": \"2019-09-17T08:05:00Z\",\n \"description\": \"Departed FedEx location\",\n \"city_locality\": \"FORT WORTH\",\n \"state_province\": \"TX\",\n \"postal_code\": \"76177\",\n \"country_code\": \"US\",\n \"company_name\": null,\n \"signer\": null,\n \"event_code\": \"DP\"\n },\n {\n \"occurred_at\": \"2019-09-17T06:22:00Z\",\n \"description\": \"Arrived at FedEx location\",\n \"city_locality\": \"FORT WORTH\",\n \"state_province\": \"TX\",\n \"postal_code\": \"76177\",\n \"country_code\": \"US\",\n \"company_name\": null,\n \"signer\": null,\n \"event_code\": \"AR\"\n },\n {\n \"occurred_at\": \"2019-09-17T03:27:00Z\",\n \"description\": \"Departed FedEx location\",\n \"city_locality\": \"OAKLAND\",\n \"state_province\": \"CA\",\n \"postal_code\": \"94621\",\n \"country_code\": \"US\",\n \"company_name\": null,\n \"signer\": null,\n \"event_code\": \"DP\"\n },\n {\n \"occurred_at\": \"2019-09-17T01:04:00Z\",\n \"description\": \"Arrived at FedEx location\",\n \"city_locality\": \"OAKLAND\",\n \"state_province\": \"CA\",\n \"postal_code\": \"94621\",\n \"country_code\": \"US\",\n \"company_name\": null,\n \"signer\": null,\n \"event_code\": \"AR\"\n },\n {\n \"occurred_at\": \"2019-09-17T00:10:00Z\",\n \"description\": \"Left FedEx origin facility\",\n \"city_locality\": \"PETALUMA\",\n \"state_province\": \"CA\",\n \"postal_code\": \"94954\",\n \"country_code\": \"US\",\n \"company_name\": null,\n \"signer\": null,\n \"event_code\": \"DP\"\n },\n {\n \"occurred_at\": \"2019-09-16T21:55:00Z\",\n \"description\": \"Picked up\",\n \"city_locality\": \"PETALUMA\",\n \"state_province\": \"CA\",\n \"postal_code\": \"94954\",\n \"country_code\": \"US\",\n \"company_name\": null,\n \"signer\": null,\n \"event_code\": \"PU\"\n },\n {\n \"occurred_at\": \"2019-09-16T15:31:38Z\",\n \"description\": \"Shipment information sent to FedEx\",\n \"city_locality\": null,\n \"state_province\": null,\n \"postal_code\": null,\n \"country_code\": null,\n \"company_name\": null,\n \"signer\": null,\n \"event_code\": \"OC\"\n }\n ]\n}"
}
]
}
