(Excel) Upsert Catalog Object

Creates or updates the target CatalogObject.

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

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

' Implements the following CURL command:

' curl https://connect.squareup.com/v2/catalog/object \
'   -X POST \
'   -H 'Square-Version: 2020-07-22' \
'   -H 'Authorization: Bearer ACCESS_TOKEN' \
'   -H 'Content-Type: application/json' \
'   -d '{
'     "idempotency_key": "af3d1afc-7212-4300-b463-0bfc5314a5ae",
'     "object": {
'       "type": "ITEM",
'       "id": "#Cocoa",
'       "item_data": {
'         "name": "Cocoa",
'         "description": "Hot chocolate",
'         "abbreviation": "Ch"
'       }
'     }
'   }'

' Use the following online tool to generate HTTP code from a CURL command
' Convert a cURL Command to HTTP Source Code

' 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": "af3d1afc-7212-4300-b463-0bfc5314a5ae",
'   "object": {
'     "type": "ITEM",
'     "id": "#Cocoa",
'     "item_data": {
'       "name": "Cocoa",
'       "description": "Hot chocolate",
'       "abbreviation": "Ch"
'     }
'   }
' }

Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
Dim success As Boolean
success = json.UpdateString("idempotency_key","af3d1afc-7212-4300-b463-0bfc5314a5ae")
success = json.UpdateString("object.type","ITEM")
success = json.UpdateString("object.id","#Cocoa")
success = json.UpdateString("object.item_data.name","Cocoa")
success = json.UpdateString("object.item_data.description","Hot chocolate")
success = json.UpdateString("object.item_data.abbreviation","Ch")

' 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/object","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)

' {
'   "catalog_object": {
'     "type": "ITEM",
'     "id": "7SB3ZQYJ5GDMVFL7JK46JCHT",
'     "updated_at": "2016-11-16T22:32:42.996Z",
'     "version": 1479335562996,
'     "is_deleted": false,
'     "item_data": {
'       "name": "Cocoa",
'       "description": "Hot chocolate",
'       "abbreviation": "Ch"
'     }
'   },
'   "id_mappings": [
'     {
'       "client_object_id": "#Cocoa",
'       "object_id": "7SB3ZQYJ5GDMVFL7JK46JCHT"
'     }
'   ]
' }

' Sample code for parsing the JSON response...
' Use the following online tool to generate parsing code from sample JSON:
' Generate Parsing Code from JSON


catalog_objectType = jResp.StringOf("catalog_object.type")

catalog_objectId = jResp.StringOf("catalog_object.id")

catalog_objectUpdated_at = jResp.StringOf("catalog_object.updated_at")

catalog_objectVersion = jResp.IntOf("catalog_object.version")

catalog_objectIs_deleted = jResp.BoolOf("catalog_object.is_deleted")

catalog_objectItem_dataName = jResp.StringOf("catalog_object.item_data.name")

catalog_objectItem_dataDescription = jResp.StringOf("catalog_object.item_data.description")

catalog_objectItem_dataAbbreviation = jResp.StringOf("catalog_object.item_data.abbreviation")

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