Skip to main content
GET
/
v1
/
items
/
{itemId}
/
descriptions
Query Item Descriptions
curl --request GET \
  --url https://api.jtl-cloud.com/erp/v1/items/{itemId}/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>'
[
  {
    "ItemId": 123,
    "Name": "<string>",
    "Description": "<string>",
    "ShortDescription": "<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

​
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

​
itemId
integer<int32>
required

The id of the item that the descriptions belong to.

Response

The requested item descriptions.

​
ItemId
integer<int32>
required

Unique ID to identify an item.

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

​
Description
string
required

The item description for the given language and sales channel.

​
ShortDescription
string
required

An item's short 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 meta description in the given language and sales channel.

​
SeoTitleTag
string
required

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

​
SeoMetaKeywords
string
required

Meta keywords in the given language and sales channel.

​
LanguageIso
string
required

The ISO code of the language for the description.

​
SalesChannelId
string
required

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