Get Synonym Definition Collection

Error

A valid request URL is required to generate request examples

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

GET

commerce

catalog

admin

synonym-definitions

{localeCode}

Error

A valid request URL is required to generate request examples

{
  "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

Response

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

Delete Synonym Definition

Add Synonym Definition Collection