B4X

Square API - List Catalog

See more Square Examples

Returns a list of CatalogObjects that includes all objects of a set of desired types (for example, all CatalogItem and CatalogTax objects) in the catalog. B4X

Dim success As Boolean = False

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

Dim http As ChilkatHttp
http.Initialize("http")

'  Implements the following CURL command:

'  curl https://connect.squareup.com/v2/catalog/list?types=category%2Ctax \
'    -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")

'  This example uses the sandbox: connect.squareupsandbox.com
'  Production should use connect.squareup.com
Dim sbResponseBody As ChilkatStringBuilder
sbResponseBody.Initialize
success = http.QuickGetSb("https://connect.squareupsandbox.com/v2/catalog/list?types=item,category,tax,image", sbResponseBody)
If success = False Then
    Log(http.LastErrorText)
    Return
End If


Dim jResp As ChilkatJsonObject
jResp.Initialize
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Log("Response Body:")
Log(jResp.Emit)

Dim respStatusCode As Int = http.LastStatus
Log("Response Status Code = " & respStatusCode)
If respStatusCode >= 400 Then
    Log("Response Header:")
    Log(http.LastHeader)
    Log("Failed.")
    Return
End If


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

'  {
'    "objects": [
'      {
'        "type": "CATEGORY",
'        "id": "5ZYQZZ2IECPVJ2IJ5KQPRDC3",
'        "updated_at": "2017-02-21T14:50:26.495Z",
'        "version": 1487688626495,
'        "is_deleted": false,
'        "present_at_all_locations": true,
'        "category_data": {
'          "name": "Beverages"
'        }
'      },
'      {
'        "type": "TAX",
'        "id": "L5R47DGBZOOVKCAFIXC56AEN",
'        "updated_at": "2017-02-21T14:50:26.495Z",
'        "version": 1487688626495,
'        "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 v_type As String
Dim id As String
Dim updated_at As String
Dim version As Int
Dim is_deleted As Boolean
Dim present_at_all_locations As Boolean
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 i As Int = 0
Dim count_i As Int = 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")
    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_dataEnabled = jResp.BoolOf("objects[i].tax_data.enabled")
    i = i + 1
Loop