Skip to main content
POST
/
categories
Create Category
curl --request POST \
  --url https://api.jtl-cloud.com/erp/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": "Binoculars",
  "Description": "Best Binoculars",
  "ParentCategoryId": 123,
  "SortNumber": 1,
  "ActiveSalesChannels": "1-1-1"
}
'
{
  "Id": 123,
  "Name": "Binoculars",
  "Description": "Best Binoculars",
  "ParentCategoryId": 123,
  "Level": 2,
  "SortNumber": 1,
  "ActiveSalesChannels": "1-1-1"
}

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

​
api-version
string

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

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

Example:

"Binoculars"

​
Description
string
Example:

"Best Binoculars"

​
ParentCategoryId
integer<int32>
​
SortNumber
integer<int32>
Example:

1

​
ActiveSalesChannels
string[]
Example:

"1-1-1"

Response

The created category.

Model Class: Category

​
Id
integer<int32>
required
​
Name
string
required

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

Example:

"Binoculars"

​
Description
string
required

Category description in the default language of JTL-Wawi.

Example:

"Best Binoculars"

​
ParentCategoryId
integer<int32>
required
​
Level
integer<int32>
required

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

Example:

2

​
SortNumber
integer<int32>
required

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

Example:

1

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

Example:

"1-1-1"