Object Index / Definition

You are viewing an old version of the API
Catalog​Pricing​Rule

Beta

Defines how prices are modified or set for items that match the pricing rule during the active time period

Properties

Name Description
discount_id
string

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

exclude_products_id
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.

exclude_strategy
string

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

Default value: LEAST_EXPENSIVE

match_products_id
string

Unique ID for the CatalogProductSet that will be matched by this rule. A match rule matches within the entire cart. A match rule can match multiple times in the cart. If no ProductSet is present, the rule will match all products.

name
string

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

time_period_ids
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.

valid_from_date
string

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

valid_from_local_time
string

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

valid_until_date
string

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

valid_until_local_time
string

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

apply_products_id
string

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.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?