Object Index / Definition

You are viewing an old version of the API
Catalog​Item

An item (i.e., product family) in the Catalog object model

Properties

Name Description
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. Searchable. This field has max length of 24 Unicode code points.

available_electronically
boolean

If true, the item can be added to electronically fulfilled orders from the merchant's online store.

available_for_pickup
boolean

If true, the item can be added to pickup orders from the merchant's online store.

available_online
boolean

If true, the item can be added to shipping orders from the merchant's online store.

category_id
string

The ID of the item's category, if any.

description
string

The item's description. Searchable. This field has max length of 4096 Unicode code points.

item_options
Catalog​Item​Option​For​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.

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.

modifier_list_info
Catalog​Item​Modifier​List​Info [ ]

A set of CatalogItemModifierListInfo objects 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 UpdateItemModifierLists.

name
string

The item's name. Searchable. This field must not be empty. This field has max length of 512 Unicode code points.

product_type
string

The product type of the item. May not be changed once an item has been created.

Only items of product type REGULAR or APPOINTMENTS_SERVICE may be created by this API; items with other product types are read-only.

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. This is the default behavior.

If 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.

tax_ids
string [ ]

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 UpdateItemTaxes.

variations
Catalog​Object [ ]

A list of CatalogObjects containing the CatalogItemVariations for this item.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?