Struct CatalogProductSet

pub struct CatalogProductSet {
    pub name: Option<String>,
    pub product_ids_any: Option<Vec<String>>,
    pub product_ids_all: Option<Vec<String>>,
    pub quantity_exact: Option<i64>,
    pub quantity_min: Option<i64>,
    pub quantity_max: Option<i64>,
    pub all_products: Option<bool>,
}

Represents a collection of catalog objects for the purpose of applying a PricingRule.

Including a catalog object will include all of its subtypes. For example, including a category in a product set will include all of its items and associated item variations in the product set. Including an item in a product set will also include its item variations.

Fields

name: Option<String>

User-defined name for the product set. For example, “Clearance Items” or “Winter Sale Items”.

product_ids_any: Option<Vec<String>>

Unique IDs for any CatalogObject included in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply.

This can be used with product_ids_all in a parent CatalogProductSet to match groups of products for a bulk discount, such as a discount for an entree and side combo.

Only one of product_ids_all, product_ids_any, or all_products can be set.

Max: 500 catalog object IDs.

product_ids_all: Option<Vec<String>>

Unique IDs for any CatalogObject included in this product set. All objects in this set must be included in an order for a pricing rule to apply.

Only one of product_ids_all, product_ids_any, or all_products can be set.

Max: 500 catalog object IDs.

quantity_exact: Option<i64>

If set, there must be exactly this many items from products_any or products_all in the cart for the discount to apply.

Cannot be combined with either quantity_min or quantity_max.

quantity_min: Option<i64>

If set, there must be at least this many items from products_any or products_all in a cart for the discount to apply. See quantity_exact. Defaults to 0 if quantity_exact, quantity_min and quantity_max are all unspecified.

quantity_max: Option<i64>

If set, the pricing rule will apply to a maximum of this many items from products_any or products_all.

all_products: Option<bool>

If set to true, the product set will include every item in the catalog. Only one of product_ids_all, product_ids_any, or all_products can be set.

Trait Implementations

impl Clone for CatalogProductSet

fn clone(&self) -> CatalogProductSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CatalogProductSet

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

Formats the value using the given formatter.

impl Default for CatalogProductSet

fn default() -> CatalogProductSet

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CatalogProductSet

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CatalogProductSet

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

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 CatalogProductSet

impl StructuralPartialEq for CatalogProductSet