| 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.
API Endpoints
getCategories
Description: Use this service call to get information about categories supported by FMTC.
Example Request: http://services.fmtc.co/v2/getCategories?key=APIKEY
getCategories
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
...
format
...
String
XML, JSON, CSV, TAB, or PIPE
...
Choose the feed format you would like returned.
...
No
...
v2
...
0,1
...
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
...
debug
...
0,1
...
Prints debug information and exits
...
No
...
0
...
view
...
0,1
...
Display feed results rather than forcing a download
...
No
...
0
Implementation
Response Elements
...
Name
...
Description
...
Slug
...
The unique slug assigned to the category.
...
Name
...
The human readable name of the category.
...
ParentID
...
The numerical ID of the parent category.
...
CategoryID
...
The unique numerical ID assigned to the category
...
Restricted
...
Flag value indicating if the category is a restricted-content category.
Example Response - JSON
Here is an example of a JSON Response from the getCategories endpoint.
| Code Block |
|---|
[
{
"cSlug": "julyfourth",
"cName": "4th Of July",
"cParent": "",
"bHoliday": "1"
},
{
"cSlug": "apparel",
"cName": "Apparel",
"cParent": "",
"bHoliday": "0"
},
{
"cSlug": "accessories",
"cName": "Accessories",
"cParent": "apparel",
"bHoliday": "0"
}
] |
Example Response - XML
Here is an example of an XML Response from the getCategories endpoint.
| Code Block |
|---|
<?xml version="1.0" encoding="iso-8859-1" ?>
<categories>
<category>
<cSlug>julyfourth</cSlug>
<name>4th Of July</name>
<parent/>
<holiday>1</holiday>
</category>
<category>
<cSlug>apparel</cSlug>
<name>Apparel</name>
<parent/>
<holiday>0</holiday>
</category>
<category>
<cSlug>accessories</cSlug>
<name>Accessories</name>
<parent>apparel</parent>
<holiday>0</holiday>
</category>
<category>
<cSlug>apparel-baby</cSlug>
<name>Apparel - Baby & Kids</name>
<parent>apparel</parent>
<holiday>0</holiday>
</category>
</categories> |
Example Response - CSV
Here is an example of a CSV Response from the getCategories endpoint.
| Code Block |
|---|
Slug,Name,Parent
julyfourth,"4th Of July",
apparel,Apparel,
accessories,Accessories,apparel |
Example Response - TAB
Here is an example of a TAB Response from the getCategories endpoint.
| Code Block |
|---|
Slug Name Parent
julyfourth "4th Of July"
apparel Apparel
accessories Accessories apparel |
Example Response - PIPE
Here is an example of a PIPE Response from the getCategories endpoint.
...
FMTC has a multitude of deals available in the system. This is the endpoint to use to know how FMTC has categorized all of the deals in the system, and see how to differentiate between all the categories inside the other FMTC API endpoints, such as getDeals.
...
v2 (Legacy) of the getCategories API endpoint.
...