Deem Offers API Documentation

Regional Deals

List all region’s deals

Returns an array of deal representations, ordered by start_at time (earliest first).

If you are using the “city, state” syntax, abbreviations are not accepted. “St Louis” must be spelled as “Saint Louis”.

Important Note: There are default filters “in_flight”, “current”, “not_bg” for backwards compatibility. Most partners will want to override the filter value with “in_flight”.

GET /regions/:region_id/deals
GET /regions/:zip/deals
GET /regions/:city,:state/deals

Parameters

user_id (optional)
String A user id that will be used to filter deals (e.g. based on user preferences).
filter (optional)
String Filter the list according to applicable filters (comma-separated). These include: “in_flight”, “offer”, “current”, “not_bg”.
count (optional)
Boolean Returns the count instead of the list. If present, per_page and page will be ignored.
per_page (optional)
Integer Limits the size of the list. Default is 100. Max is 1000.
page (optional)
Integer Returns the list corresponding to the page number if the result cannot be displayed in a single page. Default is 1.

Response

Status: 200 OK
{
  "status": "success",
  "deals": [
    {
      "id": "la-1024-wsc-hair-studio-01-2",
      "campaign": null,
      "category": "Activities",
      "category_id": "activities",
      "cost": 7000,
      "description1": "Complete cocktail and bartending how-to's. With National Bartenders School, you'll have your choice of six locations across Southern California to choose from. Each location recreates an actual bar, with all the equipment and tools you'll be using on the job. Over the course of 40 hours, you'll get to know your Tom Collins from your Shirley Temples. This deal includes all the books, registration fees and certification required to get you behind an actual bar. And with their job placement assistance, you'll be doing your best Sam Malone impression quicker than it takes to mix a Mai Tai.",
      "description2": "Do you prefer go to bed when the roosters are crowing as opposed to waking up with them? Night owls have a reason to give a hoot with today's deal: $199 for a two-week bartending course at National Bartenders School (a $495 value).",
      "end_at": "2013-10-25T06:59:59Z",
      "expires_at": "2013-12-17T23:59:59-08:00",
      "expiration_days": null,
      "fine_print": "Must be 18 or older with valid ID - Limit 1 voucher per person - By appointment/reservation only - Valid only at participating locations - Classes subject to availability - Valid at West Los Angeles, Hollywood, Orange County, Long Beach, Canyon Country and Riverside locations only - Call the location of the school you wish to take the course at to schedule your appointment for orientation",
      "fine_print_legalese": "Redeemable vouchers have two values: (1) Amount Paid; and (2) Promotional Value. The Amount Paid means the amount paid by you to purchase the voucher. Amount Paid does not expire unless the voucher is redeemed or refunded. The Promotional Value means the additional value beyond the Amount Paid. The Amount Paid for this Voucher is $39.00. This amount does not expire. The Promotional Value of this Voucher is $61.00. Promotional Value will expire on 12/17/2013 unless prohibited by law.",
      "fixed_fee": null,
      "fulfillment_method": "printed",
      "highlights": "Complete cocktail how-to's Choice of six locations 40 hours of instruction",
      "images": {
        "tiny": "https://d2x9dz1etb1m98.cloudfront.net/ugassets/deal/images/b/5/ff54ac03/tiny.jpg",
        "small": "https://d2x9dz1etb1m98.cloudfront.net/ugassets/deal/images/b/5/ff54ac03/tiny.jpg",
        "medium": "https://d2x9dz1etb1m98.cloudfront.net/ugassets/deal/images/b/5/ff54ac03/medium.jpg",
        "large": "https://d2x9dz1etb1m98.cloudfront.net/ugassets/deal/images/b/5/ff54ac03/large.jpg"
      },
      "incentive_amount": null,
      "incentive_percentage": null,
      "instructions": "The Amount Paid for this Voucher is $39. This amount does not expire. The Promotional Value of this Voucher is $61. This amount will expire on the referenced expiration date. This Voucher is redeemable starting 2012-11-12. This Voucher is transferable. This voucher has two values: (1) Amount Paid; and (2) Promotional Value. The Amount Paid means the amount paid by you to purchase the voucher. Amount Paid does not expire unless the voucher is redeemed or refunded. The Promotional Value means the additional value beyond the Amount Paid. Promotional Value will expire on the expiration dates unless prohibited by law.",
      "locations": [
        {
          "address": {
            "address_id": "8a23af0847",
            "region": "CA",
            "postal_code": "90057",
            "street": "671 la fayette park place",
            "latitude": 34.060428619,
            "locality": "los angeles",
            "longitude": -118.283882141,
            "country": "US"
          },
          "hours": "",
          "phone": "8887187201"
        }
      ],
      "max_linkage": null,
      "max_per_user": 11,
      "max_gift_per_user": 0,
      "maximum_allowance": null,
      "merchant_id": "a5b03069dd",
      "merchant_name": "1024 WSC Hair Studio 01",
      "min_spend": null,
      "num_left": 499,
      "num_qualifying": null,
      "number_sold": 0,
      "percent_fee": null,
      "purchase_url": "https://homerun-f2.offerify.com/deal/la-1024-wsc-hair-studio-01-2/checkout",
      "region_id": "los-angeles",
      "region_name": "Los Angeles",
      "robotitle": "$39 for $100 of 1024 WSC Salon - Other at 1024 WSC Hair Studio 01",
      "shipping_address_required": false,
      "show_url": "http://homerun-f2.offerify.com/deal/la-1024-wsc-hair-studio-01-2",
      "soldout": false,
      "start_at": "2013-10-17T07:00:00Z",
      "starting_price": 3900,
      "state": "in-flight",
      "subcategory": "Bike Rentals",
      "supplier_id": "homerun",
      "tags": [
        "Limited-time-only"
      ],
      "title": "1024 WSC Salon - Other - $39 for $100",
      "type": "daily-deal",
      "value": 10000
    }
  ]
}