Lightspeed · Schema
teckelRichItemDescriptionDto
Stores an item description with its locale code.
POSRetailRestaurantEcommerce
Properties
| Name | Type | Description |
|---|---|---|
| localeCode | string | The language code (ISO 639) of the description. |
| description | string | The item description in the language of the locale. |
| displayName | string | The display name of the item in the language of the locale. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "teckelRichItemDescriptionDto",
"description": "Stores an item description with its locale code.",
"$id": "https://raw.githubusercontent.com/api-evangelist/lightspeed-pos/refs/heads/main/json-schema/restaurant-k-series-teckel-rich-item-description-dto-schema.json",
"type": "object",
"properties": {
"localeCode": {
"description": "The language code (ISO 639) of the description.",
"minLength": 2,
"maxLength": 7,
"nullable": false,
"type": "string"
},
"description": {
"description": "The item description in the language of the locale.",
"maxLength": 4000,
"type": "string"
},
"displayName": {
"description": "The display name of the item in the language of the locale.",
"type": "string"
}
},
"required": [
"localeCode"
],
"example": {
"localeCode": "fr",
"description": "Ceci est un caf\u00e9. L'apostrophe.",
"displayName": "Super expresso"
}
}