Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 3.29 KB

loyalty-program-reward-definition.md

File metadata and controls

33 lines (24 loc) · 3.29 KB

Loyalty Program Reward Definition

Provides details about the reward tier discount. DEPRECATED at version 2020-12-16. Discount details are now defined using a catalog pricing rule and other catalog objects. For more information, see Getting discount details for a reward tier.

Structure

LoyaltyProgramRewardDefinition

Fields

Name Type Tags Description
scope string Required Indicates the scope of the reward tier. DEPRECATED at version 2020-12-16. Discount details
are now defined using a catalog pricing rule and other catalog objects. For more information, see
Getting discount details for a reward tier.
discountType string Required The type of discount the reward tier offers. DEPRECATED at version 2020-12-16. Discount details
are now defined using a catalog pricing rule and other catalog objects. For more information, see
Getting discount details for a reward tier.
percentageDiscount string | undefined Optional The fixed percentage of the discount. Present if discount_type is FIXED_PERCENTAGE.
For example, a 7.25% off discount will be represented as "7.25". DEPRECATED at version 2020-12-16. You can find this
information in the discount_data.percentage field of the DISCOUNT catalog object referenced by the pricing rule.
catalogObjectIds string[] | undefined Optional The list of catalog objects to which this reward can be applied. They are either all item-variation ids or category ids, depending on the type field.
DEPRECATED at version 2020-12-16. You can find this information in the product_set_data.product_ids_any field
of the PRODUCT_SET catalog object referenced by the pricing rule.
fixedDiscountMoney Money | undefined Optional Represents an amount of money. Money fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
Working with Monetary Amounts
for more information.
maxDiscountMoney Money | undefined Optional Represents an amount of money. Money fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
Working with Monetary Amounts
for more information.

Example (as JSON)

{
  "scope": "CATEGORY",
  "discount_type": "FIXED_AMOUNT",
  "fixed_discount_money": null,
  "max_discount_money": null
}