DiscountSourceLoyalty

Discount applied when redeeming a reward from the merchant's loyalty scheme.

Fields

  • idstringrequired
    format: uuid

    The unique identifier of the promotion or reward.

    Example: "075b0b5c-a1f4-46da-9aca-92fb6dd5905d"

  • loyalty_typestringrequired
    Options:"PROMOTION""REWARD"

    The type of loyalty discount, either a promotion (e.g. new customer discount) or a reward (free coffee after completing stamp card).

    Example: "REWARD"

  • scheme_typestringrequired
    Options:"STAMPS""POINTS"

    The scheme type of the loyalty program.

    Example: "POINTS"

  • namestringrequired
    maxLength: 100

    The name of the loyalty discount.

    Example: "Free coffee"

  • application_modestringrequired
    Options:"MANUAL""AUTOMATIC"

    Method of applying the discount to the items or cart.

    Example: "MANUAL"

  • pointsintegernullable
    format: int64minimum: 1

    The number of points used for this loyalty discount. Must be a positive integer if the scheme type is POINTS. Must not be populated if the scheme type is STAMPS.

    Example: 50

  • descriptionstringnullable
    maxLength: 250

    The description of the loyalty discount.

    Example: "Free coffee for 50 points"

  • discount_classstringnullable
    Options:"ITEM""CATEGORY""BUNDLE""BUY_X_GET_Y""MEAL_DEAL"

    The method used to target items to discount. Must be populated for ITEM level discounts, and must be null for CART level discounts (CART level targets all items, therefore none of these categories apply).

    Example: "ITEM"

Type to search…