SQL Server / ShipEngine Walkthrough / Create a label from a shipment
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
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'API-Key', '{{API_KEY}}'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequest', @resp OUT, 'POST', 'https://api.shipengine.com/v1/labels/shipment/se-123456'
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
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 @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)
-- {
-- "label_id": "se-1376111",
-- "status": "completed",
-- "shipment_id": "se-4140216",
-- "ship_date": "2019-09-17T00:00:00Z",
-- "created_at": "2019-09-17T21:15:06.1985884Z",
-- "shipment_cost": {
-- "currency": "usd",
-- "amount": 98.14
-- },
-- "insurance_cost": {
-- "currency": "usd",
-- "amount": 0
-- },
-- "tracking_number": "9405511899564298845657",
-- "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": false,
-- "voided_at": null,
-- "label_format": "pdf",
-- "label_layout": "4x6",
-- "trackable": true,
-- "carrier_code": "stamps_com",
-- "tracking_status": "in_transit",
-- "label_download": {
-- "pdf": "https://api.shipengine.com/v1/downloads/10/pNIA3R8QfEqnWI80_RI8OA/label-1376111.pdf",
-- "png": "https://api.shipengine.com/v1/downloads/10/pNIA3R8QfEqnWI80_RI8OA/label-1376111.png",
-- "zpl": "https://api.shipengine.com/v1/downloads/10/pNIA3R8QfEqnWI80_RI8OA/label-1376111.zpl",
-- "href": "https://api.shipengine.com/v1/downloads/10/pNIA3R8QfEqnWI80_RI8OA/label-1376111.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": "9405511899564298845657",
-- "label_messages": {
-- "reference1": null,
-- "reference2": null,
-- "reference3": null
-- },
-- "external_package_id": null
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
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 @label_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @label_id OUT, 'label_id'
DECLARE @status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @status OUT, 'status'
DECLARE @shipment_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @shipment_id OUT, 'shipment_id'
DECLARE @ship_date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ship_date OUT, 'ship_date'
DECLARE @created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'created_at'
DECLARE @v_Currency nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Currency OUT, 'shipment_cost.currency'
DECLARE @Amount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Amount OUT, 'shipment_cost.amount'
DECLARE @insurance_costCurrency nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @insurance_costCurrency OUT, 'insurance_cost.currency'
DECLARE @insurance_costAmount int
EXEC sp_OAMethod @jResp, 'IntOf', @insurance_costAmount OUT, 'insurance_cost.amount'
DECLARE @tracking_number nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @tracking_number OUT, 'tracking_number'
DECLARE @is_return_label int
EXEC sp_OAMethod @jResp, 'BoolOf', @is_return_label OUT, 'is_return_label'
DECLARE @rma_number nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @rma_number OUT, 'rma_number'
DECLARE @is_international int
EXEC sp_OAMethod @jResp, 'BoolOf', @is_international OUT, 'is_international'
DECLARE @batch_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @batch_id OUT, 'batch_id'
DECLARE @carrier_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @carrier_id OUT, 'carrier_id'
DECLARE @service_code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @service_code OUT, 'service_code'
DECLARE @package_code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @package_code OUT, 'package_code'
DECLARE @voided int
EXEC sp_OAMethod @jResp, 'BoolOf', @voided OUT, 'voided'
DECLARE @voided_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @voided_at OUT, 'voided_at'
DECLARE @label_format nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @label_format OUT, 'label_format'
DECLARE @label_layout nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @label_layout OUT, 'label_layout'
DECLARE @trackable int
EXEC sp_OAMethod @jResp, 'BoolOf', @trackable OUT, 'trackable'
DECLARE @carrier_code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @carrier_code OUT, 'carrier_code'
DECLARE @tracking_status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @tracking_status OUT, 'tracking_status'
DECLARE @v_Pdf nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Pdf OUT, 'label_download.pdf'
DECLARE @Png nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Png OUT, 'label_download.png'
DECLARE @Zpl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Zpl OUT, 'label_download.zpl'
DECLARE @Href nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Href OUT, 'label_download.href'
DECLARE @form_download nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @form_download OUT, 'form_download'
DECLARE @insurance_claim nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @insurance_claim OUT, 'insurance_claim'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
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_code OUT, 'packages[i].package_code'
EXEC sp_OAMethod @jResp, 'IntOf', @Value OUT, 'packages[i].weight.value'
EXEC sp_OAMethod @jResp, 'StringOf', @Unit OUT, 'packages[i].weight.unit'
EXEC sp_OAMethod @jResp, 'StringOf', @dimensionsUnit OUT, 'packages[i].dimensions.unit'
EXEC sp_OAMethod @jResp, 'IntOf', @Length OUT, 'packages[i].dimensions.length'
EXEC sp_OAMethod @jResp, 'IntOf', @Width OUT, 'packages[i].dimensions.width'
EXEC sp_OAMethod @jResp, 'IntOf', @Height OUT, 'packages[i].dimensions.height'
EXEC sp_OAMethod @jResp, 'StringOf', @insured_valueCurrency OUT, 'packages[i].insured_value.currency'
EXEC sp_OAMethod @jResp, 'IntOf', @insured_valueAmount OUT, 'packages[i].insured_value.amount'
EXEC sp_OAMethod @jResp, 'StringOf', @tracking_number OUT, 'packages[i].tracking_number'
EXEC sp_OAMethod @jResp, 'StringOf', @Reference1 OUT, 'packages[i].label_messages.reference1'
EXEC sp_OAMethod @jResp, 'StringOf', @Reference2 OUT, 'packages[i].label_messages.reference2'
EXEC sp_OAMethod @jResp, 'StringOf', @Reference3 OUT, 'packages[i].label_messages.reference3'
EXEC sp_OAMethod @jResp, 'StringOf', @external_package_id OUT, 'packages[i].external_package_id'
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 POST
-H "API-Key: {{API_KEY}}"
https://api.shipengine.com/v1/labels/shipment/se-123456
Postman Collection Item JSON
{
"name": "Create a label from a shipment",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/labels/shipment/{{shipment_id}}",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"labels",
"shipment",
"{{shipment_id}}"
]
},
"description": "If you've previously created a shipment on ShipEngine, then you can create a label from that shipment without having to specify any of the shipment details again."
},
"response": [
{
"name": "Create a label from a shipment",
"originalRequest": {
"method": "POST",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/labels/shipment/{{shipment_id}}",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"labels",
"shipment",
"{{shipment_id}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Tue, 17 Sep 2019 21:15:07 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "1820"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "server",
"value": "Microsoft-IIS/8.0"
},
{
"key": "x-newrelic-app-data",
"value": "PxQGVFZXCgITVVZbAwMCV1YGFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GC0HAV1fQ0sxF0VSXwcXVHpSAAMPNVkWUDFQUURfVgtNQx1RHVJIBxlQU1EMBAZRVE4aABtEIQgHClUiV1sGVQBTCg12ABFJXwBdElY/"
},
{
"key": "x-powered-by",
"value": "ASP.NET"
},
{
"key": "x-shipengine-environment",
"value": "j"
},
{
"key": "x-shipengine-requestid",
"value": "8ebc06bb-90a3-495b-bc0d-b4bb2ef13073"
},
{
"key": "x-shipengine-server",
"value": "SS-J-WEB03"
}
],
"cookie": [
],
"body": "{\n \"label_id\": \"se-1376111\",\n \"status\": \"completed\",\n \"shipment_id\": \"se-4140216\",\n \"ship_date\": \"2019-09-17T00:00:00Z\",\n \"created_at\": \"2019-09-17T21:15:06.1985884Z\",\n \"shipment_cost\": {\n \"currency\": \"usd\",\n \"amount\": 98.14\n },\n \"insurance_cost\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"tracking_number\": \"9405511899564298845657\",\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\": false,\n \"voided_at\": null,\n \"label_format\": \"pdf\",\n \"label_layout\": \"4x6\",\n \"trackable\": true,\n \"carrier_code\": \"stamps_com\",\n \"tracking_status\": \"in_transit\",\n \"label_download\": {\n \"pdf\": \"https://api.shipengine.com/v1/downloads/10/pNIA3R8QfEqnWI80_RI8OA/label-1376111.pdf\",\n \"png\": \"https://api.shipengine.com/v1/downloads/10/pNIA3R8QfEqnWI80_RI8OA/label-1376111.png\",\n \"zpl\": \"https://api.shipengine.com/v1/downloads/10/pNIA3R8QfEqnWI80_RI8OA/label-1376111.zpl\",\n \"href\": \"https://api.shipengine.com/v1/downloads/10/pNIA3R8QfEqnWI80_RI8OA/label-1376111.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\": \"9405511899564298845657\",\n \"label_messages\": {\n \"reference1\": null,\n \"reference2\": null,\n \"reference3\": null\n },\n \"external_package_id\": null\n }\n ]\n}"
}
]
}
