Skip to main content
GET
/
categories
/
{categoryId}
/
descriptions
Query Category Descriptions
curl --request GET \
  --url https://api.jtl-cloud.com/erp/categories/{categoryId}/descriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>'
[
  {
    "CategoryId": 123,
    "Name": "Binoculars",
    "Description": "Best Binoculars",
    "SeoPath": "binoculars",
    "SeoMetaDescription": "Best Binoculars",
    "SeoTitleTag": "Best Binoculars",
    "SeoMetaKeywords": "Best, Binoculars",
    "LanguageIso": "DE",
    "SalesChannelId": "1-1-0"
  }
]

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.

Path Parameters

​
categoryId
integer<int32>
required

Response

The requested category descriptions.

​
CategoryId
integer<int32>
required
​
Name
string
required

The category name in the given language and sales channel. The name in JTL-Wawi and the default language is the default name of the category.

Example:

"Binoculars"

​
Description
string
required

The category description in the given language and sales channel.

Example:

"Best Binoculars"

​
SeoPath
string
required

The SEO path in the given language and sales channel.

Example:

"binoculars"

​
SeoMetaDescription
string
required

The SEO metadescription in the given language and sales channel.

Example:

"Best Binoculars"

​
SeoTitleTag
string
required

The title tag (SEO) in the given language and sales channel.

Example:

"Best Binoculars"

​
SeoMetaKeywords
string
required

The meta keywords in the given language and sales channel.

Example:

"Best, Binoculars"

​
LanguageIso
string
required

The ISO code of the language of the description.

Example:

"DE"

​
SalesChannelId
string
required
Example:

"1-1-0"