A List Definition is a configuration template that defines a type of product list. Each list created by a customer is based on a List Definition.Documentation Index
Fetch the complete documentation index at: https://docs.omneo.io/llms.txt
Use this file to discover all available pages before exploring further.
What a List Definition controls
| Setting | Description |
|---|---|
name | Display name for this list type (e.g., “Wishlist”, “Gift Registry”) |
handle | Machine-readable identifier |
max_items | Maximum number of items a list of this type can contain |
is_shareable | Whether lists of this type can generate shareable links |
is_public | Whether shared lists are publicly accessible or require authentication |
custom_fields | Brand-defined fields available on each list item of this type |
expiry_days | Optional: number of days before a list of this type expires |
Creating and managing definitions
List Definitions are created via the List Definitions API or in CX Manager. Once a definition exists, customers can create lists of that type through Profile Portal or the SDK, and staff can view and manage them in Clienteling.Multiple definition types
A brand can have multiple List Definitions running simultaneously. For example:- A “Wishlist” definition for general saved products
- A “Wedding Registry” definition with sharing enabled and a 12-month expiry
- A “Staff Recommendations” definition only accessible via Clienteling
- A “New to You” definition managed by system automation
Content needed: step-by-step API examples for creating list definitions and managing list types in CX Manager.