Skip to content

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

EndpointMethod
/api/admin/bookings/{id}GET

Response fields

FieldTypeDescription
idIntegerBooking id.
orderId / orderIncrementIdInteger / StringParent order id and human-facing number.
orderItemIdIntegerThe order line this booking belongs to.
productId / productSku / productNameThe booked product.
bookingTypeStringBooking sub-type: default, appointment, event, rental, table.
qtyIntegerBooked quantity.
from / toIntegerBooked time window as unix timestamps (may be null for non-time-based types).
fromFormatted / toFormattedStringThe same window as readable strings.
bookingProductEventTicketIdIntegerLinked event-ticket id (set when bookingType is event).
orderObjectSlim order summary — id, incrementId, status, customerName, customerEmail, grandTotal, orderCurrencyCode.
orderItemObjectSlim order-item summary — id, sku, name, qtyOrdered.
paymentMethod / paymentTitleStringThe order's payment method code and its display title.
shippingMethod / shippingTitleStringThe order's shipping method code and its display title — null when the order had no shipping method.
billingAddressObjectThe order's billing address, or null when the order has none — see below.
shippingAddressObjectThe order's shipping address, or null when the order has none — see below.
invoicesArraySlim summaries of the order's invoices — empty when none. See below.
shipmentsArraySlim summaries of the order's shipments — empty when none. See below.
refundsArraySlim summaries of the order's refunds — empty when none. See below.
createdAtStringWhen 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.

FieldTypeDescription
idIntegerInvoice id.
incrementIdStringHuman-facing invoice number.
stateStringInvoice state — e.g. paid, pending.
baseGrandTotalNumberInvoice grand total in the store's base currency.
formattedBaseGrandTotalStringThe same total pre-formatted for display.
createdAtStringWhen the invoice was created.

Shipments (shipments)

Slim summaries of the order's shipments — an empty array when the order has none.

FieldTypeDescription
idIntegerShipment id.
totalQtyNumberTotal quantity shipped.
carrierTitleStringShipping carrier title — may be null.
trackNumberStringCarrier tracking number — may be null.
createdAtStringWhen the shipment was created.

Refunds (refunds)

Slim summaries of the order's refunds — an empty array when the order has none.

FieldTypeDescription
idIntegerRefund id.
stateStringRefund state.
baseGrandTotalNumberRefund grand total in the store's base currency.
formattedBaseGrandTotalStringThe same total pre-formatted for display.
createdAtStringWhen the refund was created.

Permission

sales.bookings.view

Released under the MIT License.