Attribute

List attribute options

Changed on

Returns attribute options with their translations, ordered by sort order. Pass attribute_id to list one attribute's options — a boolean attribute returns its No (id 0) and Yes (id 1) options — and search to match the option label in the current locale or its admin name. Public endpoint.

get/attribute-options

Request

Query parameters

attribute_idinteger
Example:23

Only the options of this attribute. Returns 404 when the attribute does not exist.

searchstring
Example:red

Partial match on the option label (current locale) or admin name.

pageinteger

The collection page number

per_pageinteger

The number of items per page

Headers

X-STOREFRONT-KEYstring required

Storefront API Key for authentication. Required for all shop/storefront API requests.

X-Localestring
Example:en

Locale code for localized data (e.g. "en", "fr", "ar"). Defaults to channel's default locale.

X-Channelstring
Example:default

Channel code (e.g. "default"). Defaults to the current channel.

X-Currencystring
Example:USD

Currency code (e.g. "USD", "EUR", "INR"). Defaults to channel's base currency.

Response

List of attribute options.

Changes

    • info

      added the new optional query request parameter attribute_id

    • info

      added the new optional query request parameter search