whoami7 - Manager
:
/
home
/
qbizpnmr
/
arif.umairtax.com
/
vendor
/
square
/
square
/
doc
/
models
/
Upload File:
files >> /home/qbizpnmr/arif.umairtax.com/vendor/square/square/doc/models/catalog-modifier-list.md
# 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 | | `imageIds` | `?(string[])` | Optional | The IDs of images associated with this `CatalogModifierList` instance.<br>Currently these images are not displayed by Square, but are free to be displayed in 3rd party applications. | getImageIds(): ?array | setImageIds(?array imageIds): void | ## Example (as JSON) ```json { "id": "#MilkType", "modifier_list_data": { "allow_quantities": false, "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", "name": "name0", "ordinal": 80, "selection_type": "SINGLE", "modifiers": [ { "type": "DISCOUNT", "id": "id1", "updated_at": "updated_at7", "version": 145, "is_deleted": true, "custom_attribute_values": { "key0": { "name": "name2", "string_value": "string_value6", "custom_attribute_definition_id": "custom_attribute_definition_id0", "type": "NUMBER", "number_value": "number_value2" } }, "catalog_v1_ids": [ { "catalog_v1_id": "catalog_v1_id5", "location_id": "location_id5" }, { "catalog_v1_id": "catalog_v1_id6", "location_id": "location_id6" } ] }, { "type": "TAX", "id": "id2", "updated_at": "updated_at8", "version": 146, "is_deleted": false, "custom_attribute_values": { "key0": { "name": "name3", "string_value": "string_value7", "custom_attribute_definition_id": "custom_attribute_definition_id9", "type": "BOOLEAN", "number_value": "number_value3" }, "key1": { "name": "name2", "string_value": "string_value6", "custom_attribute_definition_id": "custom_attribute_definition_id0", "type": "NUMBER", "number_value": "number_value2" }, "key2": { "name": "name1", "string_value": "string_value5", "custom_attribute_definition_id": "custom_attribute_definition_id1", "type": "SELECTION", "number_value": "number_value1" } }, "catalog_v1_ids": [ { "catalog_v1_id": "catalog_v1_id6", "location_id": "location_id6" }, { "catalog_v1_id": "catalog_v1_id7", "location_id": "location_id7" }, { "catalog_v1_id": "catalog_v1_id8", "location_id": "location_id8" } ] } ], "image_ids": [ "image_ids5", "image_ids6", "image_ids7" ] } ```
Copyright ©2021 || Defacer Indonesia