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

Latest commit

 

History

History
15 lines (10 loc) · 1.35 KB

CatalogModifierList.md

File metadata and controls

15 lines (10 loc) · 1.35 KB

SquareConnect.CatalogModifierList

Description

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.

Properties

Name Type Description Notes
name String 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. [optional]
ordinal Number Determines where this modifier list appears in a list of `CatalogModifierList` values. [optional]
selection_type String Indicates whether multiple options from the modifier list can be applied to a single `CatalogItem`. See CatalogModifierListSelectionType for possible values [optional]
modifiers [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]