List options

get /api/products/{productId}/product_options

Retrieves the collection of Product Option resources.

Returns the options declared on a product, ordered by position. Set the Flowkiwi-Locale header to read translatable title values 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
productId	string	required	ProductResource 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.
title	string	-	Filter on the translated "title" field (case-insensitive partial match, uses the Flowkiwi-Locale header).
order[title]	string	-	Order by translated field "title" (uses the Flowkiwi-Locale header)
order[createdAt]	string	-	Product Option order[createdAt]
order[updatedAt]	string	-	Product Option order[updatedAt]

Response

200 - Product Option 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	Product.Option[]	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 - The resource's unique identifier (UUID). position integer - The position of the product option. Use -1 to put the product option at the end. product string | null required The Product to which this option belongs. Requires the products:read scope. Returned null when the scope is missing. title string | null - This property supports translations. The name of the product option. updatedAt string - The date and time when the resource was last modified (ISO 8601 format).

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	-