List option values

get /api/product_options/{productOptionId}/option_values

Retrieves the collection of Option Value resources.

Returns the values of a given option, ordered by position. Set the Flowkiwi-Locale header to read translatable value strings in a given locale.

Headers

Name	Type	Required	Description
Flowkiwi-Locale	string	-	Specifies the locale for properties that support localization. If not provided, the default locale will be used.

Path parameters

Name	Type	Required	Description
productOptionId	string	required	ProductOptionResource identifier

Query parameters

Name	Type	Required	Description
properties[]	string[]	-	Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}
id[]	string[]	-	Only the items with one of these ids, each a UUID or the item IRI.
value	string	-	Filter on the translated "value" field (case-insensitive partial match, uses the Flowkiwi-Locale header).
order[value]	string	-	Order by translated field "value" (uses the Flowkiwi-Locale header)
order[createdAt]	string	-	Option Value order[createdAt]
order[updatedAt]	string	-	Option Value order[updatedAt]

Response

200 - Option Value collection

Property	Type	Required	Description
search	object	-
Show search fields Property Type Required Description @type string - mapping object[] - Show mapping fields Property Type Required Description @type string - property string | null - required boolean - variable string - template string - variableRepresentation string -
totalItems	integer	-
member	Option.Value[]	required
Show member fields Property Type Required Description @context string | object - @id string required @type string required createdAt string - The date and time when the resource was created (ISO 8601 format). id string - position integer | null - The position of the option value. Use -1 to put the option value at the end. productOption string | null required The Product Option to which this option value belongs. Requires the products:read scope. Returned null when the scope is missing. updatedAt string - The date and time when the resource was last modified (ISO 8601 format). value string | null required This property supports translations. The value of the option. variants string[] - A list of Variant, each one representing a variant associated with the option value. Requires the products:read scope. Returned empty when the scope is missing.

Errors

403 - Access denied. The caller is missing one or more permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
detail	string	-
missingPermissions	string[]	-	Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission.
status	integer	-
title	string	-
type	string	-