List Definitions - Omneo API

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.

What a List Definition controls

Setting	Description
`name`	Display name for this list type (e.g., “Wishlist”, “Gift Registry”)
`handle`	Machine-readable identifier
`type`	Free-form category string for grouping list types
`allow_new`	Whether customers and staff can create new lists of this type
`allow_share`	Whether lists of this type can generate share codes
`allow_quantity`	Whether items record a quantity
`allow_reserve`	Whether others can reserve items on a shared list
`allow_custom_product`	Whether items that are not in the Omneo product catalogue can be added
Reservation expiry	Optional period after which reservations on lists of this type lapse

Custom fields for list-level and item-level data are configured separately as list custom fields. For the full field reference, defaults and API examples, see List Definitions in the developer guides.

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, quantities and reservations enabled
A “Staff Recommendations” definition only accessible via Clienteling
A “New to You” definition managed by system automation

See List Definitions for API examples, and Working with Product Lists for how lists are created from a definition.