Skip to main content
POST
/
v1
/
categories
Create Category
curl --request POST \
  --url https://api.jtl-cloud.com/erp/v1/categories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "Name": "<string>",
  "Description": "<string>",
  "ParentCategoryId": 123,
  "SortNumber": 123,
  "ActiveSalesChannels": [
    "<string>"
  ]
}
'
{
  "Id": 123,
  "Name": "<string>",
  "Description": "<string>",
  "ParentCategoryId": 123,
  "Level": 123,
  "SortNumber": 123,
  "ActiveSalesChannels": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

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

x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

X-SessionId
string<uuid>

The id of a session in which the call will be executed.

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.

Body

application/json

The category to create.

Model Class: CreateCategory

Name
string
required

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 created 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.