Orders

Get an order by reference

Looks up an Order by the short customer-facing reference Trybe issues (e.g. TRY1234). Equivalent to GET /shop/orders/{orderId} but keyed by the human-readable reference printed on receipts and emails — useful when an operator has the reference but not the order ID.

The lookup is scoped to the sites the calling user belongs to. Pass site_id to narrow further. Returns 404 if the reference doesn't match any in-scope order.

Requires the RESERVATIONS_VIEW permission on the matching order's site.

get/shop/order-by-ref/{orderRef}

Query parameters

site_idstring uuid

Optional UUID filter to scope the lookup to a single site. By default the search runs across every site the calling user belongs to and returns the first match.

generic_items_arrayboolean

When true, the order's line items are returned as a single polymorphic items array rather than the typed appointment_items, area_booking_items etc. groupings. Easier to iterate from the storefront; less convenient for type-aware operator tooling.

Response

The Order was successfully retrieved

Changes