Xojo Plugin
Xojo Plugin
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 Xojo Plugin Downloads
Dim success As Boolean
success = False
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
// 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
// }
Dim json As New Chilkat.JsonObject
success = json.UpdateString("object_types[0]","ITEM")
success = json.UpdateString("query.prefix_query.attribute_name","name")
success = json.UpdateString("query.prefix_query.attribute_prefix","tea")
success = json.UpdateInt("limit",100)
// Adds the "Authorization: Bearer ACCESS_TOKEN" header.
http.AuthToken = "ACCESS_TOKEN"
http.SetRequestHeader "Square-Version","2020-07-22"
// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
Dim resp As New Chilkat.HttpResponse
success = http.HttpJson("POST","https://connect.squareupsandbox.com/v2/catalog/search",json,"application/json",resp)
If (success = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
End If
// 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
Dim v_type As String
Dim id As String
Dim updated_at As String
Dim version As Int32
Dim is_deleted As Boolean
Dim present_at_all_locations As Boolean
Dim item_dataName As String
Dim item_dataDescription As String
Dim item_dataCategory_id As String
Dim item_dataProduct_type As String
Dim item_dataVisibility As String
Dim j As Int32
Dim count_j As Int32
Dim strVal As String
Dim item_variation_dataItem_id As String
Dim item_variation_dataName As String
Dim item_variation_dataOrdinal As Int32
Dim item_variation_dataPrice_moneyAmount As Int32
Dim item_variation_dataPrice_moneyCurrency As String
Dim item_variation_dataPricing_type As String
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("objects")
While i < count_i
jResp.I = i
v_type = jResp.StringOf("objects[i].type")
id = jResp.StringOf("objects[i].id")
updated_at = jResp.StringOf("objects[i].updated_at")
version = jResp.IntOf("objects[i].version")
is_deleted = jResp.BoolOf("objects[i].is_deleted")
present_at_all_locations = jResp.BoolOf("objects[i].present_at_all_locations")
item_dataName = jResp.StringOf("objects[i].item_data.name")
item_dataDescription = jResp.StringOf("objects[i].item_data.description")
item_dataCategory_id = jResp.StringOf("objects[i].item_data.category_id")
item_dataProduct_type = jResp.StringOf("objects[i].item_data.product_type")
item_dataVisibility = jResp.StringOf("objects[i].item_data.visibility")
j = 0
count_j = jResp.SizeOfArray("objects[i].item_data.tax_ids")
While j < count_j
jResp.J = j
strVal = jResp.StringOf("objects[i].item_data.tax_ids[j]")
j = j + 1
Wend
j = 0
count_j = jResp.SizeOfArray("objects[i].item_data.variations")
While j < count_j
jResp.J = j
v_type = jResp.StringOf("objects[i].item_data.variations[j].type")
id = jResp.StringOf("objects[i].item_data.variations[j].id")
updated_at = jResp.StringOf("objects[i].item_data.variations[j].updated_at")
version = jResp.IntOf("objects[i].item_data.variations[j].version")
is_deleted = jResp.BoolOf("objects[i].item_data.variations[j].is_deleted")
present_at_all_locations = jResp.BoolOf("objects[i].item_data.variations[j].present_at_all_locations")
item_variation_dataItem_id = jResp.StringOf("objects[i].item_data.variations[j].item_variation_data.item_id")
item_variation_dataName = jResp.StringOf("objects[i].item_data.variations[j].item_variation_data.name")
item_variation_dataOrdinal = jResp.IntOf("objects[i].item_data.variations[j].item_variation_data.ordinal")
item_variation_dataPrice_moneyAmount = jResp.IntOf("objects[i].item_data.variations[j].item_variation_data.price_money.amount")
item_variation_dataPrice_moneyCurrency = jResp.StringOf("objects[i].item_data.variations[j].item_variation_data.price_money.currency")
item_variation_dataPricing_type = jResp.StringOf("objects[i].item_data.variations[j].item_variation_data.pricing_type")
j = j + 1
Wend
i = i + 1
Wend