Offer1

Represents an offer that a customer can redeem. An offer is a reward obtainable for points.

Kind	Type
Used in	CustomerBalance3, ListOffers1, LoggedOutBalance1

Properties

• id string required

  Unique ID of the offer in the Bubblehouse system, used with RedeemOffer1 endpoint.

• type OfferType required

  A string that identifies a particular kind of offer.

• title string required

  A title of the offer, suitable to be a list item title.

• desc string optional

  Longer description of the offer, if available.

• points integer required unless zero

  Number of points required to redeem the offer. If an offer does not require points to redeem (e.g. is already redeemed and can be used right away), this field will be 0 or omitted.

• available boolean required

  Whether the offer is available for use (via RedeemOffer1).

• section string required

  Section of the loyalty page that the object is normally displayed in.

• product ProductPublic2 optional

  If the offer is about a single specific product, describes the product.

• variant ProductVariantPublic2 optional

  If the offer is about a single specific product variant, describes the variant.

• image_url string optional

  URL of the offer's image, if available.

  For vendibles, this will be the URL of the vendible's image. The URL is absolute and can be used directly in image tags.

  If the vendible has no image configured, this field will be empty or omitted.

• visibility string optional

  Visibility condition expression configured for the offer.

  A Bubblehouse rules expression string that determines whether the offer should be displayed to the customer. Empty or omitted when no condition is configured.

• availability string optional

  Availability condition expression configured for the offer.

  A Bubblehouse rules expression string that determines whether the offer can be redeemed by the customer. Empty or omitted when no condition is configured.