Account Management
Username:
Password:
Documentation
HTTP Service Documentation

Please note: there is a daily download limit of 1500 hits per day.

getDeals - The main feed, retrieves all deals ("coupons").

getMerchants - Retrieves the status of each merchant in each network. Also useful for retrieving the system ID of each merchant program.

getCategories - Retrieves the list of categories and their filter codes for use in getMerchants

getRss - Retrieves merchant deals ("coupons") in RSS format.

getChanges - Retrieves details about changes to a deal.

getShippingDeadlines - Retrieves all known holiday shipping deadlines for merchant products and offers.

getLogos - Retrieves our collection of merchant logos in either 88x31 or 120x60.



getDeals

To access the feed over HTTP, first select your service format and enter your affiliate netword IDs on the Manage Feed Settings control panel. You can also select a subset of merchants on the Manage Merchants control panel. Then make an HTTP request against the Base URL (see below) plus any optional GET parameters which allow further filtering. Please note that the filters set in the control panel and filters specified in the GET arguments are cumulative (that is, AND-ed together).

Only the "key" argument is mandatory.

The "incremental=1" argument is especially useful - it will only return items that have changed since your last request.

GET Parameter Characteristics Description
key Required Your developer key; this value is available in the API Key & Calls page .
incremental Optional

1
The system will always remember your last incremental download. Including this option and setting it to 1 will download only items added or modified since your last download. The very first call will return changes in the last 48 hours.
(Setting it to any value is equivalent to setting it to 1, for backward compatibility reasons.)
GET Parameter Characteristics Description
sincedate Optional

Date/Time
YYYY-MM-DD-HH:MM ZZZ
2007-10-01-08:00
Only return items added or modified since this date. (Time is optional - defaults to midnight, the time zone is in US Pacific.
activedatestart Optional

Date
YYYY-MM-DD
2007-10-01
Include all coupons that begin on or after this date.
activedateend

Optional

Date
YYYY-MM-DD
2007-10-01

Include all coupons that begin on or before this date.
expiredatestart

Optional

Date
YYYY-MM-DD
2007-10-01

Include all coupons that expire on or after this date.
expiredateend

Optional

Date
YYYY-MM-DD
2007-10-01

Include all coupons that expire on or before this date.
network

Optional

Multi-value (comma separated)

Return only deals from a particular network.
Use the network codes found here.
merchantids

Optional

Multi-value (comma separated)

Return only deals from a particular merchant. Referer to your Merchant ID List for acceptable values to filter by.

If you do not specify a merchantids value deals will be returned from all of your selected merchants.

categoryids

Optional

Multi-value (comma separated)

Return only deals from a particular category or categories. Referer to the Category List for acceptable filtering values.

dealtype

Optional

Multi-value (comma separated)

Return only deals from of a particular type. Acceptable values are listed below.

coupon
freeshipping
rebates
clearance
sale
newcustomer
dollar
percent
gift
dod

country

Optional

Return only deals from of a particular country. Acceptable values are 'us', 'canada' and 'uk'.
count

Optional

Limit the number of deals returned at a time.

Does not work well with incremental.

offset

Optional

Used in conjunction with count. Used to return the next page of results
sortby

Optional

Options are 'merchant', 'added' and 'updated'


getMerchants

Use this service call to access this feed over HTTP, select your service format on the Manage Feed Settings control panel. Only merchants choosen on the Manage Merchants control panel are returned.

Only the "key" argument is mandatory.

The "incremental=1" argument is especially useful - it will only return items that have changed since your last request.

GET Parameter Characteristics Description
key Required Your developer key; this value is available in the API Key & Calls page .
incremental optional

1
The system will always remember your last incremental download. Including this option and setting it to 1 will download only items added or modified since your last download.
(Setting it to any value is equivalent to setting it to 1, for backward compatibility reasons.)
network

Optional

Multi-value (comma separated)

Return only deals from a particular network.
Use the network codes found here.
merchantids

Optional

Multi-value (comma separated)

Return only deals from a particular merchant. Referer to your Merchant ID List for acceptable values to filter by.

If you do not specify a merchantids value deals will be returned from all of your selected merchants.

complete Optional

1
Adding the "complete" parameter will return a feed that includes all your selected merchants and unselected merchants. Unselected merchants will include one of each merchant. In respect to dual merchants, only one of each will be returned. This parameter will cause the "selected" field to be added to your feed. This field will indicate if the merchant is in your selected merchants.
all Optional

1
Adding the "all" parameter will return a feed that includes all active merchants suppored by FMTC. This parameter will cause the "selected" field to be added to your feed. This field will indicate if the merchant is in your selected merchants.


getCategories

Use this service call to access the list of available categories in the feed.

Only the "key" argument is mandatory.

GET Parameter Characteristics Description
key Required Your developer key; this value is available in the API Key & Calls page or use the Base URL value above.


getChanges

Use this service call to get details information about changes to a particular deal.

GET Parameter Characteristics Description
key Required Your developer key; this value is available in the API Key & Calls page or use the Base URL value above.
couponid Required The CouponID of the deal you would like more information on.


getRSS

Use this service call to retrieve merchant deals in RSS format.

Only the "key" argument is mandatory.

GET Parameter Characteristics Description
key Required Your developer key; this value is available in the API Key & Calls page .
incremental optional

1
The system will always remember your last incremental download. Including this option and setting it to 1 will download only items added or modified since your last download.
(Setting it to any value is equivalent to setting it to 1, for backward compatibility reasons.)
network

Optional

Multi-value (comma separated)

Return only deals from a particular network.
Use the network codes found here.
merchantids

Optional

Multi-value (comma separated)

Return only deals from a particular merchant. Referer to your Merchant ID List for acceptable values to filter by.

If you do not specify a merchantids value deals will be returned from all of your selected merchants.

sincedate Optional

Date/Time
YYYY-MM-DD-HH:MM ZZZ
2007-10-01-08:00
Only return items added or modified since this date. (Time is optional - defaults to midnight, the time zone is in US Pacific.)
activedatestart Optional

Date
YYYY-MM-DD
2007-10-01
Include all coupons that begin on or after this date.
activedateend

Optional

Date
YYYY-MM-DD
2007-10-01

Include all coupons that begin on or before this date.
expiredatestart

Optional

Date
YYYY-MM-DD
2007-10-01

Include all coupons that expire on or after this date.
expiredateend

Optional

Date
YYYY-MM-DD
2007-10-01

Include all coupons that expire on or before this date.
categoryids

Optional

Multi-value (comma separated)

Return only deals from a particular category or categories. Referer to the Category List for acceptable filtering values.

dealtype

Optional

Multi-value (comma separated)

Return only deals from of a particular type. Acceptable values are listed below.

coupon
freeshipping
rebates
clearance
sale
newcustomer
dollar
percent
gift
dod



getShippingDeadlines

Use this service call to access information about holiday shipping deadlines.

Only the "key" argument is mandatory.

GET Parameter Characteristics Description
key Required Your developer key; this value is available in the API Key & Calls page or use the Base URL value above.


getLogos

Use this service call to access our collection of merchant logos. This service call is available only to our Premium subscribers or those with the logo upgrade.

The "key" and "size" arguments are mandatory.

* Note: This call cannot be made though https://, you must call http://www.formetocoupon.com to successfully make this service call.

GET Parameter Characteristics Description
key Required Your developer key; this value is available in the API Key & Calls page or use the Base URL value above.
size

Required

'88x31' or 120x60'

Specify what size of banners you are interested in.
incremental Optional

1
The incremental call works independently for each banner size.
© 2013 ForMeToCoupon.com