Object Index
You are viewing an old version of the API
CatalogPricingRule
Object Index
Defines how discounts are automatically applied to a set of items that match the pricing rule during the active time period.
Properties
Name | Description |
---|---|
name
|
User-defined name for the pricing rule. For example, "Buy one get one free" or "10% off". |
time_
|
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_
|
Unique ID for the |
match_
|
Unique ID for the |
apply_
Deprecated
|
Deprecated: Please use the
|
exclude_
|
|
valid_
|
Represents the date the Pricing Rule is valid from. Represented in RFC 3339 full-date format (YYYY-MM-DD). |
valid_
|
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_
|
Represents the date the Pricing Rule is valid until. Represented in RFC 3339 full-date format (YYYY-MM-DD). |
valid_
|
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_
|
If an Default value: |
minimum_
|
The minimum order subtotal (before discounts or taxes are applied) that must be met before this rule may be applied. |
customer_
|
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 |