Skip to content

Latest commit

 

History

History
51 lines (42 loc) · 8.14 KB

catalog-item.md

File metadata and controls

51 lines (42 loc) · 8.14 KB
Raw

Catalog Item

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

Structure

CatalogItem

Fields

Name Type Tags Description Getter
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		 String getName()
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.

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 and 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 description_html.
Constraints: Maximum Length: 4096		 String getDescription()
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		 String getAbbreviation()
LabelColor 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. String getLabelColor()
IsTaxable Boolean Optional Indicates whether the item is taxable (true) or non-taxable (false). Default is true. Boolean getIsTaxable()
AvailableOnline Boolean Optional If true, the item can be added to shipping orders from the merchant's online store. Boolean getAvailableOnline()
AvailableForPickup Boolean Optional If true, the item can be added to pickup orders from the merchant's online store. Boolean getAvailableForPickup()
AvailableElectronically Boolean Optional If true, the item can be added to electronically fulfilled orders from the merchant's online store. Boolean getAvailableElectronically()
CategoryId String Optional The ID of the item's category, if any. Deprecated since 2023-12-13. Use CatalogItem.categories, instead. String getCategoryId()
TaxIds List<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.		 List getTaxIds()
ModifierListInfo List<CatalogItemModifierListInfo> 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.		 List getModifierListInfo()
Variations List<CatalogObject> Optional A list of CatalogItemVariation objects for this item. An item must have
at least one variation.		 List getVariations()
ProductType String Optional The type of a CatalogItem. Connect V2 only allows the creation of REGULAR or APPOINTMENTS_SERVICE items. String getProductType()
SkipModifierScreen Boolean 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.		 Boolean getSkipModifierScreen()
ItemOptions List<CatalogItemOptionForItem> Optional List of item options IDs for this item. Used to manage and group item
variations in a specified order.

Maximum: 6 item options.		 List getItemOptions()
ImageIds List<String> Optional The IDs of images associated with this CatalogItem instance.
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.		 List getImageIds()
SortName 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.
Its value must not be empty.

It is currently supported for sellers of the Japanese locale only.		 String getSortName()
Categories List<CatalogObjectCategory> Optional The list of categories. List getCategories()
DescriptionHtml String Optional 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.
- b, strong: Bold text
- br: Line break
- code: Computer code
- div: Section
- h1-h6: Headings
- i, em: Italics
- li: List element
- ol: Numbered list
- p: Paragraph
- ul: Bullet list
- u: Underline

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
Constraints: Maximum Length: 65535		 String getDescriptionHtml()
DescriptionPlaintext String Optional A server-generated plaintext version of the description_html field, without formatting tags.
Constraints: Maximum Length: 65535		 String getDescriptionPlaintext()
Channels List<String> Optional A list of IDs representing channels, such as a Square Online site, where the item can be made visible or available. List getChannels()
IsArchived Boolean Optional Indicates whether this item is archived (true) or not (false). Boolean getIsArchived()
EcomSeoData CatalogEcomSeoData Optional SEO data for for a seller's Square Online store. CatalogEcomSeoData getEcomSeoData()
FoodAndBeverageDetails CatalogItemFoodAndBeverageDetails Optional The food and beverage-specific details of a FOOD_AND_BEV item. CatalogItemFoodAndBeverageDetails getFoodAndBeverageDetails()
ReportingCategory CatalogObjectCategory Optional A category that can be assigned to an item or a parent category that can be assigned
to another category. For example, a clothing category can be assigned to a t-shirt item or
be made as the parent category to the pants category.		 CatalogObjectCategory getReportingCategory()

Example (as JSON)

{
  "name": "name6",
  "description": "description6",
  "abbreviation": "abbreviation8",
  "label_color": "label_color8",
  "is_taxable": false
}