CatalogCategory

A category to which a CatalogItem instance belongs.

Link to section

Properties

Link to section

name

string

The category name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.

Max Length

255

Link to section

image_ids

string [ ]

The IDs of images associated with this CatalogCategory instance. Currently these images are not displayed by Square, but are free to be displayed in 3rd party applications.

Link to section

category_type

string

The type of the category.

Link to section

parent_category

The ID of the parent category of this category instance.

Link to section

is_top_level

boolean

Indicates whether a category is a top level category, which does not have any parent_category.

Link to section

channels

string [ ]

A list of IDs representing channels, such as a Square Online site, where the category can be made visible.

Link to section

availability_period_ids

string [ ]

The IDs of the CatalogAvailabilityPeriod objects associated with the category.

Link to section

online_visibility

boolean

Indicates whether the category is visible (true) or hidden (false) on all of the seller's Square Online sites.

Link to section

root_category

string

Read only The top-level category in a category hierarchy.

Link to section

ecom_seo_data

The SEO data for a seller's Square Online store.

Link to section

path_to_root

The path from the category to its root category. The first node of the path is the parent of the category and the last is the root category. The path is empty if the category is a root category.