Create or update searchability

patch

https://ac.cnstrc.com/v2/searchabilities/{name}

🔐 This endpoint requires HTTP authentication (either Basic or Bearer).
For authenticating with Bearer token, required scopes are: searchabilities(w).

Create or update searchability with specified name.

🚧
The Searchabilities API has been upgraded to v2. See the Facets and Searchabilities v2 migration guide for what's changing and how to migrate.

Path Params

name

string

required

Query Params

key

string

required

length between 1 and 100

The key of the index to use.

section

string

length between 1 and 100

The section of the index to use. Defaults to Products.

string

length between 1 and 100

The ID of the client and version that the request is coming from, such as cio-js-2.90.

skip_rebuild

boolean

Defaults to false

Skip index rebuild.

Body Params

fuzzy_searchable

boolean

Configure a field as fuzzy-searchable to enable typo-tolerant keyword-matching on field values in search and autocomplete. A field can be fuzzy-searchable or exact-searchable, but not both. Avoid marking very verbose fields (e.g. long descriptions) as fuzzy-searchable, since it can lead to recall of more items than is necessary and introduces complexity with ranking.

exact_searchable

boolean

Configure this field for ID or ID-like values (SKU ID, ISBN, part number, etc.) to enable exact matching only, with no typo-tolerance, for search and autocomplete. Do not use for fields containing natural language words. A field can be exact-searchable or fuzzy-searchable, but not both.

displayable

boolean

Specifies whether the field is displayable in the response within the results array. On create, omitted value inherits from the nearest (deepest) configured parent. To learn more about displayability inheritance, please visit this guide

hidden

boolean

Hides the field by default in the response but makes it available to retrieve via fmt_options[hidden_fields] parameter.

Responses

400

Bad Request

401

Credentials are not passed or action is forbidden.

403

The supplied token does not have the required permissions.

429

Rate limit breached

👋 Welcome to Constructor's new and improved documentation

200OK