| name |
string |
The item's name. This is a searchable attribute for use in applicable query filters. |
| description |
string |
The item's description as plain text. |
| description_html |
string |
The item's description as expressed in valid HTML elements. |
| abbreviation |
string |
The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used. |
| label_color |
string |
The color of the item's display label in the Square Point of Sale app. This must be a valid hex color code. |
| is_taxable |
boolean |
Indicates whether the item is taxable (true) or non-taxable (false). Default is true. |
| category_id |
string |
The ID of the item's category, if any. Deprecated: use categories instead. |
| categories |
array |
The list of categories that this item belongs to. |
| tax_ids |
array |
A set of IDs indicating the taxes enabled for this item. |
| modifier_list_info |
array |
A set of CatalogItemModifierListInfo objects representing the modifier lists that apply to this item. |
| variations |
array |
A list of CatalogItemVariation objects for this item. An item must have at least one variation. |
| product_type |
string |
The product type of the item. Once set, the product_type value cannot be modified. |
| skip_modifier_screen |
boolean |
If false, the Square Point of Sale app will present the CatalogItem's details screen immediately, allowing the merchant to choose CatalogModifiers before adding the item to the cart. |
| item_options |
array |
List of item options IDs for this item. Used to manage and group item variations in a specified order. Maximum: 6 item options. |
| image_ids |
array |
The IDs of images associated with this CatalogItem instance. |
| sort_name |
string |
A name to sort the item by. If unspecified, the regular name field is used for sorting. |
| reporting_category |
object |
The reporting category associated with this item. |
| channels |
array |
The channels where this item is available. |
| is_archived |
boolean |
Whether this item is archived (soft-deleted). |