Skip to main content
POST
/
v1
/
properties
/
{propertyId}
/
values
/
{propertyValueId}
/
descriptions
Create Property Value Description
curl --request POST \
  --url https://api.jtl-cloud.com/erp/v1/properties/{propertyId}/values/{propertyValueId}/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 '
{
  "PropertyValueId": 123,
  "Name": "<string>",
  "LanguageIso": "<string>",
  "Description": "<string>",
  "SeoPath": "<string>",
  "SeoMetaDescription": "<string>",
  "SeoTitleTag": "<string>",
  "SeoMetaKeywords": "<string>"
}
'
{
  "PropertyValueId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "SeoPath": "<string>",
  "SeoMetaDescription": "<string>",
  "SeoTitleTag": "<string>",
  "SeoMetaKeywords": "<string>",
  "LanguageIso": "<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

propertyId
integer<int32>
required

The id of the property.

propertyValueId
integer<int32>
required

The id of the property value.

Body

application/json

The PropertyValueDescription to create.

Model Class: CreatePropertyValueDescription

PropertyValueId
integer<int32>
required

Unique ID to identify a property value.

Name
string
required

The property value name in the given language.

LanguageIso
string
required

The ISO code of the language of the description.

Description
string

The property value description in the given language.

SeoPath
string

The SEO path in the given language.

SeoMetaDescription
string

The SEO metadescription in the given language.

SeoTitleTag
string

The title tag (SEO) in the given language.

SeoMetaKeywords
string

The meta keywords in the given language.

Response

The created property value description.

Model Class: PropertyValueDescription

PropertyValueId
integer<int32>
required

Unique ID to identify a property value.

Name
string
required

The property value name in the given language.

Description
string
required

The property value description in the given language.

SeoPath
string
required

The SEO path in the given language.

SeoMetaDescription
string
required

The SEO metadescription in the given language.

SeoTitleTag
string
required

The title tag (SEO) in the given language.

SeoMetaKeywords
string
required

The meta keywords in the given language.

LanguageIso
string
required

The ISO code of the language of the description.