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
-- 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
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'API-Key', '{{API_KEY}}'
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 @http, 'QuickGetSb', @success OUT, 'https://api.shipengine.com/v1/carriers/se-963360/services', @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
-- 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 @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)
-- {
-- "services": [
-- {
-- "carrier_id": "se-121861",
-- "carrier_code": "stamps_com",
-- "service_code": "usps_first_class_mail",
-- "name": "USPS First Class Mail",
-- "domestic": true,
-- "international": false,
-- "is_multi_package_supported": false
-- },
-- {
-- "carrier_id": "se-121861",
-- "carrier_code": "stamps_com",
-- "service_code": "usps_media_mail",
-- "name": "USPS Media Mail",
-- "domestic": true,
-- "international": false,
-- "is_multi_package_supported": false
-- },
-- {
-- "carrier_id": "se-121861",
-- "carrier_code": "stamps_com",
-- "service_code": "usps_parcel_select",
-- "name": "USPS Parcel Select Ground",
-- "domestic": true,
-- "international": false,
-- "is_multi_package_supported": false
-- },
-- {
-- "carrier_id": "se-121861",
-- "carrier_code": "stamps_com",
-- "service_code": "usps_priority_mail",
-- "name": "USPS Priority Mail",
-- "domestic": true,
-- "international": false,
-- "is_multi_package_supported": false
-- },
-- {
-- "carrier_id": "se-121861",
-- "carrier_code": "stamps_com",
-- "service_code": "usps_priority_mail_express",
-- "name": "USPS Priority Mail Express",
-- "domestic": true,
-- "international": false,
-- "is_multi_package_supported": false
-- },
-- {
-- "carrier_id": "se-121861",
-- "carrier_code": "stamps_com",
-- "service_code": "usps_first_class_mail_international",
-- "name": "USPS First Class Mail Intl",
-- "domestic": false,
-- "international": true,
-- "is_multi_package_supported": false
-- },
-- {
-- "carrier_id": "se-121861",
-- "carrier_code": "stamps_com",
-- "service_code": "usps_priority_mail_international",
-- "name": "USPS Priority Mail Intl",
-- "domestic": false,
-- "international": true,
-- "is_multi_package_supported": false
-- },
-- {
-- "carrier_id": "se-121861",
-- "carrier_code": "stamps_com",
-- "service_code": "usps_priority_mail_express_international",
-- "name": "USPS Priority Mail Express Intl",
-- "domestic": false,
-- "international": true,
-- "is_multi_package_supported": false
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @carrier_id nvarchar(4000)
DECLARE @carrier_code nvarchar(4000)
DECLARE @service_code nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @domestic int
DECLARE @international int
DECLARE @is_multi_package_supported int
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'services'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @carrier_id OUT, 'services[i].carrier_id'
EXEC sp_OAMethod @jResp, 'StringOf', @carrier_code OUT, 'services[i].carrier_code'
EXEC sp_OAMethod @jResp, 'StringOf', @service_code OUT, 'services[i].service_code'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'services[i].name'
EXEC sp_OAMethod @jResp, 'BoolOf', @domestic OUT, 'services[i].domestic'
EXEC sp_OAMethod @jResp, 'BoolOf', @international OUT, 'services[i].international'
EXEC sp_OAMethod @jResp, 'BoolOf', @is_multi_package_supported OUT, 'services[i].is_multi_package_supported'
SELECT @i = @i + 1
END
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/carriers/se-963360/services
Postman Collection Item JSON
{
"name": "List a carrier's services",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let response = pm.response.json();",
"",
"if (response.services.length > 0) {",
" response.carrier_code = response.services[0].carrier_code;",
"",
" 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>",
" <img src=\"https://www.shipengine.com/docs/img/logos/carriers/{{carrier_code}}.svg\" class=\"mr-3\" style=\"height: 50px\">",
" Services Offered",
" </h1>",
" <table class=\"table\">",
" <thead class=\"thead-dark\">",
" <tr>",
" <th>Service</th>",
" <th>Code</th>",
" <th>Regions</th>",
" </tr>",
" </thead>",
" <tbody>",
" {{#each services}}",
" <tr>",
" <td>{{name}}</td>",
" <td>",
" <samp>{{service_code}}</samp>",
" </td>",
" <td>",
" {{#if domestic}}✔{{else}}❌{{/if}} Domestic<br>",
" {{#if international}}✔{{else}}❌{{/if}} International",
" </td>",
" </tr>",
" {{/each}}",
" </tbody>",
" </table>",
" `;",
"",
" pm.visualizer.set(template, response);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/carriers/{{fedex}}/services",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"carriers",
"{{fedex}}",
"services"
]
},
"description": "Each carrier supports many different services, such as ground, air, 3-day, overnight, etc. In ShipEngine, each of these services has a `service_code`, which you'll need to specify when shipping a package. This request shows you how to list all the available services (and their service codes) for a carrier."
},
"response": [
{
"name": "List a carrier's services",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/carriers/{{stamps_com}}/services",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"carriers",
"{{stamps_com}}",
"services"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 16 Sep 2019 20:59:12 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "2263"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "ddbbd84a-03ab-48e8-8fc1-119489aae2b7"
}
],
"cookie": [
],
"body": "{\n \"services\": [\n {\n \"carrier_id\": \"se-121861\",\n \"carrier_code\": \"stamps_com\",\n \"service_code\": \"usps_first_class_mail\",\n \"name\": \"USPS First Class Mail\",\n \"domestic\": true,\n \"international\": false,\n \"is_multi_package_supported\": false\n },\n {\n \"carrier_id\": \"se-121861\",\n \"carrier_code\": \"stamps_com\",\n \"service_code\": \"usps_media_mail\",\n \"name\": \"USPS Media Mail\",\n \"domestic\": true,\n \"international\": false,\n \"is_multi_package_supported\": false\n },\n {\n \"carrier_id\": \"se-121861\",\n \"carrier_code\": \"stamps_com\",\n \"service_code\": \"usps_parcel_select\",\n \"name\": \"USPS Parcel Select Ground\",\n \"domestic\": true,\n \"international\": false,\n \"is_multi_package_supported\": false\n },\n {\n \"carrier_id\": \"se-121861\",\n \"carrier_code\": \"stamps_com\",\n \"service_code\": \"usps_priority_mail\",\n \"name\": \"USPS Priority Mail\",\n \"domestic\": true,\n \"international\": false,\n \"is_multi_package_supported\": false\n },\n {\n \"carrier_id\": \"se-121861\",\n \"carrier_code\": \"stamps_com\",\n \"service_code\": \"usps_priority_mail_express\",\n \"name\": \"USPS Priority Mail Express\",\n \"domestic\": true,\n \"international\": false,\n \"is_multi_package_supported\": false\n },\n {\n \"carrier_id\": \"se-121861\",\n \"carrier_code\": \"stamps_com\",\n \"service_code\": \"usps_first_class_mail_international\",\n \"name\": \"USPS First Class Mail Intl\",\n \"domestic\": false,\n \"international\": true,\n \"is_multi_package_supported\": false\n },\n {\n \"carrier_id\": \"se-121861\",\n \"carrier_code\": \"stamps_com\",\n \"service_code\": \"usps_priority_mail_international\",\n \"name\": \"USPS Priority Mail Intl\",\n \"domestic\": false,\n \"international\": true,\n \"is_multi_package_supported\": false\n },\n {\n \"carrier_id\": \"se-121861\",\n \"carrier_code\": \"stamps_com\",\n \"service_code\": \"usps_priority_mail_express_international\",\n \"name\": \"USPS Priority Mail Express Intl\",\n \"domestic\": false,\n \"international\": true,\n \"is_multi_package_supported\": false\n }\n ]\n}"
}
]
}
