CatalogModifierList
February 26, 2020 ยท View on GitHub
Description
A modifier list in the Catalog object model. A CatalogModifierList contains CatalogModifier objects 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 | Getter | Setter | Type | Description | Notes |
|---|---|---|---|---|---|
| name | getName() | setName($value) | string | A searchable name for the `CatalogModifierList`. This field has max length of 255 Unicode code points. | [optional] |
| ordinal | getOrdinal() | setOrdinal($value) | int | Determines where this `CatalogModifierList` appears in a list of `CatalogModifierList` values. | [optional] |
| selection_type | getSelectionType() | setSelectionType($value) | string | Indicates whether multiple options from the `CatalogModifierList` can be applied to a single `CatalogItem`. See CatalogModifierListSelectionType for possible values | [optional] |
| modifiers | getModifiers() | setModifiers($value) | \SquareConnect\Model\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] |
Note: All properties are protected and only accessed via getters and setters.