...
Name | Description | Version 1 Field | Version 2 Field | Version 3 Field ** The field has the same name, but is handled differently. See the New Fields section. |
|---|---|---|---|---|
API Key | API key for authentication. | key | key | api_token |
Incremental | Will download only deals added, modified, or deleted since your last download/call. | incremental | **incremental | |
Feed Format | Choose the feed format you would like returned. | format | format | |
Incremental Testing Parameter | Testing Parameter for incremental. | nosave | Deprecated | |
Local Only Deals | Return only local deals from your selected merchants | local | local | local |
Deals Since the Provided Date | The date from which data will be retrieved. The data returned will include all new data, modified data, deleted data, and expired data since the provided date. | sincedate | sincedate | sincedate |
Deals Active Start Date | Display deals after this start after this date | activedatestart | activedatestart | activedatestart |
Deals Active End Date | Display deals that start before this date | activedateend | activedateend | activedateend |
Deals Expire Start Date | Display deals that end after this date | expiredatestart | expiredatestart | expiredatestart |
Deals Expire End Date | Display deals that end before this date | expiredateend | expiredateend | expiredateend |
Local Deals Zip Code | Display only local deals in this zip code. | zipcode | zipcode | |
Merchant Deals | Return only deals from a particular merchant. | merchantids | merchantids | |
Category Deals | Return only deals from a particular category or categories. | categoryids | categoryids | |
Field Sorting | Field to order the results by. | sortby | sortby | |
Deal Types | Return only deals from of a particular type. | dealtype | **dealtypeid | |
Deal Countries | Return only deals from merchants with a particular Primary Country. | country | country | |
Network Deals | Return only deals from a particular network. | network | **networkid | |
Deleted Deals | Include deleted deals | deleted | Deprecated | |
Historical Deals | This option will return expired coupons and deals since your subscription began or up to two years worth of data. | historical | historical | |
Single Deal | Return only a single couponID. | couponid | couponid | couponid |
Active Deals for Today | Retrieve deals that are active today (AKA they expire after today and begin before today) | activetoday | activetoday | |
Active Deals | Display only active deals. | active | active | |
Deal Limit | Limit the number of deals returned. | count | count | Deprecated |
Print results to the screen rather than forcing a download | view | view | Deprecated | |
Coupon Code Deals | Limit to only deals with coupon codes | codes | codes | codesonly |
Apply Different Affiliate ID | Provide a placeholder value to replace with your affiliate ID | idplaceholder | idplaceholder | Deprecated |
Deal Pods | ID of the Pod. | pod | Deprecated | |
Enable New Categories | This option is used to enable v2 categories on a per call basis. | v2categories | Deprecated | |
zipcode | Deprecated | Deprecated | ||
version | Deprecated | Deprecated | ||
level | Deprecated | Deprecated | ||
mode | Deprecated | Deprecated | ||
recent | Deprecated | Deprecated |
Output Parameters
...