Glossary

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

Term

Abbreviation

Definition

API Endpoints

getChanges

Request Parameters

Name

Value(s)

Description

Required

Default

key

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

incremental

0, 1

The system will always remember your last incremental download. Using this option will download only deals added, modified, or deleted since your last download.

No

0

format

String

XML, JSON, CSV, TAB, or PIPE

Choose the feed format you would like returned.

No

couponid

Number

FMTC coupon ID that you’re looking up.

Yes

N/A, must always be provided

Implementation

Response Elements

Name

Description

ChangeID

The unique ID assigned to the change.

CouponID

The unique ID assigned to the deal.

Date

Date this particular deal has changed

Type

Change Values:

  • label

  • restrictions

  • code

  • image

  • affiliate-url

  • skimlinks-url

  • direct-url

  • type

  • category

  • expire-date

  • begin-date

  • sale-price

  • was-price

  • discount

  • percent threshold

NewValue

The most recent updated value.

OldValue

The previous value before the update.

Example Response - JSON

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

[
    {
        "nChangeID": "89376361",
        "nCouponID": "43713123",
        "dtDate": "2021-11-17T11:30:41-08:00",
        "cType": "expire-date",
        "cNewValue": "2022-01-31T23:59:00-08:00",
        "cOldValue": "2025-12-31T23:59:59-08:00"
    },
    {
        "nChangeID": "89113776",
        "nCouponID": "43713123",
        "dtDate": "2021-11-08T13:26:01-08:00",
        "cType": "type",
        "cNewValue": "added: Category Sale, Percent Off, Sale",
        "cOldValue": ""
    }
]
CODE

Example Response - XML

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

<?xml version="1.0" encoding="iso-8859-1" ?>
<changes>
    <change>
        <changeid>89376361</changeid>
        <couponid>43713123</couponid>
        <date>2021-11-17T11:30:41-08:00</date>
        <type>expire-date</type>
        <newvalue>2022-01-31T23:59:00-08:00</newvalue>
        <oldvalue>2025-12-31T23:59:59-08:00</oldvalue>
    </change>
    <change>
        <changeid>89113776</changeid>
        <couponid>43713123</couponid>
        <date>2021-11-08T13:26:01-08:00</date>
        <type>type</type>
        <newvalue>added: Category Sale, Percent Off, Sale</newvalue>
        <oldvalue/>
    </change>
</changes>
CODE

Example Response - CSV

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

ChangeID,CouponID,Date,Type,NewValue,OldValue
89376361,43713123,2021-11-17T11:30:41-08:00,expire-date,2022-01-31T23:59:00-08:00,2025-12-31T23:59:59-08:00
89113776,43713123,2021-11-08T13:26:01-08:00,type,"added: Category Sale, Percent Off, Sale",
CODE

Example Response - TAB

Here is an example of a TAB Response from the getChanges endpoint.

ChangeID CouponID Date Type NewValue OldValue
89376361 43713123 2021-11-17T11:30:41-08:00 expire-date 2022-01-31T23:59:00-08:00 2025-12-31T23:59:59-08:00
89113776 43713123 2021-11-08T13:26:01-08:00 type "added: Category Sale, Percent Off, Sale"
CODE

Example Response - PIPE

Here is an example of a PIPE Response from the getChanges endpoint.

ChangeID|CouponID|Date|Type|NewValue|OldValue
89376361|43713123|2021-11-17T11:30:41-08:00|expire-date|2022-01-31T23:59:00-08:00|2025-12-31T23:59:59-08:00
89113776|43713123|2021-11-08T13:26:01-08:00|type|"added: Category Sale, Percent Off, Sale"|
CODE