Booking Detail
Returns a single booking with its booking sub-type, the booked time window, the linked order / order-item summaries, and the underlying order's billing/shipping address, payment & shipping info, and its invoices / shipments / refunds — everything the admin Booking view shows when it opens the order, with no follow-up calls required. Requires the sales.bookings.view permission.
Endpoint
| Endpoint | Method |
|---|---|
/api/admin/bookings/{id} | GET |
Response fields
| Field | Type | Description |
|---|---|---|
id | Integer | Booking id. |
orderId / orderIncrementId | Integer / String | Parent order id and human-facing number. |
orderItemId | Integer | The order line this booking belongs to. |
productId / productSku / productName | — | The booked product. |
bookingType | String | Booking sub-type: default, appointment, event, rental, table. |
qty | Integer | Booked quantity. |
from / to | Integer | Booked time window as unix timestamps (may be null for non-time-based types). |
fromFormatted / toFormatted | String | The same window as readable strings. |
bookingProductEventTicketId | Integer | Linked event-ticket id (set when bookingType is event). |
order | Object | Slim order summary — id, incrementId, status, customerName, customerEmail, grandTotal, orderCurrencyCode. |
orderItem | Object | Slim order-item summary — id, sku, name, qtyOrdered. |
paymentMethod / paymentTitle | String | The order's payment method code and its display title. |
shippingMethod / shippingTitle | String | The order's shipping method code and its display title — null when the order had no shipping method. |
billingAddress | Object | The order's billing address, or null when the order has none — see below. |
shippingAddress | Object | The order's shipping address, or null when the order has none — see below. |
invoices | Array | Slim summaries of the order's invoices — empty when none. See below. |
shipments | Array | Slim summaries of the order's shipments — empty when none. See below. |
refunds | Array | Slim summaries of the order's refunds — empty when none. See below. |
createdAt | String | When the order was created. |
Address objects (billingAddress, shippingAddress)
The order's billing and shipping addresses, mirroring the admin order view's address panel. Each is an object (or null when the order has none) carrying id, addressType, firstName, lastName, companyName, address, city, state, country, postcode, email, and phone.
Invoices (invoices)
Slim summaries of the order's invoices — an empty array when the order has none.
| Field | Type | Description |
|---|---|---|
id | Integer | Invoice id. |
incrementId | String | Human-facing invoice number. |
state | String | Invoice state — e.g. paid, pending. |
baseGrandTotal | Number | Invoice grand total in the store's base currency. |
formattedBaseGrandTotal | String | The same total pre-formatted for display. |
createdAt | String | When the invoice was created. |
Shipments (shipments)
Slim summaries of the order's shipments — an empty array when the order has none.
| Field | Type | Description |
|---|---|---|
id | Integer | Shipment id. |
totalQty | Number | Total quantity shipped. |
carrierTitle | String | Shipping carrier title — may be null. |
trackNumber | String | Carrier tracking number — may be null. |
createdAt | String | When the shipment was created. |
Refunds (refunds)
Slim summaries of the order's refunds — an empty array when the order has none.
| Field | Type | Description |
|---|---|---|
id | Integer | Refund id. |
state | String | Refund state. |
baseGrandTotal | Number | Refund grand total in the store's base currency. |
formattedBaseGrandTotal | String | The same total pre-formatted for display. |
createdAt | String | When the refund was created. |
Permission
sales.bookings.view

