SQL Server
SQL Server
Square API - Search Catalog Objects
See more Square Examples
Searches for CatalogObject of any types against supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query expressions,Chilkat SQL Server Downloads
-- 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)
DECLARE @success int
SELECT @success = 0
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
-- Implements the following CURL command:
-- curl https://connect.squareup.com/v2/catalog/search \
-- -X POST \
-- -H 'Square-Version: 2020-07-22' \
-- -H 'Authorization: Bearer ACCESS_TOKEN' \
-- -H 'Content-Type: application/json' \
-- -d '{
-- "object_types": [
-- "ITEM"
-- ],
-- "query": {
-- "prefix_query": {
-- "attribute_name": "name",
-- "attribute_prefix": "tea"
-- }
-- },
-- "limit": 100
-- }'
-- 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.
-- {
-- "object_types": [
-- "ITEM"
-- ],
-- "query": {
-- "prefix_query": {
-- "attribute_name": "name",
-- "attribute_prefix": "tea"
-- }
-- },
-- "limit": 100
-- }
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'object_types[0]', 'ITEM'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'query.prefix_query.attribute_name', 'name'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'query.prefix_query.attribute_prefix', 'tea'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'limit', 100
-- 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'
-- This example uses the sandbox: connect.squareupsandbox.com
-- Production should use connect.squareup.com
DECLARE @resp int
EXEC @hr = sp_OACreate 'Chilkat.HttpResponse', @resp OUT
EXEC sp_OAMethod @http, 'HttpJson', @success OUT, 'POST', 'https://connect.squareupsandbox.com/v2/catalog/search', @json, 'application/json', @resp
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @resp
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
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 @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @resp
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)
-- {
-- "objects": [
-- {
-- "type": "ITEM",
-- "id": "X5DZ5NWWAQ44CKBLKIFQGOWK",
-- "updated_at": "2017-10-26T15:41:32.337Z",
-- "version": 1509032492337,
-- "is_deleted": false,
-- "present_at_all_locations": true,
-- "item_data": {
-- "name": "Tea - Black",
-- "description": "A delicious blend of black tea.",
-- "category_id": "E7CLE5RZZ744BHWVQQEAHI2C",
-- "product_type": "REGULAR",
-- "tax_ids": [
-- "ZXITPM6RWHZ7GZ7EIP3YKECM"
-- ],
-- "variations": [
-- {
-- "type": "ITEM_VARIATION",
-- "id": "5GSZPX6EU7MM75S57OONG3V5",
-- "updated_at": "2017-10-26T15:27:31.626Z",
-- "version": 1509031651626,
-- "is_deleted": false,
-- "present_at_all_locations": true,
-- "item_variation_data": {
-- "item_id": "X5DZ5NWWAQ44CKBLKIFQGOWK",
-- "name": "Regular",
-- "ordinal": 1,
-- "price_money": {
-- "amount": 150,
-- "currency": "USD"
-- },
-- "pricing_type": "FIXED_PRICING"
-- }
-- },
-- {
-- "type": "ITEM_VARIATION",
-- "id": "XVLBN7DU6JTWHJTG5F265B43",
-- "updated_at": "2017-10-26T15:27:31.626Z",
-- "version": 1509031651626,
-- "is_deleted": false,
-- "present_at_all_locations": true,
-- "item_variation_data": {
-- "item_id": "X5DZ5NWWAQ44CKBLKIFQGOWK",
-- "name": "Large",
-- "ordinal": 2,
-- "price_money": {
-- "amount": 225,
-- "currency": "USD"
-- },
-- "pricing_type": "FIXED_PRICING"
-- }
-- }
-- ],
-- "visibility": "PRIVATE"
-- }
-- },
-- {
-- "type": "ITEM",
-- "id": "NNNEM3LA656Q46NXLWCNI7S5",
-- "updated_at": "2017-10-26T15:41:23.232Z",
-- "version": 1509032483232,
-- "is_deleted": false,
-- "present_at_all_locations": true,
-- "item_data": {
-- "name": "Tea - Green",
-- "description": "Relaxing green herbal tea.",
-- "category_id": "E7CLE5RZZ744BHWVQQEAHI2C",
-- "product_type": "REGULAR",
-- "tax_ids": [
-- "ZXITPM6RWHZ7GZ7EIP3YKECM"
-- ],
-- "variations": [
-- {
-- "type": "ITEM_VARIATION",
-- "id": "FHYBVIA6NVBCSOVETA62WEA4",
-- "updated_at": "2017-10-26T15:29:00.524Z",
-- "version": 1509031740524,
-- "is_deleted": false,
-- "present_at_all_locations": true,
-- "item_variation_data": {
-- "item_id": "NNNEM3LA656Q46NXLWCNI7S5",
-- "name": "Regular",
-- "ordinal": 1,
-- "price_money": {
-- "amount": 150,
-- "currency": "USD"
-- },
-- "pricing_type": "FIXED_PRICING"
-- }
-- }
-- ],
-- "visibility": "PRIVATE"
-- }
-- }
-- ]
-- }
-- 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 @v_type nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @updated_at nvarchar(4000)
DECLARE @version int
DECLARE @is_deleted int
DECLARE @present_at_all_locations int
DECLARE @item_dataName nvarchar(4000)
DECLARE @item_dataDescription nvarchar(4000)
DECLARE @item_dataCategory_id nvarchar(4000)
DECLARE @item_dataProduct_type nvarchar(4000)
DECLARE @item_dataVisibility nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @strVal nvarchar(4000)
DECLARE @item_variation_dataItem_id nvarchar(4000)
DECLARE @item_variation_dataName nvarchar(4000)
DECLARE @item_variation_dataOrdinal int
DECLARE @item_variation_dataPrice_moneyAmount int
DECLARE @item_variation_dataPrice_moneyCurrency nvarchar(4000)
DECLARE @item_variation_dataPricing_type nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'objects'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'objects[i].type'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'objects[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @updated_at OUT, 'objects[i].updated_at'
EXEC sp_OAMethod @jResp, 'IntOf', @version OUT, 'objects[i].version'
EXEC sp_OAMethod @jResp, 'BoolOf', @is_deleted OUT, 'objects[i].is_deleted'
EXEC sp_OAMethod @jResp, 'BoolOf', @present_at_all_locations OUT, 'objects[i].present_at_all_locations'
EXEC sp_OAMethod @jResp, 'StringOf', @item_dataName OUT, 'objects[i].item_data.name'
EXEC sp_OAMethod @jResp, 'StringOf', @item_dataDescription OUT, 'objects[i].item_data.description'
EXEC sp_OAMethod @jResp, 'StringOf', @item_dataCategory_id OUT, 'objects[i].item_data.category_id'
EXEC sp_OAMethod @jResp, 'StringOf', @item_dataProduct_type OUT, 'objects[i].item_data.product_type'
EXEC sp_OAMethod @jResp, 'StringOf', @item_dataVisibility OUT, 'objects[i].item_data.visibility'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'objects[i].item_data.tax_ids'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'objects[i].item_data.tax_ids[j]'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'objects[i].item_data.variations'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'objects[i].item_data.variations[j].type'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'objects[i].item_data.variations[j].id'
EXEC sp_OAMethod @jResp, 'StringOf', @updated_at OUT, 'objects[i].item_data.variations[j].updated_at'
EXEC sp_OAMethod @jResp, 'IntOf', @version OUT, 'objects[i].item_data.variations[j].version'
EXEC sp_OAMethod @jResp, 'BoolOf', @is_deleted OUT, 'objects[i].item_data.variations[j].is_deleted'
EXEC sp_OAMethod @jResp, 'BoolOf', @present_at_all_locations OUT, 'objects[i].item_data.variations[j].present_at_all_locations'
EXEC sp_OAMethod @jResp, 'StringOf', @item_variation_dataItem_id OUT, 'objects[i].item_data.variations[j].item_variation_data.item_id'
EXEC sp_OAMethod @jResp, 'StringOf', @item_variation_dataName OUT, 'objects[i].item_data.variations[j].item_variation_data.name'
EXEC sp_OAMethod @jResp, 'IntOf', @item_variation_dataOrdinal OUT, 'objects[i].item_data.variations[j].item_variation_data.ordinal'
EXEC sp_OAMethod @jResp, 'IntOf', @item_variation_dataPrice_moneyAmount OUT, 'objects[i].item_data.variations[j].item_variation_data.price_money.amount'
EXEC sp_OAMethod @jResp, 'StringOf', @item_variation_dataPrice_moneyCurrency OUT, 'objects[i].item_data.variations[j].item_variation_data.price_money.currency'
EXEC sp_OAMethod @jResp, 'StringOf', @item_variation_dataPricing_type OUT, 'objects[i].item_data.variations[j].item_variation_data.pricing_type'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO