Grubhub

Get one Grubhub restaurant's currently active promotions

Returns the promotional offers a Grubhub restaurant is currently running -- free items, BOGO deals, spend-and-save discounts -- the same data that drives the "2 offers available" badge on the site's own restaurant cards. An empty list is the common, legitimate case: most restaurants have no active promotion at any given moment. amount.value is 0 for a free-item offer since the item itself is the value, not a monetary discount; amount.amount_maximum then caps the item's dollar value, and amount.order_minimum is the spend threshold required to unlock it.

get/grubhub/offers

Request

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

Query parameters

restaurant_idstring required

Grubhub restaurant id

latitudenumber required

Diner location latitude

longitudenumber required

Diner location longitude

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": 1,
    "offers": [
      {
        "amount": {
          "amount_maximum": 10,
          "currency": "USD",
          "order_minimum": 20,
          "type": "MENU_ITEM"
        },
        "entitlement_type": "UNIFIED_REWARD",
        "offer_type": "ENTERPRISE_REWARD",
        "pill_text": "$10 off",
        "redeem_item_count": 1,
        "title": "Free Double Cheeseburger"
      }
    ],
    "restaurant_id": "1338141"
  }
}

Changes

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