Add Synonym Definition - Kibo Documentation

Error

A valid request URL is required to generate request examples

{
  "key": "<string>",
  "synonymId": 123,
  "synonyms": [
    "<string>"
  ]
}

POST

/

commerce

/

catalog

/

admin

/

search

/

synonyms

Error

A valid request URL is required to generate request examples

{
  "key": "<string>",
  "synonymId": 123,
  "synonyms": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields

string

limits which fields are returned in the response body

Body

application/json

key

string | null

If key is defined then map is directed

synonymId

integer<int32> | null

The unique identifier for the synonym definition

synonyms

string[] | null

List of synonyms. If no key is defined the matches are bidirectional

Response

OK

key

string | null

If key is defined then map is directed

synonymId

integer<int32> | null

The unique identifier for the synonym definition

synonyms

string[] | null

List of synonyms. If no key is defined the matches are bidirectional

Get Synonym Definitions

Get shipment release rule by code