Swift
Swift
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 Swift Downloads
func chilkatTest() {
var success: Bool = false
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
// 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
// }
let json = CkoJsonObject()!
json.updateString(jsonPath: "object_types[0]", value: "ITEM")
json.updateString(jsonPath: "query.prefix_query.attribute_name", value: "name")
json.updateString(jsonPath: "query.prefix_query.attribute_prefix", value: "tea")
json.updateInt(jsonPath: "limit", value: 100)
// Adds the "Authorization: Bearer ACCESS_TOKEN" header.
http.authToken = "ACCESS_TOKEN"
http.setRequestHeader(name: "Square-Version", value: "2020-07-22")
// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
let resp = CkoHttpResponse()!
success = http.httpJson(verb: "POST", url: "https://connect.squareupsandbox.com/v2/catalog/search", json: json, contentType: "application/json", response: resp)
if success == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp.getBodySb(sb: sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sb: sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp.header!)")
print("Failed.")
return
}
// 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
var v_type: String?
var id: String?
var updated_at: String?
var version: Int
var is_deleted: Bool
var present_at_all_locations: Bool
var item_dataName: String?
var item_dataDescription: String?
var item_dataCategory_id: String?
var item_dataProduct_type: String?
var item_dataVisibility: String?
var j: Int
var count_j: Int
var strVal: String?
var item_variation_dataItem_id: String?
var item_variation_dataName: String?
var item_variation_dataOrdinal: Int
var item_variation_dataPrice_moneyAmount: Int
var item_variation_dataPrice_moneyCurrency: String?
var item_variation_dataPricing_type: String?
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "objects").intValue
while i < count_i {
jResp.i = i
v_type = jResp.string(of: "objects[i].type")
id = jResp.string(of: "objects[i].id")
updated_at = jResp.string(of: "objects[i].updated_at")
version = jResp.int(of: "objects[i].version").intValue
is_deleted = jResp.bool(of: "objects[i].is_deleted")
present_at_all_locations = jResp.bool(of: "objects[i].present_at_all_locations")
item_dataName = jResp.string(of: "objects[i].item_data.name")
item_dataDescription = jResp.string(of: "objects[i].item_data.description")
item_dataCategory_id = jResp.string(of: "objects[i].item_data.category_id")
item_dataProduct_type = jResp.string(of: "objects[i].item_data.product_type")
item_dataVisibility = jResp.string(of: "objects[i].item_data.visibility")
j = 0
count_j = jResp.size(ofArray: "objects[i].item_data.tax_ids").intValue
while j < count_j {
jResp.j = j
strVal = jResp.string(of: "objects[i].item_data.tax_ids[j]")
j = j + 1
}
j = 0
count_j = jResp.size(ofArray: "objects[i].item_data.variations").intValue
while j < count_j {
jResp.j = j
v_type = jResp.string(of: "objects[i].item_data.variations[j].type")
id = jResp.string(of: "objects[i].item_data.variations[j].id")
updated_at = jResp.string(of: "objects[i].item_data.variations[j].updated_at")
version = jResp.int(of: "objects[i].item_data.variations[j].version").intValue
is_deleted = jResp.bool(of: "objects[i].item_data.variations[j].is_deleted")
present_at_all_locations = jResp.bool(of: "objects[i].item_data.variations[j].present_at_all_locations")
item_variation_dataItem_id = jResp.string(of: "objects[i].item_data.variations[j].item_variation_data.item_id")
item_variation_dataName = jResp.string(of: "objects[i].item_data.variations[j].item_variation_data.name")
item_variation_dataOrdinal = jResp.int(of: "objects[i].item_data.variations[j].item_variation_data.ordinal").intValue
item_variation_dataPrice_moneyAmount = jResp.int(of: "objects[i].item_data.variations[j].item_variation_data.price_money.amount").intValue
item_variation_dataPrice_moneyCurrency = jResp.string(of: "objects[i].item_data.variations[j].item_variation_data.price_money.currency")
item_variation_dataPricing_type = jResp.string(of: "objects[i].item_data.variations[j].item_variation_data.pricing_type")
j = j + 1
}
i = i + 1
}
}