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-963358', @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)
-- {
-- "carrier_id": "se-121861",
-- "carrier_code": "stamps_com",
-- "account_number": "test_account_121861",
-- "requires_funded_amount": true,
-- "balance": 8343.36,
-- "nickname": "ShipEngine Test Account - Stamps.com",
-- "friendly_name": "Stamps.com",
-- "primary": false,
-- "has_multi_package_supporting_services": false,
-- "supports_label_messages": true,
-- "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
-- }
-- ],
-- "packages": [
-- {
-- "package_id": null,
-- "package_code": "cubic",
-- "name": "Cubic",
-- "description": "Cubic"
-- },
-- {
-- "package_id": null,
-- "package_code": "flat_rate_envelope",
-- "name": "Flat Rate Envelope",
-- "description": "USPS flat rate envelope. A special cardboard envelope provided by the USPS that clearly indicates \"Flat Rate\"."
-- },
-- {
-- "package_id": null,
-- "package_code": "flat_rate_legal_envelope",
-- "name": "Flat Rate Legal Envelope",
-- "description": "Flat Rate Legal Envelope"
-- },
-- {
-- "package_id": null,
-- "package_code": "flat_rate_padded_envelope",
-- "name": "Flat Rate Padded Envelope",
-- "description": "Flat Rate Padded Envelope"
-- },
-- {
-- "package_id": null,
-- "package_code": "large_envelope_or_flat",
-- "name": "Large Envelope or Flat",
-- "description": "Large envelope or flat. Has one dimension that is between 11 1/2\" and 15\" long, 6 1/18\" and 12\" high, or 1/4\" and 3/4\" thick."
-- },
-- {
-- "package_id": null,
-- "package_code": "large_flat_rate_box",
-- "name": "Large Flat Rate Box",
-- "description": "Large Flat Rate Box"
-- },
-- {
-- "package_id": null,
-- "package_code": "large_package",
-- "name": "Large Package (any side > 12\")",
-- "description": "Large package. Longest side plus the distance around the thickest part is over 84\" and less than or equal to 108\"."
-- },
-- {
-- "package_id": null,
-- "package_code": "letter",
-- "name": "Letter",
-- "description": "Letter"
-- },
-- {
-- "package_id": null,
-- "package_code": "medium_flat_rate_box",
-- "name": "Medium Flat Rate Box",
-- "description": "USPS flat rate box. A special 11\" x 8 1/2\" x 5 1/2\" or 14\" x 3.5\" x 12\" USPS box that clearly indicates \"Flat Rate Box\""
-- },
-- {
-- "package_id": null,
-- "package_code": "package",
-- "name": "Package",
-- "description": "Package. Longest side plus the distance around the thickest part is less than or equal to 84\""
-- },
-- {
-- "package_id": null,
-- "package_code": "regional_rate_box_a",
-- "name": "Regional Rate Box A",
-- "description": "Regional Rate Box A"
-- },
-- {
-- "package_id": null,
-- "package_code": "regional_rate_box_b",
-- "name": "Regional Rate Box B",
-- "description": "Regional Rate Box B"
-- },
-- {
-- "package_id": null,
-- "package_code": "small_flat_rate_box",
-- "name": "Small Flat Rate Box",
-- "description": "Small Flat Rate Box"
-- },
-- {
-- "package_id": null,
-- "package_code": "thick_envelope",
-- "name": "Thick Envelope",
-- "description": "Thick envelope. Envelopes or flats greater than 3/4\" at the thickest point."
-- }
-- ],
-- "options": [
-- {
-- "name": "non_machinable",
-- "default_value": "false",
-- "description": ""
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @service_code nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @domestic int
DECLARE @international int
DECLARE @is_multi_package_supported int
DECLARE @package_id nvarchar(4000)
DECLARE @package_code nvarchar(4000)
DECLARE @description nvarchar(4000)
DECLARE @default_value nvarchar(4000)
DECLARE @carrier_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @carrier_id OUT, 'carrier_id'
DECLARE @carrier_code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @carrier_code OUT, 'carrier_code'
DECLARE @account_number nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @account_number OUT, 'account_number'
DECLARE @requires_funded_amount int
EXEC sp_OAMethod @jResp, 'BoolOf', @requires_funded_amount OUT, 'requires_funded_amount'
DECLARE @balance nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @balance OUT, 'balance'
DECLARE @nickname nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @nickname OUT, 'nickname'
DECLARE @friendly_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @friendly_name OUT, 'friendly_name'
DECLARE @primary int
EXEC sp_OAMethod @jResp, 'BoolOf', @primary OUT, 'primary'
DECLARE @has_multi_package_supporting_services int
EXEC sp_OAMethod @jResp, 'BoolOf', @has_multi_package_supporting_services OUT, 'has_multi_package_supporting_services'
DECLARE @supports_label_messages int
EXEC sp_OAMethod @jResp, 'BoolOf', @supports_label_messages OUT, 'supports_label_messages'
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
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'packages'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @package_id OUT, 'packages[i].package_id'
EXEC sp_OAMethod @jResp, 'StringOf', @package_code OUT, 'packages[i].package_code'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'packages[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'packages[i].description'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'options'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'options[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @default_value OUT, 'options[i].default_value'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'options[i].description'
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-963358
Postman Collection Item JSON
{
"name": "Get a specific carrier",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let response = pm.response.json();",
"",
"if (response) {",
" 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\">",
" ",
" <img alt=\"{{nickname}}\" class=\"w-25 ml-5 mb-5 float-right\"",
" src=\"https://www.shipengine.com/docs/img/logos/carriers/{{carrier_code}}.svg\">",
"",
" <h1>{{nickname}}</h1>",
" <table class=\"table w-50 mt-2\">",
" <tr>",
" <th>Carrier ID:</th>",
" <td>{{carrier_id}}</td>",
" </tr>",
" <tr>",
" <th>Carrier Code:</th>",
" <td>",
" <samp>{{carrier_code}}</samp>",
" </td>",
" </tr>",
" <tr>",
" <th>Account Number</th>",
" <td>{{account_number}}</td>",
" </tr>",
" </table>",
" ",
" <div class=\"container-fluid\">",
" <div class=\"row\">",
" <div class=\"col-lg-4 mt-4\">",
" <h2>Services Offered</h2>",
" <ul style=\"list-style: circle inside\">",
" {{#each services}}",
" <li>{{name}}</li>",
" {{/each}}",
" </ul>",
" </div>",
" <div class=\"col-lg-4 mt-4\">",
" <h2>Package Types</h2>",
" <ul style=\"list-style: circle inside\">",
" {{#each packages}}",
" <li>{{name}}</li>",
" {{/each}}",
" </ul>",
" </div>",
" <div class=\"col-lg-4 mt-4\">",
" <h2>Options</h2>",
" <ul style=\"list-style: circle inside\">",
" {{#each options}}",
" <li>{{name}}</li>",
" {{/each}}",
" </ul>",
" </div>",
" </div>",
" </div>",
" `;",
" ",
" pm.visualizer.set(template, response);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/carriers/{{stamps_com}}",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"carriers",
"{{stamps_com}}"
]
},
"description": "You can get all the information about a specific carrier if you already know its `carrier_id`."
},
"response": [
{
"name": "Get a specific carrier",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/carriers/{{stamps_com}}",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"carriers",
"{{stamps_com}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 16 Sep 2019 20:58:56 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "5628"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "123c7951-2ec5-40b9-8004-f5b23f4c2c5f"
}
],
"cookie": [
],
"body": "{\n \"carrier_id\": \"se-121861\",\n \"carrier_code\": \"stamps_com\",\n \"account_number\": \"test_account_121861\",\n \"requires_funded_amount\": true,\n \"balance\": 8343.36,\n \"nickname\": \"ShipEngine Test Account - Stamps.com\",\n \"friendly_name\": \"Stamps.com\",\n \"primary\": false,\n \"has_multi_package_supporting_services\": false,\n \"supports_label_messages\": true,\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 \"packages\": [\n {\n \"package_id\": null,\n \"package_code\": \"cubic\",\n \"name\": \"Cubic\",\n \"description\": \"Cubic\"\n },\n {\n \"package_id\": null,\n \"package_code\": \"flat_rate_envelope\",\n \"name\": \"Flat Rate Envelope\",\n \"description\": \"USPS flat rate envelope. A special cardboard envelope provided by the USPS that clearly indicates \\\"Flat Rate\\\".\"\n },\n {\n \"package_id\": null,\n \"package_code\": \"flat_rate_legal_envelope\",\n \"name\": \"Flat Rate Legal Envelope\",\n \"description\": \"Flat Rate Legal Envelope\"\n },\n {\n \"package_id\": null,\n \"package_code\": \"flat_rate_padded_envelope\",\n \"name\": \"Flat Rate Padded Envelope\",\n \"description\": \"Flat Rate Padded Envelope\"\n },\n {\n \"package_id\": null,\n \"package_code\": \"large_envelope_or_flat\",\n \"name\": \"Large Envelope or Flat\",\n \"description\": \"Large envelope or flat. Has one dimension that is between 11 1/2\\\" and 15\\\" long, 6 1/18\\\" and 12\\\" high, or 1/4\\\" and 3/4\\\" thick.\"\n },\n {\n \"package_id\": null,\n \"package_code\": \"large_flat_rate_box\",\n \"name\": \"Large Flat Rate Box\",\n \"description\": \"Large Flat Rate Box\"\n },\n {\n \"package_id\": null,\n \"package_code\": \"large_package\",\n \"name\": \"Large Package (any side > 12\\\")\",\n \"description\": \"Large package. Longest side plus the distance around the thickest part is over 84\\\" and less than or equal to 108\\\".\"\n },\n {\n \"package_id\": null,\n \"package_code\": \"letter\",\n \"name\": \"Letter\",\n \"description\": \"Letter\"\n },\n {\n \"package_id\": null,\n \"package_code\": \"medium_flat_rate_box\",\n \"name\": \"Medium Flat Rate Box\",\n \"description\": \"USPS flat rate box. A special 11\\\" x 8 1/2\\\" x 5 1/2\\\" or 14\\\" x 3.5\\\" x 12\\\" USPS box that clearly indicates \\\"Flat Rate Box\\\"\"\n },\n {\n \"package_id\": null,\n \"package_code\": \"package\",\n \"name\": \"Package\",\n \"description\": \"Package. Longest side plus the distance around the thickest part is less than or equal to 84\\\"\"\n },\n {\n \"package_id\": null,\n \"package_code\": \"regional_rate_box_a\",\n \"name\": \"Regional Rate Box A\",\n \"description\": \"Regional Rate Box A\"\n },\n {\n \"package_id\": null,\n \"package_code\": \"regional_rate_box_b\",\n \"name\": \"Regional Rate Box B\",\n \"description\": \"Regional Rate Box B\"\n },\n {\n \"package_id\": null,\n \"package_code\": \"small_flat_rate_box\",\n \"name\": \"Small Flat Rate Box\",\n \"description\": \"Small Flat Rate Box\"\n },\n {\n \"package_id\": null,\n \"package_code\": \"thick_envelope\",\n \"name\": \"Thick Envelope\",\n \"description\": \"Thick envelope. Envelopes or flats greater than 3/4\\\" at the thickest point.\"\n }\n ],\n \"options\": [\n {\n \"name\": \"non_machinable\",\n \"default_value\": \"false\",\n \"description\": \"\"\n }\n ]\n}"
}
]
}
