Booking
Bearer token using a JWT
The microsite name of the restaurant.
The reference of the booking.
An authentication token for retrieivng the booking.
OK
To create a reservation in a restaurant, you need to create a Booking object. A booking can be identified by either its Id, which is unique within the restaurant the booking was created in, or its Reference, which is the booking reference given to customers.
The booking Id. This is only guaranteed to be unique within a certain restaurant.
The booking reference - automatically generated by ResDiary.
Gets or sets the full name of the restaurant.
Gets or sets the visit date.
Gets or sets the visit time.
Gets or sets the size of the party.
Gets or sets the code of the channel for the booking.
Gets or sets the special requests for the booking.
Gets or sets the promotion id.
Gets or sets the IP address.
Gets or sets whether the customer has confirmed the leave time
The concierge's Id, or null if the user making the booking isn't a concierge.
The concierge's email address, or null if the user making the booking isn't a concierge.
The concierge customer's id, or null if this isn't using an existing concierge customer
The booking reason ids associated with this booking
The status of the booking.
The date and time the booking was made (in UTC).
A URL to a page containing information about the function.
A URL to a page where you can pre-order for the booking.
The hashed booking reference.
Whether or not the booking can be edited through Consumer API calls.
Whether or not the booking can be cancelled through Consumer API calls.
Whether or not the booking currently has a credit card token stored.
The deposit amount currently paid against the booking.
The id of the area the booking is made in.
This is true of the diner can no longer edit or cancel the booking.
The room number of the booking.
True if the guest has been confirmed by phone.
True if the booking has a function enquiry linked to it.
True if this booking is a takeaway rather than a reservation.
Specifies whether a booking has no takeaway, is a delivery takeaway or a collection takeaway.
Specifies the delivery fee associated with this booking, applies only to takeaway bookings.
The Id of the pre-order linked to the booking, if one exists
The url to access the guest form of the pre-order linked to the booking, if one exists
The id of the menu version attached to this bookings preorder, if one exists
The expected duration of the booking in minutes.
Gets the visit date in Utc.
The edit token for authenticating an edit booking operation through the api.
DC Rewards voucher code for loyalty
DC Rewards voucher amount
DC Rewards voucher validity
OK
Bearer token using a JWT
The microsite name of the restaurant.
The booking's reference.
Used to create or update a booking.
The visit date of the booking.
The visit time of the booking.
The party size of the booking.
The special requests for the booking. NOTE: The request should include the existing value and append any additional notes if you want to retain the "Special requests" already on the booking to avoid unintentionally losing these notes.
The promotion that has been booked with the booking, or null if no promotion is selected.
The IP address of the client making the booking. Defaults to the IP address that the request comes from.
true if the leave time of the booking has been confirmed with the customer, false otherwise.
A list of booking reason ids to be associated with the booking
A URL to a page containing information about the function.
A URL to a page where you can pre-order for the booking.
An optional channel code parameter if the booking is being updated to use availability that is present on a booking channel that isn't the channel of the original booking.
The area in which the booking is to be seated, if no area id is specified then the booking will be seated at the most suitable table regardless of area.
The room number of the booking if there is one.
True if the guest has been confirmed by phone.
The URL that the checkout flow will redirect to upon successful completion.
The URL that the checkout flow will redirect to upon cancellation.
The payment method id if the customer has entered payment details.
The payment intent id if the customer has entered payment details, and completed 3DS2 authentication.
OK
The response from creating a booking.
The status of the request.
Any errors that occurred while creating the booking.
The amount that needs to be paid.
The key to use when making stripe payments.
The id of the checkout session used for SCA checkout flow.
The id of the stripe account that is taking payment.
The Stripe payment intent id.
The Stripe payment intent client secret.
The Stripe setup intent client secret.
OK
Bearer token using a JWT
The provider's microsite name.
The Id of the repeating group that the bookings are part of.
The page size.
The page number.
The customer Id to search for.
Specifies the start of the date range (UTC) for the booking's made date (inclusive). If left undefined no start date is considered.
Specifies the end of the date range (UTC) for the booking's made date (inclusive). If left undefined no end date is considered.
Specifies the start of the date range (UTC) for the booking's visit date (inclusive). If left undefined no start date is considered.
Specifies the end of the date range (UTC) for the booking's visit date (inclusive). If left undefined no end date is considered.
Specifies which field should be used for sorting the results.
OK
OK
Add function and pre-order URLs to a booking
Bearer token using a JWT
The microsite name of the restaurant.
The booking reference
Used to update a booking with function and pre-order URLs
The IP address of the client making the booking. Defaults to the IP address that the request comes from.
A URL to a page containing information about the function.
A URL to a page where you can pre-order for the booking.
OK
The response from updating a booking with pre order and function URLs.
The status of the request.
Any errors that occurred while creating the booking.
OK
Bearer token using a JWT
The microsite name of the restaurant.
Used to create or update a booking.
The visit date of the booking.
The visit time of the booking.
The party size of the booking.
The channel the booking came from. Defaults to the default channel for your API account when null.
The special requests for the booking.
The IP address of the client making the booking. Defaults to the IP address that the request comes from.
A list of booking reason ids to be associated with the booking
OK
The response from creating a booking.
The status of the request.
Any errors that occurred while creating the booking.
OK
Get Square settings for a restaurant
Bearer token using a JWT
The microsite name of the restaurant.
OK
The settings for the square integration of a provider
OK
Bearer token using a JWT
The microsite name of the restaurant.
Used to create or update a booking.
The visit date of the booking.
The visit time of the booking.
The party size of the booking.
The channel the booking came from. Defaults to the default channel for your API account when null.
The special requests for the booking.
The promotion that has been booked with the booking, or null if no promotion is selected.
The IP address of the client making the booking. Defaults to the IP address that the request comes from.
true if the leave time of the booking has been confirmed with the customer, false otherwise.
The concierge's Id, or null if the user making the booking isn't a concierge.
The concierge's email address, or null if the user making the booking isn't a concierge.
The concierge customer's id, or null if this isn't using an existing concierge customer
A list of booking reason ids to be associated with the booking
A URL to a page containing information about the function.
A URL to a page where you can pre-order for the booking.
The portal user id if the customer has one.
The area in which the booking is to be seated, if no area id is specified then the booking will be seated at the most suitable table regardless of area.
The room number of the booking if there is one.
The stripe token if the customer has entered payment details.
The payment method id if the customer has entered payment details.
The payment intent id if the customer has entered payment details, and completed 3DS2 authentication.
The confirmation token id if the customer has entered payment details.
The URL that the checkout flow will redirect to upon successful completion.
The URL that the checkout flow will redirect to upon cancellation.
The Stripe Checkout session id if the customer has entered payment details using Stripe Checkout.
The number of households if there is one.
DC Rewards voucher code for loyalty
DC Rewards voucher amount
DC Rewards voucher validity
Indicates whether a booking request is via the booking widget
Gets or sets the original microsite name used in cross-selling widget.
Gets or sets the user selected microsite name used in cross-selling widget.
Gets or sets the widget theme id.
OK
The response from creating a booking.
The status of the request.
Any errors that occurred while creating the booking.
The amount that needs to be paid.
The key to use when making stripe payments.
Payment Amount formatted for viewing by user
Payment Amount formatted for viewing by user
Secret used for SetupIntent API
Secret used for PaymentIntents API when card requires authentication.
The id of the checkout session used for SCA checkout flow.
True if DC rewards voucher attached to booking, false if not
OK
Create a booking with a stripe confirmation token
Bearer token using a JWT
The microsite name of the restaurant.
The visit date of the booking.
The visit time of the booking.
The party size of the booking.
The channel the booking came from. Defaults to the default channel for your API account when null.
The special requests for the booking.
The promotion that has been booked with the booking, or null if no promotion is selected.
The IP address of the client making the booking. Defaults to the IP address that the request comes from.
true if the leave time of the booking has been confirmed with the customer, false otherwise.
The concierge's Id, or null if the user making the booking isn't a concierge.
The concierge's email address, or null if the user making the booking isn't a concierge.
The concierge customer's id, or null if this isn't using an existing concierge customer
A list of booking reason ids to be associated with the booking
A URL to a page containing information about the function.
A URL to a page where you can pre-order for the booking.
The portal user id if the customer has one.
The area in which the booking is to be seated, if no area id is specified then the booking will be seated at the most suitable table regardless of area.
The room number of the booking if there is one.
The stripe token if the customer has entered payment details.
The payment method id if the customer has entered payment details.
The payment intent id if the customer has entered payment details, and completed 3DS2 authentication.
The setup intent id if the customer has entered payment details, and completed 3DS2 authentication.
The confirmation token id if the customer has entered payment details.
The URL that the checkout flow will redirect to upon successful completion.
The URL that the checkout flow will redirect to upon cancellation.
The Stripe Checkout session id if the customer has entered payment details using Stripe Checkout.
The number of households if there is one.
DC Rewards voucher code for loyalty
DC Rewards voucher amount
DC Rewards voucher validity
Indicates whether a booking request is via the booking widget
Gets or sets the original microsite name used in cross-selling widget.
Gets or sets the user selected microsite name used in cross-selling widget.
Gets or sets the widget theme id.
OK
The response from creating a booking.
The status of the request.
Any errors that occurred while creating the booking.
The amount that needs to be paid.
The key to use when making stripe payments.
Payment Amount formatted for viewing by user
Payment Amount formatted for viewing by user
Secret used for SetupIntent API
Secret used for PaymentIntents API when card requires authentication.
The id of the checkout session used for SCA checkout flow.
True if DC rewards voucher attached to booking, false if not
OK
Get booking edit token
Bearer token using a JWT
The microsite name of the restaurant.
The reference of the booking.
Encapsulates a diner's authentication details.
The diner's email. (Required if phone number is not supplied)
The diners phone number. (Required if email is not supplied)
OK
OK
Move a booking to a new restaurant
Bearer token using a JWT
The microsite name of the restaurant where the booking currently exists.
The booking's reference.
Used to move a booking to a different restaurant
The microsite name of the target restaurant where the booking is being moved to
Optional. The visit date of the booking if different from the current visit date of the booking. If not specified then the visit date will not be updated.
Optional. The visit time of the booking if different from the current visit time of the booking. If not specified then the visit time will not be updated.
Optional. The party size for the booking if different from the current party size of the booking. If not specified then the party size will not be updated.
Optional. The id of the promotion for the booking on the new provider.
The IP address of the client making the booking. Defaults to the IP address that the request comes from.
An optional channel code parameter if the booking is being updated to use availability that is present on a booking channel that isn't the channel of the original booking.
true if the leave time of the booking has been confirmed with the customer, false otherwise.
OK
The response from creating a booking.
The status of the request.
Any errors that occurred while creating the booking.
The amount that needs to be paid.
The key to use when making stripe payments.
The id of the checkout session used for SCA checkout flow.
The id of the stripe account that is taking payment.
The Stripe payment intent id.
The Stripe payment intent client secret.
The Stripe setup intent client secret.
OK
Confirm a booking
Bearer token using a JWT
OK
OK
Cancel a booking
Bearer token using a JWT
The restaurant's microsite name.
The booking reference.
An optional cancellation reason id to use. Refer to 'api/ConsumerApi/v1/Restaurant/{micrositeName}/CancellationReasons' to get the cancellation reason ids for the restaurant.
No Content
No Content
No content
Add Square payment info to a booking
Bearer token using a JWT
The microsite name of the restaurant.
The reference of the booking being confirmed.
The Square nonce.
OK
The result of confirming the booking.
The overall status of the confirm booking request.
The detailed status of the request.
An error message explaining why the booking could not be confirmed.
OK
Last updated
Was this helpful?