Loyalty API

Type

AvailableReward1

Describes a reward that can be used by a customer.

Kind Type
Used in CustomerBalance3, ListCustomers3, LoggedOutBalance1

Properties

  • type string required

    Identifies a particular kind of reward.

    coupon_reward marks a granted gift coupon, such as a birthday or anniversary gift. It has no pts or change_bhid.

  • desc string required

    Describes the source of the reward, suitable to be a list item title.

  • reward_desc string optional

    Describes a particular benefit the user will get when they use the code, suitable to be a list item subtitle.

  • code string required

    Online shop (e.g. Shopify) coupon code or gift card code.

    Empty for rewards redeemed for in-store use (see channel), and for coupon_reward entries created without a coupon code.

  • since time required

    A time when the reward became available, in case you want to display this or sort by this field.

  • pts integer optional

    The number of points spent for this reward, if applicable.

    If the reward has been obtained without spending points, this field will be null or missing

  • amount monetary optional

    A fixed amount benefit the coupon code gives, if applicable.

    Only present for point redemptions, and for vendible redemptions in certain configurations.

  • status string optional

    Redemption status of the reward, e.g. pending.

  • change_bhid string optional

    Bubblehouse ID of the redemption change behind this reward.

    Needed to cancel a pending redemption through Unredeem1.

  • channel string optional

    Redemption channel chosen by the customer.

    Set to retail for rewards redeemed for in-store use; absent otherwise.

Previous
Availability1