Loyalty API

AvailableReward1

Describes a reward that can be used by a customer.

Properties

  • typestringrequired

    Identifies a particular kind of reward.

  • descstringrequired

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

  • reward_descstringoptional

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

  • codestringrequired

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

  • sincetimerequired

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

  • ptstimeoptional

    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
  • amountmonetaryoptional

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

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