...
| Table of Contents | ||||
|---|---|---|---|---|
|
Glossary
Here is the glossary of all terms that are used within this document.
...
Term
...
Abbreviation
...
Definition
API Endpoints
Deal Merchants
Description: Information to help gather information on all the merchants inside of our system.
Example Request: https://s3.fmtc.co/api/v3/deals-merchants?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 |
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 |
premium | 0,1 | Select premium merchants | No | 0 |
merchantids | Number(s) | Return only deals from a the particular merchant(s). If you do not specify a merchantids value deals , you will be returned from all of your selected merchants. | No | null |
programid | Number | Return only merchants from a particular network. Referer Refer to the Network List for valid network slug values. | No | null |
networkid | Number | Return only deals merchants from a particular network. | No | null |
country | String. Two-Letter Country Code | Return only merchants with a particular Primary Country. | null | |
sincedate | Date (YYYY-MM-DD) | Only return items added or modified since this date. The time pasted will be treated as US Pacific Time. | No | null |
all | 0, 1 | Return all merchants rather than selected merchants | No | 0 |
page_size | Number 0 - 1000 | Size of each page for the results of this call. | No | 100 |
...
Name | Description |
|---|---|
id | Unique ID assigned to the merchant by FMTC. |
master_merchant_id | Each unique merchant has an ID that is shared across all the networks a merchant is active on. |
skimlinks_id | More than one Skimlinks id can be associated with a single FMTC ID. This field contains all of the associated skimlinks_ids. This information can be useful for associating Skimlinks commissions to a,merchant in your system. This array replaces the skimlinks_id value also,in the feed. We added this field after discovering that there is more,than one skimlinks_id for the same merchant and it is impossible to,predict which skimlinks_id they are using to track clicks and commissions. |
name | Name of the merchant. |
network_id | An FMTC assigned ID for the affiliate network associated with this merchant. Use Network endpoint for available networks. |
program_id | A Network assigned ID for the merchant that their program is on. |
network_notes | Details on locating the merchant on the network. Mostly used when the merchant is listed under a parent company name. |
dual_merchants | Signifies if the merchant is available on more than one network. |
affiliate_url | Homepage affiliate link for the merchant. |
skimlinks_url | The merchant's homepage URL monetized by Skimlinks. Must be enabled and Skimlinks Publisher ID must be provided. |
freshreach_url | The merchant's homepage URL monetized by FreshReach®. Must be enabled and FreshReach® ID must be provided. |
fmtc_url | FMTC tracking URL. FMTC will determine if you should use the Network Affiliate URL or the Skimlinks URL depending on your relationship status with the merchant. |
homepage | The merchant's homepage URL. |
status | The status of a merchant in the FMTC database. Statuses are active - Normal deactivated - Merchant program may be temporarily offline. deleted - Merchant has been removed from FMTC's system. These merchants are temporarily included for your information. |
selected_status | Indicates if a merchant is among your selected merchants. 0 = not selected. 1 = selected. |
relationship_status | Indicates if you are approved at the network for this specific merchant. Requires Merchant Sync set up. |
primary_country | The country the merchant is primarily targeting. |
shiptocountries | The country or countries the merchant will ship to. Country name, comma delimited. |
ap_fpo_shipping | Indicates if a merchant ships to APO/FPO (overseas military) addresses. |
categories | Categories of merchandise the merchant sells. |
mobile_certified | Indicates the affiliate cookie will track on a mobile device. This data provided by the networks and not verified by FMTC. |
last_updated | Indicates the last time a merchant's information was changed. Changes,can sometimes be made to logos, categories, ship-to countries, special payment options, etc. |
rep_name | Merchant Representative Name (when available) |
rep_email | Merchant Representative Email (when available) |
rep_phone | Merchant Representative Phone (when available) |
logos | Logo information for the merchant.
NOTE: Not all information will be available for all merchants. |
links - JSON and XML link - CSV, Tab, Pipe - will be located in the HTML link header. Â | All the different links that are for going through the pagination. first - The first page of the endpoint call. last - The last page of the endpoint call. prev - The previous page of the endpoint call. next - The next page of the endpoint call. |
meta | The information about the current endpoint call. |
...
| Code Block |
|---|
{
"data": [
{
"id": 13,
"master_merchant_id": 13,
"name": "AreYouGame.com",
"homepage": "https://www.areyougame.com/",
"premium": 0,
"network_id": 3,
"program_id": "247913",
"dual_merchants": [],
"status": "active",
"created": "2007-01-01T08:00:00.000000Z",
"last_updated": "2022-05-01T13:07:59.000000Z",
"selected_status": 1,
"relationship_status": 1,
"affiliate_url": "https://www.dpbolvw.net/click-TestCJP-55431",
"skimlinks_url": "https://go.redirectingat.com/?id=1&xs=1&xcust=4mtc&url=https%3A%2F%2Fwww.areyougame.com%2F",
"freshreach_url": "https://freshreach.co/click.php?m=13&cid=FMTC&uid=9107&sid=4mtc",
"fmtc_url": "https://fmtc.co/m/13/",
"primary_country": "US",
"shiptocountries": [
"US",
"CA",
"UK",
"AU"
],
"categories": [
"toys-games"
],
"skimlinks_id": 645,
"network_notes": "",
"rep_name": "Heather Mannion",
"rep_email": "affiliates@areyougame.com ",
"rep_phone": "",
"apo_fpo_shipping": 0,
"curbside_pickup": 0,
"mobile_certified": 0,
"logos": [
{
"size": "88x31",
"image_name": "MerchantID_88x31.jpg",
"last_updated": "2021-05-06T10:45:12.000000Z",
"image_url": url
},
{
"size": "120x60",
"image_name": "MerchantID_120x60.jpg",
"last_updated": "2021-05-06T10:45:12.000000Z",
"image_url": url
},
{
"size": "600x450",
"image_name": "MerchantID_600x450.png",
"last_updated": "2024-09-15T05:15:22.000000Z",
"image_url": url
},
{
"size": "280x210",
"image_name": "MerchantID_280x210.png",
"last_updated": "2024-09-15T05:15:22.000000Z",
"image_url": url
}
]
}
],
"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": "http://s3.fmtc.co/api/v3/deals-merchants",
"per_page": 100,
"to": 100,
"total": 1518
},
} |
...