Reservation

A restaurant table reservation.

Fields

    approvedAt
    DateTime
    When staff accepted a booking that needed approval (UTC). Null otherwise.
    cancellationReason
    String
    Why the booking was cancelled. Null unless it was cancelled.
    cancelledAt
    DateTime
    When the booking was cancelled (UTC). Null unless it was cancelled.
    code
    String!
    Required
    Short reference the guest quotes at the door.
    completedAt
    DateTime
    When the meal finished (UTC). Null until the table is freed.
    confirmedAt
    DateTime
    When the booking was confirmed (UTC). Null while it is still pending.
    createdAt
    DateTime!
    Required
    When the booking was made (UTC).
    depositAmount
    Decimal
    Deposit taken to hold the table, in the restaurant's currency. Null when no deposit was required.
    durationMinutes
    Int!
    Required
    How long the table is held for.
    id
    Int!
    Required
    Unique identifier for the reservation.
    noShowFeeAmount
    Decimal
    Charge kept if the party never arrives, in the restaurant's currency. Null when no such fee applies.
    occasion
    String
    What the party is celebrating. Null when the guest gave none.
    orderId
    Int
    Order carrying the deposit. Null when no deposit was taken.
    partySize
    Int!
    Required
    Number of guests expected.
    rejectedAt
    DateTime
    When staff turned the booking down (UTC). Null otherwise.
    requiresApproval
    Boolean!
    Required
    True for large-party / private-dining bookings awaiting vendor approval.
    reservedAt
    DateTime!
    Required
    When the party is expected (UTC).
    restaurantServicePeriodId
    Int
    Shift the booking falls in. Null when it sits outside every defined shift.
    restaurantTableId
    Int
    Table assigned to the party. Null until the restaurant assigns one.
    seatedAt
    DateTime
    When the party was seated (UTC). Null until they arrive.
    seatingPreference
    String
    Where the guest would like to sit. Null when they expressed no preference.
    source
    String!
    Required
    Where the booking came from: "app" for a guest booking, "manual" for one entered by restaurant staff.
    specialRequests
    String
    Free-text requests from the guest. Null when they made none.
    status
    TableReservationStatus!
    Required
    Current state of the reservation.
    userId
    Int!
    Required
    Guest the table is held for.
    vendorId
    Int!
    Required
    Merchant that owns the restaurant.
    vendorLocationId
    Int!
    Required
    Branch the table is booked at.
Built with