Add Synonym Definition Collection

Add or update a synonym definition collection.

POST /commerce/catalog/admin/search/synonym-definitions/{localeCode}

Error

A valid request URL is required to generate request examples

200

{
  "localeCode": "<string>",
  "siteId": 123,
  "synonymDefinitions": [
    {
      "key": "<string>",
      "synonymId": 123,
      "synonyms": [
        "<string>"
      ]
    }
  ],
  "tenantId": 123
}

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

Body

application/json

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

localeCode · string | null

The locale code to which this definition applies

siteId · integer<int32>

Read-only Site Id

synonymDefinitions · object[] | null

List of mappings for this definition

Show child attributes

tenantId · integer<int32>

Read-only TenantId

Response

200

application/json

OK

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

localeCode · string | null

The locale code to which this definition applies

siteId · integer<int32>

Read-only Site Id

synonymDefinitions · object[] | null

List of mappings for this definition

Show child attributes

tenantId · integer<int32>

Read-only TenantId