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.

Product Lists are personalised catalogues linked to a customer profile. They bridge online and in-store shopping — a customer can build a list online, and staff can view and act on it in-store via Clienteling. Common use cases: wishlists, gift registries, hold lists, style edits.

​
How Lists work

Lists follow a Definition/Instance pattern:
  • List Definition — defines the type of list (name, handle, type, and rules like whether items can be reserved or shared)
  • Product List — an instance of a definition, linked to a profile and containing items
Before creating lists for customers, you need at least one List Definition. See List Definitions.

​
Creating a product list

curl -X POST https://api.[tenant].getomneo.com/api/v3/profiles/{profileId}/lists \
  -H "Authorization: Bearer ${TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Birthday Wishlist",
    "list_definition_id": 3,
    "description": "Items I would love for my birthday",
    "tags": ["birthday"]
  }'

​
Reading all lists for a profile

GET /api/v3/profiles/{profileId}/lists

​
Reading a specific list

GET /api/v3/profiles/{profileId}/lists/{listId}

​
Updating a list

curl -X PUT https://api.[tenant].getomneo.com/api/v3/profiles/{profileId}/lists/{listId} \
  -H "Authorization: Bearer ${TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "2025 Birthday Wishlist"
  }'

​
Sharing a list

If the List Definition has allow_share enabled, a list can be shared. Sharing generates a share code that can be passed to others: 
POST /api/v3/profiles/{profileId}/lists/{listId}/shares

​
Getting a shared list by share code

Anyone with the share code can retrieve the list (without seeing the profile’s personal data): 
GET /api/v3/lists/shares/{shareCode}

​
Unsharing a list

DELETE /api/v3/profiles/{profileId}/lists/{listId}/shares/{shareId}

​
Deleting a list

DELETE /api/v3/profiles/{profileId}/lists/{listId}