Working with Product Lists

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"
  }'

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

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}

Walk-in queues and waitlists List Definitions

⌘I

Core setup

Profiles and data

Commerce

Incentives

Reactions

Webhooks and events

Frontend & SDK

POS integration

Appointments

Lists

Groups

Feedback

Extensions

Working with Product Lists

How lists work

Creating a product list

Reading all lists for a profile

Reading a specific list

Updating a list

Unsharing a list

Deleting a list

​How lists work

​Creating a product list

​Reading all lists for a profile

​Reading a specific list

​Updating a list

​Sharing a list

​Getting a shared list by share code

​Unsharing a list

​Deleting a list

How lists work

Creating a product list

Reading all lists for a profile

Reading a specific list

Updating a list

Sharing a list

Getting a shared list by share code

Unsharing a list

Deleting a list