Skip to content

Latest commit

 

History

History
25 lines (20 loc) · 3.4 KB

CatalogItem.md

File metadata and controls

25 lines (20 loc) · 3.4 KB
Raw

SquareConnect.CatalogItem

Description

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

Properties

Name Type Description Notes
name String The item's name. Searchable. This field must not be empty. This field has max length of 512 Unicode code points. [optional]
description String The item's description. Searchable. This field has max length of 4096 Unicode code points. [optional]
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. [optional]
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. [optional]
available_online Boolean If `true`, the item can be added to shipping orders from the merchant's online store. [optional]
available_for_pickup Boolean If `true`, the item can be added to pickup orders from the merchant's online store. [optional]
available_electronically Boolean If `true`, the item can be added to electronically fulfilled orders from the merchant's online store. [optional]
category_id String The ID of the item's category, if any. [optional]
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`. [optional]
modifier_list_info [CatalogItemModifierListInfo] 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`. [optional]
variations [CatalogObject] A list of CatalogObjects containing the `CatalogItemVariation`s for this item. [optional]
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. See CatalogItemProductType for possible values [optional]
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 `CatalogModifier`s 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. [optional]
item_options [CatalogItemOptionForItem] List of item options IDs for this item. Used to manage and group item variations in a specified order. Maximum: 6 item options. [optional] [beta]