Skip to main content
PATCH
Update Category

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

categoryId
integer<int32>
required

The id of the category to update.

Body

application/json

The category to update.

Model Class: UpdateCategory

Name
string

Name of the category in the default language of JTL-Wawi.

Description
string

Category description in the default language of JTL-Wawi.

ParentCategoryId
integer<int32>

ID of the parent category, if the category is a child category.

SortNumber
integer<int32>

The category sort number used in some sales channels for arranging the categories.

ActiveSalesChannels
string[]

The list of active sales channels for this category. The items must be activated individually. Only online shops and JTL-POS are allowed. Sales channels removed from this list will be deactivated for this category.

Response

The updated category.

Model Class: Category

Id
integer<int32>
required

Unique ID to identify a category.

Name
string
required

Name of the category in the default language of JTL-Wawi.

Description
string
required

Category description in the default language of JTL-Wawi.

ParentCategoryId
integer<int32>
required

ID of the parent category, if the category is a child category.

Level
integer<int32>
required

Returns the category level number within its category tree. A root category without a parent has a level 1.

SortNumber
integer<int32>
required

The category sort number used in some sales channels for arranging the categories.

ActiveSalesChannels
string[]
required

The list of active sales channels for this category. The items must be activated individually. Only online shops and JTL-POS are allowed. Sales channels removed from this list will be deactivated for this category.