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
order[createdAt]	string	-
order[updatedAt]	string	-
title	string	-	Filter on translated field (strategy: ipartial)
order[title]	string	-	Order by translated field "title" (uses the Flowkiwi-Locale header)

Response

200 - Product Option collection

Property	Type	Required	Description
totalItems	integer	-
search	object	-
Show search fields Property Type Required Description @type string - template string - variableRepresentation string - mapping object[] - Show mapping fields Property Type Required Description @type string - variable string - property string | null - required boolean -
member	Product.Option[]	required
Show member fields Property Type Required Description @context object - @id string required @type string required id string - The resource's unique identifier (UUID). title string | null - This property supports translations. The name of the product option. position integer - The position of the product option. Use -1 to put the product option at the end. product string required The Product to which this option belongs. createdAt string - The date and time when the resource was created (ISO 8601 format). 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 identity permissions required for this operation.

Content-Type: application/problem+json

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