(SQL Server) Shippo Create Transaction Object

Creates a Transaction object that represents a shipping label purchase and is based on the shipping rate.

For more information, see https://goshippo.com/docs/shipping-labels/

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- 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

    -- Implements the following CURL command:

    -- curl https://api.goshippo.com/transactions \
    --     -H "Authorization: ShippoToken <API_TOKEN>" \
    --     -d rate="478fb066930e4e3195a3686f7ea5b612"
    --     -d label_file_type="PDF"
    --     -d async=false

    DECLARE @req int
    -- Use "Chilkat_9_5_0.HttpRequest" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.HttpRequest', @req OUT

    EXEC sp_OASetProperty @req, 'HttpVerb', 'POST'
    EXEC sp_OASetProperty @req, 'Path', '/transactions'
    EXEC sp_OASetProperty @req, 'ContentType', 'application/x-www-form-urlencoded'
    EXEC sp_OAMethod @req, 'AddParam', NULL, 'rate', '478fb066930e4e3195a3686f7ea5b612'
    EXEC sp_OAMethod @req, 'AddParam', NULL, 'label_file_type', 'PDF'
    EXEC sp_OAMethod @req, 'AddParam', NULL, 'async', 'false'

    EXEC sp_OAMethod @req, 'AddHeader', NULL, 'Authorization', 'ShippoToken <API_TOKEN>'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostUrlEncoded', @resp OUT, 'https://api.goshippo.com/transactions', @req
    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 @req
        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 @req
        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)

    -- {
    --   "object_state": "VALID",
    --   "status": "SUCCESS",
    --   "object_created": "2019-06-28T18:04:08.679Z",
    --   "object_updated": "2019-06-28T18:04:10.516Z",
    --   "object_id": "6178e155da304f10aa4b4271fdca84fb",
    --   "object_owner": "admin@chilkatsoft.com",
    --   "test": true,
    --   "rate": "dd7556c284e8444294d2ab7099e662d2",
    --   "tracking_number": "92701902416755000000000015",
    --   "tracking_status": "UNKNOWN",
    --   "eta": null,
    --   "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=92701902416755000000000015",
    --   "label_url": "https://shippo-delivery-east.s3.amazonaws.com/6178e155da304f10aa4b4271fdca84fb.pdf?Signature=1LU0Qf11nQJGei%2FeLZr%2BQ5EwJS4%3D&Expires=1593281050&AWSAccessKeyId=AKIAJGLCC5MYLLWIG42A",
    --   "commercial_invoice_url": null,
    --   "messages": [
    --   ],
    --   "order": null,
    --   "metadata": "",
    --   "parcel": "5af766ff15684a4186b0e3c833348fac",
    --   "billing": {
    --     "payments": [
    --     ]
    --   }
    -- }

    -- Sample code for parsing the JSON response...
    -- Use the following online tool to generate parsing code from sample JSON:
    -- Generate Parsing Code from JSON

    DECLARE @object_state nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @object_state OUT, 'object_state'
    DECLARE @status nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @status OUT, 'status'
    DECLARE @object_created nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @object_created OUT, 'object_created'
    DECLARE @object_updated nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @object_updated OUT, 'object_updated'
    DECLARE @object_id nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @object_id OUT, 'object_id'
    DECLARE @object_owner nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @object_owner OUT, 'object_owner'
    DECLARE @test int
    EXEC sp_OAMethod @jResp, 'BoolOf', @test OUT, 'test'
    DECLARE @rate nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @rate OUT, 'rate'
    DECLARE @tracking_number nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @tracking_number OUT, 'tracking_number'
    DECLARE @tracking_status nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @tracking_status OUT, 'tracking_status'
    DECLARE @eta nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @eta OUT, 'eta'
    DECLARE @tracking_url_provider nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @tracking_url_provider OUT, 'tracking_url_provider'
    DECLARE @label_url nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @label_url OUT, 'label_url'
    DECLARE @commercial_invoice_url nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @commercial_invoice_url OUT, 'commercial_invoice_url'
    DECLARE @order nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @order OUT, 'order'
    DECLARE @metadata nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @metadata OUT, 'metadata'
    DECLARE @parcel nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @parcel OUT, 'parcel'
    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'messages'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        SELECT @i = @i + 1
      END
    SELECT @i = 0
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'billing.payments'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @req
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jResp


END
GO