KFC

Look up one KFC promotion by its redemption code or serialized code

Returns one promotion by its redemption code (the code a customer types in at checkout) or its serialized code (a unique per-print QR/serial code, e.g. from a printed coupon, that resolves to a shared redemption code and its promotion). Exactly one of code or serialized_code is required. A serialized-code lookup additionally returns that code's own usage metadata (redemption_code, times_used, code_status, group_status, effective_date, expiration_date) alongside the promotion. An unknown or expired code returns a 404 rather than a null success payload.

get/kfc/promotion

Request

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

Query parameters

codestring

The redemption code as a customer would type it in at checkout. Use a value returned by kfc-promotions when available. Exactly one of code or serialized_code is required

serialized_codestring

A unique per-print serialized/QR code that resolves to a shared redemption code. Exactly one of code or serialized_code is required

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": {
    "automatic": true,
    "display_name": "50% off Chicken Sandwich",
    "name": "Digital-Q324 - 50% off Chicken Sandwich",
    "promotion_id": "6815f409-5b1e-44dc-9f99-26b1c1a2699a",
    "redemption_code": "WELCOME10",
    "redemption_codes": [
      "WALMART5DOLLARSOFF"
    ]
  }
}

Changes

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