Localized strings

The Propeller REST API uses LocalizedString and LocalizedStringArray data types to handle multi-language content. These types allow you to store and retrieve content in multiple languages for entities like products, categories and surcharges.

LocalizedString

Used for fields that contain a single translatable value across multiple languages.

{
  "language": "EN",
  "value": "Product Name"
}

Property	Type	Required	Description
`language`	string	Yes	2-character language code per ISO 639-1
`value`	string	Yes	The translated text content

LocalizedString is typically used in arrays to represent content in multiple languages:

[
  { "language": "EN", "value": "Product Name" },
  { "language": "NL", "value": "Productnaam" },
  { "language": "DE", "value": "Produktname" }
]

LocalizedStringArray

Used for fields that contain multiple text values in multiple languages, such as attribute text values and media tags.

{
  "language": "EN",
  "values": ["Tag1", "Tag2", "Tag3"]
}

Property	Type	Required	Description
`language`	string	Yes	2-character language code per ISO 639-1
`values`	string[]	Yes	Array of translated text values

LocalizedStringArray is typically used in arrays to represent multiple values in multiple languages:

[
  { "language": "EN", "values": ["Electronics", "Gadgets", "Technology"] },
  { "language": "NL", "values": ["Elektronica", "Gadgets", "Technologie"] },
  { "language": "DE", "values": ["Elektronik", "Gadgets", "Technologie"] }
]

Common use cases

Product information

Products use LocalizedString for names, descriptions and keywords. Keywords are one comma-separated list per language:

{
  "names": [
    { "language": "EN", "value": "Garmin Edge 1030" },
    { "language": "NL", "value": "Garmin Edge 1030" },
    { "language": "DE", "value": "Garmin Edge 1030" }
  ],
  "descriptions": [
    { "language": "EN", "value": "High-end cycling computer with advanced features" },
    { "language": "NL", "value": "High-end fietscomputer met geavanceerde functies" },
    { "language": "DE", "value": "High-End-Fahrradcomputer mit erweiterten Funktionen" }
  ],
  "keywords": [
    { "language": "EN", "value": "cycling, computer, GPS" },
    { "language": "NL", "value": "fietsen, computer, GPS" },
    { "language": "DE", "value": "Radfahren, Computer, GPS" }
  ]
}

Attributes

Attributes use LocalizedStringArray for text values that can have multiple entries per language:

{
  "textValues": [
    { "language": "EN", "values": ["Red", "Blue", "Green"] },
    { "language": "NL", "values": ["Rood", "Blauw", "Groen"] },
    { "language": "DE", "values": ["Rot", "Blau", "Grün"] }
  ]
}

Language codes

The API uses 2-character language codes as defined by ISO 639-1.

Language	Code	Language	Code
English	`EN`	Dutch	`NL`
German	`DE`	French	`FR`
Spanish	`ES`	Italian	`IT`
Portuguese	`PT`	Swedish	`SV`
Norwegian	`NO`	Danish	`DA`
Finnish	`FI`	Polish	`PL`
Czech	`CS`	Hungarian	`HU`
Slovak	`SK`	Slovenian	`SL`
Croatian	`HR`	Serbian	`SR`
Bulgarian	`BG`	Romanian	`RO`
Greek	`EL`	Turkish	`TR`
Russian	`RU`	Ukrainian	`UK`
Japanese	`JA`	Korean	`KO`
Chinese	`ZH`	Arabic	`AR`
Hebrew	`HE`	Thai	`TH`
Vietnamese	`VI`

important

Language codes are always uppercase.

Retrieving localized content

A GET returns every language of each localized field. There is no parameter to request a single language, so pick the language you need from the array:

GET /v2/products/id/123