Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Creating and configuring List Definitions that govern the behaviour of product lists.
| Field | Required | Default | Description |
|---|---|---|---|
name | Yes | Display name for the list type | |
handle | Yes | Unique slug identifier. Not accepted on update. | |
type | Yes | Free-form category string for grouping (for example wishlist) | |
short_description | No | Brief description shown to customers | |
description | No | Full description | |
icon, cover | No | Display assets for the list type | |
allow_new | No | true | Whether new lists can be created from this definition. Creating a list against a definition with allow_new: false returns 422. |
allow_edit | No | true | Whether lists of this type can be edited |
allow_delete | No | true | Whether lists of this type can be deleted |
allow_share | No | true | Whether lists of this type can be shared. Creating a share on a list whose definition has allow_share: false returns an error. |
allow_quantity | No | false | Whether items store a quantity (for example “2 of this item”). When false, any quantity sent on an item is ignored. |
allow_reserve | No | false | Whether others can reserve items on shared lists. See List reservations. |
allow_custom_product | No | false | Whether custom (non-catalogue) items can be added through the /custom endpoint |
is_published | No | false | Publication flag for surfaces that display list types |
is_active | No | false | Active flag for surfaces that display list types |
meta | No | Free-form metadata | |
tags | No | Array of tags for filtering |
is_published and is_active are not checked when a list is created or an item is added through the API. Use allow_new to stop new lists being created from a definition.timezone, reservation_period, reservation_period_type, reservation_absolute_expiry and the reservation targets). See List reservations.
curl -X POST https://api.[tenant].getomneo.com/api/v3/lists/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.
GET /api/v3/lists/definitions/{definitionId}
curl -X PUT https://api.[tenant].getomneo.com/api/v3/lists/definitions/{definitionId} \
-H "Authorization: Bearer ${TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"allow_reserve": false
}'
DELETE /api/v3/lists/definitions/{definitionId}
| 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 |