API Endpoint
Advertiser Programs
-
Purpose: Retrieve comprehensive merchant and program data including program management and network name information
-
Example Request:
https://s3.fmtc.co/api/4.0.0/advertisers-programs?api_token=YOUR_API_KEY
What's New
This endpoint is a custom extension of the Merchants 4.0.0 endpoint, built for advertiser subscription use cases. Two fields differ from the standard Merchants response:
-
program_platform_namereplaces the numericnetwork_idfield with the human-readable network name (e.g.,"AWIN"instead of14). -
managed_byis a new field that returns the name of the agency or managing network responsible for the program. Returnsnullif the program is managed in-house or has no agency/network relationship.
Request Parameters
|
Parameter |
Values |
Description |
Required |
Default |
|---|---|---|---|---|
|
api_token |
API Key |
Authentication key (from API Keys & Calls page) |
Yes |
N/A |
|
format |
XML, JSON, CSV, TAB, PIPE |
Feed format |
No |
JSON |
|
incremental |
Number |
Minutes since last call to capture changes |
No |
0 |
|
premium |
0, 1 |
Filter premium merchants |
No |
0 |
|
merchantids |
Number(s) |
Specific merchant IDs to return (comma-separated) |
No |
null |
|
programid |
Number |
Filter by network program |
No |
null |
|
networkid |
Number |
Filter by network |
No |
null |
|
country |
Two-letter code |
Filter by primary country |
No |
null |
|
sincedate |
YYYY-MM-DD |
Return items added/modified since date (Pacific Time) |
No |
null |
|
all |
0, 1 |
Return all merchants vs. selected only |
No |
0 |
|
page_size |
0–1000 |
Results per page |
No |
100 |
Response Elements
|
Field |
Type |
Description |
|---|---|---|
|
|
Integer |
FMTC merchant ID |
|
|
Integer |
Master merchant identifier |
|
|
String |
Merchant name |
|
|
String |
Merchant homepage URL |
|
|
Boolean |
Whether the merchant is premium |
|
|
String |
Human-readable network name (replaces the numeric |
|
|
Integer |
Network program ID |
|
|
String | null |
Name of the agency or managed network responsible for the program. Returns |
|
|
Array |
Array of dual merchant IDs |
|
|
String |
Program status: |
|
|
String |
Creation timestamp (UTC) |
|
|
String |
Last modified timestamp (UTC) |
|
|
String |
Whether the merchant is selected for the authenticated account |
|
|
String |
Monetized affiliate link |
|
|
String |
Skimlinks tracking URL |
|
|
String |
FreshReach tracking URL |
|
|
String |
Sovrn tracking URL |
|
|
String |
FMTC deal page URL |
|
|
String |
Two-letter primary country code |
|
|
Array |
Array of two-letter country codes the merchant ships to |
|
|
Array |
Array of merchandise category slugs |
|
|
Array |
Associated Skimlinks IDs for commission tracking |
|
|
String |
Notes from the network |
|
|
String |
Affiliate representative name |
|
|
String |
Affiliate representative email |
|
|
String |
Affiliate representative phone |
|
|
Integer |
Whether APO/FPO shipping is available (0 or 1) |
|
|
Integer |
Whether curbside pickup is available (0 or 1) |
|
|
Integer |
Whether mobile tracking is certified (0 or 1) |
|
|
Array |
Logo objects, each with |
|
|
Object |
Pagination links |
|
|
Object |
Pagination metadata |
Optional Fields
The following fields are included only when the corresponding request parameter is provided:
|
Field |
Parameter |
Description |
|---|---|---|
|
|
|
Approval/relationship status for the authenticated account |
|
|
|
Primary merchandise category |
|
|
|
Accepted payment methods |
managed_by Field
The managed_by field reflects who manages the affiliate program on behalf of the merchant:
|
Scenario |
managed_by value |
|---|---|
|
Agency-managed |
Agency name (e.g., |
|
Network team–managed |
Network team name (e.g., |
|
Merchant in-house managed |
Merchant name (e.g., |
|
No manager assigned |
|
Response Formats
The endpoint supports JSON, XML, CSV, TAB, and PIPE-delimited formats.
Specify the desired format using the format parameter. JSON is returned by default unless overridden by the format URL parameter or your account’s Deal Feed Settings.
Example Response - JSON
Here is an example of a JSON Response from the Advertiser Programs endpoint.
{
"data": [
{
"id": 13,
"master_merchant_id": 13,
"name": "AreYouGame.com",
"homepage": "https://www.areyougame.com/",
"premium": 0,
"program_platform_name": "Commission Junction",
"managed_by": null,
"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,
"affiliate_url": "https://www.dpbolvw.net/click-TestCJP-55431",
"freshreach_url": "https://freshreach.co/click?m=13&cid=FMTC&uid=9107&cpid=1",
"sovrn_url": "https://redirect.viglink.com/?u=https%3A%2F%2Fwww.areyougame.com%2F&key=d6277b2875cb2bc03c25266bf1ac225d&prodOvrd=CUP&type=PLFM",
"skimlinks_url": "https://go.redirectingat.com/?id=1&xs=1&xcust=4mtc&url=https%3A%2F%2Fwww.areyougame.com%2F",
"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": "13_88x31.jpg",
"last_updated": "2021-05-06T10:45:12.000000Z",
"image_url": "https://logos.fmtc.co/storage/logos/programs/88x31/13.jpg"
},
{
"size": "120x60",
"image_name": "13_120x60.jpg",
"last_updated": "2021-05-06T10:45:12.000000Z",
"image_url": "https://logos.fmtc.co/storage/logos/programs/120x60/13.jpg"
},
{
"size": "600x450",
"image_name": "13_600x450.png",
"last_updated": "2022-05-01T13:07:59.000000Z",
"image_url": "https://logos.fmtc.co/storage/screenshots/programs/600x450/13.png"
},
{
"size": "280x210",
"image_name": "13_280x210.png",
"last_updated": "2022-05-01T13:07:59.000000Z",
"image_url": "https://logos.fmtc.co/storage/screenshots/programs/280x210/13.png"
}
]
}
],
"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/v4/advertiser-programs",
"per_page": 100,
"to": 100,
"total": 1518
}
}
Example Response - XML
Here is an example of an XML Response from the Advertiser Programs endpoint.
<results>
<data>
<merchant>
<id>13</id>
<master_merchant_id>13</master_merchant_id>
<name>AreYouGame.com</name>
<homepage>https://www.areyougame.com/</homepage>
<premium>0</premium>
<program_platform_name>Commission Junction</program_platform_name>
<managed_by/>
<program_id>247913</program_id>
<dual_merchants/>
<status>active</status>
<created>2007-01-01 08:00:00</created>
<last_updated>2022-05-01 13:07:59</last_updated>
<selected_status>1</selected_status>
<affiliate_url>https://www.dpbolvw.net/click-TestCJP-55431</affiliate_url>
<freshreach_url>https://freshreach.co/click?m=13&cid=FMTC&uid=9107&cpid=1</freshreach_url>
<sovrn_url>https://redirect.viglink.com/?u=https%3A%2F%2Fwww.areyougame.com%2F&key=d6277b2875cb2bc03c25266bf1ac225d&prodOvrd=CUP&type=PLFM</sovrn_url>
<skimlinks_url>https://go.redirectingat.com/?id=1&xs=1&xcust=4mtc&url=https%3A%2F%2Fwww.areyougame.com%2F</skimlinks_url>
<fmtc_url>https://fmtc.co/m/13/</fmtc_url>
<primary_country>US</primary_country>
<shiptocountries>
<country>US</country>
<country>CA</country>
<country>UK</country>
<country>AU</country>
</shiptocountries>
<categories>
<category>toys-games</category>
</categories>
<skimlinks_id>645</skimlinks_id>
<network_notes/>
<rep_name>Heather Mannion</rep_name>
<rep_email>affiliates@areyougame.com</rep_email>
<rep_phone/>
<apo_fpo_shipping>0</apo_fpo_shipping>
<curbside_pickup>0</curbside_pickup>
<mobile_certified>0</mobile_certified>
</merchant>
</data>
<links>
<first>URL + &page=1</first>
<last>URL + &page=16</last>
<prev/>
<next>URL + &page=2</next>
</links>
<meta>
<current_page>1</current_page>
<from>1</from>
<last_page>16</last_page>
<path>http://s3.fmtc.co/api/v4/advertiser-programs</path>
<per_page>100</per_page>
<to>100</to>
<total>1518</total>
</meta>
</results>
Example Response - CSV
Here is an example of a CSV Response from the Advertiser Programs endpoint.
id,master_merchant_id,name,homepage,premium,program_platform_name,managed_by,program_id,dual_merchants,status,created,last_updated,selected_status,affiliate_url,freshreach_url,sovrn_url,skimlinks_url,fmtc_url,primary_country,shiptocountries,categories,skimlinks_id,network_notes,rep_name,rep_email,rep_phone,apo_fpo_shipping,curbside_pickup,mobile_certified
13,13,AreYouGame.com,https://www.areyougame.com/,0,Commission Junction,,247913,,active,2007-01-01 08:00:00,2022-05-01 13:07:59,1,https://www.dpbolvw.net/click-TestCJP-55431,https://freshreach.co/click?m=13&cid=FMTC&uid=9107&cpid=1,https://redirect.viglink.com/?u=https%3A%2F%2Fwww.areyougame.com%2F&key=d6277b2875cb2bc03c25266bf1ac225d&prodOvrd=CUP&type=PLFM,https://go.redirectingat.com/?id=1&xs=1&xcust=4mtc&url=https%3A%2F%2Fwww.areyougame.com%2F,https://fmtc.co/m/13/,US,"US, CA, UK, AU",toys-games,645,,"Heather Mannion","affiliates@areyougame.com",,0,0,0
Example Response - TAB
Here is an example of a TAB Response from the Advertiser Programs endpoint.
id master_merchant_id name homepage premium program_platform_name managed_by program_id dual_merchants status created last_updated selected_status affiliate_url freshreach_url sovrn_url skimlinks_url fmtc_url primary_country shiptocountries categories skimlinks_id network_notes rep_name rep_email rep_phone apo_fpo_shipping curbside_pickup mobile_certified
13 13 AreYouGame.com https://www.areyougame.com/ 0 Commission Junction 247913 active 2007-01-01 08:00:00 2022-05-01 13:07:59 1 https://www.dpbolvw.net/click-TestCJP-55431 https://freshreach.co/click?m=13&cid=FMTC&uid=9107&cpid=1 https://redirect.viglink.com/?u=https%3A%2F%2Fwww.areyougame.com%2F&key=d6277b2875cb2bc03c25266bf1ac225d&prodOvrd=CUP&type=PLFM https://go.redirectingat.com/?id=1&xs=1&xcust=4mtc&url=https%3A%2F%2Fwww.areyougame.com%2F https://fmtc.co/m/13/ US "US CA UK AU" toys-games 645 "Heather Mannion" affiliates@areyougame.com 0 0 0
Example Response - PIPE
Here is an example of a PIPE Response from the Advertiser Programs endpoint.
id|master_merchant_id|name|homepage|premium|program_platform_name|managed_by|program_id|dual_merchants|status|created|last_updated|selected_status|affiliate_url|freshreach_url|sovrn_url|skimlinks_url|fmtc_url|primary_country|shiptocountries|categories|skimlinks_id|network_notes|rep_name|rep_email|rep_phone|apo_fpo_shipping|curbside_pickup|mobile_certified
13|13|AreYouGame.com|https://www.areyougame.com/|0|Commission Junction||247913||active|2007-01-01 08:00:00|2022-05-01 13:07:59|1|https://www.dpbolvw.net/click-TestCJP-55431|https://freshreach.co/click?m=13&cid=FMTC&uid=9107&cpid=1|https://redirect.viglink.com/?u=https%3A%2F%2Fwww.areyougame.com%2F&key=d6277b2875cb2bc03c25266bf1ac225d&prodOvrd=CUP&type=PLFM|https://go.redirectingat.com/?id=1&xs=1&xcust=4mtc&url=https%3A%2F%2Fwww.areyougame.com%2F|https://fmtc.co/m/13/|US|"US| CA| UK| AU"|toys-games|645||"Heather Mannion"|affiliates@areyougame.com||0|0|0