Learn more with this article about specifications.

If you wish to implement color variation in your products, we recommend you do not use specifications. Instead, see this tutorial about How to implement product color variation.

Field	Description	Required	Format	Default
Id	ID of Specification. This Id is used to delete/update the specification	No	Integer	AutoIncrement
ProductId	ID of Product	Yes	Integer	-
FieldId	Field ID	Yes	Integer	-
FieldValueId	ID of FieldValue. ONLY for FieldTypeId(5,6,7).	Mandatory for 5,6,7. MUST NOT be used for any other field types	Integer	null
Text	Value of specification. Only for FieldTypeId different from (5,6,7)	Mandatory for all fields EXCEPT 5,6,7 where it MUSTN’T be used	String	null

To create a product specification, use the API below. Remembering that you must have saved the ID of the field for which you want to create a specification.

If the specification field is of the Combo, Radio or Checkbox type (FieldTypeId of 5, 6 and 7 respectively), the FieldValueId field is required and the Text field is not.\n- For text type fields, it is not necessary to create values for the field, that is, the FieldValueId attribute must be null and the Text attribute must be provided with the specification value.

POST

Body:

Header:

Response:

POST

Body:

Headers:

Response:

To get all specification fields and values from a product, use the Get product specification and its information by product ID endpoint. See an example response below.

To update a product specification use the Update a product specification by product ID API endpoint. It's also possible to update specification values in bulk.

Updating product specification by fieldName does not work.

Example request

Body:

Response:

To remove a specification from a product, use the Delete product specification API endpoint.

To delete all specifications registered in a product, use the Delete all product specification API endpoint.