This is archived documentation. The V2 Catalog API is deprecated. For current API documentation, see the Catalog API.
A reusable set of option facets that can be applied to products.
Gets the collection of option sets. (Default sorting is by option-set id, from lowest to highest.)
GET /stores/{store_hash}/v2/option_sets
Filter parameters can be added to the URL query string to select specific option_sets in the collection.
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_sets are returned by default.
Example JSON returned in the response:
Gets an option set.
GET /stores/{store_hash}/v2/option_sets/{id}
Example JSON returned in the response:
Gets a count of the number of option sets in the store.
GET /stores/{store_hash}/v2/option_sets/count
Example JSON returned in the response:
Creates a new Option set.
POST /stores/{store_hash}/v2/option_sets
The following properties of the option set 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 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.
PUT /stores/{store_hash}/v2/option_sets/{id}
The following properties of the option set 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 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 set.
DELETE /stores/{store_hash}/v2/option_sets/{id}
Deletes all option sets in the store.
DELETE /stores/{store_hash}/v2/option_sets