Struct square_api_client::models::CatalogPricingRule

pub struct CatalogPricingRule {

    pub name: Option<String>,
    pub time_period_ids: Option<Vec<String>>,
    pub discount_id: Option<String>,
    pub match_products_id: Option<String>,
    pub apply_products_id: Option<String>,
    pub exclude_products_id: Option<String>,
    pub valid_from_date: Option<String>,
    pub valid_from_local_time: Option<String>,
    pub valid_until_date: Option<String>,
    pub valid_until_local_time: Option<String>,
    pub exclude_strategy: Option<ExcludeStrategy>,
    pub minimum_order_subtotal_money: Option<Money>,
    pub customer_group_ids_any: Option<Vec<String>>,
}

Defines how discounts are automatically applied to a set of items that match the pricing rule during the active time period.

Fields

name: Option<String>

User-defined name for the pricing rule. For example, “Buy one get one free” or “10% off”.

time_period_ids: Option<Vec<String>>

A list of unique IDs for the catalog time periods when this pricing rule is in effect. If left unset, the pricing rule is always in effect.

discount_id: Option<String>

Unique ID for the CatalogDiscount to take off the price of all matched items.

match_products_id: Option<String>

Unique ID for the CatalogProductSet that will be matched by this rule. A match rule matches within the entire cart, and can match multiple times. This field will always be set.

apply_products_id: Option<String>

👎Deprecated

Deprecated: Please use the exclude_products_id field to apply an exclude set instead. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount.

CatalogProductSet to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules.

exclude_products_id: Option<String>

CatalogProductSet to exclude from the pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules.

valid_from_date: Option<String>

Represents the date the Pricing Rule is valid from. Represented in RFC 3339 full-date format (YYYY-MM-DD).

valid_from_local_time: Option<String>

Represents the local time the pricing rule should be valid from. Represented in RFC 3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.

valid_until_date: Option<String>

Represents the date the Pricing Rule is valid until. Represented in RFC 3339 full-date format (YYYY-MM-DD).

valid_until_local_time: Option<String>

Represents the local time the pricing rule should be valid until. Represented in RFC 3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.

exclude_strategy: Option<ExcludeStrategy>

If an exclude_products_id was given, controls which subset of matched products is excluded from any discounts.

Default value: LEAST_EXPENSIVE

minimum_order_subtotal_money: Option<Money>

The minimum order subtotal (before discounts or taxes are applied) that must be met before this rule may be applied.

customer_group_ids_any: Option<Vec<String>>

A list of IDs of customer groups, the members of which are eligible for discounts specified in this pricing rule. Notice that a group ID is generated by the Customers API. If this field is not set, the specified discount applies to matched products sold to anyone whether the buyer has a customer profile created or not. If this customer_group_ids_any field is set, the specified discount applies only to matched products sold to customers belonging to the specified customer groups.

Trait Implementations

impl Clone for CatalogPricingRule

fn clone(&self) -> CatalogPricingRule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CatalogPricingRule

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

Formats the value using the given formatter.

impl Default for CatalogPricingRule

fn default() -> CatalogPricingRule

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CatalogPricingRule

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<CatalogPricingRule> for CatalogPricingRule

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CatalogPricingRule

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 CatalogPricingRule

impl StructuralEq for CatalogPricingRule

impl StructuralPartialEq for CatalogPricingRule