categories

commerce

Product category for organizing and classifying items in an e-commerce store. Supports hierarchical categories with parent-child relationships, visual styling, and item counts.

Request Builder

https://api.mockly.codes/categories?page=1&limit=10&count=10

Configure your request and click Send Request to see the response here.

Endpoints

GET/categories

Get a collection of categories

Alternative: /commerce/categories
GET/categories/:id

Get a single category by ID

Alternative: /commerce/categories/:id
GET/categories/meta

Get resource metadata and schema

Alternative: /commerce/categories/meta

How to Use Search

The search feature allows you to filter results by searching for text across all or specific fields. Choose between ?q= or ?search= parameter names.

1. Basic Search

Search across all text fields:

Basic Search
GET https://api.mockly.codes/categories?q=laptop

2. Search Specific Fields

Field-Specific Search
GET https://api.mockly.codes/categories?q=laptop&search_fields=name,description

Pro Tips

  • •Search is case-insensitive and performs partial matching
  • •Without search_fields, all text fields are searched
  • •Combine with pagination to handle large result sets efficiently

Code Examples

curl "https://api.mockly.codes/categories?page=1&limit=10&count=10"

Examples reflect your current request builder settings.

Schema Properties

idinteger

Unique identifier for the category

Gen:random_int
namestring

Display name of the category (e.g., Electronics, Clothing, Books)

Gen:category
slugstring

URL-friendly identifier for the category used in web addresses

Gen:slug
descriptionstring

Brief description of what products belong to this category

Gen:sentence
parent_idinteger

ID of the parent category if this is a subcategory, null for top-level categories

Gen:random_int
orderinteger

Display order or sort position for the category in listings

Gen:random_int
iconstring

Icon identifier or name for visual representation of the category

Gen:word
colorstring

Hex color code or color name for category branding and visual distinction

Gen:color
items_countinteger

Total number of products currently assigned to this category

Gen:random_int
created_atstring

Timestamp when the category was created

Gen:past_datedate-time

Query Parameters

countinteger

Number of items to return (default: 10, max: 100)

seedinteger

Seed for reproducible data generation

nocacheboolean

Bypass cache and generate fresh data on every request