PureBasic
PureBasic
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 PureBasic Downloads
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
Procedure ChilkatExample()
success.i = 0
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; 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
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"object_types[0]","ITEM")
CkJsonObject::ckUpdateString(json,"query.prefix_query.attribute_name","name")
CkJsonObject::ckUpdateString(json,"query.prefix_query.attribute_prefix","tea")
CkJsonObject::ckUpdateInt(json,"limit",100)
; Adds the "Authorization: Bearer ACCESS_TOKEN" header.
CkHttp::setCkAuthToken(http, "ACCESS_TOKEN")
CkHttp::ckSetRequestHeader(http,"Square-Version","2020-07-22")
; This example uses the sandbox: connect.squareupsandbox.com
; Production should use connect.squareup.com
resp.i = CkHttpResponse::ckCreate()
If resp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckHttpJson(http,"POST","https://connect.squareupsandbox.com/v2/catalog/search",json,"application/json",resp)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
v_type.s
id.s
updated_at.s
version.i
is_deleted.i
present_at_all_locations.i
item_dataName.s
item_dataDescription.s
item_dataCategory_id.s
item_dataProduct_type.s
item_dataVisibility.s
j.i
count_j.i
strVal.s
item_variation_dataItem_id.s
item_variation_dataName.s
item_variation_dataOrdinal.i
item_variation_dataPrice_moneyAmount.i
item_variation_dataPrice_moneyCurrency.s
item_variation_dataPricing_type.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"objects")
While i < count_i
CkJsonObject::setCkI(jResp, i)
v_type = CkJsonObject::ckStringOf(jResp,"objects[i].type")
id = CkJsonObject::ckStringOf(jResp,"objects[i].id")
updated_at = CkJsonObject::ckStringOf(jResp,"objects[i].updated_at")
version = CkJsonObject::ckIntOf(jResp,"objects[i].version")
is_deleted = CkJsonObject::ckBoolOf(jResp,"objects[i].is_deleted")
present_at_all_locations = CkJsonObject::ckBoolOf(jResp,"objects[i].present_at_all_locations")
item_dataName = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.name")
item_dataDescription = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.description")
item_dataCategory_id = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.category_id")
item_dataProduct_type = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.product_type")
item_dataVisibility = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.visibility")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"objects[i].item_data.tax_ids")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.tax_ids[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"objects[i].item_data.variations")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
v_type = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.variations[j].type")
id = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.variations[j].id")
updated_at = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.variations[j].updated_at")
version = CkJsonObject::ckIntOf(jResp,"objects[i].item_data.variations[j].version")
is_deleted = CkJsonObject::ckBoolOf(jResp,"objects[i].item_data.variations[j].is_deleted")
present_at_all_locations = CkJsonObject::ckBoolOf(jResp,"objects[i].item_data.variations[j].present_at_all_locations")
item_variation_dataItem_id = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.variations[j].item_variation_data.item_id")
item_variation_dataName = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.variations[j].item_variation_data.name")
item_variation_dataOrdinal = CkJsonObject::ckIntOf(jResp,"objects[i].item_data.variations[j].item_variation_data.ordinal")
item_variation_dataPrice_moneyAmount = CkJsonObject::ckIntOf(jResp,"objects[i].item_data.variations[j].item_variation_data.price_money.amount")
item_variation_dataPrice_moneyCurrency = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.variations[j].item_variation_data.price_money.currency")
item_variation_dataPricing_type = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.variations[j].item_variation_data.pricing_type")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure