(Excel) Square API - Batch Upsert Catalog Objects

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.

For more information, see https://developer.squareup.com/reference/square/catalog-api/batch-upsert-catalog-objects

Download Excel Class Modules Chilkat Excel Class Modules

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

' 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
'           }
'         }
'       ]
'     }
'   ]
' }

Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
Dim success As Boolean
success = json.UpdateString("idempotency_key","789ff020-f723-43a9-b4b5-43b5dc1fa3dc")
i = 0
json.I = i
j = 0
json.J = j
success = json.UpdateString("batches[i].objects[j].type","ITEM")
success = json.UpdateString("batches[i].objects[j].id","#Tea")
success = json.UpdateBool("batches[i].objects[j].present_at_all_locations",True)
success = json.UpdateString("batches[i].objects[j].item_data.name","Tea")
success = json.UpdateString("batches[i].objects[j].item_data.description","Hot Leaf Juice")
success = json.UpdateString("batches[i].objects[j].item_data.category_id","#Beverages")
success = json.UpdateString("batches[i].objects[j].item_data.tax_ids[0]","#SalesTax")
success = json.UpdateString("batches[i].objects[j].item_data.variations[0].type","ITEM_VARIATION")
success = json.UpdateString("batches[i].objects[j].item_data.variations[0].id","#Tea_Mug")
success = json.UpdateBool("batches[i].objects[j].item_data.variations[0].present_at_all_locations",True)
success = json.UpdateString("batches[i].objects[j].item_data.variations[0].item_variation_data.item_id","#Tea")
success = json.UpdateString("batches[i].objects[j].item_data.variations[0].item_variation_data.name","Mug")
success = json.UpdateString("batches[i].objects[j].item_data.variations[0].item_variation_data.pricing_type","FIXED_PRICING")
success = json.UpdateInt("batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.amount",150)
success = json.UpdateString("batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.currency","USD")
j = j + 1
json.J = j
success = json.UpdateString("batches[i].objects[j].type","ITEM")
success = json.UpdateString("batches[i].objects[j].id","#Coffee")
success = json.UpdateBool("batches[i].objects[j].present_at_all_locations",True)
success = json.UpdateString("batches[i].objects[j].item_data.name","Coffee")
success = json.UpdateString("batches[i].objects[j].item_data.description","Hot Bean Juice")
success = json.UpdateString("batches[i].objects[j].item_data.category_id","#Beverages")
success = json.UpdateString("batches[i].objects[j].item_data.tax_ids[0]","#SalesTax")
k = 0
json.K = k
success = json.UpdateString("batches[i].objects[j].item_data.variations[k].type","ITEM_VARIATION")
success = json.UpdateString("batches[i].objects[j].item_data.variations[k].id","#Coffee_Regular")
success = json.UpdateBool("batches[i].objects[j].item_data.variations[k].present_at_all_locations",True)
success = json.UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.item_id","#Coffee")
success = json.UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.name","Regular")
success = json.UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type","FIXED_PRICING")
success = json.UpdateInt("batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount",250)
success = json.UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency","USD")
k = k + 1
json.K = k
success = json.UpdateString("batches[i].objects[j].item_data.variations[k].type","ITEM_VARIATION")
success = json.UpdateString("batches[i].objects[j].item_data.variations[k].id","#Coffee_Large")
success = json.UpdateBool("batches[i].objects[j].item_data.variations[k].present_at_all_locations",True)
success = json.UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.item_id","#Coffee")
success = json.UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.name","Large")
success = json.UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type","FIXED_PRICING")
success = json.UpdateInt("batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount",350)
success = json.UpdateString("batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency","USD")
j = j + 1
json.J = j
success = json.UpdateString("batches[i].objects[j].type","CATEGORY")
success = json.UpdateString("batches[i].objects[j].id","#Beverages")
success = json.UpdateBool("batches[i].objects[j].present_at_all_locations",True)
success = json.UpdateString("batches[i].objects[j].category_data.name","Beverages")
j = j + 1
json.J = j
success = json.UpdateString("batches[i].objects[j].type","TAX")
success = json.UpdateString("batches[i].objects[j].id","#SalesTax")
success = json.UpdateBool("batches[i].objects[j].present_at_all_locations",True)
success = json.UpdateString("batches[i].objects[j].tax_data.name","Sales Tax")
success = json.UpdateString("batches[i].objects[j].tax_data.calculation_phase","TAX_SUBTOTAL_PHASE")
success = json.UpdateString("batches[i].objects[j].tax_data.inclusion_type","ADDITIVE")
success = json.UpdateString("batches[i].objects[j].tax_data.percentage","5.0")
success = json.UpdateBool("batches[i].objects[j].tax_data.applies_to_custom_amounts",True)
success = json.UpdateBool("batches[i].objects[j].tax_data.enabled",True)

' Adds the "Authorization: Bearer ACCESS_TOKEN" header.
http.AuthToken = "ACCESS_TOKEN"
http.SetRequestHeader "Square-Version","2020-07-22"
http.SetRequestHeader "Content-Type","application/json"

' This example uses the sandbox: connect.squareupsandbox.com
' Production should use connect.squareup.com

Set resp = http.PostJson3("https://connect.squareupsandbox.com/v2/catalog/batch-upsert","application/json",json)
If (http.LastMethodSuccess = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As Chilkat.JsonObject
Set jResp = Chilkat.NewJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.Print "Response Body:"
Debug.Print jResp.Emit()


respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = "; respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' 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

count_i = jResp.SizeOfArray("objects")
Do While i < count_i
    jResp.I = i
    v_type = jResp.StringOf("objects[i].type")
    id = jResp.StringOf("objects[i].id")
    updated_at = jResp.StringOf("objects[i].updated_at")
    version = jResp.IntOf("objects[i].version")
    is_deleted = jResp.BoolOf("objects[i].is_deleted")
    present_at_all_locations = jResp.BoolOf("objects[i].present_at_all_locations")
    item_dataName = jResp.StringOf("objects[i].item_data.name")
    item_dataDescription = jResp.StringOf("objects[i].item_data.description")
    item_dataCategory_id = jResp.StringOf("objects[i].item_data.category_id")
    category_dataName = jResp.StringOf("objects[i].category_data.name")
    tax_dataName = jResp.StringOf("objects[i].tax_data.name")
    tax_dataCalculation_phase = jResp.StringOf("objects[i].tax_data.calculation_phase")
    tax_dataInclusion_type = jResp.StringOf("objects[i].tax_data.inclusion_type")
    tax_dataPercentage = jResp.StringOf("objects[i].tax_data.percentage")
    tax_dataApplies_to_custom_amounts = jResp.BoolOf("objects[i].tax_data.applies_to_custom_amounts")
    tax_dataEnabled = jResp.BoolOf("objects[i].tax_data.enabled")
    j = 0
    count_j = jResp.SizeOfArray("objects[i].item_data.tax_ids")
    Do While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("objects[i].item_data.tax_ids[j]")
        j = j + 1
    Loop
    j = 0
    count_j = jResp.SizeOfArray("objects[i].item_data.variations")
    Do While j < count_j
        jResp.J = j
        v_type = jResp.StringOf("objects[i].item_data.variations[j].type")
        id = jResp.StringOf("objects[i].item_data.variations[j].id")
        updated_at = jResp.StringOf("objects[i].item_data.variations[j].updated_at")
        version = jResp.IntOf("objects[i].item_data.variations[j].version")
        is_deleted = jResp.BoolOf("objects[i].item_data.variations[j].is_deleted")
        present_at_all_locations = jResp.BoolOf("objects[i].item_data.variations[j].present_at_all_locations")
        item_variation_dataItem_id = jResp.StringOf("objects[i].item_data.variations[j].item_variation_data.item_id")
        item_variation_dataName = jResp.StringOf("objects[i].item_data.variations[j].item_variation_data.name")
        item_variation_dataOrdinal = jResp.IntOf("objects[i].item_data.variations[j].item_variation_data.ordinal")
        item_variation_dataPricing_type = jResp.StringOf("objects[i].item_data.variations[j].item_variation_data.pricing_type")
        item_variation_dataPrice_moneyAmount = jResp.IntOf("objects[i].item_data.variations[j].item_variation_data.price_money.amount")
        item_variation_dataPrice_moneyCurrency = jResp.StringOf("objects[i].item_data.variations[j].item_variation_data.price_money.currency")
        j = j + 1
    Loop
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("id_mappings")
Do While i < count_i
    jResp.I = i
    client_object_id = jResp.StringOf("id_mappings[i].client_object_id")
    object_id = jResp.StringOf("id_mappings[i].object_id")
    i = i + 1
Loop