Skip to main content
GET
/
commerce
/
catalog
/
admin
/
search
/
synonym-definitions
/
{localeCode}
Error
A valid request URL is required to generate request examples
{
  "tenantId": 123,
  "siteId": 123,
  "localeCode": "<string>",
  "synonymDefinitions": [
    {
      "synonymId": 123,
      "key": "<string>",
      "synonyms": [
        "<string>"
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
localeCode
string
required

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Response

Success

Non-paged collection of all synonyms for a Site-Locale. Used for bulk operations

​
tenantId
integer<int32>

Read-only TenantId

​
siteId
integer<int32>

Read-only Site Id

​
localeCode
string | null

The locale code to which this definition applies

​
synonymDefinitions
object[] | null

List of mappings for this definition