List Reservations

List Reservations

With List Reservations, users can share a list they have put together, allow different users to view it, and reserve items in specified quantities. The user reserving a list item must know the share code for the list, and cannot access any information about the profile that owns it - only the available items and their quantities in the list.

🚧

Please Note

In order for List Reservations to work, the list definition needs to have "allow_reserve" enabled.

To create a List Item Reservation, you can use POST:

Text

POST: https://{tenant}.manager.getomneo.com/list/items/{item_id}/reservations

The data looks different for this depending on whether or not you are allowing customers without profiles to access the shared lists, and reserve items.

For when only known customers with an existing profile can reserve items:

JSON

{
   "profile_id": "<string>",
   "quantity": "<integer>",
}

And for when people without existing profiles can reserve items:

JSON

{
   "external_profile_id": "<string>",
   "quantity": "<integer>",
}

To retrieve the reservations under a specific profile, you can use GET:

Text

GET: https://{tenant}.manager.getomneo.com/profile/{profile_id}/reservations

You can update the quantity of a list reservation using PUT:

Text

PUT: https://{tenant}.manager.getomneo.com/list/items/{item_id}/reservations/{reservation_id}

And you can delete a reservation by using DELETE:

Text

DELETE: https://{tenant}.manager.getomneo.com/list/items/{item_id}/reservations/{reservation_id}