Skip to content
This repository has been archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
17 lines (11 loc) · 1.68 KB

CatalogModifierList.md

File metadata and controls

17 lines (11 loc) · 1.68 KB

CatalogModifierList

squareconnect.models.catalog_modifier_list

Description

A modifier list in the Catalog object model. A CatalogModifierList contains Modifiers that can be applied to a CatalogItem at the time of sale. For example, a modifier list "Condiments" that would apply to a "Hot Dog" CatalogItem might contain CatalogModifiers "Ketchup", "Mustard", and "Relish". The selection_type field specifies whether or not multiple selections from the modifier list are allowed.

Properties

Name Type Description Notes
name str The CatalogModifierList's name. Searchable. This field has max length of 255 Unicode code points. [optional]
selection_type str Indicates whether multiple options from the CatalogModifierList can be applied to a single CatalogItem. See CatalogModifierListSelectionType for possible values [optional]
modifiers list[CatalogObject] The options included in the CatalogModifierList. You must include at least one CatalogModifier. Each CatalogObject must have type `MODIFIER` and contain CatalogModifier data. [optional]

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