API Reference

This guide explains how to manage customer data in Omnium. It covers both private and business customers, as well as how to use features like the Customer Club, track points, and update customer profiles. The API allows you to handle customer interactions efficiently.

Customers

Omnium allows you to manage customer data for both private and business customers. Below are the key details for each customer type and their associated features.

Private and Business Customers

Omnium provides models for both private and business customers:

Private Customers: Omnium Private Customer Model
Business Customers: Omnium Business Customer Model

Customer Club

The Customer Club feature in Omnium can be turned on or off, depending on your needs. When active, it adds the ability to track membership, manage consents, and use customer-related features.

Functionality

The system checks membership status, consents, and other relevant information when items are added to the shopping cart.
Enabling the Customer Club gives you access to features like customer segmentation, newsletters, and tracking of consents and opt-outs.

API Usage

If the Customer Club is enabled, use the Customer Club Member API endpoints to manage membership data.
If the feature is disabled, the isCustomerClubMember attribute in the customer data is used to check membership status. This provides limited functionality but still supports promotions and campaigns.

Customer Club Model

For more details on the Customer Club structure, refer to the Omnium Customer Club Member Model.