Swift
Swift
Square API - Batch Upsert Catalog Objects
See more Square Examples
Creates or updates up to 10,000 target objects based on the provided list of objects. The target objects are grouped into batches and each batch is inserted/updated in an all-or-nothing manner.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()!
// 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": "789ff020-f723-43a9-b4b5-43b5dc1fa3dc",
// "batches": [
// {
// "objects": [
// {
// "type": "ITEM",
// "id": "#Tea",
// "present_at_all_locations": true,
// "item_data": {
// "name": "Tea",
// "description": "Hot Leaf Juice",
// "category_id": "#Beverages",
// "tax_ids": [
// "#SalesTax"
// ],
// "variations": [
// {
// "type": "ITEM_VARIATION",
// "id": "#Tea_Mug",
// "present_at_all_locations": true,
// "item_variation_data": {
// "item_id": "#Tea",
// "name": "Mug",
// "pricing_type": "FIXED_PRICING",
// "price_money": {
// "amount": 150,
// "currency": "USD"
// }
// }
// }
// ]
// }
// },
// {
// "type": "ITEM",
// "id": "#Coffee",
// "present_at_all_locations": true,
// "item_data": {
// "name": "Coffee",
// "description": "Hot Bean Juice",
// "category_id": "#Beverages",
// "tax_ids": [
// "#SalesTax"
// ],
// "variations": [
// {
// "type": "ITEM_VARIATION",
// "id": "#Coffee_Regular",
// "present_at_all_locations": true,
// "item_variation_data": {
// "item_id": "#Coffee",
// "name": "Regular",
// "pricing_type": "FIXED_PRICING",
// "price_money": {
// "amount": 250,
// "currency": "USD"
// }
// }
// },
// {
// "type": "ITEM_VARIATION",
// "id": "#Coffee_Large",
// "present_at_all_locations": true,
// "item_variation_data": {
// "item_id": "#Coffee",
// "name": "Large",
// "pricing_type": "FIXED_PRICING",
// "price_money": {
// "amount": 350,
// "currency": "USD"
// }
// }
// }
// ]
// }
// },
// {
// "type": "CATEGORY",
// "id": "#Beverages",
// "present_at_all_locations": true,
// "category_data": {
// "name": "Beverages"
// }
// },
// {
// "type": "TAX",
// "id": "#SalesTax",
// "present_at_all_locations": true,
// "tax_data": {
// "name": "Sales Tax",
// "calculation_phase": "TAX_SUBTOTAL_PHASE",
// "inclusion_type": "ADDITIVE",
// "percentage": "5.0",
// "applies_to_custom_amounts": true,
// "enabled": true
// }
// }
// ]
// }
// ]
// }
var i: Int
var j: Int
var k: Int
let json = CkoJsonObject()!
json.updateString(jsonPath: "idempotency_key", value: "789ff020-f723-43a9-b4b5-43b5dc1fa3dc")
i = 0
json.i = i
j = 0
json.j = j
json.updateString(jsonPath: "batches[i].objects[j].type", value: "ITEM")
json.updateString(jsonPath: "batches[i].objects[j].id", value: "#Tea")
json.updateBool(jsonPath: "batches[i].objects[j].present_at_all_locations", value: true)
json.updateString(jsonPath: "batches[i].objects[j].item_data.name", value: "Tea")
json.updateString(jsonPath: "batches[i].objects[j].item_data.description", value: "Hot Leaf Juice")
json.updateString(jsonPath: "batches[i].objects[j].item_data.category_id", value: "#Beverages")
json.updateString(jsonPath: "batches[i].objects[j].item_data.tax_ids[0]", value: "#SalesTax")
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[0].type", value: "ITEM_VARIATION")
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[0].id", value: "#Tea_Mug")
json.updateBool(jsonPath: "batches[i].objects[j].item_data.variations[0].present_at_all_locations", value: true)
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[0].item_variation_data.item_id", value: "#Tea")
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[0].item_variation_data.name", value: "Mug")
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[0].item_variation_data.pricing_type", value: "FIXED_PRICING")
json.updateInt(jsonPath: "batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.amount", value: 150)
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.currency", value: "USD")
j = j + 1
json.j = j
json.updateString(jsonPath: "batches[i].objects[j].type", value: "ITEM")
json.updateString(jsonPath: "batches[i].objects[j].id", value: "#Coffee")
json.updateBool(jsonPath: "batches[i].objects[j].present_at_all_locations", value: true)
json.updateString(jsonPath: "batches[i].objects[j].item_data.name", value: "Coffee")
json.updateString(jsonPath: "batches[i].objects[j].item_data.description", value: "Hot Bean Juice")
json.updateString(jsonPath: "batches[i].objects[j].item_data.category_id", value: "#Beverages")
json.updateString(jsonPath: "batches[i].objects[j].item_data.tax_ids[0]", value: "#SalesTax")
k = 0
json.k = k
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[k].type", value: "ITEM_VARIATION")
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[k].id", value: "#Coffee_Regular")
json.updateBool(jsonPath: "batches[i].objects[j].item_data.variations[k].present_at_all_locations", value: true)
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[k].item_variation_data.item_id", value: "#Coffee")
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[k].item_variation_data.name", value: "Regular")
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type", value: "FIXED_PRICING")
json.updateInt(jsonPath: "batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount", value: 250)
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency", value: "USD")
k = k + 1
json.k = k
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[k].type", value: "ITEM_VARIATION")
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[k].id", value: "#Coffee_Large")
json.updateBool(jsonPath: "batches[i].objects[j].item_data.variations[k].present_at_all_locations", value: true)
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[k].item_variation_data.item_id", value: "#Coffee")
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[k].item_variation_data.name", value: "Large")
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type", value: "FIXED_PRICING")
json.updateInt(jsonPath: "batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount", value: 350)
json.updateString(jsonPath: "batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency", value: "USD")
j = j + 1
json.j = j
json.updateString(jsonPath: "batches[i].objects[j].type", value: "CATEGORY")
json.updateString(jsonPath: "batches[i].objects[j].id", value: "#Beverages")
json.updateBool(jsonPath: "batches[i].objects[j].present_at_all_locations", value: true)
json.updateString(jsonPath: "batches[i].objects[j].category_data.name", value: "Beverages")
j = j + 1
json.j = j
json.updateString(jsonPath: "batches[i].objects[j].type", value: "TAX")
json.updateString(jsonPath: "batches[i].objects[j].id", value: "#SalesTax")
json.updateBool(jsonPath: "batches[i].objects[j].present_at_all_locations", value: true)
json.updateString(jsonPath: "batches[i].objects[j].tax_data.name", value: "Sales Tax")
json.updateString(jsonPath: "batches[i].objects[j].tax_data.calculation_phase", value: "TAX_SUBTOTAL_PHASE")
json.updateString(jsonPath: "batches[i].objects[j].tax_data.inclusion_type", value: "ADDITIVE")
json.updateString(jsonPath: "batches[i].objects[j].tax_data.percentage", value: "5.0")
json.updateBool(jsonPath: "batches[i].objects[j].tax_data.applies_to_custom_amounts", value: true)
json.updateBool(jsonPath: "batches[i].objects[j].tax_data.enabled", value: true)
// 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/batch-upsert", 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": "ZSDZN34NAXDLC6D5ZQMNSOUM",
// "updated_at": "2017-05-10T18:48:39.798Z",
// "version": 1494442119798,
// "is_deleted": false,
// "present_at_all_locations": true,
// "item_data": {
// "name": "Tea",
// "description": "Hot Leaf Juice",
// "category_id": "LYT72K3WGJFFCIMB63XARP3I",
// "tax_ids": [
// "XHSHLHNWSI3HVI4BW5ZUZXI3"
// ],
// "variations": [
// {
// "type": "ITEM_VARIATION",
// "id": "NAYHET5R52MIYCEF34ZMAHFM",
// "updated_at": "2017-05-10T18:48:39.798Z",
// "version": 1494442119798,
// "is_deleted": false,
// "present_at_all_locations": true,
// "item_variation_data": {
// "item_id": "ZSDZN34NAXDLC6D5ZQMNSOUM",
// "name": "Mug",
// "ordinal": 0,
// "pricing_type": "FIXED_PRICING",
// "price_money": {
// "amount": 150,
// "currency": "USD"
// }
// }
// }
// ]
// }
// },
// {
// "type": "ITEM",
// "id": "PJMCEBHHUS3OKDB6PYUHLCPP",
// "updated_at": "2017-05-10T18:48:39.798Z",
// "version": 1494442119798,
// "is_deleted": false,
// "present_at_all_locations": true,
// "item_data": {
// "name": "Coffee",
// "description": "Hot Bean Juice",
// "category_id": "LYT72K3WGJFFCIMB63XARP3I",
// "tax_ids": [
// "XHSHLHNWSI3HVI4BW5ZUZXI3"
// ],
// "variations": [
// {
// "type": "ITEM_VARIATION",
// "id": "OTYDX45SPG7LJQUVCBZI4INH",
// "updated_at": "2017-05-10T18:48:39.798Z",
// "version": 1494442119798,
// "is_deleted": false,
// "present_at_all_locations": true,
// "item_variation_data": {
// "item_id": "PJMCEBHHUS3OKDB6PYUHLCPP",
// "name": "Regular",
// "ordinal": 0,
// "pricing_type": "FIXED_PRICING",
// "price_money": {
// "amount": 250,
// "currency": "USD"
// }
// }
// },
// {
// "type": "ITEM_VARIATION",
// "id": "GZDA3JB37FYVOPI4AOEBOITI",
// "updated_at": "2017-05-10T18:48:39.798Z",
// "version": 1494442119798,
// "is_deleted": false,
// "present_at_all_locations": true,
// "item_variation_data": {
// "item_id": "PJMCEBHHUS3OKDB6PYUHLCPP",
// "name": "Large",
// "ordinal": 1,
// "pricing_type": "FIXED_PRICING",
// "price_money": {
// "amount": 350,
// "currency": "USD"
// }
// }
// }
// ]
// }
// },
// {
// "type": "CATEGORY",
// "id": "LYT72K3WGJFFCIMB63XARP3I",
// "updated_at": "2017-05-10T18:48:39.798Z",
// "version": 1494442119798,
// "is_deleted": false,
// "present_at_all_locations": true,
// "category_data": {
// "name": "Beverages"
// }
// },
// {
// "type": "TAX",
// "id": "XHSHLHNWSI3HVI4BW5ZUZXI3",
// "updated_at": "2017-05-10T18:48:39.798Z",
// "version": 1494442119798,
// "is_deleted": false,
// "present_at_all_locations": true,
// "tax_data": {
// "name": "Sales Tax",
// "calculation_phase": "TAX_SUBTOTAL_PHASE",
// "inclusion_type": "ADDITIVE",
// "percentage": "5.0",
// "applies_to_custom_amounts": true,
// "enabled": true
// }
// }
// ],
// "id_mappings": [
// {
// "client_object_id": "#Tea",
// "object_id": "ZSDZN34NAXDLC6D5ZQMNSOUM"
// },
// {
// "client_object_id": "#Coffee",
// "object_id": "PJMCEBHHUS3OKDB6PYUHLCPP"
// },
// {
// "client_object_id": "#Beverages",
// "object_id": "LYT72K3WGJFFCIMB63XARP3I"
// },
// {
// "client_object_id": "#SalesTax",
// "object_id": "XHSHLHNWSI3HVI4BW5ZUZXI3"
// },
// {
// "client_object_id": "#Tea_Mug",
// "object_id": "NAYHET5R52MIYCEF34ZMAHFM"
// },
// {
// "client_object_id": "#Coffee_Regular",
// "object_id": "OTYDX45SPG7LJQUVCBZI4INH"
// },
// {
// "client_object_id": "#Coffee_Large",
// "object_id": "GZDA3JB37FYVOPI4AOEBOITI"
// }
// ]
// }
// 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 category_dataName: String?
var tax_dataName: String?
var tax_dataCalculation_phase: String?
var tax_dataInclusion_type: String?
var tax_dataPercentage: String?
var tax_dataApplies_to_custom_amounts: Bool
var tax_dataEnabled: Bool
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_dataPricing_type: String?
var item_variation_dataPrice_moneyAmount: Int
var item_variation_dataPrice_moneyCurrency: String?
var client_object_id: String?
var object_id: String?
i = 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")
category_dataName = jResp.string(of: "objects[i].category_data.name")
tax_dataName = jResp.string(of: "objects[i].tax_data.name")
tax_dataCalculation_phase = jResp.string(of: "objects[i].tax_data.calculation_phase")
tax_dataInclusion_type = jResp.string(of: "objects[i].tax_data.inclusion_type")
tax_dataPercentage = jResp.string(of: "objects[i].tax_data.percentage")
tax_dataApplies_to_custom_amounts = jResp.bool(of: "objects[i].tax_data.applies_to_custom_amounts")
tax_dataEnabled = jResp.bool(of: "objects[i].tax_data.enabled")
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_dataPricing_type = jResp.string(of: "objects[i].item_data.variations[j].item_variation_data.pricing_type")
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")
j = j + 1
}
i = i + 1
}
i = 0
count_i = jResp.size(ofArray: "id_mappings").intValue
while i < count_i {
jResp.i = i
client_object_id = jResp.string(of: "id_mappings[i].client_object_id")
object_id = jResp.string(of: "id_mappings[i].object_id")
i = i + 1
}
}