Struct OrderLineItemModifier

pub struct OrderLineItemModifier {
    pub uid: Option<String>,
    pub catalog_object_id: Option<String>,
    pub catalog_version: Option<i64>,
    pub name: Option<String>,
    pub base_price_money: Option<Money>,
    pub total_price_money: Option<Money>,
    pub metadata: Option<HashMap<String, String>>,
}

A [CatalogModifier].

Fields

uid: Option<String>

A unique ID that identifies the modifier only within this order.

catalog_object_id: Option<String>

The catalog object ID referencing [CatalogModifier].

catalog_version: Option<i64>

The version of the catalog object that this modifier references.

name: Option<String>

The name of the item modifier.

base_price_money: Option<Money>

The base price for the modifier.

base_price_money is required for ad hoc modifiers. If both catalog_object_id and base_price_money are set, base_price_money will override the predefined [CatalogModifier] price.

total_price_money: Option<Money>

Read only The total price of the item modifier for its line item. This is the modifier’s base_price_money multiplied by the line item’s quantity.

metadata: Option<HashMap<String, String>>

Application-defined data attached to this order. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details).

Keys written by applications must be 60 characters or less and must be in the character set [a-zA-Z0-9_-]. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ‘:’ character.

Values have a maximum length of 255 characters.

An application can have up to 10 entries per metadata field.

Entries written by applications are private and can only be read or modified by the same application.

For more information, see Metadata.

Trait Implementations

impl Clone for OrderLineItemModifier

fn clone(&self) -> OrderLineItemModifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderLineItemModifier

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

Formats the value using the given formatter.

impl Default for OrderLineItemModifier

fn default() -> OrderLineItemModifier

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OrderLineItemModifier

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OrderLineItemModifier

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

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 OrderLineItemModifier

impl StructuralPartialEq for OrderLineItemModifier