Create an option value

post /api/option_values

Creates a Option Value resource.

Creates a value on a Product Option - for example Medium on a Size option. Point it at the option with the productOption IRI.

Linking to an option

productOption is the IRI of the option this value belongs to, e.g. /api/product_options/{productOptionId}. The value’s position controls its order within that option.

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.

Request body

Property	Type	Required	Description
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.
value	string | null	required	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.

Response

201 - Option Value resource created

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

400 - Invalid input

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
code	string	-	Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
description	string | null	-
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
message	string	-	End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
slug	string	-	Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
status	integer | null	-
title	string | null	-	A short, human-readable summary of the problem. For a catalogued error it repeats the slug.
type	string	-	A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.

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	-

422 - An error occurred

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
description	string	-
detail	string	-
instance	string | null	-
status	integer	-
title	string | null	-
type	string	-
violations	object[]	-
Show violations fields Property Type Required Description code string - The code of the violation hint string - An extra hint to understand the violation message string required The message associated with the violation parameters object - Dynamic placeholder values for the violation message template (substitute into the code catalogue message). payload object - The serialized payload of the violation propertyPath string required The property path of the violation slug string - Stable centralized error-code slug for this violation (see /api/error-codes).