Skip to content

Attribute lists

View as Markdown

An Attribute list is an attribute whose values come from a predefined set of options - think “Color” with values Red, Green, Blue, or “Size” with S, M, L. It has a translatable name and the categories it applies to.

The attribute is the definition; each option is an Attribute list value, and a product references the option(s) that apply to it.

PropertyTypeRequiredDescription
idstring-The resource's unique identifier (UUID).
namestring | null-This property supports translations.

The name of the attribute
categoriesstring[]-A list of Category, each one representing a category associated with the attribute list.

All requests require an OAuth 2.0 bearer token and the organization scope header:

Authorization: Bearer <token>
X-Flowkiwi-Organization-Id: <organization-id>

For the translatable name, set X-Flowkiwi-Locale (and optionally X-Flowkiwi-Locale-Fallback). PATCH uses JSON Merge Patch.