Skip to content

Latest commit

 

History

History
24 lines (20 loc) · 4.06 KB

CatalogItem.md

File metadata and controls

24 lines (20 loc) · 4.06 KB

CatalogItem

Properties

Name Getter Setter Type Description Notes
name getName() setName($value) string The item's name. Searchable. [optional]
description getDescription() setDescription($value) string The item's description. Searchable. [optional]
abbreviation getAbbreviation() setAbbreviation($value) 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. [optional]
label_color getLabelColor() setLabelColor($value) string The color of the item's display label in the Square Point of Sale app. [optional]
available_online getAvailableOnline() setAvailableOnline($value) bool If `true`, the item can be added to shipping orders from the merchant's online store. [optional]
available_for_pickup getAvailableForPickup() setAvailableForPickup($value) bool If `true`, the item can be added to pickup orders from the merchant's online store. [optional]
available_electronically getAvailableElectronically() setAvailableElectronically($value) bool If `true`, the item can be added to electronically fulfilled orders from the merchant's online store. [optional]
category_id getCategoryId() setCategoryId($value) string The ID of the item's category, if any. [optional]
tax_ids getTaxIds() setTaxIds($value) string[] A set of IDs indicating the CatalogTaxes that are enabled for this item. When updating an item, any taxes listed here will be added to the item. CatalogTaxes may also be added to or deleted from an item using `UpdateItemTaxes`. [optional]
modifier_list_info getModifierListInfo() setModifierListInfo($value) \SquareConnect\Model\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. CatalogModifierLists may also be added to or deleted from an item using `UpdateItemModifierLists`. [optional]
image_url getImageUrl() setImageUrl($value) string The URL of an image representing this item. [optional]
variations getVariations() setVariations($value) \SquareConnect\Model\CatalogObject[] A list of CatalogObjects containing the CatalogItemVariations for this item. [optional]
product_type getProductType() setProductType($value) string The product type of the item. May not be changed once an item has been created. Only items of product type `REGULAR` may be created by this API; items with other product types are read-only. See CatalogItemProductType for all possible values. [optional]
skip_modifier_screen getSkipModifierScreen() setSkipModifierScreen($value) bool 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. [optional]

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]