Skip to main content
POST
Create Category Description

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-runas
string

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

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

categoryId
integer<int32>
required

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.

Example:

"Binoculars"

LanguageIso
string
required

The ISO code of the language of the description.

Example:

"DE"

SalesChannelId
string
required
Example:

"1-1-0"

Description
string
Example:

"Best Binoculars"

SeoPath
string
Example:

"binoculars"

SeoMetaDescription
string
Example:

"Best Binoculars"

SeoTitleTag
string
Example:

"Best Binoculars"

SeoMetaKeywords
string
Example:

"Best, Binoculars"

Response

The created category description.

Model Class: CategoryDescription

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"