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.
The item's description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.
Deprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use
description_html to set the description
of the CatalogItem instance. The
description_html field values are kept in sync. If you try to
set the both fields, the
description_html text value overwrites the
description value. Updates in one field are also reflected in the other,
except for when you use an early version before Square API 2022-07-20 and
description_html is set to blank, setting the
description value to null
does not nullify
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.
The color of the item's display label in the Square Point of Sale app. This must be a valid hex color code.
true, the item can be added to shipping orders from the merchant's online store.
true, the item can be added to pickup orders from the merchant's online store.
true, the item can be added to electronically fulfilled orders from the merchant's online store.
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
A set of
representing the modifier lists that apply to this item, along with the overrides and min
and max limits that are specific to this item. Modifier lists
may also be added to or deleted from an item using
The product type of the item. May not be changed once an item has been created.
Only items of product type
APPOINTMENTS_SERVICE may be created by this API; items with other product
types are read-only.
false, the Square Point of Sale app will present the
details screen immediately, allowing the merchant to choose
before adding the item to the cart. This is the default behavior.
true, the Square Point of Sale app will immediately add the item to the cart with the pre-selected
modifiers, and merchants can edit modifiers by drilling down onto the item's details.
Third-party clients are encouraged to implement similar behaviors.
List of item options IDs for this item. Used to manage and group item variations in a specified order.
Maximum: 6 item options.
The IDs of images associated with this
These images will be shown to customers in Square Online Store.
The first image will show up as the icon for this item in POS.
A name to sort the item by. If this name is unspecified, namely, the
sort_name field is absent, the regular
name field is used for sorting.
Its value must not be empty.
It is currently supported for sellers of the Japanese locale only.
The item's description as expressed in valid HTML elements. The length of this field value, including those of HTML tags, is of Unicode points. With application query filters, the text values of the HTML elements and attributes are searchable. Invalid or unsupported HTML elements or attributes are ignored.
Supported HTML elements include:
a: Link. Supports linking to website URLs, email address, and telephone numbers.
strong: Bold text
br: Line break
code: Computer code
li: List element
ol: Numbered list
ul: Bullet list
Supported HTML attributes include:
align: Alignment of the text content
href: Link destination
rel: Relationship between link's target and source
target: Place to open the linked document
Read only A server-generated plaintext version of the
description_html field, without formatting tags.