The getMerchants Feed Deal Merchants Endpoint contains information to help you map our merchants to your own internal system, as well as provide you with robust data about the merchant, the kinds of products it sells, where it ships to, and more. Only merchants you have selected will be included in this feed.

Table of Contents

minLevel	1
maxLevel	7

Glossary

Here is the glossary of all terms that are used within this document.

...

Term

...

Abbreviation

...

Definition

API Endpoints

getMerchantsDeal 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_KEYgetMerchantsKEY

Request Parameters

Name	Value(s)	Description	Required	Default

key

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

all

0,1

Return all merchants rather than the selected merchants

No

0

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

30

100

deactivated

0,1

Include deactivated merchants

No

0

deleted

0,1

Include deleted merchants

No

0

no_save

0, 1

This option is used for testing your incremental implementation. It prevents the incremental last download pointer from changing.

No

0

Implementation

Response Elements

...

Name

...

Description

...

MerchantID

...

Unique ID assigned to the merchant by FMTC.

...

MasterMerchantID

...

Implementation

Response Elements

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.

SkimlinksID

Deprecated - use the SkimlinksIDs field documented below.

SkimlinksIDs

skimlinks_id

More than one

SkimlinksID

Skimlinks id can be associated with a single

FMTCID

FMTC ID. This field contains all of the associated

SkimlinksIDs

skimlinks_ids. This information can be useful for associating Skimlinks commissions to a,merchant in your system. This array replaces the

SkimlinksID

skimlinks_id value also,in the feed. We added this field after discovering that there is more,than one

SkimlinksID

skimlinks_id for the same merchant and it is impossible to,predict which

SkimlinksID

skimlinks_id they are using to track clicks and commissions.

MerchantName

name	Name of the merchant.

Network

Network this merchant is on.

NetworkID

ID assigned to the merchant by the network

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.

This field is also known as the ProgramID.ProgramID

ID assigned to the merchant by the network their program is on. This field is also known as the NetworkID.

NetworkNotes

network_notes

Details on locating the merchant on the network. Mostly used when the merchant is listed under a parent company name.

DualMerchant

dual_merchants

Signifies if the merchant is available on more than one network.

RelatedMerchants

If a merchant is available on more than one network, information about the other programs will be provided in the following, format FMTC MerchantID - Merchant Name - Network - Network ProgramID.

AffiliateLink

Homepage affiliate link for the merchant.

SkimlinksURL

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.

FreshReachURL

freshreach_url

The merchant's homepage URL monetized by

FreshReach™

FreshReach®. Must be enabled and

FreshReach

FreshReach® ID must be provided.

FMTCURL

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

homepage

The merchant's homepage URL.

Status

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.

SelectedStatus

selected_status

Indicates if a merchant is among your selected merchants. 0 = not selected. 1 = selected.

Especially helpful when using the complete=1 or all=1 parameter.

RelationshipStatus


relationship_status	Indicates if you are approved at the network for this specific merchant. Requires Merchant Sync set up.

PrimaryCountry

primary_country

The country the merchant is primarily targeting.

ShiptoCountries

shiptocountries

The country or countries the merchant will ship to. Country name, comma delimited.

APOFPO

ap_fpo_shipping

Indicates if a merchant ships to APO/FPO (overseas military) addresses.

PrimaryCategory

Example Response - JSON

Here is an example of a JSON Response from the getMerchants endpoint.

...

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. size: size of the logo image_name: file name of the image last_updated: UTC timestamp of the last time the logo was updated image_url: URL to the logo 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.

Example Response - JSON

Here is an example of a JSON Response from the Deal Merchants endpoint.

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",
           "nMerchantID": 40028,         "nMasterMerchantIDlast_updated": 657,"2024-09-15T05:15:22.000000Z",
          "nSkimlinksID": 0,         "cNameimage_url": "Petco",url
        "cNetwork": "IR",       }
 "cProgramID": "10290",         "cNetworkNotes": "", ]
        "bDual": 0,}
    ],
    "aDualMerchantslinks": [],
 {
      "nParentMerchantIDfirst": URL + "0&page=1",
 
      "cAffiliateURLlast": "http://petco.9zpg.net/c/ACTID/657027/10290",
 URL + "&page=16",
      "cSkimlinksURLprev": ""null,
        "cFreshReachURLnext": "https://freshreach.co/click.php?m=40028&cid=FMTC&uid=9081&sid=",
  URL + "&page=2"
      },
      "cFMTCURLmeta": "https://fmtc.co/m/40028/c117cd8df8f45b133f2e26ff5cc53bfe",
 {
      "cHomepageURLcurrent_page": "https://www.petco.com/",
1,
       "cStatusfrom": "active"1,
 
      "dtCreatedlast_page": "2019-09-20T07:09:45-07:00",
 16,
      "dtLastUpdatedpath": "2021-02-02T21:58:55-08:00http://s3.fmtc.co/api/v3/deals-merchants",
        "bSelectedper_page": 1100,
        "bRelationshipExiststo": "0"100,
 
      "cPrimaryCountrytotal": "US",
        "aShipToCountries": [
   1518
    },
}

Example Response - XML

Here is an example of an XML Response from the Deal Merchants endpoint.

Code Block

<!-- Created with Liquid Studio 2019 (https://www.liquid-technologies.com) -->
<results>
    <data>
        <merchant>
"US",             "CA",<id>13</id>
             "UK"<master_merchant_id>13</master_merchant_id>
        ],     <name>AreYouGame.com</name>
   "bAPOFPO": 1,         "cPrimaryCategory": "pets",<homepage>https://www.areyougame.com/</homepage>
          "bMobileCertified": "0",
 <premium>0</premium>
       "aLogos": [],    <network_id>3</network_id>
    "aSkimlinksIDs": null,       <program_id>247913</program_id>
 "aPaymentOptions": [],         "cCustomMerchantName": "", <dual_merchants/>
        "cCustomMerchantLogo": "",   <status>active</status>
     "cCustomMerchantDescription": "",      <created>2007-01-01 08:00:00</created>
 "repName": "",         "repEmail": "",
 <last_updated>2022-05-01 13:07:59</last_updated>
       "repPhone": "",    <selected_status>1</selected_status>
    "bCurbsidePickup": "0",       <relationship_status>1</relationship_status>
 "aCategories": [          <affiliate_url>https://www.dpbolvw.net/click-TestCJP-55431</affiliate_url>
  "pets"         ]
    }
]

Example Response - XML

Here is an example of an XML Response from the getMerchants endpoint.

Code Block

<?xml version="1.0"?>
<merchants>
    <merchant> <skimlinks_url>https://go.redirectingat.com/?id=1&xs=1&xcust=4mtc&url=https%3A%2F%2Fwww.areyougame.com%2F</skimlinks_url>
            <freshreach_url>https://freshreach.co/click.php?m=13&cid=FMTC&uid=9107&sid=4mtc</freshreach_url>
         <merchantid>40028</merchantid>   <fmtc_url>https://fmtc.co/m/13/</fmtc_url>
     <mastermerchantid>657</mastermerchantid>         <name>Petco</name>
 <primary_country>US</primary_country>
      <network>IR</network>       <shiptocountries>
 <networkid>10290</networkid>         <networknote/>         <dualmerchant>0</dualmerchant><country>US</country>
        <relatedmerchants/>         <parentmerchant>0<<country>CA</parentmerchant>
country>
       <affiliateurl>http://petco.9zpg.net/c/ACTID/657027/10290</affiliateurl>         <skimlinksurl/><country>UK</country>
                <freshreachurl>https://freshreach.co/click.php?m=40028&amp;cid=FMTC&amp;uid=9081&amp;sid=</freshreachurl><country>AU</country>
            <homepageurl>https://www.petco.com/</homepageurl>shiptocountries>
          <fmtcurl>https://fmtc.co/m/40028/c117cd8df8f45b133f2e26ff5cc53bfe</fmtcurl>  <categories>
      <status>active</status>          <created>2019-09-20T07:09:45-07:00</created><category>toys-games</category>
        <lastupdated>2021-02-02T21:58:55-08:00</lastupdated>     </categories>
   <selectedstatus>1</selectedstatus>         <relationshipstatus>0</relationshipstatus><skimlinks_id>645</skimlinks_id>
        <mobilecertified>0</mobilecertified>    <network_notes/>
    <primarycountry>US</primarycountry>         <shiptocountries><rep_name>Heather Mannion</rep_name>
            <rep_email>affiliates@areyougame.com <country>US<</country>rep_email>
            <country>CA<<rep_phone/country>>
            <country>UK</country><apo_fpo_shipping>0</apo_fpo_shipping>
            </shiptocountries><curbside_pickup>0</curbside_pickup>
         <apofpo>1</apofpo>   <mobile_certified>0</mobile_certified>
     <primarycategory>pets</primarycategory>   </merchant>
    </data>
<categories>    <links>
      <first>URL + <category>pets</category>&page=1</first>
      <last>URL + </categories>&page=16</last>
        <paymentoptions<prev/>
      <next>URL + <skimlinksids/>&page=2</next>
      </links>
    <logos/>  <meta>
      <custommerchantname/><current_page>1</current_page>
        <custommerchantlogo<from>1</>from>
        <custommerchantdescription/><last_page>16</last_page>
        <repName/><path>http://s3.fmtc.co/api/v3/deals-merchants</path>
        <repEmail/><per_page>100</per_page>
        <repPhone<to>100</>to>
      <total>1518</total>
 <bCurbsidePickup>0</bCurbsidePickup>     </merchant>meta>
</merchants>results>

Example Response - CSV

Here is an example of a CSV Response from the getMerchants Deal Merchants endpoint.

Code Block

MerchantID,MerchantName,Network,NetworkID,NetworkNotes,DualMerchant,RelatedMerchants,ParentMerchantID,AffiliateURL,SkimlinksURL,HomepageURL,Status,Added,LastUpdated,SelectedStatus,RelationshipStatus,PrimaryCountry,ShipsToCountries,APOFPO,PrimaryCategory,Subcategories,SpecialPaymentOptions,MobileCertified,Logo88x31,Logo120x60,CustomLogo,CustomDescription,nMasterMerchantID,FreshReachURL,"Rep Name","Rep Email","Rep Phone",bCurbsidePickup
40028,Petco,IR,10290,,0,,0,http://petco.9zpg.net/c/ACTID/657027/10290,id,master_merchant_id,name,homepage,premium,network_id,program_id,dual_merchants,status,created,last_updated,selected_status,relationship_status,affiliate_url,skimlinks_url,freshreach_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.petcoareyougame.com/,0,3,247913,,active,2019"2007-09-20T07:09:45-07:00,2021-02-02T21:58:55-08:00,1,0,US,"US,CA,UK01-01 08:00:00","2022-05-01 13:07:59",1,pets,pets,,0,40028.jpg,40028.jpg,,,657,1,https://www.dpbolvw.net/click-TestCJP-55431,https://go.redirectingat.com/?id=1&xs=1&xcust=4mtc&url=https%3A%2F%2Fwww.areyougame.com%2F,https://freshreach.co/click.php?m=4002813&cid=FMTC&uid=90819107&sid=4mtc,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 getMerchants Deal Merchants endpoint.

Code Block

MerchantID	MerchantName	Network	NetworkID	NetworkNotes	DualMerchant	RelatedMerchants	ParentMerchantID	AffiliateURL	SkimlinksURL	HomepageURL	Status	Added	LastUpdated	SelectedStatus	RelationshipStatus	PrimaryCountry	ShipsToCountries	APOFPO	PrimaryCategory	Subcategories	SpecialPaymentOptions	MobileCertified	Logo88x31	Logo120x60	CustomLogo	CustomDescription	nMasterMerchantID	FreshReachURL	"Rep Name"	"Rep Email"	"Rep Phone"	bCurbsidePickup
40028	Petco	IR	10290		0		0	http://petco.9zpg.net/c/ACTID/657027/10290		https://www.petco.com/	active	2019-09-20T07:09:45-07:00	2021-02-02T21:58:55-08:00	1	0	US	US,CA,UK	1	pets	pets		0	40028.jpg	40028.jpg			0	id	master_merchant_id	name	homepage	premium	network_id	program_id	dual_merchants	status	created	last_updated	selected_status	relationship_status	affiliate_url	skimlinks_url	freshreach_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	3	247913		active	"2007-01-01 08:00:00"	"2022-05-01 13:07:59"	1	1	https://www.dpbolvw.net/click-TestCJP-55431	https://go.redirectingat.com/?id=1&xs=1&xcust=4mtc&url=https%3A%2F%2Fwww.areyougame.com%2F	https://freshreach.co/click.php?m=4002813&cid=FMTC&uid=9081&sid=			9107&sid=4mtc	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 getMerchants Deal Merchants endpoint.

Code Block

MerchantID|MerchantName|Network|NetworkID|NetworkNotes|DualMerchant|RelatedMerchants|ParentMerchantID|AffiliateURL|SkimlinksURL|HomepageURL|Status|Added|LastUpdated|SelectedStatus|RelationshipStatus|PrimaryCountry|ShipsToCountries|APOFPO|PrimaryCategory|Subcategories|SpecialPaymentOptions|MobileCertified|Logo88x31|Logo120x60|CustomLogo|CustomDescription|nMasterMerchantID|FreshReachURL|"Rep Name"|"Rep Email"|"Rep Phone"|bCurbsidePickup
40028|Petco|IR|10290||0||0|http://petco.9zpg.net/c/ACTID/657027/10290|id|master_merchant_id|name|homepage|premium|network_id|program_id|dual_merchants|status|created|last_updated|selected_status|relationship_status|affiliate_url|skimlinks_url|freshreach_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.petcoareyougame.com/|0|3|247913||active|2019"2007-0901-20T07:09:45-0701 08:00:00"|2021"2022-02-02T21:58:55-08:0005-01 13:07:59"|1|0|US|US,CA,UK|1|pets|pets||0|40028.jpg|40028.jpg|||0|1|https://www.dpbolvw.net/click-TestCJP-55431|https://go.redirectingat.com/?id=1&xs=1&xcust=4mtc&url=https%3A%2F%2Fwww.areyougame.com%2F|https://freshreach.co/click.php?m=4002813&cid=FMTC&uid=90819107&sid=4mtc|https://fmtc.co/m/13/|US|"US| CA| UK| AU"|toys-games|645||"Heather Mannion"|"affiliates@areyougame.com "||0|0|0

Versions Compared

Old Version 5

New Version Current

Key

Glossary

API Endpoints

Request Parameters

Implementation

Response Elements

Implementation

Response Elements

Example Response - JSON

Example Response - JSON

Example Response - XML

Example Response - XML

Example Response - CSV

Example Response - TAB

Example Response - PIPE

Page Comparison

Versions Compared

Old Version 5

New Version Current

Key

Glossary

API Endpoints

Request Parameters

Implementation

Response Elements

Implementation

Response Elements

Example Response - JSON

Example Response - JSON

Example Response - XML

Example Response - XML

Example Response - CSV

Example Response - TAB

Example Response - PIPE