Reservation Object

Reservation ID.

Status of the reservation.

See the Reservation Lifecycle article(REST | SDK) for an explanation of the role of statuses in the reservation lifecycle.

Reservation source.

This indicates how the reservation was made.

Reservation details.

Information about the person the reservation is being made for.

A reservation created with any source other than WALK_IN requires the reservation.reservee.phone and reservation.reservee.firstName fields. Attempting to create a reservation without these fields results in an error.

Information about the person making the reservation.

This field is required if the reservation's status is anything other than WALK_IN.

Team message.

A message for the restaurant staff containing any additional information regarding the reservation, such as special requirements for the guests.

Date and time the reservation was created.

Date and time the reservation was changed.

Revision number, which increments by 1 each time the reservation is updated. To prevent conflicting changes, the current revision must be specified when updating the reservation.

Ignored when creating a reservation.

The reason the reservation was declined.

Payment status.

Custom field data for the reservation object.

Extended fields must be configured in the app dashboard before they can be accessed with API calls.