Struct CatalogModifier

pub struct CatalogModifier {
    pub name: Option<String>,
    pub price_money: Option<Money>,
    pub ordinal: Option<i32>,
    pub modifier_list_id: Option<String>,
    pub image_ids: Option<Vec<String>>,
    pub on_by_default: Option<bool>,
}

A modifier applicable to items at the time of sale.

Fields

name: Option<String>

The modifier name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.

Max Length 255

price_money: Option<Money>

The modifier price.

ordinal: Option<i32>

Determines where this CatalogModifier appears in the CatalogModifierList.

modifier_list_id: Option<String>

The ID of the CatalogModifierList associated with this modifier.

image_ids: Option<Vec<String>>

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

on_by_default: Option<bool>

If true, this CatalogModifier should be selected by default for this CatalogItem.

Trait Implementations

impl Clone for CatalogModifier

fn clone(&self) -> CatalogModifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CatalogModifier

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

Formats the value using the given formatter.

impl Default for CatalogModifier

fn default() -> CatalogModifier

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CatalogModifier

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CatalogModifier

fn eq(&self, other: &CatalogModifier) -> 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 CatalogModifier

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 CatalogModifier

impl StructuralPartialEq for CatalogModifier