(SQL Server) Upsert Catalog Object

Creates or updates the target CatalogObject.

For more information, see https://developer.squareup.com/reference/square/catalog-api/upsert-catalog-object

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://connect.squareup.com/v2/catalog/object \
    --   -X POST \
    --   -H 'Square-Version: 2020-07-22' \
    --   -H 'Authorization: Bearer ACCESS_TOKEN' \
    --   -H 'Content-Type: application/json' \
    --   -d '{
    --     "idempotency_key": "af3d1afc-7212-4300-b463-0bfc5314a5ae",
    --     "object": {
    --       "type": "ITEM",
    --       "id": "#Cocoa",
    --       "item_data": {
    --         "name": "Cocoa",
    --         "description": "Hot chocolate",
    --         "abbreviation": "Ch"
    --       }
    --     }
    --   }'

    -- Use the following online tool to generate HTTP code from a CURL command
    -- Convert a cURL Command to HTTP Source Code

    -- Use this online tool to generate code from sample JSON:
    -- Generate Code to Create JSON

    -- The following JSON is sent in the request body.

    -- {
    --   "idempotency_key": "af3d1afc-7212-4300-b463-0bfc5314a5ae",
    --   "object": {
    --     "type": "ITEM",
    --     "id": "#Cocoa",
    --     "item_data": {
    --       "name": "Cocoa",
    --       "description": "Hot chocolate",
    --       "abbreviation": "Ch"
    --     }
    --   }
    -- }

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

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'idempotency_key', 'af3d1afc-7212-4300-b463-0bfc5314a5ae'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'object.type', 'ITEM'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'object.id', '#Cocoa'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'object.item_data.name', 'Cocoa'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'object.item_data.description', 'Hot chocolate'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'object.item_data.abbreviation', 'Ch'

    -- Adds the "Authorization: Bearer ACCESS_TOKEN" header.
    EXEC sp_OASetProperty @http, 'AuthToken', 'ACCESS_TOKEN'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Square-Version', '2020-07-22'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'

    -- This example uses the sandbox: connect.squareupsandbox.com
    -- Production should use connect.squareup.com
    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://connect.squareupsandbox.com/v2/catalog/object', 'application/json', @json
    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 @json
        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 @json
        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)

    -- {
    --   "catalog_object": {
    --     "type": "ITEM",
    --     "id": "7SB3ZQYJ5GDMVFL7JK46JCHT",
    --     "updated_at": "2016-11-16T22:32:42.996Z",
    --     "version": 1479335562996,
    --     "is_deleted": false,
    --     "item_data": {
    --       "name": "Cocoa",
    --       "description": "Hot chocolate",
    --       "abbreviation": "Ch"
    --     }
    --   },
    --   "id_mappings": [
    --     {
    --       "client_object_id": "#Cocoa",
    --       "object_id": "7SB3ZQYJ5GDMVFL7JK46JCHT"
    --     }
    --   ]
    -- }

    -- 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 @client_object_id nvarchar(4000)

    DECLARE @object_id nvarchar(4000)

    DECLARE @catalog_objectType nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @catalog_objectType OUT, 'catalog_object.type'
    DECLARE @catalog_objectId nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @catalog_objectId OUT, 'catalog_object.id'
    DECLARE @catalog_objectUpdated_at nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @catalog_objectUpdated_at OUT, 'catalog_object.updated_at'
    DECLARE @catalog_objectVersion int
    EXEC sp_OAMethod @jResp, 'IntOf', @catalog_objectVersion OUT, 'catalog_object.version'
    DECLARE @catalog_objectIs_deleted int
    EXEC sp_OAMethod @jResp, 'BoolOf', @catalog_objectIs_deleted OUT, 'catalog_object.is_deleted'
    DECLARE @catalog_objectItem_dataName nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @catalog_objectItem_dataName OUT, 'catalog_object.item_data.name'
    DECLARE @catalog_objectItem_dataDescription nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @catalog_objectItem_dataDescription OUT, 'catalog_object.item_data.description'
    DECLARE @catalog_objectItem_dataAbbreviation nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @catalog_objectItem_dataAbbreviation OUT, 'catalog_object.item_data.abbreviation'
    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'id_mappings'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'StringOf', @client_object_id OUT, 'id_mappings[i].client_object_id'
        EXEC sp_OAMethod @jResp, 'StringOf', @object_id OUT, 'id_mappings[i].object_id'
        SELECT @i = @i + 1
      END

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


END
GO