...
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
Deal Count Differences
In the upgraded API system for the deals endpoint, you may notice differences in the total deal counts compared to the previous system. These variations are due to a combination of fixes addressing earlier system errors and the introduction of new validation rules that ensure all deals are properly verified before being returned. Additionally, we've changed how deleted deals are handled; they are no longer returned by default and will only be included if the incremental or sincedate parameters are used in the API call. This means that the deal counts in the new system are more accurate and reliable than those from the legacy system, providing a clearer and more up-to-date view of available deals.
...
URL Structure
FMTC offers access to seven Deal API Endpoints. The URL structure and access methods for each endpoint are detailed below, along with their alignment. Two distinct URLs are utilized; the services.fmtc.co endpoint encompasses Versions 1 and 2, whereas the s3.fmtc.co endpoint contains the latest Version 3 endpoints."
...
You can find more information on each of the fields on the respective API pages.
Deals
Input 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 | 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 | **dealtypeiddealtypeids |
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 Available | pod | Deprecated |
Enable New Categories | This option is used to enable v2 categories on a per call basis. | Not Available | v2categories | Deprecated |
...
You can find more information on each of the fields on the respective API pages.
Merchants - v3 (Beta)3.0.0
Input 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 | key | api_token |
Incremental | Will download only deals added, modified, or deleted since your last download/call. | incremental | incremental | incremental |
Feed Format | Choose the feed format you would like returned. | format | format | format |
Merchant Deals | Return only specific merchants . | merchantids | merchantids | merchantids |
Merchant Countries | Return only merchants with a particular Primary Country. | Not Available | country | country |
Premium Merchants | Return selected premium merchants. | Not Available | preferred | premium |
All Merchants | Return all merchants | all | all | Deprecated |
Print results to the screen rather than forcing a download | view | view | Deprecated | |
Deactivated Merchants | Include deactivated merchants | Not Available | deactivated | Deprecated |
Apply Different Affiliate ID | Provide a placeholder value to replace with your affiliate ID | idplaceholder | idplaceholder | Deprecated |
Print Format | Same as view, except for JSON and CSV | Not Available | plain-text | Deprecated |
Incremental Testing Parameter | Testing Parameter for incremental. | nosave | nosave | Deprecated |
Network Merchants | Return only deals from a particular network. | network | network | **networkid |
Merchant Network ID | Return only merchants from a particular network. | Not Available | 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. | Not Available | sincedate | sincedate |
Deleted Merchants | Include deleted merchants | Not Available | deleted | Deprecated |
Version 2 Categories | This option is used to enable v2 categories on a per call basis. | Not Available | v2categories | Deprecated |
...
Name | Description | Version 1 Field | Version 2 Field | Version 3 Field |
|---|---|---|---|---|
Merchant Identifier | The ID assigned to the merchant by FMTC. | MerchantID | MerchantID | 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 |
Original Skimlinks ID | This field contains one associated SkimlinksIDs. | Not Available | SkimlinksID | Deprecated |
Updated Skimlinks IDs | This field contains all of the associated SkimlinksIDs. | Not Available | SkimlinksIDs | skimlinks_id |
Merchant Name | Name of the merchant in the FMTC database. | MerchantName | MerchantName | name |
Network Name | Name of the network in the FMTC database. | Network | Network | Deprecated |
Network Identifier | An FMTC assigned ID for the affiliate network associated with this merchant. | NetworkID | NetworkID | network_id |
Program Identifier | A Network assigned ID for the merchant that their program is on. | Not Available | ProgramID | program_id |
Network Information | Details on locating the merchant on the network. | NetworkNotes | NetworkNotes | network_notes |
Multi-Network Merchant | Signifies if the merchant is available on more than one network. | DualMerchant | DualMerchant | Deprecated |
Multi-Network Merchant | Signifies if the merchant is available on more than one network. | RelatedMerchants | RelatedMerchants | dual_merchants |
Affiliate URL | The affiliate link containing your own affiliate ID | Link | AffiliateLink | affiliate_url |
Skimlinks URL | Link that lands on the page associated with the offer and is monetized by Skimlinks. | Not Available | SkimlinksURL | skimlinks_url |
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 |
Merchant Homepage | The merchant's homepage URL. | HomepagehomepageHomepage | homepageurl | homepage |
Merchant Status | The status of a merchant in the FMTC database. | Status | Status | status |
Merchant Selection Status | Indicates if a merchant is among your selected merchants. | Not Available | SelectedStatus | selected_status |
Network Relationship | Indicates if you are approved at the network for this specific merchant. | Not Available | RelationshipStatus | relationship_status |
Merchant Primary Country | The country the merchant is primarily targeting. | PrimaryCountry | PrimaryCountry | primary_country |
Merchant Ship-To Countries | The country or countries the merchant will ship to. | Not Available | ShiptoCountries | shiptocountries |
Merchant APOFPO Availability | Indicates if a merchant ships to APO/FPO (overseas military) addresses. | APOFPO | APOFPO | ap_fpo_shipping |
Merchant Primary Category | Primary category of merchandise the merchant sells. | Not Available | PrimaryCategory | primary_category |
Merchant Secondary Categories | Subcategories of merchandise the merchant sells. | Not Available | Subcategories | Deprecated |
Updated FMTC Categories | Categories the coupon or deal can be classified by, i.e. apparel, books, shoes, toys, etc. | Categories | CategoriesV2 | categories |
Merchant Payment Availability | Indicates if a merchant accepts special payment types like Paypal. | Not Available | SpecialPaymentOptions | Deprecated |
Merchant Mobile Certification | Indicates the affiliate cookie will track on a mobile device. | Not Available | MobileCertified | mobile_certified |
Merchant Logos | Contains information about the logo files that are returned in the getLogos call. | Not Available | Logos | Deprecated |
Merchant Custom Logos | Custom logo that was added by you (if any). | Not Available | CustomLogo | Deprecated |
Merchant Custom Descriptions | Custom description that was added by you (if any). | Not Available | CustomDescription | Deprecated |
FMTC Addition | Indicates the date the merchant was added to FMTC's database. | Not Available | Added | created |
FMTC Last Update | Indicates the last time a merchant's information was changed. | LastUpdated | LastUpdated | last_updated |
Name | Merchant Representative Name (when available) | Not Available | cRepName | rep_name |
Merchant Representative Email (when available) | Not Available | cRepEmail | rep_email | |
Phone Number | Merchant Representative Phone (when available) | Not Available | cRepPhone | rep_phone |
...
You can find more information on each of the fields on the respective API pages.
Categories - v3 (Beta)3.0.0
Input Parameters
Name | Description | Version 1 Field | Version 2 Field | Version 3 Field |
|---|---|---|---|---|
API Key | API key for authentication. | key | key | api_token |
Feed Format | Choose the feed format you would like returned. | format | format | format |
New Categories | Whether to return the v1 Categories or v2. | Not Available | v2 | Deprecated |
Print results to the screen rather than forcing a download | Not Available | view | Deprecated |
...
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 | key | api_token |
Feed Format | Choose the feed format you would like returned. | format | format | format |
New Deal Types | Whether to return the v1 Deal Types or v2. | Not Avialable | v2 | Deprecated |
...
You can find more information on each of the fields on the respective API pages.
Networks - v3 (Beta)3.0.0
Input Parameters
Name | Description | Version 1 Field | Version 2 Field | Version 3 Field |
|---|---|---|---|---|
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 | Deprecated |
Feed Format | Choose the feed format you would like returned. | format | format | format |
...
| Code Block |
|---|
"links": {
"first": URL + "&page=1",
"last": URL + "&page=16",
"prev": null,
"next": URL + "&page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 16,
"path": "httphttps://s3.fmtc.co/api/v3/deals",
"per_page": 100,
"to": 100,
"total": 1518
}, |
...