Page Comparison

...

getMerchants
- 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
keyapi_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 particular merchant. If you do not specify a merchantids value deals will be returned from all of your selected merchants.	No	null
programid	Number	Return only merchants from a particular network. Referer to the Network List for valid network slug values.	No	null
networkid	Number	Return only deals from a particular network.	No	null
country	String. Two-Letter Country Code	Return only merchants with a particular Primary Country.		null
sincedate	Date	Only return items added or modified since this date. The time pasted will be treated as US Pacific Time.	No	null
page_size	Number 0 - 1000	Size of each page for the results of this call.	No	30
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

...

Response Elements

Name	Description
MerchantIDid	Unique ID assigned to the merchant by FMTC.
MasterMerchantIDmaster_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 can be associated with a single FMTCID. This field contains all of the associated SkimlinksIDs. This information can be useful for associating Skimlinks commissions to a,merchant in your system. This array replaces the SkimlinksID value also,in the feed. We added this field after discovering that there is more,than one SkimlinksID for the same merchant and it is impossible to,predict which SkimlinksID they are using to track clicks and commissions.
MerchantNamename	Name of the merchant.
Network	Network this merchant is on.
NetworkID	network_id	ID assigned to the merchant by the network their program is on. This field is also known as the ProgramID.
ProgramIDprogram_id	ID assigned to the merchant by the network their program is on. This field is also known as the NetworkID.
NetworkNotesnetwork_notes	Details on locating the merchant on the network. Mostly used when the merchant is listed under a parent company name.
DualMerchantdual_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	affiliate_url	Homepage affiliate link for the merchant.
SkimlinksURLskimlinks_url	The merchant's homepage URL monetized by Skimlinks. Must be enabled and Skimlinks Publisher ID must be provided.
FreshReachURLfreshreach_url	The merchant's homepage URL monetized by FreshReach™. Must be enabled and FreshReach ID must be provided.
FMTCURLfmtc_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.
Homepagehomepage	The merchant's homepage URL.
Statusstatus	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.
SelectedStatusselected_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.
RelationshipStatusrelationship_status	Indicates if you are approved at the network for this specific merchant. Requires Merchant Sync set up.
PrimaryCountryprimary_country	The country the merchant is primarily targeting.
ShiptoCountriesshiptocountries	The country or countries the merchant will ship to. Country name, comma delimited.
APOFPOap_fpo_shipping	Indicates if a merchant ships to APO/FPO (overseas military) addresses.
PrimaryCategorycategories	Primary category Categories of merchandise the merchant sells.
Subcategories	Subcategories of merchandise the merchant sells.
CategoriesV2	V2 Categories of merchandise the merchant sells.
SpecialPaymentOptions	Indicates if a merchant accepts Paypal, Amazon Payment, V.me, WU Pay, and/or Bill Me Later, Google Wallet. Premium Feed users can activate this field in Feed Settings. Options: paypal, amazon-payments, vme, wu-pay, and bill-me-later. Comma delimited.
MobileCertified	Indicates the affiliate cookie will track on a mobile device. This data provided by the networks and not verified by FMTC.
Logos	Contains information about the logo files that are returned in the getLogos call. Premium subscription required. Coupon Mini subscribers can add logos to their feed for $50 / month.
CustomLogo	Custom logo that was added by you (if any). This feature must first be enabled in Feed Settings. You will then be able to add a custom logo on the Manage Merchants page by clicking the customize icon next to the merchant name. The image must be hosted on your own site and you simply need to provide us with the URL.
CustomDescription	Custom description that was added by you (if any). This feature must first be enabled in Feed Settings. You will then be able to add a custom description on the Manage Merchants page by clicking the customize icon next to the merchant name.
Added	Indicates the date the merchant was added to FMTC's database.
LastUpdated	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.
cRepName	Merchant Representative Name (when available)
cRepEmail	Merchant Representative Email (when available)
cRepPhone	Merchant Representative Phone (when available)

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)

Example Response - JSON

Here is an example of a JSON Response from the getMerchants 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",
            "nMerchantIDlast_updated": 40028,"2022-05-01T13:07:59.000000Z",
         "nMasterMerchantID   "selected_status": 6571,
            "nSkimlinksID": 0,relationship_status": 1,
            "cNameaffiliate_url": "Petcohttps://www.dpbolvw.net/click-TestCJP-55431",
        "cNetwork": "IR",
     "skimlinks_url": "https://go.redirectingat.com/?id=1&xs=1&xcust=4mtc&url=https%3A%2F%2Fwww.areyougame.com%2F",
      "cProgramID": "10290",         "cNetworkNotes"freshreach_url": "https://freshreach.co/click.php?m=13&cid=FMTC&uid=9107&sid=4mtc",
 
      "bDual": 0,         "aDualMerchantsfmtc_url": [],"https://fmtc.co/m/13/",
         "nParentMerchantID   "primary_country": "0US",
            "cAffiliateURLshiptocountries": "http://petco.9zpg.net/c/ACTID/657027/10290",
   [
     "cSkimlinksURL": "",         "cFreshReachURL": "https://freshreach.co/click.php?m=40028&cid=FMTC&uid=9081&sid=", "US",
               "cFMTCURL": "https://fmtc.co/m/40028/c117cd8df8f45b133f2e26ff5cc53bfe",CA",
               "cHomepageURL": "https://www.petco.com/UK",
          "cStatus": "active",      "AU"
           "dtCreated": "2019-09-20T07:09:45-07:00", ],
            "dtLastUpdatedcategories": "2021-02-02T21:58:55-08:00", [
                "bSelected": 1,toys-games"
           "bRelationshipExists": "0", ],
            "cPrimaryCountryskimlinks_id": "US", 645,
            "aShipToCountriesnetwork_notes": ["",
            "USrep_name": "Heather Mannion",
            "CArep_email": "affiliates@areyougame.com ",
            "UKrep_phone":  "",
      ],      "apo_fpo_shipping": 0,
 "bAPOFPO": 1,           "cPrimaryCategorycurbside_pickup": "pets",0,
            "bMobileCertifiedmobile_certified": "0",
        "aLogos": [],}
         "aSkimlinksIDs": null,
        "aPaymentOptions": [],
],
}

Example Response - XML

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

Code Block

<!-- Created with Liquid Studio 2019 (https://www.liquid-technologies.com) -->
<results>
       "cCustomMerchantName": "",<data>
        <merchant>
"cCustomMerchantLogo": "",         "cCustomMerchantDescription": "", <id>13</id>
       "repName": "",    <master_merchant_id>13</master_merchant_id>
     "repEmail": "",      <name>AreYouGame.com</name>
  "repPhone": "",         "bCurbsidePickup": "0",<homepage>https://www.areyougame.com/</homepage>
        "aCategories": [   <premium>0</premium>
         "pets"   <network_id>3</network_id>
     ]     }
]

Example Response - XML

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

Code Block

<?xml version="1.0"?>
<merchants>
    <program_id>247913</program_id>
   <merchant>         <merchantid>40028<<dual_merchants/merchantid>>
        <mastermerchantid>657</mastermerchantid>    <status>active</status>
    <name>Petco</name>         <network>IR</network><created>2007-01-01 08:00:00</created>
          <networkid>10290</networkid>  <last_updated>2022-05-01 13:07:59</last_updated>
     <networknote/>         <dualmerchant>0</dualmerchant><selected_status>1</selected_status>
        <relatedmerchants/>    <relationship_status>1</relationship_status>
    <parentmerchant>0</parentmerchant>         <affiliateurl>http<affiliate_url>https://petcowww.9zpgdpbolvw.net/c/ACTID/657027/10290</affiliateurl>click-TestCJP-55431</affiliate_url>
            <skimlinks_url>https://go.redirectingat.com/?id=1&xs=1&xcust=4mtc&url=https%3A%2F%2Fwww.areyougame.com%2F</skimlinks_url>
   <skimlinksurl/>         <freshreachurl>https<freshreach_url>https://freshreach.co/click.php?m=4002813&amp;cid=FMTC&amp;uid=90819107&amp;sid=</freshreachurl>
 4mtc</freshreach_url>
      <homepageurl>https://www.petco.com/</homepageurl>         <fmtcurl>https<fmtc_url>https://fmtc.co/m/4002813/c117cd8df8f45b133f2e26ff5cc53bfe</fmtcurl></fmtc_url>
            <status>active</status><primary_country>US</primary_country>
             <created>2019-09-20T07:09:45-07:00</created><shiptocountries>
         <lastupdated>2021-02-02T21:58:55-08:00</lastupdated>       <country>US</country>
 <selectedstatus>1</selectedstatus>         <relationshipstatus>0</relationshipstatus>      <country>CA</country>
  <mobilecertified>0</mobilecertified>         <primarycountry>US</primarycountry>     <country>UK</country>
   <shiptocountries>             <country>US<<country>AU</country>
            <country>CA</country></shiptocountries>
            <categories>
  <country>UK</country>         </shiptocountries>     <category>toys-games</category>
   <apofpo>1</apofpo>         <primarycategory>pets<</primarycategory>categories>
        <categories>    <skimlinks_id>645</skimlinks_id>
        <category>pets</category>    <network_notes/>
    </categories>        <rep_name>Heather <paymentoptionsMannion</>rep_name>
        <skimlinksids/>    <rep_email>affiliates@areyougame.com </rep_email>
   <logos/>         <custommerchantname<rep_phone/>
        <custommerchantlogo/>     <apo_fpo_shipping>0</apo_fpo_shipping>
   <custommerchantdescription/>         <repName/>
<curbside_pickup>0</curbside_pickup>
       <repEmail/>         <repPhone/><mobile_certified>0</mobile_certified>
        <bCurbsidePickup>0<</bCurbsidePickup>merchant>
    </merchant>data>
</merchants>results>

Example Response - CSV

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

...

getMerchants endpoint.

Code Block

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=13&cid=FMTC&uid=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 - TAB

Here is an example of a TAB Response from the getMerchants 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	https://freshreach.co/click.php?m=40028&cid=FMTC&uid=9081&sid=			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=13&cid=FMTC&uid=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 endpoint.

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|

Code Block

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-0205-02T2101 13:58:55-08:00|1|0|US|US,CA,UK|1|pets|pets||0|40028.jpg|40028.jpg|||007: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=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 6

Key

Request Parameters

Response Elements

Example Response - JSON

Example Response - JSON

Example Response - XML

Example Response - XML

Example Response - CSV

Example Response - TAB

Example Response - PIPE