post

/shopgate.catalog.getCategory.v1

This pipeline will retrieve one specific category and, if “includeChildren” is set to true, it’s child categories. If it’s set to false, the “children” property will be set to an empty array. It will also add a property “parent”, which holds the id and name of the parent category, of the retrieved one.

Request Body

Schema
object
categoryId
string

The categoryId of the category you want to retrieve

required
includeChildren
boolean
default: false
childrenSort
string

If children are included, they will be sorted by this. If relevance is selected, the merchants shop system or import decides the order

Allowed Values: nameAsc, nameDesc, relevance

Responses

Successful response.

1 Example
Schema
object
category
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
parent
object

If the retrieved parent is not the root/default one, this will hold basic information about the parent category, of the retrieved one.

required
children
array[object]

If includeChildren is true, this property will hold the child categories of the retrieved one

Send a Test Request

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