Skip to content

List Bookings

Mirrors the admin Sales → Bookings datagrid. Every booking column plus the linked order and orderItem summaries are populated on each row — the field set is identical to Booking Detail.

How this menu works

For what a booking row is, the booking sub-types, and the time-window fields, see the Bookings overview.

Endpoint

EndpointMethod
/api/admin/bookingsGET

Query Parameters

ParameterTypeDescription
page, per_pageintegerPagination (default 10, cap 50).
idstringFilter by booking id (int or comma-list).
order_idstringPartial order increment number.
qtyintegerExact quantity.
product_idintegerFilter by product id.
from_from, from_todateSlot-start range.
to_from, to_todateSlot-end range.
created_at_from / _todateOrder created range.
sortstringid, order_id, qty, from, to, created_at.
orderstringasc, desc.

from and to are emitted as both raw unix timestamps (from, to) and pre-formatted strings (fromFormatted, toFormatted). For non-time-based booking types they may be null.

Permission

sales.bookings.view

Released under the MIT License.