(VB.NET) Square API - Retrieve Catalog Object

Returns a single CatalogItem as a CatalogObject based on the provided ID.

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

Chilkat .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

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

Dim http As New Chilkat.Http
Dim success As Boolean

' Implements the following CURL command:

' curl https://connect.squareup.com/v2/catalog/object/W62UWFY35CWMYGVWK6TWJDNI?include_related_objects=true 
'   -H 'Square-Version: 2020-07-22' 
'   -H 'Authorization: Bearer ACCESS_TOKEN' 
'   -H 'Content-Type: application/json'

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

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

http.SetUrlVar("id","2PTZYUOFGGDMT75UZLHQAPAC")

' This example uses the sandbox: connect.squareupsandbox.com
' Production should use connect.squareup.com
Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://connect.squareupsandbox.com/v2/catalog/object/{$id}?include_related_objects=true",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

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

Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastHeader)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "object": {
'     "type": "ITEM",
'     "id": "W62UWFY35CWMYGVWK6TWJDNI",
'     "updated_at": "2016-11-16T22:25:24.878Z",
'     "version": 1479335124878,
'     "is_deleted": false,
'     "present_at_all_locations": true,
'     "item_data": {
'       "name": "Tea",
'       "description": "Hot Leaf Juice",
'       "category_id": "BJNQCF2FJ6S6UIDT65ABHLRX",
'       "tax_ids": [
'         "HURXQOOAIC4IZSI2BEXQRYFY"
'       ],
'       "variations": [
'         {
'           "type": "ITEM_VARIATION",
'           "id": "2TZFAOHWGG7PAK2QEXWYPZSP",
'           "updated_at": "2016-11-16T22:25:24.878Z",
'           "version": 1479335124878,
'           "is_deleted": false,
'           "present_at_all_locations": true,
'           "item_variation_data": {
'             "item_id": "W62UWFY35CWMYGVWK6TWJDNI",
'             "name": "Mug",
'             "ordinal": 0,
'             "pricing_type": "FIXED_PRICING",
'             "price_money": {
'               "amount": 150,
'               "currency": "USD"
'             }
'           }
'         }
'       ]
'     }
'   },
'   "related_objects": [
'     {
'       "type": "CATEGORY",
'       "id": "BJNQCF2FJ6S6UIDT65ABHLRX",
'       "updated_at": "2016-11-16T22:25:24.878Z",
'       "version": 1479335124878,
'       "is_deleted": false,
'       "present_at_all_locations": true,
'       "category_data": {
'         "name": "Beverages"
'       }
'     },
'     {
'       "type": "TAX",
'       "id": "HURXQOOAIC4IZSI2BEXQRYFY",
'       "updated_at": "2016-11-16T22:25:24.878Z",
'       "version": 1479335124878,
'       "is_deleted": false,
'       "present_at_all_locations": true,
'       "tax_data": {
'         "name": "Sales Tax",
'         "calculation_phase": "TAX_SUBTOTAL_PHASE",
'         "inclusion_type": "ADDITIVE",
'         "percentage": "5.0",
'         "enabled": true
'       }
'     }
'   ]
' }

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



Dim strVal As String
Dim v_type As String
Dim id As String
Dim updated_at As String
Dim version As Integer
Dim is_deleted As Boolean
Dim present_at_all_locations As Boolean
Dim item_variation_dataItem_id As String
Dim item_variation_dataName As String
Dim item_variation_dataOrdinal As Integer
Dim item_variation_dataPricing_type As String
Dim item_variation_dataPrice_moneyAmount As Integer
Dim item_variation_dataPrice_moneyCurrency As String
Dim category_dataName As String
Dim tax_dataName As String
Dim tax_dataCalculation_phase As String
Dim tax_dataInclusion_type As String
Dim tax_dataPercentage As String
Dim tax_dataEnabled As Boolean

Dim objectType As String = jResp.StringOf("object.type")
Dim objectId As String = jResp.StringOf("object.id")
Dim objectUpdated_at As String = jResp.StringOf("object.updated_at")
Dim objectVersion As Integer = jResp.IntOf("object.version")
Dim objectIs_deleted As Boolean = jResp.BoolOf("object.is_deleted")
Dim objectPresent_at_all_locations As Boolean = jResp.BoolOf("object.present_at_all_locations")
Dim objectItem_dataName As String = jResp.StringOf("object.item_data.name")
Dim objectItem_dataDescription As String = jResp.StringOf("object.item_data.description")
Dim objectItem_dataCategory_id As String = jResp.StringOf("object.item_data.category_id")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("object.item_data.tax_ids")
While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("object.item_data.tax_ids[i]")
    i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("object.item_data.variations")
While i < count_i
    jResp.I = i
    v_type = jResp.StringOf("object.item_data.variations[i].type")
    id = jResp.StringOf("object.item_data.variations[i].id")
    updated_at = jResp.StringOf("object.item_data.variations[i].updated_at")
    version = jResp.IntOf("object.item_data.variations[i].version")
    is_deleted = jResp.BoolOf("object.item_data.variations[i].is_deleted")
    present_at_all_locations = jResp.BoolOf("object.item_data.variations[i].present_at_all_locations")
    item_variation_dataItem_id = jResp.StringOf("object.item_data.variations[i].item_variation_data.item_id")
    item_variation_dataName = jResp.StringOf("object.item_data.variations[i].item_variation_data.name")
    item_variation_dataOrdinal = jResp.IntOf("object.item_data.variations[i].item_variation_data.ordinal")
    item_variation_dataPricing_type = jResp.StringOf("object.item_data.variations[i].item_variation_data.pricing_type")
    item_variation_dataPrice_moneyAmount = jResp.IntOf("object.item_data.variations[i].item_variation_data.price_money.amount")
    item_variation_dataPrice_moneyCurrency = jResp.StringOf("object.item_data.variations[i].item_variation_data.price_money.currency")
    i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("related_objects")
While i < count_i
    jResp.I = i
    v_type = jResp.StringOf("related_objects[i].type")
    id = jResp.StringOf("related_objects[i].id")
    updated_at = jResp.StringOf("related_objects[i].updated_at")
    version = jResp.IntOf("related_objects[i].version")
    is_deleted = jResp.BoolOf("related_objects[i].is_deleted")
    present_at_all_locations = jResp.BoolOf("related_objects[i].present_at_all_locations")
    category_dataName = jResp.StringOf("related_objects[i].category_data.name")
    tax_dataName = jResp.StringOf("related_objects[i].tax_data.name")
    tax_dataCalculation_phase = jResp.StringOf("related_objects[i].tax_data.calculation_phase")
    tax_dataInclusion_type = jResp.StringOf("related_objects[i].tax_data.inclusion_type")
    tax_dataPercentage = jResp.StringOf("related_objects[i].tax_data.percentage")
    tax_dataEnabled = jResp.BoolOf("related_objects[i].tax_data.enabled")
    i = i + 1
End While