Skip to main content
GET
/
commerce
/
catalog
/
admin
/
search
/
synonyms
Error
A valid request URL is required to generate request examples
{
  "startIndex": 123,
  "pageSize": 123,
  "pageCount": 123,
  "totalCount": 123,
  "items": [
    {
      "synonymId": 123,
      "key": "<string>",
      "synonyms": [
        "<string>"
      ]
    }
  ]
}

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

Success

Paged collection of synonyms for a Site-Locale.

startIndex
integer<int32>
pageSize
integer<int32>
pageCount
integer<int32>
totalCount
integer<int32>
items
object[] | null