Popeyes

List Popeyes Rewards' bonus-points promotion catalog

Returns a page of Popeyes Rewards' bonus-points promotion catalog -- flat or multiplied points bonuses tied to a qualifying purchase (e.g. "Get Double Bonus Points on Your Cart, minimum $20"), distinct from /popeyes/offers (priced menu deals) and /popeyes/quests (multi-step challenges). This is public CMS content, not a signed-in member's own applied-promotions state. points_multiplier and bonus_points are mutually exclusive in practice -- a promotion is either an "Nx points" campaign or a flat bonus. start_date/end_date bound the promotion's published active window when Popeyes sets one; both empty means no published window restriction, not that the promotion is permanently active.

get/popeyes/promotions

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/popeyes/promotions
  • Auth: API key in header x-api-key

Query parameters

limitinteger

Maximum promotions to return, 1-100 (default 20)

offsetinteger

Number of promotions to skip, for paging (default 0)

marketstring

Restaurant market: US (default) or CA

Headers

x-api-keystring required

API key required

Response

OK

codeinteger

Code is the HTTP status code or a custom code used to indicate the result of the request @example 200

msgunknown

Example response

{
  "data": {
    "count": 20,
    "has_more": true,
    "promotions": [
      {
        "bonus_points": 300,
        "end_date": "2021-08-16T04:00:00.000Z",
        "id": "11d41e3c-75b5-458c-8166-7cdfb20a635a",
        "message": "Get Double Bonus Points on Your Cart, minimum $20",
        "name": "Get Double Bonus Points on Your Cart, minimum $20",
        "points_multiplier": 2,
        "start_date": "2021-08-02T04:00:00.000Z"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.