v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

Loyalty

ListLoyaltyPromotions

Lists the loyalty promotions associated with a loyalty program. Results are sorted by the created_at date in descending order (newest to oldest).

get/v2/loyalty/programs/{program_id}/promotions

Path parameters

program_idstring required

The ID of the base loyalty program. To get the program ID, call RetrieveLoyaltyProgram using the main keyword.

Query parameters

status'ACTIVE' | 'ENDED' | 'CANCELED' | 'SCHEDULED'

Indicates the status of a loyalty promotion.

The status to filter the results by. If a status is provided, only loyalty promotions with the specified status are returned. Otherwise, all loyalty promotions associated with the loyalty program are returned.

cursorstring

The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see Pagination.

limitinteger

The maximum number of results to return in a single paged response. The minimum value is 1 and the maximum value is 30. The default value is 30. For more information, see Pagination.

Response

Success

cursorstring

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 response

{
  "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": {
          "multiplier": "3.000",
          "points_multiplier": 3
        },
        "type": "POINTS_MULTIPLIER"
      },
      "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
      "name": "Tuesday Happy Hour Promo",
      "qualifying_item_variation_ids": [
        "CJ3RYL56ITAKMD4VRCM7XERS",
        "AT3RYLR3TUA9C34VRCB7X5RR"
      ],
      "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": {
          "multiplier": "2.000",
          "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",
      "qualifying_category_ids": [
        "XTQPYLR3IIU9C44VRCB3XD12"
      ],
      "status": "ENDED",
      "trigger_limit": {
        "interval": "ALL_TIME",
        "times": 5
      },
      "updated_at": "2022-06-27T15:37:38Z"
    }
  ]
}