Struct CatalogModifierList

pub struct CatalogModifierList {
    pub name: Option<String>,
    pub ordinal: Option<i32>,
    pub selection_type: Option<CatalogModifierListSelectionType>,
    pub modifiers: Option<Vec<CatalogObject>>,
    pub image_ids: Option<Vec<String>>,
}

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.

Fields

name: Option<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.

Max Length 255

ordinal: Option<i32>

Determines where this modifier list appears in a list of CatalogModifierList values.

selection_type: Option<CatalogModifierListSelectionType>

Indicates whether multiple options from the modifier list can be applied to a single CatalogItem.

modifiers: Option<Vec<CatalogObject>>

The options included in the CatalogModifierList. You must include at least one CatalogModifier. Each CatalogObject must have type MODIFIER and contain CatalogModifier data.

image_ids: Option<Vec<String>>

The IDs of images associated with this CatalogModifierList instance. Currently these images are not displayed by Square, but are free to be displayed in 3rd party applications.

Trait Implementations

impl Clone for CatalogModifierList

fn clone(&self) -> CatalogModifierList

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CatalogModifierList

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CatalogModifierList

fn default() -> CatalogModifierList

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CatalogModifierList

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CatalogModifierList

fn eq(&self, other: &CatalogModifierList) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CatalogModifierList

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CatalogModifierList

impl StructuralPartialEq for CatalogModifierList