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.

List Reservations allow users to reserve items on a shared list. A gift registry guest, for example, can reserve a specific item so other guests know it has been purchased. Reservations require:
  • The List Definition to have allow_reserve: true
  • The list to be shared (the reserver uses the list’s share code)
The reserver only sees the list’s items and quantities — they cannot view any personal data about the profile that owns the list.

​
Creating a reservation (known profile)

curl -X POST https://api.[tenant].getomneo.com/api/v3/list/items/{itemId}/reservations \
  -H "Authorization: Bearer ${TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "profile_id": "9332c9b2-e31c-4d49-8ec3-62a9466d339c",
    "quantity": 1
  }'

​
Creating a reservation (anonymous user)

If anonymous reservations are permitted, use external_profile_id instead: 
curl -X POST https://api.[tenant].getomneo.com/api/v3/list/items/{itemId}/reservations \
  -H "Authorization: Bearer ${TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "external_profile_id": "guest-session-id-abc123",
    "quantity": 1
  }'

​
Reading reservations for a profile

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

​
Updating a reservation quantity

curl -X PUT https://api.[tenant].getomneo.com/api/v3/list/items/{itemId}/reservations/{reservationId} \
  -H "Authorization: Bearer ${TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "quantity": 2
  }'

​
Deleting a reservation

DELETE /api/v3/list/items/{itemId}/reservations/{reservationId}