Skip to main content
GET
/
categories
/
{categoryId}
Get Category
curl --request GET \
  --url https://api.jtl-cloud.com/erp/categories/{categoryId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'
{
  "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.

Headers

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

​
x-runas
string

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

​
x-companyid
string

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

Path Parameters

​
categoryId
integer<int32>
required

The id of the category to return.

Response

Returns the category for the given id.

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.