Values of List Properties for Products: Overview of Methods

A property of type List has a set of permissible values. Each value is stored as a separate element:

• id — identifier of the list value
• propertyId — identifier of the property to which the value belongs
• value — textual value of the list element
• xmlId — external code of the list value
• def — indicator of the default value
• sort — sorting index

Quick navigation: all methods

Considerations Before Calling MethodsConsiderations Before Calling Methods

• Methods only work for properties of type List. If a property of another type is specified when adding a value, the method catalog.productPropertyEnum.add will return the error Only list properties are supported.

• The xmlId field is mandatory and must be unique within a single property.

• To read list property values and delete them, you need the "View product catalog" access permission. For creating and updating, you additionally need permission to modify the information block property.

How to Work with List Property ValuesHow to Work with List Property Values

1. Check the structure of the fields using catalog.productPropertyEnum.getFields.
2. Determine the propertyId of the list property using the method catalog.productProperty.list.
3. Request the current list values using the method catalog.productPropertyEnum.list with a filter by propertyId.
4. Add a value using the method catalog.productPropertyEnum.add or modify an existing one using the method catalog.productPropertyEnum.update.
5. Retrieve a value by id using the method catalog.productPropertyEnum.get or delete it using the method catalog.productPropertyEnum.delete.

Relationship with Other ObjectsRelationship with Other Objects

Product or Variation Property. The list value is associated with the property through propertyId. To work with properties, use the methods in the catalog.productProperty.* section.

Product Card. If a product or variation has a property of type List, the id of the required value is passed in the field of that property.

Overview of MethodsOverview of Methods

Scope: catalog

Who can execute the method: depending on the method

Method	Description
catalog.productPropertyEnum.add	Adds a list property value
catalog.productPropertyEnum.update	Modifies a list property value
catalog.productPropertyEnum.get	Returns a list property value by identifier
catalog.productPropertyEnum.list	Returns a list of list property values by filter
catalog.productPropertyEnum.delete	Deletes a list property value
catalog.productPropertyEnum.getFields	Returns the description of the fields of a list property value