Retrieve a list of product categories. The product categories can be filtered by fields such as handle or q. The product categories can also be paginated. This API Route can also be used to retrieve a product category by its handle.
Request
Query Params
q
string
optional
term used to search product category's names and handles.
handle
string
optional
Filter by handle.
parent_category_id
string
optional
Filter by the ID of a parent category. Only children of the provided parent category are retrieved.
include_descendants_tree
string
optional
Whether all nested categories inside a category should be retrieved.
offset
integer
optional
The number of product categories to skip when retrieving the product categories.
limit
integer
optional
Limit the number of product categories returned.
expand
string
optional
Comma-separated relations that should be expanded in the returned product categories.
fields
string
optional
Comma-separated fields that should be included in the returned product categories.
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl--location--request GET '/store/product-categories'
Responses
🟢200OK
application/json
Body
The list of product categories with pagination fields.
count
integer
required
The total number of items available
offset
integer
required
The number of product categories skipped when retrieving the product categories.
limit
integer
required
The number of items per page
product_categories
array[object (Product Category) {15}]
required
An array of product categories details.
id
string
required
The product category's ID
Example:
pcat_01G2SG30J8C85S4A5CHM2S1NS2
name
string
required
The product category's name
Example:
Regular Fit
description
string
optional
The product category's description.
Default:
handle
string
required
A unique string that identifies the Product Category - can for example be used in slug structures.
Example:
regular-fit
mpath
string|null
required
A string for Materialized Paths - used for finding ancestors and descendents
Example:
pcat_id1.pcat_id2.pcat_id3
is_internal
boolean
required
A flag to make product category an internal category for admins
Default:
false
is_active
boolean
required
A flag to make product category visible/hidden in the store front
Default:
false
rank
integer
optional
An integer that depicts the rank of category in a tree node
Default:
0
parent_category_id
string|null
required
The ID of the parent category.
Default:
null
parent_category
object|null
optional
The details of the parent of this category.
created_at
string<date-time>
required
The date with timezone at which the resource was created.
updated_at
string<date-time>
required
The date with timezone at which the resource was updated.
category_children
array [object]
required
The details of the category's children.
products
array [object]
optional
The details of the products that belong to this category.
