A List Definition is the configuration template for a type of product list. It defines the rules that all lists of that type will follow, whether items can have quantities, whether the list can be shared, and whether items can be reserved.
List definition fields
| Field | Required | Description |
|---|
name | Yes | Display name for the list type |
handle | Yes | Unique slug identifier |
type | Yes | Category/type string for grouping |
short_description | No | Brief description shown to customers |
description | No | Full description |
allow_share | No | Whether lists of this type can be shared with others |
allow_quantity | No | Whether items can have a quantity (e.g., “2 of this item”) |
allow_reserve | No | Whether others can reserve items on shared lists |
allow_custom_product | No | Whether custom (non-Omneo-product) items can be added |
is_published | No | Whether the definition is active |
is_active | No | Whether new lists can be created from this definition |
tags | No | Array of tags for filtering |
Creating a list definition
curl -X POST https://api.[tenant].getomneo.com/api/v3/list-definitions \
-H "Authorization: Bearer ${TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"name": "Wishlist",
"handle": "wishlist",
"type": "wishlist",
"short_description": "Save items you love",
"allow_share": true,
"allow_quantity": false,
"allow_reserve": true,
"allow_custom_product": false,
"is_published": true,
"is_active": true
}'
id, you will need it when creating customer lists.
Reading a list definition
GET /api/v3/list-definitions/{definitionId}
Updating a list definition
curl -X PUT https://api.[tenant].getomneo.com/api/v3/list-definitions/{definitionId} \
-H "Authorization: Bearer ${TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"allow_reserve": false
}'
Deleting a list definition
DELETE /api/v3/list-definitions/{definitionId}
Deleting a List Definition will affect all product lists that use it. Only delete definitions that have no active lists.
Common definition types
| Type | allow_share | allow_reserve | allow_quantity | Use case |
|---|
wishlist | true | true | false | Customer-built wishlist for gifting |
gift-registry | true | true | true | Bridal/baby registry with quantities |
hold | false | false | false | In-store hold list visible to staff |
style-edit | false | false | false | Stylist-curated list for a client |
