Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/www/admin1/vendor/square/square/doc/models/ |
Upload File : |
# Catalog Modifier List
A list of modifiers applicable to items at the time of sale.
For example, a "Condiments" modifier list applicable to a "Hot Dog" item
may contain "Ketchup", "Mustard", and "Relish" modifiers.
Use the `selection_type` field to specify whether or not multiple selections from
the modifier list are allowed.
## Structure
`CatalogModifierList`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `name` | `?string` | Optional | The name for the `CatalogModifierList` instance. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.<br>**Constraints**: *Maximum Length*: `255` | getName(): ?string | setName(?string name): void |
| `ordinal` | `?int` | Optional | Determines where this modifier list appears in a list of `CatalogModifierList` values. | getOrdinal(): ?int | setOrdinal(?int ordinal): void |
| `selectionType` | [`?string (CatalogModifierListSelectionType)`](/doc/models/catalog-modifier-list-selection-type.md) | Optional | Indicates whether a CatalogModifierList supports multiple selections. | getSelectionType(): ?string | setSelectionType(?string selectionType): void |
| `modifiers` | [`?(CatalogObject[])`](/doc/models/catalog-object.md) | Optional | The options included in the `CatalogModifierList`.<br>You must include at least one `CatalogModifier`.<br>Each CatalogObject must have type `MODIFIER` and contain<br>`CatalogModifier` data. | getModifiers(): ?array | setModifiers(?array modifiers): void |
## Example (as JSON)
```json
{
"id": "#MilkType",
"modifier_list_data": {
"modifiers": [
{
"modifier_data": {
"name": "Whole Milk",
"price_money": {
"amount": 0,
"currency": "USD"
}
},
"present_at_all_locations": true,
"type": "MODIFIER"
},
{
"modifier_data": {
"name": "Almond Milk",
"price_money": {
"amount": 250,
"currency": "USD"
}
},
"present_at_all_locations": true,
"type": "MODIFIER"
},
{
"modifier_data": {
"name": "Soy Milk",
"price_money": {
"amount": 250,
"currency": "USD"
}
},
"present_at_all_locations": true,
"type": "MODIFIER"
}
],
"name": "Milk Type",
"selection_type": "SINGLE"
},
"present_at_all_locations": true,
"type": "MODIFIER_LIST"
}
```