Skip to main content

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.

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

FieldRequiredDescription
nameYesDisplay name for the list type
handleYesUnique slug identifier
typeYesCategory/type string for grouping
short_descriptionNoBrief description shown to customers
descriptionNoFull description
allow_shareNoWhether lists of this type can be shared with others
allow_quantityNoWhether items can have a quantity (e.g., “2 of this item”)
allow_reserveNoWhether others can reserve items on shared lists
allow_custom_productNoWhether custom (non-Omneo-product) items can be added
is_publishedNoWhether the definition is active
is_activeNoWhether new lists can be created from this definition
tagsNoArray 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
  }'
Note the 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

Typeallow_shareallow_reserveallow_quantityUse case
wishlisttruetruefalseCustomer-built wishlist for gifting
gift-registrytruetruetrueBridal/baby registry with quantities
holdfalsefalsefalseIn-store hold list visible to staff
style-editfalsefalsefalseStylist-curated list for a client