Synonyms

Synonym dictionaries configure the analyzer used by the tenant's search surface. Each dictionary maps alternate terms to a canonical one so searching for "faucet" finds "tap" and vice versa.

Endpoints

GET/api/b2b/pim/synonym-dictionariesauth: session
GET/api/b2b/pim/synonym-dictionaries/:idauth: session
POST/api/b2b/pim/synonym-dictionariesauth: session
PATCH/api/b2b/pim/synonym-dictionaries/:idauth: session
DELETE/api/b2b/pim/synonym-dictionaries/:idauth: session
POST/api/b2b/pim/synonym-dictionaries/:id/publishauth: session

Entry formats

Two synonym formats are supported — the dictionary applies both.

  • Equivalent: faucet, tap, spigot — all terms are interchangeable.
  • Explicit: faucet => tap, spigot — left-hand terms expand to the right-hand ones only.