Product Feature Variants

GET /features/

curl -X GET 'http://example.com/api/features'

This example request returns the list of product features with their properties.

GET /features/:id/

curl -X GET 'http://example.com/api/features/14'

This example request returns the properties of the product feature with feature_id=14.

POST /features/

Send the data in the body of the HTTP request. The data should comply with the content-type.

If you successfully create a feature, you will receive HTTP/1.1 201 Created.

If the feature couldn’t be created, you will receive HTTP/1.1 400 Bad Request.

Required fields: company_id, description, feature_type

Available fields: company_id, feature_type, purpose, feature_style, filter_style, parent_id, display_on_product, display_on_catalog, display_on_header, description, lang_code, prefix, suffix, categories_path, full_description, status, comparison, position, variants

curl --header 'Content-type: application/json' -X POST 'http://example.com/api/features' --data-binary '{"company_id":"1", "feature_type":"C", "description":"Handmade", "status":"A"}'

This example request creates a new checkbox feature called Handmade in the store with the company_id=1. The status of this product feature is set to Active.

In the response you receive the ID of the feature.

{feature_id: 22}

PUT /features/:id/

Send the data in the body of the HTTP request. The data should comply with the content-type.

Required fields: company_id, description, feature_type

Available fields: company_id, feature_type, parent_id, display_on_product, display_on_catalog, display_on_header, description, lang_code, prefix, suffix, categories_path, full_description, status, comparison, position, variants

curl --header 'Content-type: application/json' -X PUT 'http://example.com/api/features/22' --data-binary '{"company_id":"1", "feature_type":"S", "comparison":"Y", "variants":[{"variant": "Unique"}, {"variant": "Mass-produced"}]}'

This example request turns the feature with feature_id=22 (Handmade in our case) into a Select Box: Text feature and creates 2 new variants for it: Unique and Mass-produced. The request also makes this feature appear on the product comparison page.

To update an already existing variant, add its variant_id to the object:

curl --header 'Content-type: application/json' -X PUT 'http://example.com/api/features/22' --data-binary '{"company_id":"1", "feature_type":"S", "variants":[{"variant_id":"150", "variant":"Unique"}, {"variant_id":"151", "variant":"Mass-produced"}]}'

This example request updates the variants of the the feature with feature_id=22 (Handmade in our case)

In the response you receive the ID of the feature.

{feature_id: 22}

DELETE /features/:id/

If you successfully delete a product feature, you will receive HTTP/1.1 204 No Content.

If the product feature couldn’t be deleted, you will receive HTTP/1.1 400 Bad Request.

If the product feature doesn’t exist, you will receive HTTP/1.1 404 Not Found.

curl -X DELETE 'http://example.com/api/features/22'

This example request deletes the product feature with the feature_id=22.

Learn a Product’s Features

To get the features of a product use the following method:

curl -X GET 'http://example.com/api/products/14/features'

This example request returns the list of features of a product with product_id=14.

Create a Product with a Feature

Suppose we have a product feature of the Other: Text type with feature_id=23.

Let’s specify the value of this feature as we create a new product with POST /products/.

Send the data in the body of the HTTP request. The data should comply with the content-type.

curl --header 'Content-type: application/json' -X POST 'http://example.com/api/products' --data-binary '{"product": "New Product", "category_ids": "223", "main_category": "223", "price": "10", "status": "A", "product_features": {"23": {"feature_type": "T", "value": "Test"}}}'

This example request creates a new product with the value of the feature set to Test.

If you successfully create a product, you will receive the ID of the product in the response.

{product_id: 250}

Update a Product’s Feature

Update a feature of a product using PUT /products/:id/.

Send the data in the body of the HTTP request. The data should comply with the content-type.

curl --header 'Content-type: application/json' -X PUT 'http://example.com/api/products/250' --data-binary {"product_features": {"23": {"feature_type": "T", "value": "Feature updated"}}}

This example request updates the product with product_id=250. It sets the value of the text feature with feature_id=23 to Feature updated.

In the response you receive the ID of the product.

{product_id: 250}