Skip to main content

​
Get Category Details

GET /api/v2/category/t-shirts
Retrieve detailed information about a specific category including banners, metadata, and themes.

​
Path Parameters

​
slug
string
required
Category URL key/slug. The slug is URL-decoded and may be aliased to another category based on configuration.

​
Query Parameters

​
platform
string
Platform identifier:
  • web: Web platform (action_source = 1)
  • Other values: Mobile/app (action_source = 2)

​
Category Aliases

Some categories have predefined aliases that redirect to other categories:
  • Check settings.CAT_ALIAS for configured aliases
  • Example: toys-and-action-figures → toys-and-video-games

​
Response

​
id
integer
Category ID
​
category
string
Category name
​
url_key
string
Category URL slug
​
parent_id
integer
Parent category ID (0 if root category)
​
parent_cat
string
Parent category name
​
is_active
integer
Category active status (1 = active, 0 = inactive)
​
catBanner
array
Array of category banner objects filtered by country
​
themes
array
Array of theme objects associated with this category
​
meta_title
string
SEO meta title
​
meta_keys
string
SEO meta keywords
​
meta_desc
string
SEO meta description
​
footer_text
string
Category footer text/description
​
event_id
string
Facebook pageview event ID (web platform only)
  1. Country Filtering: Banners are filtered by country_id (default: “99” for India)
  2. Sale Period Handling: If current time is within sale_start_date and sale_end_date:
    • filename is replaced with sale_image
    • mobile_image is replaced with sale_mob_image
  3. Timezone: All date comparisons use Asia/Kolkata timezone

​
Category Hierarchy

Categories support parent-child relationships:
  • parent_id = 0: Root category
  • parent_id > 0: Child category (subcategory)
  • parent_cat: Name of the parent category

​
Themes

Themes (tags/collections) associated with the category are included:
  • Only root themes (parent_id = 0) are returned
  • Themes can be used to filter products within the category

​
Error Responses

  • 404 Not Found: Category slug doesn’t exist or category is inactive

​
Get Categories Information

GET /api/v2/categories-info
Retrieve information about all active categories, including hierarchy and metadata.

​
Response

Returns a structured object containing all active categories with their relationships and metadata.
​
categories
array
Array of category objects with full details

​
Get Mobile Cover Listing

GET /api/v2/mobile-covers
Retrieve a structured listing of mobile cover categories with subcategories.

​
Response

​
meta_data
object
SEO metadata for mobile covers category
​
data
object
Object keyed by parent category ID, each containing subcategories

​
Implementation Details

  • Queries categories where parent is “mobile-covers”
  • Groups subcategories by parent category
  • Limited to 500 results
  • Sorted by parent and subcategory sort order
  • Results are cached in long-term cache

Build docs developers (and LLMs) love

Get started for freeTalk to us