Versions Compared

Old Version 1

changes.mady.by.user Joshua Hutter

Saved on

compared with

New Version Current

changes.mady.by.user Joshua Hutter

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Glossary

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

Term

Abbreviation

Definition

Slug

Slug

The unique identifying part of a web address, typically at the end of the URL

A URL safe string used to identify an entity, usually generated by the name of the entity.

API Endpoints

...

deal-types

Request Parameters

Name

Value(s)

Description

Required

Default

key

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

v2

JSON

slug

Boolean

We recently consolidated our deal types. To receive a list of our active deal types include v2 parameter or enable V2 in your Feed Settings page.

No

String

Filter by deal type to only return the passed in deal type

No

N/A, by default will return all deal types

Implementation

Response Elements

Name

Description

Slug

slug

The unique slug assigned to the type.

Name

name

The human readable name of the type.

id

The FMTC ID of the deal type to be used in other FMTC endpoints.

Example Response - JSON

Here is an example of a JSON Response from the getTypes deal-types endpoint.

Code Block
[
    {
        "cSlug"id": "apofreeshipping",
    14,
   "cNamename": "APO Free Shipping"
    },
    {
   
    "cSlugslug": "bogo",
        "cName": "BOGO"
    }
]apofreeshipping"
}

Example Response - XML

Here is an example of an XML Response from the getTypes deal-types endpoint.

Code Block
<?xml version="1.0" encoding="iso-8859-1" ?>
<types><dealType>
    <type>
        <slug>apofreeshipping</slug>
 <id>14</id>
      <name>APO Free Shipping</name>
    </type>
    <type>
        <slug>bogo</slug>
        <name>BOGO</name>
    </type>
</types><slug>apofreeshipping</slug>
</dealType>

Example Response - CSV

Here is an example of a CSV Response from the getTypes deal-types endpoint.

Code Block
Slugid,name,Nameslug
apofreeshipping14,"APO Free Shipping"
bogo,BOGOapofreeshipping

Example Response - TAB

Here is an example of a TAB Response from the getTypes deal-types endpoint.

Code Block
Slug,Name
apofreeshipping,id	name	slug
14	"APO Free Shipping"
bogo,BOGO	apofreeshipping

Example Response - PIPE

Here is an example of a PIPE Response from the getTypes deal-types endpoint.

Code Block
Slugid|name|Nameslug
apofreeshipping14|"APO Free Shipping"
bogo|BOGOapofreeshipping