Skip to main content
POST
/
categories
/
{categoryId}
/
descriptions
Create Category Description
curl --request POST \
  --url https://api.jtl-cloud.com/erp/categories/{categoryId}/descriptions \
  --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>",
  "LanguageIso": "<string>",
  "SalesChannelId": "<string>",
  "Description": "<string>",
  "SeoPath": "<string>",
  "SeoMetaDescription": "<string>",
  "SeoTitleTag": "<string>",
  "SeoMetaKeywords": "<string>"
}
'
{
  "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.

​
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

The id of the category that the descriptions belong to.

Body

application/json

The categoryDescription to create.

Model Class: CreateCategoryDescription

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

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

​
Description
string

The category description in the given language and sales channel.

​
SeoPath
string

The SEO path in the given language and sales channel.

​
SeoMetaDescription
string

The SEO metadescription in the given language and sales channel.

​
SeoTitleTag
string

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

​
SeoMetaKeywords
string

The meta keywords in the given language and sales channel.

Response

The created category description.

Model Class: CategoryDescription

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