+813-444-3589+44 118 328 3220+49-231-976765-0 | Contact us

Category

Categories are used by the shop to categorize products to make it easier to navigate. Each product can be associated to no, one or multiple categories.

Categories can have a hierarchical structure in which certain categories can be sub categories of others.

What can you do with Category?

The FlickRocket API lets you do the following with the Category resource. More detailed versions of these general actions may be available:

GET /api/categories.json

Receive a list of all categories.

GET /api/categories/count.json

Receive a a count of all categories.

GET /api/categories/#{id}.json

Receive a single Category

POST /api/categories.json

Create a new Category

PUT /api/categories/#{id}.json

Modify an existing Category

DELETE /api/categories/#{id}.json

Remove a Category from the database

Category Properties

comment
"comment": ""

Comment about a category. It is not used by the shop but displayed in the admin interface.

created_at
"created_at": "2008-06-27T09:40:40"

GMT date and tiem the category was created.

enabled
"enabled": false

Is set to true if the catgory is active.

id
"id": 198

Unique identifier for this category.

locales

locales: []

Localized data for this category.

"id": 1525

Unique identifier for this locale.

"title": "Great Films"

The title of this category. It is displayed in the shop. If no locale for a certain lanaguge is defined, the fallback is to english.

"seo_title": "Great Films"

The HTML title tag used for the category overview page. If not specified, it is dynamically created from the shop data.

"seo_description": "Greatest content of all times"

The HTML description tag used for the category overview page. If not specified, it is dynamically created from the shop data.

"seo_keywords": "Films, Video, Audio"

The HTML keywords tag used for the category overview page. 

"description": "Description - Sci-Fi EN"

Description fot this category. Typically this is displayed by the theme on the category overview page.

"src": ""

the URL of an image associated with this category. Can be used for download and upload.

"language": "en"

The two byte language code for this locale.

parent_id
"parent_id": 0

ID of the parent category (if exists)

position
"position": 0

The position of this category element relative to other elements of the same level. "0" is the top position.

entries

"entries": []

Array of elements for each product which are included in this category.

"created_at": "2016-04-15T09:28:44"

GMT date and time when the product was added to the category.

"id": 49043

Unique ID for referencing this element.

"product_id": "0000-E59B-5CAC-9CB2"

Product_id defining the product for this element.

title
"title": "Sci-Fi"

The title of the Category as displayed in the admin interface.

Endpoints

GET /api/categories.json

GET /api/categories.json
View Response

GET /api/categories/count.json

GET /api/categories/count.json
View Response

GET /api/categories/#id.json

GET /api/categories/1062.json
View Response

POST /api/categories.json

POST /api/categories.json
{
    "category": {
        "title": "New Category",
        "enabled": true
    }
}
View Response

POST /api/categories/#id.json

POST /api/categories/2280.json
{
	"category": {
		"id": 2280,
		"created_at": null,
		"title": "New Category",
		"parent_id": 0,
		"position": 0,
		"enabled": true,
		"comment": "",
		"locales": [{
			"language": "de",
			"title": "Neue Kategorie"
		}],
		"entries": []
	}
}
View Response

DELETE /api/categories/#id.json

DELETE /api/categories/2280.json
View Response