Restaurant
Bearer token using a JWT
Comma separated string of microsite names
OK
OK
Bearer token using a JWT
The microsite name.
OK
OK
Bearer token using a JWT
The microsite name.
OK
Information regarding the days of the week and any periods in which the restaurant is closed for online bookings
OK
Bearer token using a JWT
The restaurant's microsite name.
OK
Contains the information about a booking reason.
The internal ResDiary Id for the booking reason.
The name of the booking reason.
OK
Get the tracking details for a restaurant
Bearer token using a JWT
The restaurant's microsite name.
OK
Represents widget tracking information.
The Google Universal Analytics ID.
The Google Tag Manager Container ID.
The Google Analytics 4 ID.
The Google AdWords Id.
The Google Adwords Label.
The Facebook Pixel ID.
The Twitter Ad ID.
OK
Bearer token using a JWT
The microsite name.
The menu url name.
OK
OK
Bearer token using a JWT
The microsite name.
The culture name, when specified the API will return translated values for the specified culture where translated versions are available.
OK
A restaurant that customers can book into.
The name of the restaurant.
The contact email address of the restaurant.
The reservation phone number.
The restaurant website.
The maximum number of covers that can be in a booking for the restaurant.
A short description of the restaurant.
The full description of the restaurant.
The RSS feed to get news about the restaurant.
The URL of the restaurant's blog.
Information about when the restaurant is open.
The URL to the booking form.
The restaurant's logo URL.
The "Powered by ResDiary" URL.
The microsite name of the restaurant.
The order the reviews are sorted in.
The page of reviews being returned.
true if the restaurant uses the standard ResDiary booking widget, false if they use a custom widget.
An array of the cuisine type Ids available at the restaurant.
The meta description tag to display on the portal for the restaurant.
The restaurant's price point if set.
The currency symbol used by the restaurant.
The currency code used by the restaurant.
The telephone country code used by the restaurant.
Whether the restaurant allows function enquiries.
The number of days in advance that the restaurant accepts bookings.
The number of days in advance that the restaurant accepts function enquiries.
Whether the restaurant allows standby function enquiries.
Whether the restaurant allows bookings to be edited and cancelled by diners
The name of the group this restaurant belongs to
Whether this restaurant is part of a group of more than 1 restaurant
True if this restaurant sells vouchers, false otherwise
The url to the vouchers widget for this restaurant
A list of the dress codes for this restaurant.
Whether this restaurant allows multiple rounds of ordering for pay at table
The url link to the 1920 x 1080 size main restaurant image
The url link to the 1440 x 810 size main restaurant image
The url link to the 768 x 432 size main restaurant image
The url link to the 375 x 210 size main restaurant image
True if this restaurant partakes in the Loyalty Program
The facebook pixel id associated to this restaurant.
The Restaurants Widget Terms and Conditions (formatted in a HTML String).
Whether the restaurant should be hidden on the Portal or not.
OK
Bearer token using a JWT
The text to search for.
OK
Contains the search result.
The restaurant name.
The microsite name.
OK
Verify a restaurant has a microsite
Bearer token using a JWT
The restaurant's microsite name.
OK
OK
Bearer token using a JWT
The microsite name.
The date we are requesting the setup for
OK
Contains information about the setup of a restaurant for event enquiries.
The restaurant's Id.
The name of the restaurant.
The maximum party size (covers) for an event enquiry.
The minimum party size (covers) for an event enquiry.
The terms and conditions for making bookings (formatted in a HTML String).
Gets or sets countryCode for phone numbers
The ISO 2 letter code for the restaurant's country. Note that this can currently be null because a restaurant can technically set their country to one that doesn't exist.
The Restaurant Group Name
Whether the restaurant is part of a group of more than one restaurant
Whether provider marketing is enabled
Whether group marketing is enabled
The name the provider has chosen to display to their group marketing prefernces
The custom message the restaurant wants to display when a customer is trying to book an event below the minimum limit.
The custom message the restaurant wants to display when a customer is trying to book an event above the maximum limit.
The current date and time of the restaurant.
The privacy policy for the restaurant.
Whether the restaurant has any area that is enabled for event enquiries on the requested date.
Allow Online Event Enquiries X Days In Advance.
OK
Get a widget theme's styles
Bearer token using a JWT
OK
Dto used for passing visual styles to the widget
Theme Id
ResDiary logo
Overall section. General background colour
Overall section. General text colour
Overall section. General border colour
Overall section. General border radius
Overall section. General font
Overall section. Book button colour
Overall section. Book button font colour
Overall section. Message text colour
Overall section. Message background colour
Booking section. Summary background colour
Booking section. Summary text colour
Booking section. Summary border radius
Calendar section. Background colour
Calendar section. Border colour
Calendar section. Month day text colour
Calendar section. Border radius
Calendar section. Day text colour
Calendar section. Day background colour
Calendar section. Day border colour
Calendar section. Selected text colour
Calendar section. Selected background colour
Promotion section. Border colour
Promotion section. Border radius
Promotion section. Option background colour
Promotion section. Option text colour
Promotion section. Option hover background colour
Promotion section. Option hover text colour
Promotion section. Selected background colour
Promotion section. Selected text colour
Dropdown section. General background colour
Dropdown section. General text colour
Dropdown section. General validation error colour
Dropdown section. General placeholder colour
Dropdown section. General border colour
Dropdown section. Border focus colour
Dropdown section. Border radius
Dropdown section. Selected background colour
Dropdown section.Selected text colour
Custom logo url
OK
Bearer token using a JWT
The text to search for.
OK
Contains the search result.
The restaurant name.
The microsite name.
The restaurant address.
The restaurant's Latitude.
The restaurant's Longitude.
OK
Get a widget theme's settings
Bearer token using a JWT
OK
Dto used for passing behavioural settings to the widget
Stores behaviour of book button on mini widget
Stores data for the behaviour of the book button on the mini widget
Gets the URL to the custom CSS for the theme.
Whether or not to display the date of birth field.
Whether or not to display the date of birth year field.
Whether or not the date of birth is required.
A description displayed below the date of birth field.
Whether or not to show a seperate covers drop down for the number of children covers.
Whether or not to show a seperate covers drop down for the number of infants covers.
An optional url for a custom success page to replace the default one.
An optional id specifying a fixed promotion for the widget to use
Whether or not to show the customer title field
Whether ot not to divide the time slots by service
Whether or not to ask for permission to send marketing material via sms
Whether or not to show opt-in checkboxes
Whether or not to show the postcode field
Whether or not a postcode is required to make a booking
Whether or not the diner can choose an area for their booking
Whether or not the list of areas should include an 'Any Area' option
The channel code that the widget theme uses
Whether to show the telephone number field.
Whether to show the mobile number field.
Whether to show the company field.
Whether to show the membership number field.
Membership ID field placeholder value
Whether Membership ID is required
Whether to show the room number field.
Whether or not to the promotions screen should be skipped
The dropdown text colour. This has to be passed so it can set on the stripe elements via javascript
The dropdown invalid text colour. This has to be passed so it can set on the stripe elements via javascript
The dropdown placeholder text colour. This has to be passed so it can set on the stripe elements via javascript
Whether or not this theme is for a group widget.
Whether or not this theme is for a cross sell widget.
Indicates if the restaurant where the theme was created has the event enquiry feature enabled.
Indicates which the type of the widget theme
Indicates the marketing level. E.g VenueAndGroup, VenueOnly, GroupOnly
Text Title used for the contact details view
Optional Theme Id
How the widget should behave with takeaway and reservation bookings
Whether or not to show the Households field
Whether or not to show the restaurant address
Whether or not to show the grouping by city option
Whether or not to show the order by closest option
Whether or not to pre-check the venue email marketing optin checkbox
Whether to show the comments field.
OK
Bearer token using a JWT
The microsite name.
The number of reviews to include.
OK
OK
Bearer token using a JWT
The microsite name.
The date we are requesting the setup for
The channel code.
OK
Contains the basic settings for a restaurant.
The restaurant's Id.
The name of the restaurant.
The maximum party size (covers) for an online booking.
The minimum party size (covers) for an online booking.
The default party size (covers) for an online booking.
true if the restaurant supports membership Ids, false otherwise.
true if the restaurant requires membership Ids when making bookings, false otherwise.
The name of the membership Id field.
The text to display if the restaurant has no availability.
true if the restaurant's phone number should be displayed when there is no availability.
The phone number to call to make bookings.
The currency symbol for the restaurant.
The currency code for the restaurant.
The name of the time zone the restaurant is in.
The name of the culture the restaurant uses.
The terms and conditions for making bookings (formatted in a HTML String).
The privacy policy for the restaurant (formatted in a HTML String).
The number of days in advance that the restaurant accepts bookings.
The type of Cut-off to be applied to bookings
The number of minutes before Service or Visit that the cut-off is applied. 0 means no cut-off applies
The maximum party size (covers) for a function.
The number of days in advance that the restaurant accepts function enquiries.
Whether the restaurant allows standby function enquiries.
Whether the restaurant allows customers to add themselves to the standby list.
Gets or sets countryCode for phone numbers
The ISO 2 letter code for the restaurant's country. Note that this can currently be null because a restaurant can technically set their country to one that doesn't exist.
The Restaurant Group Name
The Restaurant Remote Group Id
Whether the restaurant is part of a group of more than one restaurant
Whether provider marketing is enabled
Whether group marketing is enabled
The name the provider has chosen to display to their group marketing prefernces
Whether the restuarant has any active takeaway promotions
True if this restaurant partakes in the Loyalty Program
OK
Bearer token using a JWT
The microsite name of the restaurant.
The order to sort the reviews in.
The page number.
The number of reviews per page.
OK
OK
Bearer token using a JWT
The microsite name.
Optionally indicates whether to only get enabled cancellation reasons.
OK
Cancellation Reason
The Id of the reason.
The description of the reason.
Does this reason cause the customer to be blocked?
The priority that this reason should be displayed in, where a lower number means a higher priority.
Is the booking being cancelled because the customer didn't turn up?
Indicates if the reason is visible to the ONLINE channels regardless of the type of booking
Indicates if the reason is visible when cancelling standard bookings
Indicates if the reason is visible when cancelling function bookings
Indicates if the reason is visible when cancelling w8list bookings
OK
Find restaurants by location with availability
Bearer token using a JWT
The latitude (required).
The longitude (required).
The visit date required (required).
The visit time required (required).
The number of covers required (required).
The page number (required).
The number of items per page (required).
The number of minutes either side of the visit time to look for availability.
The search radius in metres.
The id of the user searching if authenticated
OK
OK
Bearer token using a JWT
The start date
The end date.
The channel codes
The list of microsite names requiring microsite summaries
The number of reviews required for each provider
OK
Contains the Microsite Summary Details.
The name of the restaurant.
The microsite name of the restaurant.
The address of the restaurant.
The restaurant's latitude co-ordinate
The restaurant's longitude co-ordinate
The restaurant's price point if set.
The logo Url.
The number of reviews.
The average review score.
The available promotions
OK
Find restaurants with availability by name
Bearer token using a JWT
A collection of restaurant names to match (required).
The visit date required (required).
The visit time required (required).
The number of covers required (required).
The page number.
The number of items per page.
the number of minutes before and after the visit time to search
Indicates whether all the pages up to {page} should be returned, or just that page.
An optional list of promotion types to filter the availability by.
Indicates if all promotion types passed in must be included in the time slot's promotion in order to be considered as valid availability. Requires at least one promotion type to be passed in to be used.
An optional list of cuisine types to filter the restaurants by.
OK
OK
Bearer token using a JWT
The latitude (required).
The longitude (required).
The visit date required (required).
The visit time required (required).
The number of covers required (required).
The search radius in metres.
The page number.
The number of items per page.
Indicates whether all the pages up to {page} should be returned, or just that page.
The id of the user searching if authenticated
An optional list of promotion types to filter the availability by.
Indicates if all promotion types passed in must be included in the time slot's promotion in order to be considered as valid availability. Requires at least one promotion type to be passed in to be used.
An optional list of cuisine types to filter the restaurants by.
The preferred sort order, ie, availability, price or review rating.
OK
OK
Bearer token using a JWT
The latitude (required).
The longitude (required).
The order to return the results (required).
The search radius in metres.
The page number.
The number of items per page.
Indicates whether all the pages up to {page} should be returned, or just that page.
Whether to prioritise restaurants that are bookable via the API
The id of the user searching if authenticated
An optional list of promotion types to filter the availability by.
Indicates if all promotion types passed in must be included in the time slot's promotion in order to be considered as valid availability. Requires at least one promotion type to be passed in to be used.
An optional list of cuisine types to filter the restaurants by.
OK
OK
Bearer token using a JWT
The microsite name.
The review Id.
The flag type.
The reason the review is being reported.
The IP address of the reporter.
OK
OK
Last updated
Was this helpful?