...
Name | Value(s) | Description | Required | Default |
|---|---|---|---|---|
key | APIKEY | API key for authentication, available on the API Keys & Calls page.(https://account.fmtc.co/cp/api_keys) | Yes | N/A, must always be provided |
incremental | 0, 1 | The system will always remember your last incremental download. Using this option will download only deals added, modified, or deleted since your last download. | No | 0 |
format | String XML, JSON, CSV, TAB, or PIPE | Choose the feed format you would like returned. | No | |
nosave | 0, 1 | This option is used for testing your incremental implementation. It prevents the incremental last download pointer from changing. | No | |
local | 0, 1 | This option will return only local deals from your selected merchants. Account level restrictions apply. | No | |
sincedate | Date (YYYY-MM-DDTH:M:S) | Only return items added or modified since this date. The time pasted will be treated as US Pacific Time. | No | |
activedatestart | Date (YYYY-MM-DD) | Display deals after this start after this date | No | No Limit |
activedateend | Date (YYYY-MM-DD) | Display deals that start before this date | No | No Limit |
expiredatestart | Date (YYYY-MM-DD) | Display deals that end after this date | No | No Limit |
expiredateend | Date (YYYY-MM-DD) | Display deals that end before this date | No | No Limit |
zipcode | US Zip Code (#####) | Display only local deals in this zip code. Requires local deals to be enabled on the account | No | No Limit |
merchantids | Number(s) | Return only deals from a particular merchant. If you do not specify a merchantids value deals will be returned from all of your selected merchants. | No | |
categoryids | String(s) | Return only deals from a particular category or categories. Use getCategories call for available categories. | No | |
sortby | String “merchant,” “added,” and “update” | Field to order you | No | merchantname |
dealtype | String(s) | Return only deals from of a particular type. Use getTypes call for available types. | No | |
country | String | Return only deals from merchants with a particular Primary Country. Value Format: A two-letter Country Code, or multiple Country Codes separated by commas. | No | |
network | String(s) | Return only deals from a particular network. | No | |
deleted | 0,1 | Include deleted deals, overridden by historical | No | 0 |
historical | 0, 1 | This option will return expired coupons and deals since your subscription began or up to two years worth of data. You just must specify at least one merchantid with the historical parameter. | No | |
couponid | Number | Return only a single couponID. | No | |
activetoday | 0,1 | Retrieve deals that are active today (AKA they expire after today and begin before today) | No | 0 |
active | 0,1 | Display only active deals | No | 0 |
count | Number | Limit the number of deals returned. | No | 0 (Unlimited) |
view | 0,1 | Print results to the screen rather than forcing a download | No | 0 |
codes | 0,1 | Only return deals with coupon codes | No | 0 |
idplaceholder | String | Provide a placeholder value to replace with your affiliate ID | No | |
pod | Number | ID of the Pod (https://www.fmtc.co/features/pods/) consuming the feed. | No | |
v2categories | 0, 1 | This option is used to enable v2 categories on a per call basis. If V2 Categories is enabled on the Feed Settings (https://account.fmtc.co/cp/feed_settings) page this parameter is unnecessary. | No |
...