Lianja
Lianja
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 Lianja Downloads
llSuccess = .F.
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// 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
// }
// }
// ]
// }
// ]
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("idempotency_key","789ff020-f723-43a9-b4b5-43b5dc1fa3dc")
i = 0
loJson.I = i
j = 0
loJson.J = j
loJson.UpdateString("batches[i].objects[j].type","ITEM")
loJson.UpdateString("batches[i].objects[j].id","#Tea")
loJson.UpdateBool("batches[i].objects[j].present_at_all_locations",.T.)
loJson.UpdateString("batches[i].objects[j].item_data.name","Tea")
loJson.UpdateString("batches[i].objects[j].item_data.description","Hot Leaf Juice")
loJson.UpdateString("batches[i].objects[j].item_data.category_id","#Beverages")
loJson.UpdateString("batches[i].objects[j].item_data.tax_ids[0]","#SalesTax")
loJson.UpdateString("batches[i].objects[j].item_data.variations[0].type","ITEM_VARIATION")
loJson.UpdateString("batches[i].objects[j].item_data.variations[0].id","#Tea_Mug")
loJson.UpdateBool("batches[i].objects[j].item_data.variations[0].present_at_all_locations",.T.)
loJson.UpdateString("batches[i].objects[j].item_data.variations[0].item_variation_data.item_id","#Tea")
loJson.UpdateString("batches[i].objects[j].item_data.variations[0].item_variation_data.name","Mug")
loJson.UpdateString("batches[i].objects[j].item_data.variations[0].item_variation_data.pricing_type","FIXED_PRICING")
loJson.UpdateInt("batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.amount",150)
loJson.UpdateString("batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.currency","USD")
j = j + 1
loJson.J = j
loJson.UpdateString("batches[i].objects[j].type","ITEM")
loJson.UpdateString("batches[i].objects[j].id","#Coffee")
loJson.UpdateBool("batches[i].objects[j].present_at_all_locations",.T.)
loJson.UpdateString("batches[i].objects[j].item_data.name","Coffee")
loJson.UpdateString("batches[i].objects[j].item_data.description","Hot Bean Juice")
loJson.UpdateString("batches[i].objects[j].item_data.category_id","#Beverages")
loJson.UpdateString("batches[i].objects[j].item_data.tax_ids[0]","#SalesTax")
k = 0
loJson.K = k
loJson.UpdateString("batches[i].objects[j].item_data.variations[k].type","ITEM_VARIATION")
loJson.UpdateString("batches[i].objects[j].item_data.variations[k].id","#Coffee_Regular")
loJson.UpdateBool("batches[i].objects[j].item_data.variations[k].present_at_all_locations",.T.)
loJson.UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.item_id","#Coffee")
loJson.UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.name","Regular")
loJson.UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type","FIXED_PRICING")
loJson.UpdateInt("batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount",250)
loJson.UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency","USD")
k = k + 1
loJson.K = k
loJson.UpdateString("batches[i].objects[j].item_data.variations[k].type","ITEM_VARIATION")
loJson.UpdateString("batches[i].objects[j].item_data.variations[k].id","#Coffee_Large")
loJson.UpdateBool("batches[i].objects[j].item_data.variations[k].present_at_all_locations",.T.)
loJson.UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.item_id","#Coffee")
loJson.UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.name","Large")
loJson.UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type","FIXED_PRICING")
loJson.UpdateInt("batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount",350)
loJson.UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency","USD")
j = j + 1
loJson.J = j
loJson.UpdateString("batches[i].objects[j].type","CATEGORY")
loJson.UpdateString("batches[i].objects[j].id","#Beverages")
loJson.UpdateBool("batches[i].objects[j].present_at_all_locations",.T.)
loJson.UpdateString("batches[i].objects[j].category_data.name","Beverages")
j = j + 1
loJson.J = j
loJson.UpdateString("batches[i].objects[j].type","TAX")
loJson.UpdateString("batches[i].objects[j].id","#SalesTax")
loJson.UpdateBool("batches[i].objects[j].present_at_all_locations",.T.)
loJson.UpdateString("batches[i].objects[j].tax_data.name","Sales Tax")
loJson.UpdateString("batches[i].objects[j].tax_data.calculation_phase","TAX_SUBTOTAL_PHASE")
loJson.UpdateString("batches[i].objects[j].tax_data.inclusion_type","ADDITIVE")
loJson.UpdateString("batches[i].objects[j].tax_data.percentage","5.0")
loJson.UpdateBool("batches[i].objects[j].tax_data.applies_to_custom_amounts",.T.)
loJson.UpdateBool("batches[i].objects[j].tax_data.enabled",.T.)
// Adds the "Authorization: Bearer ACCESS_TOKEN" header.
loHttp.AuthToken = "ACCESS_TOKEN"
loHttp.SetRequestHeader("Square-Version","2020-07-22")
// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
loResp = createobject("CkHttpResponse")
llSuccess = loHttp.HttpJson("POST","https://connect.squareupsandbox.com/v2/catalog/batch-upsert",loJson,"application/json",loResp)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
release loResp
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loHttp
release loJson
release loResp
release loSbResponseBody
release loJResp
return
endif
// 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
i = 0
lnCount_i = loJResp.SizeOfArray("objects")
do while i < lnCount_i
loJResp.I = i
lcV_type = loJResp.StringOf("objects[i].type")
lcId = loJResp.StringOf("objects[i].id")
lcUpdated_at = loJResp.StringOf("objects[i].updated_at")
lnVersion = loJResp.IntOf("objects[i].version")
llIs_deleted = loJResp.BoolOf("objects[i].is_deleted")
llPresent_at_all_locations = loJResp.BoolOf("objects[i].present_at_all_locations")
lcItem_dataName = loJResp.StringOf("objects[i].item_data.name")
lcItem_dataDescription = loJResp.StringOf("objects[i].item_data.description")
lcItem_dataCategory_id = loJResp.StringOf("objects[i].item_data.category_id")
lcCategory_dataName = loJResp.StringOf("objects[i].category_data.name")
lcTax_dataName = loJResp.StringOf("objects[i].tax_data.name")
lcTax_dataCalculation_phase = loJResp.StringOf("objects[i].tax_data.calculation_phase")
lcTax_dataInclusion_type = loJResp.StringOf("objects[i].tax_data.inclusion_type")
lcTax_dataPercentage = loJResp.StringOf("objects[i].tax_data.percentage")
llTax_dataApplies_to_custom_amounts = loJResp.BoolOf("objects[i].tax_data.applies_to_custom_amounts")
llTax_dataEnabled = loJResp.BoolOf("objects[i].tax_data.enabled")
j = 0
lnCount_j = loJResp.SizeOfArray("objects[i].item_data.tax_ids")
do while j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("objects[i].item_data.tax_ids[j]")
j = j + 1
enddo
j = 0
lnCount_j = loJResp.SizeOfArray("objects[i].item_data.variations")
do while j < lnCount_j
loJResp.J = j
lcV_type = loJResp.StringOf("objects[i].item_data.variations[j].type")
lcId = loJResp.StringOf("objects[i].item_data.variations[j].id")
lcUpdated_at = loJResp.StringOf("objects[i].item_data.variations[j].updated_at")
lnVersion = loJResp.IntOf("objects[i].item_data.variations[j].version")
llIs_deleted = loJResp.BoolOf("objects[i].item_data.variations[j].is_deleted")
llPresent_at_all_locations = loJResp.BoolOf("objects[i].item_data.variations[j].present_at_all_locations")
lcItem_variation_dataItem_id = loJResp.StringOf("objects[i].item_data.variations[j].item_variation_data.item_id")
lcItem_variation_dataName = loJResp.StringOf("objects[i].item_data.variations[j].item_variation_data.name")
lnItem_variation_dataOrdinal = loJResp.IntOf("objects[i].item_data.variations[j].item_variation_data.ordinal")
lcItem_variation_dataPricing_type = loJResp.StringOf("objects[i].item_data.variations[j].item_variation_data.pricing_type")
lnItem_variation_dataPrice_moneyAmount = loJResp.IntOf("objects[i].item_data.variations[j].item_variation_data.price_money.amount")
lcItem_variation_dataPrice_moneyCurrency = loJResp.StringOf("objects[i].item_data.variations[j].item_variation_data.price_money.currency")
j = j + 1
enddo
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("id_mappings")
do while i < lnCount_i
loJResp.I = i
lcClient_object_id = loJResp.StringOf("id_mappings[i].client_object_id")
lcObject_id = loJResp.StringOf("id_mappings[i].object_id")
i = i + 1
enddo
release loHttp
release loJson
release loResp
release loSbResponseBody
release loJResp