Offer1

Properties

• idstringrequired

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

• typeOfferTyperequired

  A string that identifies a particular kind of offer.

• titlestringrequired

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

• descstringoptional

  Longer description of the offer, if available.

• pointsintegerrequired 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.

• availablebooleanrequired

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

• sectionstringrequired

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

• productProductView2optional

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

• variantProductVariantView2optional

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

• image_urlstringoptional

  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.