reservation-settings

Get merchant reservation settings

This endpoint provides all data that is required to initiate the reservation flow and is not part of the search endpoint.

Example curl:

curl https://{host}/v{X}/merchants/15/reservation-settings

Example response:

{
  "areaIds": [
    {
      "id": 2,
      "name": "Garden",
      "priority": 10
    }
  ],
  "areaSelectionRequired": true,
  "capacities": [
    1,
    2,
    3,
    4,
    5,
    6
  ],
  "links": [
    {
      "href": "https://{host}/v{X}/merchants/15",
      "method": "GET",
      "rel": "parent"
    },
    {
      "href": "https://{host}/v{X}/merchants/15/availabilities",
      "method": "GET",
      "rel": "availability_days"
    },
    {
      "href": "https://{host}/v{X}/merchants/15/availabilities/2017-01-01/times",
      "method": "GET",
      "rel": "availability"
    }
  ],
  "merchantNewsletterSelectionRequired": true,
  "minimumCapacityForEnquiries": 10,
  "onlineReservationInterval": 60,
  "reservationEnquiryEnabled": true,
  "specialTerms": "This is any custom string for special terms",
  "automaticConfirmation": true,
  "ccvEnabled": true
}
get/v1/merchants/{merchantId}/reservation-settings

Request

Path parameters

merchantIdinteger required

Id of the merchant

Response

Reservation settings response

capacitiesinteger[]

Number of guests allowed in a reservation

merchantNewsletterSelectionRequiredboolean

If true, a separate checkbox is displayed in the checkout for newsletter received from the restaurant

areaSelectionRequiredboolean

If true, we display available areas in a dropdown when a guest is making an online reservation

reservationEnquiryEnabledboolean

If true, the restaurants allows enquiries

minimumCapacityForEnquiriesinteger

Minimum number of guests for an enquiry

onlineReservationIntervalinteger

Time slots displayed for making a reservation

specialTermsstring

If true, special terms and conditions of the restaurant need to be confirmed upon making an online reservation

automaticConfirmationboolean

If true, the customer will receive an automatic email confirmation after he makes a reservation

ccvEnabledboolean

If true, credit card information is required when creating a reservation

Changes

No recorded changes to this operation across all 7 revisions of this API.