|
Chilkat • HOME • .NET Core C# • Android™ • AutoIt • C • C# • C++ • Chilkat2-Python • CkPython • Classic ASP • DataFlex • Delphi ActiveX • Delphi DLL • Go • Java • Lianja • Mono C# • Node.js • Objective-C • PHP ActiveX • PHP Extension • Perl • PowerBuilder • PowerShell • PureBasic • Ruby • SQL Server • Swift 2 • Swift 3,4,5... • Tcl • Unicode C • Unicode C++ • VB.NET • VBScript • Visual Basic 6.0 • Visual FoxPro • Xojo Plugin
(Tcl) Square API - Batch Upsert Catalog ObjectsCreates 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. For more information, see https://developer.squareup.com/reference/square/catalog-api/batch-upsert-catalog-objects
load ./chilkat.dll # This example assumes the Chilkat API to have been previously unlocked. # See Global Unlock Sample for sample code. set http [new_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 # } # } # ] # } # ] # } set json [new_CkJsonObject] CkJsonObject_UpdateString $json "idempotency_key" "789ff020-f723-43a9-b4b5-43b5dc1fa3dc" set i 0 CkJsonObject_put_I $json $i set j 0 CkJsonObject_put_J $json $j CkJsonObject_UpdateString $json "batches[i].objects[j].type" "ITEM" CkJsonObject_UpdateString $json "batches[i].objects[j].id" "#Tea" CkJsonObject_UpdateBool $json "batches[i].objects[j].present_at_all_locations" 1 CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.name" "Tea" CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.description" "Hot Leaf Juice" CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.category_id" "#Beverages" CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.tax_ids[0]" "#SalesTax" CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[0].type" "ITEM_VARIATION" CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[0].id" "#Tea_Mug" CkJsonObject_UpdateBool $json "batches[i].objects[j].item_data.variations[0].present_at_all_locations" 1 CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[0].item_variation_data.item_id" "#Tea" CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[0].item_variation_data.name" "Mug" CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[0].item_variation_data.pricing_type" "FIXED_PRICING" CkJsonObject_UpdateInt $json "batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.amount" 150 CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.currency" "USD" set j [expr $j + 1] CkJsonObject_put_J $json $j CkJsonObject_UpdateString $json "batches[i].objects[j].type" "ITEM" CkJsonObject_UpdateString $json "batches[i].objects[j].id" "#Coffee" CkJsonObject_UpdateBool $json "batches[i].objects[j].present_at_all_locations" 1 CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.name" "Coffee" CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.description" "Hot Bean Juice" CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.category_id" "#Beverages" CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.tax_ids[0]" "#SalesTax" set k 0 CkJsonObject_put_K $json $k CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[k].type" "ITEM_VARIATION" CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[k].id" "#Coffee_Regular" CkJsonObject_UpdateBool $json "batches[i].objects[j].item_data.variations[k].present_at_all_locations" 1 CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[k].item_variation_data.item_id" "#Coffee" CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[k].item_variation_data.name" "Regular" CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type" "FIXED_PRICING" CkJsonObject_UpdateInt $json "batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount" 250 CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency" "USD" set k [expr $k + 1] CkJsonObject_put_K $json $k CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[k].type" "ITEM_VARIATION" CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[k].id" "#Coffee_Large" CkJsonObject_UpdateBool $json "batches[i].objects[j].item_data.variations[k].present_at_all_locations" 1 CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[k].item_variation_data.item_id" "#Coffee" CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[k].item_variation_data.name" "Large" CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type" "FIXED_PRICING" CkJsonObject_UpdateInt $json "batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount" 350 CkJsonObject_UpdateString $json "batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency" "USD" set j [expr $j + 1] CkJsonObject_put_J $json $j CkJsonObject_UpdateString $json "batches[i].objects[j].type" "CATEGORY" CkJsonObject_UpdateString $json "batches[i].objects[j].id" "#Beverages" CkJsonObject_UpdateBool $json "batches[i].objects[j].present_at_all_locations" 1 CkJsonObject_UpdateString $json "batches[i].objects[j].category_data.name" "Beverages" set j [expr $j + 1] CkJsonObject_put_J $json $j CkJsonObject_UpdateString $json "batches[i].objects[j].type" "TAX" CkJsonObject_UpdateString $json "batches[i].objects[j].id" "#SalesTax" CkJsonObject_UpdateBool $json "batches[i].objects[j].present_at_all_locations" 1 CkJsonObject_UpdateString $json "batches[i].objects[j].tax_data.name" "Sales Tax" CkJsonObject_UpdateString $json "batches[i].objects[j].tax_data.calculation_phase" "TAX_SUBTOTAL_PHASE" CkJsonObject_UpdateString $json "batches[i].objects[j].tax_data.inclusion_type" "ADDITIVE" CkJsonObject_UpdateString $json "batches[i].objects[j].tax_data.percentage" "5.0" CkJsonObject_UpdateBool $json "batches[i].objects[j].tax_data.applies_to_custom_amounts" 1 CkJsonObject_UpdateBool $json "batches[i].objects[j].tax_data.enabled" 1 # Adds the "Authorization: Bearer ACCESS_TOKEN" header. CkHttp_put_AuthToken $http "ACCESS_TOKEN" CkHttp_SetRequestHeader $http "Square-Version" "2020-07-22" CkHttp_SetRequestHeader $http "Content-Type" "application/json" # This example uses the sandbox: connect.squareupsandbox.com # Production should use connect.squareup.com # resp is a CkHttpResponse set resp [CkHttp_PostJson3 $http "https://connect.squareupsandbox.com/v2/catalog/batch-upsert" "application/json" $json] if {[CkHttp_get_LastMethodSuccess $http] == 0} then { puts [CkHttp_lastErrorText $http] delete_CkHttp $http delete_CkJsonObject $json exit } set sbResponseBody [new_CkStringBuilder] CkHttpResponse_GetBodySb $resp $sbResponseBody set jResp [new_CkJsonObject] CkJsonObject_LoadSb $jResp $sbResponseBody CkJsonObject_put_EmitCompact $jResp 0 puts "Response Body:" puts [CkJsonObject_emit $jResp] set respStatusCode [CkHttpResponse_get_StatusCode $resp] puts "Response Status Code = $respStatusCode" if {$respStatusCode >= 400} then { puts "Response Header:" puts [CkHttpResponse_header $resp] puts "Failed." delete_CkHttpResponse $resp delete_CkHttp $http delete_CkJsonObject $json delete_CkStringBuilder $sbResponseBody delete_CkJsonObject $jResp exit } delete_CkHttpResponse $resp # 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 set i 0 set count_i [CkJsonObject_SizeOfArray $jResp "objects"] while {$i < $count_i} { CkJsonObject_put_I $jResp $i set v_type [CkJsonObject_stringOf $jResp "objects[i].type"] set id [CkJsonObject_stringOf $jResp "objects[i].id"] set updated_at [CkJsonObject_stringOf $jResp "objects[i].updated_at"] set version [CkJsonObject_IntOf $jResp "objects[i].version"] set is_deleted [CkJsonObject_BoolOf $jResp "objects[i].is_deleted"] set present_at_all_locations [CkJsonObject_BoolOf $jResp "objects[i].present_at_all_locations"] set item_dataName [CkJsonObject_stringOf $jResp "objects[i].item_data.name"] set item_dataDescription [CkJsonObject_stringOf $jResp "objects[i].item_data.description"] set item_dataCategory_id [CkJsonObject_stringOf $jResp "objects[i].item_data.category_id"] set category_dataName [CkJsonObject_stringOf $jResp "objects[i].category_data.name"] set tax_dataName [CkJsonObject_stringOf $jResp "objects[i].tax_data.name"] set tax_dataCalculation_phase [CkJsonObject_stringOf $jResp "objects[i].tax_data.calculation_phase"] set tax_dataInclusion_type [CkJsonObject_stringOf $jResp "objects[i].tax_data.inclusion_type"] set tax_dataPercentage [CkJsonObject_stringOf $jResp "objects[i].tax_data.percentage"] set tax_dataApplies_to_custom_amounts [CkJsonObject_BoolOf $jResp "objects[i].tax_data.applies_to_custom_amounts"] set tax_dataEnabled [CkJsonObject_BoolOf $jResp "objects[i].tax_data.enabled"] set j 0 set count_j [CkJsonObject_SizeOfArray $jResp "objects[i].item_data.tax_ids"] while {$j < $count_j} { CkJsonObject_put_J $jResp $j set strVal [CkJsonObject_stringOf $jResp "objects[i].item_data.tax_ids[j]"] set j [expr $j + 1] } set j 0 set count_j [CkJsonObject_SizeOfArray $jResp "objects[i].item_data.variations"] while {$j < $count_j} { CkJsonObject_put_J $jResp $j set v_type [CkJsonObject_stringOf $jResp "objects[i].item_data.variations[j].type"] set id [CkJsonObject_stringOf $jResp "objects[i].item_data.variations[j].id"] set updated_at [CkJsonObject_stringOf $jResp "objects[i].item_data.variations[j].updated_at"] set version [CkJsonObject_IntOf $jResp "objects[i].item_data.variations[j].version"] set is_deleted [CkJsonObject_BoolOf $jResp "objects[i].item_data.variations[j].is_deleted"] set present_at_all_locations [CkJsonObject_BoolOf $jResp "objects[i].item_data.variations[j].present_at_all_locations"] set item_variation_dataItem_id [CkJsonObject_stringOf $jResp "objects[i].item_data.variations[j].item_variation_data.item_id"] set item_variation_dataName [CkJsonObject_stringOf $jResp "objects[i].item_data.variations[j].item_variation_data.name"] set item_variation_dataOrdinal [CkJsonObject_IntOf $jResp "objects[i].item_data.variations[j].item_variation_data.ordinal"] set item_variation_dataPricing_type [CkJsonObject_stringOf $jResp "objects[i].item_data.variations[j].item_variation_data.pricing_type"] set item_variation_dataPrice_moneyAmount [CkJsonObject_IntOf $jResp "objects[i].item_data.variations[j].item_variation_data.price_money.amount"] set item_variation_dataPrice_moneyCurrency [CkJsonObject_stringOf $jResp "objects[i].item_data.variations[j].item_variation_data.price_money.currency"] set j [expr $j + 1] } set i [expr $i + 1] } set i 0 set count_i [CkJsonObject_SizeOfArray $jResp "id_mappings"] while {$i < $count_i} { CkJsonObject_put_I $jResp $i set client_object_id [CkJsonObject_stringOf $jResp "id_mappings[i].client_object_id"] set object_id [CkJsonObject_stringOf $jResp "id_mappings[i].object_id"] set i [expr $i + 1] } delete_CkHttp $http delete_CkJsonObject $json delete_CkStringBuilder $sbResponseBody delete_CkJsonObject $jResp |
||||
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.