Create facet option

post

https://ac.cnstrc.com/v1/facets/{facet_name}/options

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

Create facet option for the given facet_name.

Path Params

facet_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.

Body Params

value

string

required

length ≤ 200

A value for this facet option. Must be unique for particular facet.

value_alias

string

length ≤ 200

A value alias. It is used to merge several different but semantically similar facet options into one. For example, 'dark blue' and 'light blue' can be aliased to 'blue'.

replace_value_alias

boolean

Defaults to true

Determines the handling of a value alias when present. If set to true, exclusively considers the aliased value. If false, both the original and the aliased values are used.

display_name

string

length ≤ 200

A display name for this facet option.

position

integer

Used to order facet options.

data

object

Dictionary with any extra facet option data. Default value is null.

hidden

boolean

Defaults to false

Specifies whether the facet option is hidden from users.

Responses

400

Validation Error

401

Credentials are not passed or action is forbidden.

403

The supplied token does not have the required permissions.

404

Not Found

409

Conflict

429

Rate limit breached

👋 Welcome to Constructor's new and improved documentation

200OK