Update a sort option

patch

https://ac.cnstrc.com/v1/sort_option/{sort_by}/{sort_order}

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

Update existing sort option. Note that total number of sort options is limited, and every combination of sort_by and sort_order fields among the sort options must be unique.

Path Params

sort_by

string

required

sort_order

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

display_name

string

length between 1 and 200

The name of the sort option as it is displayed to end users.

path_in_metadata

string

length ≤ 200

The path in the item's metadata to the field that results will be sorted according to.

position

integer

The position of the sort option, used to provide sort options in a specific order.

hidden

boolean

Defaults to false

Indicates if a sort option is hidden. This can be marked at sort_by level. A hidden sort option will be ignored in response by default.

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

429

Rate limit breached

👋 Welcome to Constructor's new and improved documentation

200OK