Order Property Values in an Online Store: Overview of Methods

A property value refers to the actual data transmitted in the order field during checkout. For instance, this includes the phone number, delivery address, delivery date, or customer comments. These values are essential for processing a specific order, transmitting data for delivery and payment, and maintaining accurate information in the order detail form.

Each property value is defined by a set of fields:

• id — identifier of the property value
• name — name of the property
• orderId — identifier of the order
• code — symbolic code of the property
• orderPropsId — identifier of the order property
• orderPropsXmlId — external identifier of the order property
• value — value of the order property

Quick Navigation: all methods

Considerations Before Calling MethodsConsiderations Before Calling Methods

• The methods sale.propertyvalue.* are accessible only to administrators.
• The value field is transmitted in a format that corresponds to the type of order property. For the FILE type, use the object sale_order_property_value_file_value; for other types, use string. The property type can be obtained using the methods sale.property.get and sale.property.list.
• The method sale.propertyvalue.modify accepts a complete set of order property values. If some values are not provided, the current values of those properties will be deleted.

How to Start Working with Property ValuesHow to Start Working with Property Values

1. Obtain orderId using the method sale.order.get or sale.order.list.
2. Retrieve orderPropsId using the method sale.property.list.
3. Check available fields using the method sale.propertyvalue.getFields.
4. View current values through sale.propertyvalue.list or sale.propertyvalue.get.
5. Prepare a complete set of order property values and update it using the method sale.propertyvalue.modify.
6. If necessary, delete a specific property value using the method sale.propertyvalue.delete.

Relationship with Other ObjectsRelationship with Other Objects

Order. Property values are always tied to a specific order through orderId. To work with an order, use the methods in the sale.order.* section.

Order Properties. A value pertains to a specific property via orderPropsId. To work with order properties, use the methods in the sale.property.* section.

Property Binding. The visibility and display conditions of a property during order checkout are configured separately using the methods in the sale.propertyRelation.* section.

Overview of MethodsOverview of Methods

Scope: sale

Who can execute the methods: administrator

Method	Description
sale.propertyvalue.modify	Modifies the property value
sale.propertyvalue.get	Retrieves the property value by identifier
sale.propertyvalue.list	Retrieves a list of property values
sale.propertyvalue.delete	Deletes the property value
sale.propertyvalue.getFields	Returns available fields for the property value