Sign in
AreaBookings

Retrieve an AreaBooking

Retrieves a single AreaBooking by ID. Use this when you have an AreaBooking ID from createBasketAreaBookingItem, a webhook payload, or a calendar view and need the canonical reservation record — including which BookableAreas are assigned, the customer details, and the parent order context.

get/shop/area-bookings/{areaBookingId}

Response

The AreaBooking was successfully retrieved.

Example response

{
  "data": {
    "area_booking_type_name": "Pool Cabana",
    "order_ref": "TRY00",
    "order_labels": [
      {
        "color": "#FF0000",
        "name": "VIP"
      }
    ],
    "email": "janedoe@example.com",
    "phone": "+447727123456",
    "first_name": "Jane",
    "last_name": "Doe",
    "areas": [
      {
        "name": "Hot Tub 1"
      }
    ],
    "guests": [
      {
        "id": "5dcb47800000000000000000",
        "checked_in_at": "2025-10-01T12:00:00+00:00",
        "checked_out_at": "2025-10-01T16:30:00+00:00",
        "customer_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
        "email": "jane.doe@example.com",
        "first_name": "Jane",
        "intake_form_submission_id": "5dcb47800000000000000010",
        "last_name": "Doe",
        "name": "Jane Doe"
      }
    ],
    "start_time": "2019-01-15T12:00:00+01:00",
    "end_time": "2019-01-15T13:00:00+01:00",
    "duration": 60,
    "end_buffer": 15,
    "product_code": "SPA-CABANA",
    "created_at": "2025-02-04T12:00:00+01:00",
    "updated_at": "2025-02-04T12:00:00+01:00"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.