# Venues

A Venue is a business location that offers online booking services through Mozrest.

## Object definition

| Key | Type | Status | Description |
|  --- | --- | --- | --- |
| id | String | **Mandatory** | Unique identifier for the Venue. |
| name | String | **Mandatory** | Name of the Venue. |
| city | String | **Mandatory** | City where the Venue is located. |
| address | String | **Mandatory** | Full address of the Venue. |
| countryCode | String | **Mandatory** | Country code in ISO 3166-1 alpha-2 format. |
| postalCode | String | **Optional** | Postal code of the Venue. |
| phoneNumber | String | **Optional** | Contact phone number of the Venue. |
| latitude | Float | **Optional** | Geolocation latitude. |
| longitude | Float | **Optional** | Geolocation longitude. |
| timezone | String | **Mandatory** | Timezone of the Venue in IANA format (e.g. Europe/London). |
| minCovers | Int | **Optional** | Minimum number of covers allowed per booking. |
| maxCovers | Int | **Optional** | Maximum number of covers allowed per booking. |
| bookingMessage | String | **Optional** | Custom message shown to users before booking. |
| bookableAreas | Bool | **Optional** | Indicates if the Venue supports selection of specific areas. |
| rms[id] | String | **Optional** | ID of the Reservation Management System associated with the Venue. |
| rms[name] | String | **Optional** | Name of the Reservation Management System. |
| url | String | **Optional** | Venue website URL. |
| minAdvanceBooking | Int | **Optional** | Minimum number of hours in advance a booking must be made. |
| minAdvanceOnlineCancelling | Int | **Optional** | Minimum number of hours in advance a booking can be canceled online. |
| currency | String | **Mandatory** | ISO 4217 currency code. |
| paymentDefinition | Object | **Optional** | Definition of deposit and no-show fee requirements. |
| paymentGateway | Object | **Optional** | Payment gateway configuration details. |
| paymentPolicy | String | **Optional** | Text describing the Venue’s cancellation or payment policy. |
| confirmationMessage | String | **Optional** | Message displayed after booking confirmation. |


## Get Available Venues

This endpoint retrieves a list of available Venues.

#### Endpoint

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

#### Query Parameters

| Parameter | Status | Description |
|  --- | --- | --- |
| filters[criteria] | **Optional** | Filter by Venue name (`LIKE %criteria%`). |
| filters[city] | **Optional** | Filter by Venue city (`LIKE %city%`). |
| filters[countryCode] | **Optional** | Filter by country code (ISO2). |


#### Example Request


```shell
curl GET "https://api-sandbox.mozrest.com/v1/bc/venues" \
  -H "Authorization: Bearer {{api_key}}" \
  -d "offset=0" \
  -d "limit=10" \
  -d "filters[criteria]=par" \
  -d "filters[city]=Par" \
  -d "filters[countryCode]=FR"
```

#### Example Response


```json
{
  "total": 1,
  "data": [
    {
      "id": "60e5a3ed409541da3650bd90",
      "name": "Restaurant Name",
      "city": "London",
      "address": "The Address 24, Picadilly",
      "countryCode": "GB",
      "postalCode": "W1J 9LL",
      "phoneNumber": "442072343456",
      "latitude": null,
      "longitude": null,
      "timezone": "Europe/London",
      "minCovers": 1,
      "maxCovers": 15,
      "bookingMessage": "Enjoy unique moments of relaxation...",
      "bookableAreas": true,
      "rms": {
        "id": "60e5a3ed409541da3650bd90",
        "name": "Reservation Software name"
      },
      "url": "https://venuewebsite.com",
      "minAdvanceBooking": 1,
      "minAdvanceOnlineCancelling": 24,
      "currency": "GBP",
      "paymentDefinition": {
        "requireCreditCard": true,
        "deposit": {
          "type": "fixed_price",
          "amount": 2000
        },
        "noShowFee": {
          "type": "fixed_price",
          "amount": 2000
        }
      },
      "paymentGateway": {
        "gateway": "stripe",
        "publishKey": "pk_test_2343823823823",
        "merchantId": null
      },
      "paymentPolicy": "Dinner Cancellation Policy...",
      "confirmationMessage": "Thank you for choosing Scampi!..."
    }
  ]
}
```

## Get a Specific Venue

This endpoint retrieves a specific Venue.

#### Endpoint

`GET https://api-sandbox.mozrest.com/v1/bc/venues/{id}`

#### URL Parameters

| Parameter | Status | Description |
|  --- | --- | --- |
| id | **Mandatory** | ID of the Venue. |


#### Example Request


```shell
curl GET "https://api-sandbox.mozrest.com/v1/bc/venues/{venue_id}" \
  -H "Authorization: Bearer {{api_key}}"
```

#### Example Response


```json
{
  "id": "60e5a3ed409541da3650bd90",
  "name": "Restaurant Name",
  "city": "London",
  "address": "The Address 24, Picadilly",
  "countryCode": "GB",
  "postalCode": "W1J 9LL",
  "phoneNumber": "442072343456",
  "latitude": null,
  "longitude": null,
  "timezone": "Europe/London",
  "minCovers": 1,
  "maxCovers": 15,
  "bookingMessage": "Enjoy unique moments of relaxation...",
  "bookableAreas": true,
  "rms": {
    "id": "60e5a3ed409541da3650bd90",
    "name": "Reservation Software name"
  },
  "url": "https://venuewebsite.com",
  "minAdvanceBooking": 1,
  "minAdvanceOnlineCancelling": 24,
  "currency": "GBP",
  "paymentDefinition": {
    "requireCreditCard": true,
    "deposit": {
      "type": "fixed_price",
      "amount": 2000
    },
    "noShowFee": {
      "type": "fixed_price",
      "amount": 2000
    }
  },
  "paymentGateway": {
    "gateway": "stripe",
    "publishKey": "pk_test_2343823823823",
    "merchantId": null
  },
  "paymentPolicy": "Dinner Cancellation Policy...",
  "confirmationMessage": "Thank you for choosing Scampi!..."
}
```