...
Name | Description |
|---|---|
id | Our proprietary coupon ID - especially useful in identifying deals that are delivered more than once because they have changed. |
merchant_name | Name of the merchant in the FMTC database. |
merchant_id | The 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. |
network_id | An FMTC assigned ID for the affiliate network associated with this merchant. Use Networks - v3 endpoint for available networks. |
program_id | A Network assigned ID for the merchant that their program is on. |
label | Describes the coupon value or description of the deal. |
code | If the offer requires the user to enter a code, it is in this field. Any deal with a code will also contain the Deal Type ID (Types - v3) for “coupon” in the types field. |
coupon_code_on_page | Automated FMTC has found the coupon code on the deal’s landing page. NOTE: This has the potential to provide false positives if the code is a generic term that is possibly used in multiple places on the page. |
code_verified_at | The date that the code was verified by FMTC. This will be updated each time the code has been verified. (example: 2014-07-17T00:01:00-07:00). |
image | Images are included when possible and are typically delivered with product offers and grocery coupons. |
state_date | Date the offer begins with start time (example: 2013-07-17T00:01:00-07:00). |
end_date | Date the offer ends with end time (example: 2014-07-17T00:01:00-07:00). |
affiliate_url | The affiliate link containing your own affiliate ID that is used to go to the merchant's landing page and set the appropriate network cookie. It requires that you have inserted your affiliate IDs on the Manage Affiliate IDs page. NOTE: Any deal with a code will also contain the Deal Type ID (Types - v3) for “coupon” in the types field. |
skimlinks_url | Link that lands on the page associated with the offer and is monetized by Skimlinks. You must have a Skimlinks account and provide us with your Skimlinks publisher ID to activate this field. |
freshreach_url | Link that lands on the page associated with the offer and is monetized by FreshReach™️FreshReach®. You must have a FreshReach™️ FreshReach® account to activate this field. |
direct_link | Unmonetized non-affiliate link that lands on the page associated with the offer. May be a homepage link or a deep link. |
fmtc_url | FMTC tracking URL. FMTC will determine if you should use the NetworkAffiliate URL or the Sub-Affiliate (FreshReach®/Skimlinks/FreshReach™️) URL depending on your relationship status with the merchant. This will be a shortened URL. |
cascading_full_url | This will direct to the same location as the FMTC URL. The difference is that this URL is not shortened. |
subaffiliate_url | Link that lands on the page associated with the offer and is monetized by a subaffiliate network. You must have an applicable account with one of the participating subaffiliate networks to activate this field. |
link_verified_at | The date that the link was verified by FMTC. This will be updated each time the link has been verified. (example: 2014-07-17T00:01:00-07:00). |
pixel_html | Tracking pixel provided by the associated affiliate network when available. |
restrictions | Any information the merchant provides regarding restrictions relating to how the coupon can or cannot be used. |
categories | Categories the coupon or deal can be classified by, i.e. apparel, books, shoes, toys, etc. |
types | Used to signify a offer's type, i.e. $ off, % off, category coupon, product coupon, free shipping, sale, category sale, product sale, rebate, etc. This is an array of ID’s that can be looked up via the Types - v3 endpoint. |
status | The status should always be checked, and only "active" deals should be displayed (regardless of expiration date). The status is critical to tell if the deal is currently valid. Values may be: active - Deal is active, valid, and may be displayed; deleted - Deal was deleted - ignore other values and remove deal; suspended - The merchant was deactivated by FMTC, check your affiliation status; or expired - The deal expired normally. |
created | The date the offer was added to FMTC's database. |
last_update | When this deal was last modified by FMTC. |
sale_price | Discounted price of a product. Not included on all product deals. |
was_price | Original price of a product. Not included on all product deals. |
discount | The system calculated dollar off savings when a sale product has "was" and "now" pricing. |
percent | The system calculated percent off savings when a sale product has "was" and "now" pricing. |
threshold | The minimum amount a shopper must spend in order to qualify for an offer. |
rating | Deal Rankings are assigned to every offer. They can be used to aid in the placement of coupons and deals on your merchant pages based on offer value and potential of customer appeal. Rankings start at 1 (lowest value) and higher is better. |
brands | List of brands related to this deal. Note: currently this field is only populated for grocery deals. |
local | This will determine if the deal is a local deal, and will be a 0 or 1. |
tiered_deal | This offer was flagged by an FMTC Data Processor as being a tiered deal. |
link_id | This is the Network LinkID associated with this deal. |
locations | This is an array of local deal information if the deal is a local deal. The following information is provided: name: Name of the business. street_address: Address of the business offering the deal. extended_address: Address of the business offering the deal. locality: The area in which the deal is being offered. region: The region in which the deal is being offered. postal_code: The Postal code of the deal being offered. country: The country the deal is located in. latitude: Geographical north-south location of the business offering the deal. longitude: Geographical east-west location of the business offering the deal. link: Website of the business offering the deal. |
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. |
...