Skip to content
Last updated

Areas

An Area represents a specific space within a Venue where a customer can be seated, such as "Terrace", "Dining Room", or "Bar".

Object definition

KeyTypeStatusDescription
idStringMandatoryUnique identifier of the Area.
nameStringMandatoryName of the Area (e.g. "Terrace", "Inside", "Garden").
descriptionStringOptionalDescription of the Area shown to the user. Supports translations.

Get Available Areas

This endpoint retrieves a list of available Areas for a given Venue, based on party size and requested date.

Endpoint

GET https://api-sandbox.mozrest.com/v1/bc/areas

Query Parameters

ParameterStatusDescription
mzIdMandatoryID of the Venue to retrieve areas for.
partySizeMandatoryNumber of people for the booking.
dateMandatoryBooking date and time in UTC timestamp format (e.g. 1634387400 for 2021-10-16 14:30 UTC).

Example Request

curl GET "https://api-sandbox.mozrest.com/v1/bc/areas?mzId=63f37d00ebcf5bcf810efd64&partySize=2&date=1681308000" \
  -H "Authorization: Bearer {{api_key}}" \
  -H "x-locale: en"

Example Response

[
  {
    "id": "E05UL1pbTpCM6FU_hee29Q",
    "name": "Inside",
    "description": "Enjoy Mediterranean seafood, organic meat as well as a wide variety of innovative, locally inspired farm-to-table dishes that we have created for you, using fresh ingredients directly from local producers."
  },
  {
    "id": "HfzB4wU9RFGPaF1wrm6XBg",
    "name": "Outside",
    "description": "Enjoy unique moments of relaxation under the sky, with sunshade and comfortable pillows, just a 'bloom' away from the seawater."
  }
]