Get Synonym Definitions

Get synonym definitions.

GET /commerce/catalog/admin/search/synonyms

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "key": "<string>",
      "synonymId": 123,
      "synonyms": [
        "<string>"
      ]
    }
  ],
  "pageCount": 123,
  "pageSize": 123,
  "startIndex": 123,
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

startIndex · integer<int32> · default: 0

pageSize · integer<int32> · default: 0

sortBy · string

filter · string

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

Paged collection of synonyms for a Site-Locale.

items · object[] | null

Show child attributes

pageCount · integer<int32>

pageSize · integer<int32>

startIndex · integer<int32>

totalCount · integer<int32>