Skip to content

Latest commit

 

History

History
85 lines (76 loc) · 3.22 KB

list-loyalty-promotions-response.md

File metadata and controls

85 lines (76 loc) · 3.22 KB

List Loyalty Promotions Response

Represents a ListLoyaltyPromotions response. One of loyalty_promotions, an empty object, or errors is present in the response. If additional results are available, the cursor field is also present along with loyalty_promotions.

Structure

ListLoyaltyPromotionsResponse

Fields

Name Type Tags Description
errors Error[] | undefined Optional Any errors that occurred during the request.
loyaltyPromotions LoyaltyPromotion[] | undefined Optional The retrieved loyalty promotions.
cursor string | undefined Optional The cursor to use in your next call to this endpoint to retrieve the next page of results
for your original request. This field is present only if the request succeeded and additional
results are available. For more information, see Pagination.

Example (as JSON)

{
  "loyalty_promotions": [
    {
      "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"
    },
    {
      "available_time": {
        "end_date": "2022-08-01",
        "start_date": "2022-07-01",
        "time_periods": [
          "BEGIN:VEVENT\nDTSTART:20220704T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=MO\nEND:VEVENT",
          "BEGIN:VEVENT\nDTSTART:20220705T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=TU\nEND:VEVENT",
          "BEGIN:VEVENT\nDTSTART:20220706T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=WE\nEND:VEVENT",
          "BEGIN:VEVENT\nDTSTART:20220707T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=TH\nEND:VEVENT",
          "BEGIN:VEVENT\nDTSTART:20220701T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=FR\nEND:VEVENT"
        ]
      },
      "created_at": "2022-06-27T15:37:38Z",
      "id": "loypromo_e696f057-2286-35ff-8108-132241328106",
      "incentive": {
        "points_multiplier_data": {
          "points_multiplier": 2
        },
        "type": "POINTS_MULTIPLIER"
      },
      "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
      "minimum_spend_amount_money": {
        "amount": 2000,
        "currency": "USD"
      },
      "name": "July Special",
      "status": "ENDED",
      "trigger_limit": {
        "interval": "ALL_TIME",
        "times": 5
      },
      "updated_at": "2022-06-27T15:37:38Z"
    }
  ]
}