Object Index
You are viewing an old version of the API
CatalogItem
Object Index
A CatalogObject instance of the ITEM
type, also referred to as an item, in the catalog.
Properties
Name | Description |
---|---|
name
|
The item's name. This is a searchable attribute for use in applicable query filters, its value must not be empty, and the length is of Unicode code points. |
description
|
The item's description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. |
abbreviation
|
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. This attribute is searchable, and its value length is of Unicode code points. |
label_
|
The color of the item's display label in the Square Point of Sale app. This must be a valid hex color code. |
available_
|
If |
available_
|
If |
available_
|
If |
category_
|
The ID of the item's category, if any. |
tax_
|
A set of IDs indicating the taxes enabled for
this item. When updating an item, any taxes listed here will be added to the item.
Taxes may also be added to or deleted from an item using |
modifier_
|
A set of |
variations
|
A list of CatalogObjects containing the |
product_
|
The product type of the item. May not be changed once an item has been created. Only items of product type |
skip_
|
If If Third-party clients are encouraged to implement similar behaviors. |
item_
Beta
|
List of item options IDs for this item. Used to manage and group item variations in a specified order. Maximum: 6 item options. |