Xbase++
Xbase++
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 Xbase++ Downloads
LOCAL nSuccess
LOCAL oHttp
LOCAL i
LOCAL j
LOCAL k
LOCAL oJson
LOCAL oResp
LOCAL oSbResponseBody
LOCAL oJResp
LOCAL nRespStatusCode
LOCAL cV_type
LOCAL cId
LOCAL cUpdated_at
LOCAL nVersion
LOCAL nIs_deleted
LOCAL nPresent_at_all_locations
LOCAL cItem_dataName
LOCAL cItem_dataDescription
LOCAL cItem_dataCategory_id
LOCAL cCategory_dataName
LOCAL cTax_dataName
LOCAL cTax_dataCalculation_phase
LOCAL cTax_dataInclusion_type
LOCAL cTax_dataPercentage
LOCAL nTax_dataApplies_to_custom_amounts
LOCAL nTax_dataEnabled
LOCAL nCount_j
LOCAL cStrVal
LOCAL cItem_variation_dataItem_id
LOCAL cItem_variation_dataName
LOCAL nItem_variation_dataOrdinal
LOCAL cItem_variation_dataPricing_type
LOCAL nItem_variation_dataPrice_moneyAmount
LOCAL cItem_variation_dataPrice_moneyCurrency
LOCAL cClient_object_id
LOCAL cObject_id
LOCAL nCount_i
nSuccess := 0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
oHttp := CreateObject("Chilkat.Http")
// 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
// }
// }
// ]
// }
// ]
// }
oJson := CreateObject("Chilkat.JsonObject")
oJson:UpdateString("idempotency_key", "789ff020-f723-43a9-b4b5-43b5dc1fa3dc")
i := 0
oJson:I := i
j := 0
oJson:J := j
oJson:UpdateString("batches[i].objects[j].type", "ITEM")
oJson:UpdateString("batches[i].objects[j].id", "#Tea")
oJson:UpdateBool("batches[i].objects[j].present_at_all_locations", 1)
oJson:UpdateString("batches[i].objects[j].item_data.name", "Tea")
oJson:UpdateString("batches[i].objects[j].item_data.description", "Hot Leaf Juice")
oJson:UpdateString("batches[i].objects[j].item_data.category_id", "#Beverages")
oJson:UpdateString("batches[i].objects[j].item_data.tax_ids[0]", "#SalesTax")
oJson:UpdateString("batches[i].objects[j].item_data.variations[0].type", "ITEM_VARIATION")
oJson:UpdateString("batches[i].objects[j].item_data.variations[0].id", "#Tea_Mug")
oJson:UpdateBool("batches[i].objects[j].item_data.variations[0].present_at_all_locations", 1)
oJson:UpdateString("batches[i].objects[j].item_data.variations[0].item_variation_data.item_id", "#Tea")
oJson:UpdateString("batches[i].objects[j].item_data.variations[0].item_variation_data.name", "Mug")
oJson:UpdateString("batches[i].objects[j].item_data.variations[0].item_variation_data.pricing_type", "FIXED_PRICING")
oJson:UpdateInt("batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.amount", 150)
oJson:UpdateString("batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.currency", "USD")
j := j + 1
oJson:J := j
oJson:UpdateString("batches[i].objects[j].type", "ITEM")
oJson:UpdateString("batches[i].objects[j].id", "#Coffee")
oJson:UpdateBool("batches[i].objects[j].present_at_all_locations", 1)
oJson:UpdateString("batches[i].objects[j].item_data.name", "Coffee")
oJson:UpdateString("batches[i].objects[j].item_data.description", "Hot Bean Juice")
oJson:UpdateString("batches[i].objects[j].item_data.category_id", "#Beverages")
oJson:UpdateString("batches[i].objects[j].item_data.tax_ids[0]", "#SalesTax")
k := 0
oJson:K := k
oJson:UpdateString("batches[i].objects[j].item_data.variations[k].type", "ITEM_VARIATION")
oJson:UpdateString("batches[i].objects[j].item_data.variations[k].id", "#Coffee_Regular")
oJson:UpdateBool("batches[i].objects[j].item_data.variations[k].present_at_all_locations", 1)
oJson:UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.item_id", "#Coffee")
oJson:UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.name", "Regular")
oJson:UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type", "FIXED_PRICING")
oJson:UpdateInt("batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount", 250)
oJson:UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency", "USD")
k := k + 1
oJson:K := k
oJson:UpdateString("batches[i].objects[j].item_data.variations[k].type", "ITEM_VARIATION")
oJson:UpdateString("batches[i].objects[j].item_data.variations[k].id", "#Coffee_Large")
oJson:UpdateBool("batches[i].objects[j].item_data.variations[k].present_at_all_locations", 1)
oJson:UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.item_id", "#Coffee")
oJson:UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.name", "Large")
oJson:UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type", "FIXED_PRICING")
oJson:UpdateInt("batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount", 350)
oJson:UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency", "USD")
j := j + 1
oJson:J := j
oJson:UpdateString("batches[i].objects[j].type", "CATEGORY")
oJson:UpdateString("batches[i].objects[j].id", "#Beverages")
oJson:UpdateBool("batches[i].objects[j].present_at_all_locations", 1)
oJson:UpdateString("batches[i].objects[j].category_data.name", "Beverages")
j := j + 1
oJson:J := j
oJson:UpdateString("batches[i].objects[j].type", "TAX")
oJson:UpdateString("batches[i].objects[j].id", "#SalesTax")
oJson:UpdateBool("batches[i].objects[j].present_at_all_locations", 1)
oJson:UpdateString("batches[i].objects[j].tax_data.name", "Sales Tax")
oJson:UpdateString("batches[i].objects[j].tax_data.calculation_phase", "TAX_SUBTOTAL_PHASE")
oJson:UpdateString("batches[i].objects[j].tax_data.inclusion_type", "ADDITIVE")
oJson:UpdateString("batches[i].objects[j].tax_data.percentage", "5.0")
oJson:UpdateBool("batches[i].objects[j].tax_data.applies_to_custom_amounts", 1)
oJson:UpdateBool("batches[i].objects[j].tax_data.enabled", 1)
// Adds the "Authorization: Bearer ACCESS_TOKEN" header.
oHttp:AuthToken := "ACCESS_TOKEN"
oHttp:SetRequestHeader("Square-Version", "2020-07-22")
// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpJson("POST", "https://connect.squareupsandbox.com/v2/catalog/batch-upsert", oJson, "application/json", oResp)
IF (nSuccess == 0)
? oHttp:LastErrorText
oHttp:destroy()
oJson:destroy()
oResp:destroy()
RETURN
ENDIF
oSbResponseBody := CreateObject("Chilkat.StringBuilder")
oResp:GetBodySb(oSbResponseBody)
oJResp := CreateObject("Chilkat.JsonObject")
oJResp:LoadSb(oSbResponseBody)
oJResp:EmitCompact := 0
? "Response Body:"
? oJResp:Emit()
nRespStatusCode := oResp:StatusCode
? "Response Status Code = " + Str(nRespStatusCode)
IF (nRespStatusCode >= 400)
? "Response Header:"
? oResp:Header
? "Failed."
oHttp:destroy()
oJson:destroy()
oResp:destroy()
oSbResponseBody:destroy()
oJResp:destroy()
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
nCount_i := oJResp:SizeOfArray("objects")
DO WHILE i < nCount_i
oJResp:I := i
cV_type := oJResp:StringOf("objects[i].type")
cId := oJResp:StringOf("objects[i].id")
cUpdated_at := oJResp:StringOf("objects[i].updated_at")
nVersion := oJResp:IntOf("objects[i].version")
nIs_deleted := oJResp:BoolOf("objects[i].is_deleted")
nPresent_at_all_locations := oJResp:BoolOf("objects[i].present_at_all_locations")
cItem_dataName := oJResp:StringOf("objects[i].item_data.name")
cItem_dataDescription := oJResp:StringOf("objects[i].item_data.description")
cItem_dataCategory_id := oJResp:StringOf("objects[i].item_data.category_id")
cCategory_dataName := oJResp:StringOf("objects[i].category_data.name")
cTax_dataName := oJResp:StringOf("objects[i].tax_data.name")
cTax_dataCalculation_phase := oJResp:StringOf("objects[i].tax_data.calculation_phase")
cTax_dataInclusion_type := oJResp:StringOf("objects[i].tax_data.inclusion_type")
cTax_dataPercentage := oJResp:StringOf("objects[i].tax_data.percentage")
nTax_dataApplies_to_custom_amounts := oJResp:BoolOf("objects[i].tax_data.applies_to_custom_amounts")
nTax_dataEnabled := oJResp:BoolOf("objects[i].tax_data.enabled")
j := 0
nCount_j := oJResp:SizeOfArray("objects[i].item_data.tax_ids")
DO WHILE j < nCount_j
oJResp:J := j
cStrVal := oJResp:StringOf("objects[i].item_data.tax_ids[j]")
j := j + 1
ENDDO
j := 0
nCount_j := oJResp:SizeOfArray("objects[i].item_data.variations")
DO WHILE j < nCount_j
oJResp:J := j
cV_type := oJResp:StringOf("objects[i].item_data.variations[j].type")
cId := oJResp:StringOf("objects[i].item_data.variations[j].id")
cUpdated_at := oJResp:StringOf("objects[i].item_data.variations[j].updated_at")
nVersion := oJResp:IntOf("objects[i].item_data.variations[j].version")
nIs_deleted := oJResp:BoolOf("objects[i].item_data.variations[j].is_deleted")
nPresent_at_all_locations := oJResp:BoolOf("objects[i].item_data.variations[j].present_at_all_locations")
cItem_variation_dataItem_id := oJResp:StringOf("objects[i].item_data.variations[j].item_variation_data.item_id")
cItem_variation_dataName := oJResp:StringOf("objects[i].item_data.variations[j].item_variation_data.name")
nItem_variation_dataOrdinal := oJResp:IntOf("objects[i].item_data.variations[j].item_variation_data.ordinal")
cItem_variation_dataPricing_type := oJResp:StringOf("objects[i].item_data.variations[j].item_variation_data.pricing_type")
nItem_variation_dataPrice_moneyAmount := oJResp:IntOf("objects[i].item_data.variations[j].item_variation_data.price_money.amount")
cItem_variation_dataPrice_moneyCurrency := oJResp:StringOf("objects[i].item_data.variations[j].item_variation_data.price_money.currency")
j := j + 1
ENDDO
i := i + 1
ENDDO
i := 0
nCount_i := oJResp:SizeOfArray("id_mappings")
DO WHILE i < nCount_i
oJResp:I := i
cClient_object_id := oJResp:StringOf("id_mappings[i].client_object_id")
cObject_id := oJResp:StringOf("id_mappings[i].object_id")
i := i + 1
ENDDO
oHttp:destroy()
oJson:destroy()
oResp:destroy()
oSbResponseBody:destroy()
oJResp:destroy()