catalog-item.md

Catalog Item

A CatalogObject instance of the ITEM type, also referred to as an item, in the catalog.

Structure

Catalog Item

Fields

Name	Type	Tags	Description
name	string	Optional	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. Constraints: Maximum Length: 512
description	string	Optional	The item's description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. Constraints: Maximum Length: 4096
abbreviation	string	Optional	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. Constraints: Maximum Length: 24
label_color	string	Optional	The color of the item's display label in the Square Point of Sale app. This must be a valid hex color code.
available_online	bool	Optional	If true, the item can be added to shipping orders from the merchant's online store.
available_for_pickup	bool	Optional	If true, the item can be added to pickup orders from the merchant's online store.
available_electronically	bool	Optional	If true, the item can be added to electronically fulfilled orders from the merchant's online store.
category_id	string	Optional	The ID of the item's category, if any.
tax_ids	List of string	Optional	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.
modifier_list_info	List of Catalog Item Modifier List Info	Optional	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.
variations	List of Catalog Object	Optional	A list of CatalogItemVariation objects for this item. An item must have at least one variation.
product_type	str (Catalog Item Product Type)	Optional	The type of a CatalogItem. Connect V2 only allows the creation of REGULAR or APPOINTMENTS_SERVICE items.
skip_modifier_screen	bool	Optional	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.
item_options	List of Catalog Item Option for Item	Optional	List of item options IDs for this item. Used to manage and group item variations in a specified order. Maximum: 6 item options.
sort_name	string	Optional	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. It is currently supported for sellers of the Japanese locale only.

Example (as JSON)

{
  "object": {
    "id": "#Cocoa",
    "item_data": {
      "abbreviation": "Ch",
      "description": "Hot chocolate",
      "name": "Cocoa",
      "visibility": "PRIVATE"
    },
    "present_at_all_locations": true,
    "type": "ITEM"
  }
}