| Table of Contents |
|---|
Glossary
Here is the glossary of all terms that are used within this document.
...
Term
...
Abbreviation
...
Definition
API Endpoints
Deals
Description: Get normalized deals across all merchants.
Example Request: https://s3.fmtc.co/api/3.2.1/deals?api_token=API_KEY
...
Name | Value(s) | Description | Required | Default |
|---|---|---|---|---|
api_token | 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 |
format | String XML, JSON, CSV, TAB, or PIPE | Choose the feed format you would like returned. | No | JSON |
codesonly | 0, 1 | Limit to only deals with coupon codes | No | 0 |
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 | null |
categoryids | Number(s) | Return only deals from a particular category or categories. Use the Categories - 3.0.0 endpoint for available categories. | No | null |
dealtypeiddealtypeids | Number | Return only deals from of a particular type. Use Types - 3.0.0 endpoint for available types. | No | null |
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 | null |
networkid | Number | Return only deals from a particular network. Use Networks - 3.0.0 endpoint for available networks. | No | null |
local | 0, 1 | This option will return only local deals from your selected merchants. Account level restrictions apply. | No | 0 |
zipcode | US Zip Code (#####) | Display only local deals in this zip code. Requires local deals to be enabled on the account | No | null |
active | 0,1 | Display only active deals. 0 - will show both the expired and currently active deals. This will not show deleted deals. 1 - will only show deals that are currently active. | No | 1 |
activetoday | 0,1 | Retrieve deals that are active today (AKA they expire after today and begin before today) | No | 0 |
sincedate | Date (YYYY-MM-DD) | 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. NOTE: This will search for any deals that existed in the API before the date and it will return those deals. The deals will be marked as deleted to indicate that the deals are not a part of the current active deal feed. | No | null |
incremental | Number | The amount of time from the previous call and to include only items that have changed since this time. For Example, setting this value to 60 will send back all changes in the past 60 minutes from the time of this call. | No | 0 |
activedatestart | Date (YYYY-MM-DD) | Display deals after this start after this date | No | null |
activedateend | Date (YYYY-MM-DD) | Display deals that start before this date | No | null |
expiredatestart | Date (YYYY-MM-DD) | Display deals that end after this date | No | null |
expiredateend | Date (YYYY-MM-DD) | Display deals that end before this date | No | null |
historical | 0, 1 | This option will return active, expired and deleted coupons and deals. This will grab from when your subscription began or up to two years worth of data. You must specify at least one merchantid with the historical parameter. | No | 0 |
couponid | Number | Return only a single couponID. | No | null |
sortby | String “merchant,” “added,” and “update” | Field to order the results by. | No | merchant |
public_only | 0, 1 | This option will return only publically available deals. | No | 0 |
exclusive_only | 0, 1 | This option will return only exclusive deals available to the subscriber. | No | 0 |
page_size | Number 1 - 150,000 | Size of each page for the results of this call. | No | 100 |
...