Last updated: Oct 24 2016

Area: Episerver Commerce Applies to versions: 10
Other versions:

Customer groups

This topic describes how to work with customer groups. You can manage contacts within customer groups, and apply group-specific pricing and personalization.

Create customer groups in the Commerce Manager administration interface. Next, assign customers (users) or organizations to the customer group. Finally, when working with variants, you can assign special prices for selected customer groups.

Classes in this topic are available in the following namespaces:

  • Mediachase.Commerce.Customers
  • Mediachase.BusinessFoundation.Common

How it works

Customer Group is available as a field for both customer and organization records. The CustomerContact class exposes this field as CustomerGroup, and the Organization class exposes it as OrgCustomerGroup, with get and set public accessors available for both. These fields use a descriptive string value representation of the Customer Group to which a customer or organization belongs.

Internally, the field stores the strings as integers that map to the string values, so the acceptable values are limited by that mapping. But the acceptable values can be expanded at runtime. This capability is provided through the Business Foundation (BF) library. The acceptable values are shared between the two fields as the "ContactGroup" MetaEnum type. See MetaEnum class to learn about working with the BF dynamic enum implementation.

As a BF field, CustomerGroup does not exist in the database in the initial installation but is added when you run AutoInstallMetaDataModule during initial site load. The default values available in the field are included in code in the enum CustomerGroup.eContactGroup, although the enum is of limited use otherwise. The eContactGroup enum is fixed at compile time and will not change at runtime when the list is edited in the application or in code by external processes.

The accessor properties on the Organization and CustomerContact are the preferred means of accessing these data. If you need to access the values directly, use EntityObjectHelper.GetStringEntityEnumProperyValue(). The field name for the CustomerContact version of the BF field is stored as a constant in ContactEntity.FieldCustomerGroup, and the equivalent field name for the Organization Business Foundation field is stored as a constant in OrganizationEntity.FieldOrgCustomerGroup.

The CustomerContact class has an additional get-only property, EffectiveCustomerGroup, which combines these data.

  • If the CustomerContact is associated with an Organization, and that organization has a CustomerGroup assigned, then EffectiveCustomerGroup returns the Organization's CustomerGroup.
  • If no Organization is assigned to the CustomerContact or if the assigned Organization does not have a CustomerGroup assigned, then EffectiveCustomerGroup returns the CustomerGroup recorded on the CustomerContact record itself, if any.

This evaluation is not recursive on the Organization hierarchy, so only the Organization to which the CustomerContact belongs directly is considered. Any parent Organizations of that Organization are ignored.

Note: Pricing evaluates customer group membership based on EffectiveCustomerGroup, so use EffectiveCustomerGroup instead of CustomerGroup where possible.

Working in the UI

In this section, for ease of reading, we will use the term "entity" as a collective name for both organizations and customer contacts.

Assigning Customer Groups to entities

Customer groups are managed and assigned to entities in the Customer Management UI. Find the entity you wish to assign a customer group to, click it, then click the Edit button. From here, select an available customer group from the drop-down.

Next to the customer group drop-down is a button to edit the list of available customer groups. The same list of customer groups is used for all entities-it does not matter from which type of entity the customer group was created.

Setting prices for Customer Groups

When adding a new price for a variation, you can specify that the price should apply to a customer group.

Using customer group pricing

See Customer pricing.

Do you have feedback on this documentation? Send an email to documentation@episerver.com. For development-related questions and discussions, refer to our Forums on https://world.episerver.com/forum/