Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

The getMerchants Feed 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.

Glossary

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

Term

Abbreviation

Definition

API Endpoints

Request Parameters

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

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 (YYYY-MM-DD)

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

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.

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

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

program_id

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

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. Especially helpful when using the all=1 parameter.

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)

Example Response - JSON

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

{
    "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
        }
    ],
}

Example Response - XML

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

<!-- Created with Liquid Studio 2019 (https://www.liquid-technologies.com) -->
<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>
            <network_id>3</network_id>
            <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>
            <relationship_status>1</relationship_status>
            <affiliate_url>https://www.dpbolvw.net/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>
            <freshreach_url>https://freshreach.co/click.php?m=13&cid=FMTC&uid=9107&sid=4mtc</freshreach_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>
</results>

Example Response - CSV

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

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.

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.

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

  • No labels