Property Groups in the Online Store: Overview of Methods

All order or shipment properties are grouped into categories: personal information, delivery details, company information, and contact information.

Each payer type has its own groups. The payer type of a created property group cannot be changed.

Quick Navigation: all methods

Linking Property Groups to Other Objects

Payer Types. Specify the payer type to which you want to associate the order property group. You can retrieve the available payer types using the sale.persontype.list method.

Order Properties. Create fields that the buyer must fill out when placing an order, such as "Metro Station" or "Delivery Date and Time." Use the sale.property.* methods to create order properties.

Shipment Properties. If there are multiple shipments in one order, create shipment properties using the sale.shipmentproperty.* methods. For example, if an order contains three books that need to be sent to different addresses, create shipment properties to specify the address for each shipment.

Overview of Methods

Scope: sale

Who can execute the methods: administrator

Method

Description

sale.propertygroup.add

Creates a property group

sale.propertygroup.update

Updates the fields of a property group

sale.propertygroup.get

Returns the values of all fields in the property group

sale.propertygroup.list

Returns a list of property groups

sale.propertygroup.delete

Deletes a property group

sale.propertygroup.getFields

Returns the available fields of property groups