post

/shopgate.catalog.getCategoryChildren.v1

This pipeline will retrieve the sub-categories of one specific category.

Request Body

Schema
object
categoryId
string

The categoryId for which you want to retrieve children

required
sort
string

How to sort the result, if you use relevance the merchants shopsystem or import will decide the order

Allowed Values: nameAsc, nameDesc, relevance
default: relevance

Responses

Successful response.

1 Example
Schema
object
categories
array[object]
id
string

the category-number or unique id inside this specific shop

required
name
string

the display-name of this category

required
productCount
integer

Combined number of prodcts in the current and all subcategories

1 validation + required
imageUrl
string

the category-image

required
childrenCount
integer

It is the number of direct sub categories

1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
host