FMTC Knowledge Base
FMTC Knowledge Base
Breadcrumbs

Categories - 4.0.0

Glossary

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

Term

Abbreviation

Definition

Slug

Slug

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

API Endpoints

What’s New?

  • Return an error upon mismatching request parameters.

categories

Request Parameters

Name

Value(s)

Description

Required

Default

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

JSON

slug

String

Choose the category slugs that you want returned.

No

N/A, by default all categories will be returned unless specified

Implementation

Response Elements

Name

Description

slug

The unique slug assigned to the category. The sub-categories will have an addition of the parent category at the beginning of the string. For example, see below (Bird Supplies).

name

The human readable name of the category.

parent_id

The numerical ID of the parent category.

id

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 categories endpoint.

[
  {
    "id": 1,
    "parent_id": 0,
    "name": "Animals & Pet Supplies",
    "slug": "animals-pet-supplies",
    "restricted": 0
  },
  {
    "id": 5,
    "parent_id": 1,
    "name": "Bird Supplies",
    "slug": "animals-pet-supplies-bird-supplies",
    "restricted": 0
  },
  {
    "id": 12,
    "parent_id": 1,
    "name": "Cat Supplies",
    "slug": "animals-pet-supplies-cat-supplies",
    "restricted": 0
  },
  {
    "id": 13,
    "parent_id": 1,
    "name": "Dog Supplies",
    "slug": "animals-pet-supplies-dog-supplies",
    "restricted": 0
  },
  {
    "id": 368,
    "parent_id": 1,
    "name": "Horse Supplies",
    "slug": "animals-pet-supplies-horse-supplies",
    "restricted": 0
  }
]

Example Response - XML

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

<?xml version="1.0" encoding="iso-8859-1" ?>
<category>
  <id>1</id>
  <parent_id>0</parent_id>
  <name>Animals & Pet Supplies</name>
  <slug>animals-pet-supplies</slug>
  <restricted>0</restricted>
</category>
<category>
  <id>5</id>
  <parent_id>1</parent_id>
  <name>Bird Supplies</name>
  <slug>animals-pet-supplies-bird-supplies</slug>
  <restricted>0</restricted>
</category>
<category>
  <id>12</id>
  <parent_id>1</parent_id>
  <name>Cat Supplies</name>
  <slug>animals-pet-supplies-cat-supplies</slug>
  <restricted>0</restricted>
</category>
<category>
  <id>13</id>
  <parent_id>1</parent_id>
  <name>Dog Supplies</name>
  <slug>animals-pet-supplies-dog-supplies</slug>
  <restricted>0</restricted>
</category>
<category>
  <id>368</id>
  <parent_id>1</parent_id>
  <name>Horse Supplies</name>
  <slug>animals-pet-supplies-horse-supplies</slug>
  <restricted>0</restricted>
</category>

Example Response - CSV

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

id,parent_id,name,slug,restricted
1,0,"Animals & Pet Supplies",animals-pet-supplies,0
5,1,"Bird Supplies",animals-pet-supplies-bird-supplies,0
12,1,"Cat Supplies",animals-pet-supplies-cat-supplies,0
13,1,"Dog Supplies",animals-pet-supplies-dog-supplies,0
368,1,"Horse Supplies",animals-pet-supplies-horse-supplies,0

Example Response - TAB

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

id	parent_id	name	slug	restricted
1	0	"Animals & Pet Supplies"	animals-pet-supplies	0
5	1	"Bird Supplies"	animals-pet-supplies-bird-supplies	0
12	1	"Cat Supplies"	animals-pet-supplies-cat-supplies	0
13	1	"Dog Supplies"	animals-pet-supplies-dog-supplies	0
368	1	"Horse Supplies"	animals-pet-supplies-horse-supplies	0

Example Response - PIPE

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

id|parent_id|name|slug|restricted
1|0|"Animals & Pet Supplies"|animals-pet-supplies|0
5|1|"Bird Supplies"|animals-pet-supplies-bird-supplies|0
12|1|"Cat Supplies"|animals-pet-supplies-cat-supplies|0
13|1|"Dog Supplies"|animals-pet-supplies-dog-supplies|0
368|1|"Horse Supplies"|animals-pet-supplies-horse-supplies|0