Options belonging to an option set.
This is archived documentation. The V2 Catalog API is deprecated. For current API documentation, see the Catalog API.
Gets the options associated with an option set. (Default sorting is by option id, from lowest to highest.)
GET /stores/{store_hash}/v2/option_sets/{option_set_id}/options
Parameters can be added to the URL query string to paginate the collection. The maximum limit is 250. If a limit isn’t provided, up to 50 option_set_options are returned by default.
Example JSON returned in the response:
Gets an option set option.
GET /stores/{store_hash}/v2/option_sets/{option_set_id}/options/{id}
Example JSON returned in the response:
Creates a new option associated with an option set.
POST /stores/{store_hash}/v2/option_sets/{option_set_id}/options
The following properties of the option set option are read-only. If one or more of these properties are included in the request, it will be rejected.
The following properties of the option set option are required. The request won’t be fulfilled unless these properties are valid.
Example request object:
Example JSON returned in the response:
Updates an existing option set option.
PUT /stores/{store_hash}/v2/option_sets/{option_set_id}/options/{id}
The following properties of the option set option are read-only. If one or more of these properties are included in the request, it will be rejected.
The following properties of the option set option are required. The request won’t be fulfilled unless these properties are valid.
Example request object:
Example JSON returned in the response:
Deletes an option belonging to an option set.
DELETE /stores/{store_hash}/v2/option_sets/{option_set_id}/options/{id}
Deletes multiple options associated with an option set.
DELETE /stores/{store_hash}/v2/option_sets/{option_set_id}/options
Parameters can be added to the URL query string to paginate the collection. The maximum limit is 250. If a limit isn’t provided, up to 50 option_set_options are returned by default.