Retrieving Featured Deal
URL:
http://cachedailydeals.com/newyork/deals.json
Supported Formats:
JSON / XML
Description:
Returns a list of deals. The API returns an ordered list of deals currently running for a given Division. Priority is based on position within the response (top deals are higher in priority).
Deal Response
id
Description: A unique identifier for a specific deal. Allowable characters include [a-z][0-9][-], and will contain no whitespace.
Example: my-great-restaurant-deal
deal_url
Description: A URL for the deal as it can be accessed on the main CacheDailyDeals.com site. This would be the same URL a user would enter to access the deal in a web browser.
Example: http://cachedailydeals.com/deal/green-door-tavern
title
Description: A one-line summary of the deal.
Example: $10 for $25 Worth of Food and Drink at Green Door Tavern
small_image_url
medium_image_url
large_image_url
Description: Fixed size URLs for the main image associated with the deal
Example: http://cachedailydeals.com/img/medium_big_thumb/Deal/0.a5522c7c3f8b1a86fbd764dcad1cf216.jpg
division_id
Description: A unique identifier for the division that the deal is located in. Allowable characters include [a-z][0-9][-], and will contain no whitespace. The identifier for a division may or may not be geographic in nature.
Example: minneapolis-stpaul
division_name
Description: The human-readable form of the division id.
Example: Minneapolis / St Paul
division_lat
division_lng
Description: Geographic coordinates. These coordinates will only appear in cases where the division is geographic in nature. CacheDailyDeals.com reserves the right to define divisions which span multiple geographic regions, and in this case, geographic coordinate smay not present.
Example: 41.88941 , -87.624039
vendor_id
Description: A unique identifier for the vendor providing this deal. Allowable characters include [a-z][0-9][-], and will contain no whitespace.
Example: green-door-tavern
vendor_name
Description: A human-readable form of the vendor id.
Example: Green Door Tavern
vendor_website_url
Description: The external URL for the vendor, if available. This URL will not point back to any content on CacheDailyDeals.com.com.
Example: http://www.greendoorchicago.com
status
Description: The status of the deal. A deal will either be 'open', or 'closed' depending on whether it is currently active and allowing purchases, or no longer available for purchase.
Example: open
start_date
Description: The date and time at which the deal became available (status: open), represented in UTC.
Example: Jun 16, 2010 10:38 AM
end_date
Description: For closed deals, the date and time at which the deal no longer became available. For deals that are currently open, this represents the closing date and time of the deal.
Example: Jun 19, 2010 10:38 AM
tipped
Description: A boolean value (true, false) that indicates whether this deal has tipped. A deal is considered 'tipped' when it reaches a tipping point, whereby a minimum number of members join.
Example: true / false
tipping_point
Description: The minimum number (zero or more) of purchases that must be met by all participants in the deal in order for the deal to tip.
Example: 100
tipped_date
Description: For any deals that have tipped, the date and time at which the deal tipped. For deals that did not tip, this field will not be present.
Example: Aug 16, 2010 10:38 AM
sold_out
Description: A boolean value indicating whether the deal had specified a limited quantity available, and that quantity sold out. This provides an easy way for clients to visually indicate that the deal ended early due to a limited quantity being depleted. If the deal does not have limits applied, or has not yet sold out, this value will be false.
Example: true / false
quantity_sold
Description: The number of units sold so far. For deals that have closed, this number represents the total number of units sold.
Example: 174
price
Description: The discounted cost of each unit to the customer.
Example: 40.00USD
value
Description: The actual value of the CacheDailyDeals.com. This is effectively the full value of the CacheDailyDeals.com when it is redeemed.
Example: 80.00USD
discount_amount
Description:
Example:
discount_percent
Description: The discounted percent (0-100). This is effectively the same as (price / value * 100).
Example: 60
shipping_address_required
Description: CacheDailyDeals.com which would require a user to enter a shipping address. This denotes a deal whose purchase will require the user to supply such an address in order to redeem.
Example: true / false
limited_quantity
Description: This flag dictates whether or not there are only a limited quantity of inventory available for this deal. Once this limit is reached, the deal is 'sold out' (see above).
Example: true / false
initial_quantity
Description: The initial quantity available. If quantity is limited, this value will normally not change, unless the merchant / vendor decides to open up more inventory once the deal is launched.
Example: 250
quantity_remaining
Description: The quantity still available for purchase. Upon launching, this value will equal the 'initial quantity'. For deals that sell out, this will equal zero.
Example: 249
minimum_purchase
Description: The minimum amount that a customer must order in order to purchase this deal.
Example: 2
maximum_purchase
Description: The maximum number which any single customer is allowed to purchase. In rare cases this number may be '1', but normally
Example: 7
expiration_date
Description: The date at which a voucher will expire.
Example: Aug 16, 2010 10:38 AM
details
Description: An array of details and restrictions for this deal. This is effectively the 'Fine Print' which appears on the site itself.
Example: Limit 1 per person. May purchase 1
additional as gift.
Sample Response (JSON)
{
"status"
"message":"Deals found",
"deals":[
{
"id":"242",
"deal_url":"http://cachedailydeals.com/deal/deal02-2",
"title":"deal02",
"small_image_url":"http://cachedailydeals.com/img/small_thumb/Deal/.797b12d0ec6fbdca1b761768ab59e233.jpg",
"medium_image_url":"http://cachedailydeals.com/img/small_big_thumb/Deal/.101835f24ac2fc3c5cfdad6426a8ef3c.jpg",
"large_image_url":"http://cachedailydeals.com/img/medium_big_thumb/Deal/.db548c3ddb67f895f0495c53f3fc2a23.jpg",
"division_id":"6618",
"division_name":"Kigali",
"division_lat":"-1.95",
"division_lng":"30.0667",
"vendor_id":"30",
"vendor_name":"dcom01",
"vendor_website_url":"http:\/\/www.google.com",
"status":"Paid To Company",
"start_date":"Jun 16, 2010 10:38 AM",
"end_date": "Jun 19, 2010 10:38 AM",
"tipped":"false",
"tipping_point":"1",
"tipped_date":"Not Yet Tipped",
"quantity_sold":"2",
"price":"$9.00",
"value":"$10.00",
"discount_amount":"$1.00",
"discount_percent":"10%",
"conditions":{
"limited_quantity":"true",
"initial_quantity":"1",
"quantity_remaining":0,
"minimum_purchase":"1",
"maximum_purchase":"2",
"expiration_date":"Aug 19, 2010 10:38 AM",
"details":{
"detail":"Test Deal<\/p>"
}
}
}
]
}