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
1 validation
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

1 validation

Responses

Successful response.

1 Example
Schema
object
category
object

Describes a category

1 validation

Send a Test Request

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