retrieve-loyalty-promotion-response.md

Retrieve Loyalty Promotion Response

Represents a RetrieveLoyaltyPromotionPromotions response.

Structure

RetrieveLoyaltyPromotionResponse

Fields

Name	Type	Tags	Description
errors	Error[] | undefined	Optional	Any errors that occurred during the request.
loyaltyPromotion	LoyaltyPromotion | undefined	Optional	Represents a promotion for a loyalty program. Loyalty promotions enable buyers to earn extra points on top of those earned from the base program. A loyalty program can have a maximum of 10 loyalty promotions with an ACTIVE or SCHEDULED status.

Example (as JSON)

{
  "loyalty_promotion": {
    "available_time": {
      "start_date": "2022-08-16",
      "time_periods": [
        "BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT"
      ]
    },
    "created_at": "2022-08-16T08:38:54Z",
    "id": "loypromo_f0f9b849-725e-378d-b810-511237e07b67",
    "incentive": {
      "points_multiplier_data": {
        "points_multiplier": 3
      },
      "type": "POINTS_MULTIPLIER"
    },
    "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
    "name": "Tuesday Happy Hour Promo",
    "status": "ACTIVE",
    "trigger_limit": {
      "interval": "DAY",
      "times": 1
    },
    "updated_at": "2022-08-16T08:38:54Z"
  }
}