...
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. | Not Available | incremental | **incremental |
Feed Format | Choose the feed format you would like returned. | Not Available | format | format |
Incremental Testing Parameter | Testing Parameter for incremental. | Not Available | 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 | zipcode |
Merchant Deals | Return only deals from a particular merchant. | merchantids | merchantids | merchantids |
Category Deals | Return only deals from a particular category or categories. | categoryids | categoryids | categoryids |
Field Sorting | Field to order the results by. | sortorder | sortby | sortby |
Deal Types | Return only deals from of a particular type. | dealtype | dealtype | **dealtypeid |
Deal Countries | Return only deals from merchants with a particular Primary Country. | country | country | country |
Network Deals | Return only deals from a particular network. | network | network | **networkid |
Deleted Deals | Include deleted deals | deleted | deleted | Deprecated |
Historical Deals | This option will return expired coupons and deals since your subscription began or up to two years worth of data. | Not Available | 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 | activetoday |
Active Deals | Display only active deals. | active | 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. | Not Avilable | pod | Deprecated |
Enable New Categories | This option is used to enable v2 categories on a per call basis. | Not Available | v2categories | Deprecatedzipcode |
Output Parameters
Name |
---|
Description |
---|
version
Deprecated
Deprecated
level
Deprecated
Deprecated
mode
Deprecated
Deprecated
recent
Deprecated
Deprecated
Output Parameters
Name | Description | Version 1 Field | Version 2 Field | Version 3 Version 1 Field | Version 2 Field | Version 3 Field |
---|---|---|---|---|---|---|
Deal Identifier | Our proprietary Deal ID. | CouponID | CouponID | id | ||
Merchant Name | Name of the merchant in the FMTC database. | MerchantName | MerchantName | merchant_name | ||
Merchant Identifier | The ID assigned to the merchant by FMTC. | MerchantID | MerchantID | merchant_id | ||
Master Merchant Identifier | Each unique merchant has an ID that is shared across all the networks a merchant is active on. | Not Available | MasterMerchantID | master_merchant_id | ||
Network Identifier | An FMTC assigned ID for the affiliate network associated with this merchant. | Network | Network | network_id | ||
Program Identifier | A Network assigned ID for the merchant that their program is on. | Not Available | ProgramID | program_id | ||
Label | Describes the coupon value or description of the deal. | Label | Label | label | ||
Custom Content Label | Short description of the deal in a custom format selected by the user. | Not Available | CustomLabel | Future Update | ||
Custom Content Description | Long Description of the deal in a custom format selected by the user. | Not Available | CustomDescription | Future Update | ||
Deal Code | If the offer requires the user to enter a code, it is in this field. | CouponCode | CouponCode | code | ||
Image URL | Images are included when possible and are typically delivered with product offers and grocery coupons. | Image | Image | image | ||
Deal Start Date | Date the offer begins with start time. | StartDate | StartDate | start_date | ||
Deal End Date | Date the offer ends with end time. | EndDate | EndDate | end_date | ||
Custom Content End Date | Custom End Date selected by the user. | CustomEndDate | Future Update | |||
Affiliate URL | The affiliate link containing your own affiliate ID | Link | AffiliateURL | affiliate_url | ||
Direct URL | Unmonetized non-affiliate link that lands on the page associated with the offer. | DierctLink | DirectURL | direct_link | ||
FreshReach® URL | Link that lands on the page associated with the offer and is monetized by FreshReach®. | Not Available | FreshReachURL | freshreach_url | ||
FMTC URL | FMTC tracking URL. FMTC will determine if you should use the NetworkAffiliate URL or the Sub-Affiliate (FreshReach®/Skimlinks) URL depending on your relationship status with the merchant. This will be a shortened URL. | Not Available | FMTCURL | fmtc_url | ||
Skimlinks URL | Link that lands on the page associated with the offer and is monetized by Skimlinks. | Not Available | SkimlinksURL | skimlinks_url | ||
SubAffiliate URL | Link that lands on the page associated with the offer and is monetized by a subaffiliate network. | Not Available | SubAffiliateURL | subaffiliate_url | ||
Tracking Pixels | Tracking pixel provided by the associated affiliate network when available. | Not Available | PixelHTML | pixel_html | ||
Deal Restrictions | Any information the merchant provides regarding restrictions relating to how the coupon can or cannot be used. | Restrictions | Restrictions | restrictions | ||
Original FMTC Categories | Categories the coupon or deal can be classified by, i.e. apparel, books, shoes, toys, etc. | Categories | Categories | Deprecated | ||
Updated FMTC Categories | Categories the coupon or deal can be classified by, i.e. apparel, books, shoes, toys, etc. | Not Avialable | CategoriesV2 | categories | ||
FMTC Deal Types | Used to signify a offer's type, i.e. $ off, % off, category coupon, product coupon, free shipping, sale, category sale, product sale, rebate, etc. | DealTypes | DealTypes | types | ||
Deal Status | The status should always be checked, and only "active" deals should be displayed. | Status | Status | status | ||
Deal Create Date | The date the offer was added to FMTC's database. | Created | Created | created | ||
Deal Update Date | When this deal was last modified by FMTC. | LastUpdated | LastUpdated | last_update | ||
Deal Sale Price | Discounted price of a product. Not included on all product deals. | Not Available | SalePrice | sale_price | ||
Deal Was Price | Original price of a product. Not included on all product deals. | Not Available | WasPrice | was_price | ||
Deal Dollar Off Amount | The system calculated dollar off savings when a sale product has "was" and "now" pricing. | Not Available | DollarsOff | discount | ||
Deal Percent Off Amount | The system calculated percent off savings when a sale product has "was" and "now" pricing. | Not Available | PercentOff | percent | ||
Deal Threshold Amount | The minimum amount a shopper must spend in order to qualify for an offer. | Not Available | Threshold | threshold | ||
FMTC Deal Rating | Deal Rankings are assigned to every offer. | Not Available | Rank/Rating | rating | ||
Star Ranking | This offer was flagged by an FMTC Data Engineer as being exceptionally valuable. | Not Available | Starred | Deprecdted | ||
Brand Name | List of brands related to this deal. | Not Available | Brands | brands | ||
Tiered Deal | This offer was flagged by an FMTC Data Processor as being a tiered deal. | Not Available | nTieredDeal | tiered_deal | ||
Network Link ID | This is the Network LinkID associated with this deal. | Not Available | LinkID | link_id | ||
Local Deal | Local Information about the deal, including address and zip code. | Country | local | locations |
Merchants
You can find more information on each of the fields on the respective API pages.
...
Name | Description | Version 1 Field | Version 2 Field | Version 3 Field |
---|
Output Parameters
...
Name
...
Description
...
Version 1 Field
...
Version 2 Field
...
Version 3 Field
Categories
You can find more information on each of the fields on the respective API pages.
Input Parameters
...
Name
...
Description
...
Version 1 Field
...
Version 2 Field
...
Version 3 Field
Output Parameters
...
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 | 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 | |
Merchant Deals | Return only specific merchants . | merchantids | merchantids | |
Merchant Countries | Return only merchants with a particular Primary Country. | country | country | |
preferred | premium | |||
all | Deprecated | |||
view | Deprecated | |||
deactivated | Deprecated | |||
idplaceholder | Deprecated | |||
plain-text | Deprecated | |||
nosave | Deprecated | |||
network | **networkid | |||
programid | programid | |||
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 | |
deleted | Deprecated | |||
v2categories | Deprecated |
Output Parameters
Name | Description | Version 1 Field | Version 2 Field | Version 3 Field |
---|---|---|---|---|
MerchantID | id | |||
MasterMerchantID | master_merchant_id | |||
SkimlinksID | Deprecated | |||
SkimlinksIDs | skimlinks_id | |||
MerchantName | name | |||
Network | Deprecated | |||
NetworkID | network_id | |||
ProgramID | program_id | |||
NetworkNotes | network_notes | |||
DualMerchant | dual_merchants | |||
RelatedMerchants | Deprecated | |||
AffiliateLink | affiliate_url | |||
SkimlinksURL | skimlinks_url | |||
FreshReachURL | freshreach_url | |||
FMTCURL | fmtc_url | |||
Homepage | homepage | |||
Status | status | |||
SelectedStatus | selected_status | |||
RelationshipStatus | relationship_status | |||
PrimaryCountry | primary_country | |||
ShiptoCountries | shiptocountries | |||
APOFPO | ap_fpo_shipping | |||
PrimaryCategory | primary_category | |||
Subcategories | Deprecated | |||
CategoriesV2 | categories | |||
SpecialPaymentOptions | Deprecated | |||
MobileCertified | mobile_certified | |||
Logos | Deprecated | |||
CustomLogo | Deprecated | |||
CustomDescription | Deprecated | |||
Added | created | |||
LastUpdated | last_updated | |||
cRepName | rep_name | |||
cRepEmail | rep_email | |||
cRepPhone | rep_phone |
Categories
You can find more information on each of the fields on the respective API pages.
Input Parameters
Name | Description | Version 1 Field | Version 2 Field | Version 3 Field |
---|---|---|---|---|
API Key | API key for authentication. | key | api_token | |
Feed Format | Choose the feed format you would like returned. | format | format | |
New Categories | Whether to return the v1 Categories or v2. | v2 | Deprecated | |
Print results to the screen rather than forcing a download | view | Deprecated |
Output Parameters
Name | Description | Version 1 Field | Version 2 Field | Version 3 Field |
---|---|---|---|---|
Slug | slug | |||
Name | name | |||
ParentID | parent_id | |||
CategoryID | id | |||
Restricted | restricted |
Types
You can find more information on each of the fields on the respective API pages.
Input Parameters
Name | Description | Version 1 Field | Version 2 Field | Version 3 Field |
---|---|---|---|---|
API Key | API key for authentication. | key | api_token | |
Feed Format | Choose the feed format you would like returned. | format | format | |
New Deal Types | Whether to return the v1 Deal Types or v2. | Not Avialable | v2 | Deprecated |
Output Parameters
Name | Description | Version 1 Field | Version 2 Field | Version 3 Field |
---|---|---|---|---|
Slug | slug | |||
Name | name |
Logos
You can find more information on each of the fields on the respective API pages.
Input Parameters
Name | Description | Version 1 Field | Version 2 Field | Version 3 Field |
---|---|---|---|---|
API Key | API key for authentication. | key | api_token | |
Incremental | Will download only deals added, modified, or deleted since your last download/call. | incremental | Deprecated | |
Logo Sizes | Specific Logo sizes for each of the merchants | size | size | |
Merchant Deals | Return only deals from a particular merchant. | merchantids | merchantids | |
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 | |
Full Logos | Return all logos of selected merchants | complete | complete |
Output Parameters
The response will be a zip file containing all of the logos. The logo files will have the filename with the FMTC Merchant ID.
Network
You can find more information on each of the fields on the respective API pages.
Types Network - v2 (Legacy)
Input Parameters
Name | Description | Version 1 Field | Version 2 Field | Version 3 Field |
---|
Output Parameters
...
Name
...
Description
...
Version 1 Field
...
Version 2 Field
...
Version 3 Field
Logos
You can find more information on each of the fields on the respective API pages.
...
API Key | API key for authentication. | key | api_token | |
Incremental | Will download only deals added, modified, or deleted since your last download/call. | incremental | Deprecated | |
Feed Format | Choose the feed format you would like returned. | format | format |
Output Parameters
Name | Description | Version 1 Field | Version 2 Field | Version 3 Field |
---|---|---|---|---|
Slug |
...
slug | |||
Name |
Description
Version 1 Field
Version 2 Field
Version 3 Field
...
name | ||||
Countries | countries |
Changes
You can find more information on each of the fields on the respective API pages.
Network Changes - v2 (Legacy)Networks - v3 (Beta)
Input Parameters
Name | Description | Version 1 Field | Version 2 Field | Version 3 Field |
---|
Version 3 Field
Output Parameters
...
Name
...
Description
...
Version 1 Field
...
Version 2 Field
...
Version 3 Field
Changes
You can find more information on each of the fields on the respective API pages.
...
API Key | API key for authentication. | key | api_token | |
Incremental | Will download only deals added, modified, or deleted since your last download/call. | incremental | Deprecated | |
Feed Format | Choose the feed format you would like returned. | format | format | |
Single Deal | Return only a single couponID. | couponid | dealId |
Output Parameters
Name | Description | Version 1 Field | Version 2 Field | Version 3 Field |
---|
...
ChangeID | ||||||
Name | CouponID | |||||
Description | Date | Version 1 Field | Version 2 Field | Version 3 Field|||
---|---|---|---|---|---|---|
Type | ||||||
NewValue | ||||||
OldValue |
...
New Fields
Deals
Input Parameters
...
Input Parameters
Output Parameters
premium
Categories
Input Parameters
slug
Output Parameters
Types
Input Parameters
slug | String | Filter by deal type to only return the passed in deal type |
Output Parameters
id
Logos
Input Parameters
Output Parameters
Networks
Input Parameters
networkid
Output Parameters
id
Changes
Input Parameters
Output Parameters
...