shop.feature.getList
Returns the list of product features.
Parameters
-
type_id
GET
Optional
ID of a product type whose features should be returned. If not specified, the method returns the list of all product features set up in the online store.
-
format
GET
Optional
Sets response format. Available options:
json
(default),xml
.
Return value
Product feature list. The returned object’s keys are feature IDs. Its values are objects with the following keys:
- [feature_id]['id'] int Feature ID.
- [feature_id]['code'] string Feature identifier editable in the store settings.
- [feature_id]['status'] strong Feature visibility in the storefront: 'private' (not visible), 'public' (visible).
- [feature_id]['name'] string Feature name.
- [feature_id]['type'] strong Feature type.
- [feature_id]['selectable'] int Flag denoting the possibility to select feature values from a pre-defined list in the product editor: 0 (available), 1 (unavailable).
- [feature_id]['multiple'] int Flag denoting the possibility to select multiple feature values from a pre-defined list in the product editor: 0 (available), 1 (unavailable).
- [feature_id]['count'] int Number of products associated with the feature’s values.
- [feature_id]['available_for_sku'] int Flag denoting the possibility to select feature values in product variants’ properties.
- [feature_id]['default_unit'] string Default measure unit selected in the feature settings.
- [feature_id]['builtin'] int Flag denoting whether it is a system feature: 0 (ordinary), 1 (system).
- [feature_id]['values'] array Array with the list of values for features with the selectable flag.