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-tenant-id: <x-tenant-id>'
[
  {
    "CategoryId": 123,
    "Name": "<string>",
    "Description": "<string>",
    "SeoPath": "<string>",
    "SeoMetaDescription": "<string>",
    "SeoTitleTag": "<string>",
    "SeoMetaKeywords": "<string>",
    "LanguageIso": "<string>",
    "SalesChannelId": "<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 that the descriptions belong to.

Response

The requested category descriptions.

​
CategoryId
integer<int32>
required

Unique ID to identify a category.

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

​
Description
string
required

The category description in the given language and sales channel.

​
SeoPath
string
required

The SEO path in the given language and sales channel.

​
SeoMetaDescription
string
required

The SEO metadescription in the given language and sales channel.

​
SeoTitleTag
string
required

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

​
SeoMetaKeywords
string
required

The meta keywords in the given language and sales channel.

​
LanguageIso
string
required

The ISO code of the language of the description.

​
SalesChannelId
string
required

The sales channel ID of the description. Only specific sales channels are allowed for this operation and are specified in the sales channel endpoint(GET).