PureBasic
PureBasic
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 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
; 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
; }
; }
; ]
; }
; ]
; }
i.i
j.i
k.i
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"idempotency_key","789ff020-f723-43a9-b4b5-43b5dc1fa3dc")
i = 0
CkJsonObject::setCkI(json, i)
j = 0
CkJsonObject::setCkJ(json, j)
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].type","ITEM")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].id","#Tea")
CkJsonObject::ckUpdateBool(json,"batches[i].objects[j].present_at_all_locations",1)
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.name","Tea")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.description","Hot Leaf Juice")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.category_id","#Beverages")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.tax_ids[0]","#SalesTax")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[0].type","ITEM_VARIATION")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[0].id","#Tea_Mug")
CkJsonObject::ckUpdateBool(json,"batches[i].objects[j].item_data.variations[0].present_at_all_locations",1)
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[0].item_variation_data.item_id","#Tea")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[0].item_variation_data.name","Mug")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[0].item_variation_data.pricing_type","FIXED_PRICING")
CkJsonObject::ckUpdateInt(json,"batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.amount",150)
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.currency","USD")
j = j + 1
CkJsonObject::setCkJ(json, j)
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].type","ITEM")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].id","#Coffee")
CkJsonObject::ckUpdateBool(json,"batches[i].objects[j].present_at_all_locations",1)
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.name","Coffee")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.description","Hot Bean Juice")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.category_id","#Beverages")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.tax_ids[0]","#SalesTax")
k = 0
CkJsonObject::setCkK(json, k)
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[k].type","ITEM_VARIATION")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[k].id","#Coffee_Regular")
CkJsonObject::ckUpdateBool(json,"batches[i].objects[j].item_data.variations[k].present_at_all_locations",1)
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[k].item_variation_data.item_id","#Coffee")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[k].item_variation_data.name","Regular")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type","FIXED_PRICING")
CkJsonObject::ckUpdateInt(json,"batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount",250)
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency","USD")
k = k + 1
CkJsonObject::setCkK(json, k)
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[k].type","ITEM_VARIATION")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[k].id","#Coffee_Large")
CkJsonObject::ckUpdateBool(json,"batches[i].objects[j].item_data.variations[k].present_at_all_locations",1)
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[k].item_variation_data.item_id","#Coffee")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[k].item_variation_data.name","Large")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type","FIXED_PRICING")
CkJsonObject::ckUpdateInt(json,"batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount",350)
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency","USD")
j = j + 1
CkJsonObject::setCkJ(json, j)
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].type","CATEGORY")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].id","#Beverages")
CkJsonObject::ckUpdateBool(json,"batches[i].objects[j].present_at_all_locations",1)
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].category_data.name","Beverages")
j = j + 1
CkJsonObject::setCkJ(json, j)
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].type","TAX")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].id","#SalesTax")
CkJsonObject::ckUpdateBool(json,"batches[i].objects[j].present_at_all_locations",1)
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].tax_data.name","Sales Tax")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].tax_data.calculation_phase","TAX_SUBTOTAL_PHASE")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].tax_data.inclusion_type","ADDITIVE")
CkJsonObject::ckUpdateString(json,"batches[i].objects[j].tax_data.percentage","5.0")
CkJsonObject::ckUpdateBool(json,"batches[i].objects[j].tax_data.applies_to_custom_amounts",1)
CkJsonObject::ckUpdateBool(json,"batches[i].objects[j].tax_data.enabled",1)
; 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/batch-upsert",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": "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
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
category_dataName.s
tax_dataName.s
tax_dataCalculation_phase.s
tax_dataInclusion_type.s
tax_dataPercentage.s
tax_dataApplies_to_custom_amounts.i
tax_dataEnabled.i
count_j.i
strVal.s
item_variation_dataItem_id.s
item_variation_dataName.s
item_variation_dataOrdinal.i
item_variation_dataPricing_type.s
item_variation_dataPrice_moneyAmount.i
item_variation_dataPrice_moneyCurrency.s
client_object_id.s
object_id.s
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")
category_dataName = CkJsonObject::ckStringOf(jResp,"objects[i].category_data.name")
tax_dataName = CkJsonObject::ckStringOf(jResp,"objects[i].tax_data.name")
tax_dataCalculation_phase = CkJsonObject::ckStringOf(jResp,"objects[i].tax_data.calculation_phase")
tax_dataInclusion_type = CkJsonObject::ckStringOf(jResp,"objects[i].tax_data.inclusion_type")
tax_dataPercentage = CkJsonObject::ckStringOf(jResp,"objects[i].tax_data.percentage")
tax_dataApplies_to_custom_amounts = CkJsonObject::ckBoolOf(jResp,"objects[i].tax_data.applies_to_custom_amounts")
tax_dataEnabled = CkJsonObject::ckBoolOf(jResp,"objects[i].tax_data.enabled")
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_dataPricing_type = CkJsonObject::ckStringOf(jResp,"objects[i].item_data.variations[j].item_variation_data.pricing_type")
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")
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"id_mappings")
While i < count_i
CkJsonObject::setCkI(jResp, i)
client_object_id = CkJsonObject::ckStringOf(jResp,"id_mappings[i].client_object_id")
object_id = CkJsonObject::ckStringOf(jResp,"id_mappings[i].object_id")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure