catalog-category.md

Catalog Category

A category to which a CatalogItem instance belongs.

Structure

Catalog Category

Fields

Name	Type	Tags	Description
name	str	Optional	The category name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. Constraints: Maximum Length: 255
image_ids	List[str]	Optional	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.
category_type	str (Catalog Category Type)	Optional	Indicates the type of a category.
parent_category	Catalog Object Category	Optional	A category that can be assigned to an item or a parent category that can be assigned to another category. For example, a clothing category can be assigned to a t-shirt item or be made as the parent category to the pants category.
is_top_level	bool	Optional	Indicates whether a category is a top level category, which does not have any parent_category.
channels	List[str]	Optional	A list of IDs representing channels, such as a Square Online site, where the category can be made visible.
availability_period_ids	List[str]	Optional	The IDs of the CatalogAvailabilityPeriod objects associated with the category.
online_visibility	bool	Optional	Indicates whether the category is visible (true) or hidden (false) on all of the seller's Square Online sites.
root_category	str	Optional	The top-level category in a category hierarchy.
ecom_seo_data	Catalog Ecom Seo Data	Optional	SEO data for for a seller's Square Online store.
path_to_root	List Category Path to Root Node	Optional	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.

Example (as JSON)

{
  "object": {
    "category_data": {
      "name": "Beverages"
    },
    "id": "#Beverages",
    "present_at_all_locations": true,
    "type": "CATEGORY"
  },
  "name": "name2",
  "image_ids": [
    "image_ids7",
    "image_ids6",
    "image_ids5"
  ],
  "category_type": "REGULAR_CATEGORY",
  "parent_category": {
    "id": "id4",
    "ordinal": 114
  },
  "is_top_level": false
}