Skip to main content
POST
Create Item 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

itemId
integer<int32>
required

Body

application/json

The itemDescription to create.

Model Class: CreateItemDescription

Name
string
required

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

Example:

"Interdimensional goggles"

LanguageIso
string
required

The ISO code of the language for the description.

Example:

"DE"

SalesChannelId
string
required
Example:

"1-1-1"

Description
string
Example:

"These goggles are a must have product. Everyone needs them. Buy them."

ShortDescription
string
Example:

"The best goggles anyone can buy."

SeoPath
string
Example:

"Interdimensional-goggles"

SeoMetaDescription
string
Example:

"A meta description"

SeoTitleTag
string
Example:

"Interdimensional goggles"

SeoMetaKeywords
string
Example:

"Interdimensional, Vision, Goggles"

Response

The created item description.

Model Class: ItemDescription

ItemId
integer<int32>
required
Name
string
required

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

Example:

"Interdimensional goggles"

Description
string
required

The item description for the given language and sales channel.

Example:

"These goggles are a must have product. Everyone needs them. Buy them."

ShortDescription
string
required

An item's short description in the given language and sales channel.

Example:

"The best goggles anyone can buy."

SeoPath
string
required

The SEO path in the given language and sales channel.

Example:

"Interdimensional-goggles"

SeoMetaDescription
string
required

The SEO meta description in the given language and sales channel.

Example:

"A meta description"

SeoTitleTag
string
required

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

Example:

"Interdimensional goggles"

SeoMetaKeywords
string
required

Meta keywords in the given language and sales channel.

Example:

"Interdimensional, Vision, Goggles"

LanguageIso
string
required

The ISO code of the language for the description.

Example:

"DE"

SalesChannelId
string
required
Example:

"1-1-1"