resmio

https://documentation.resmio.com/
Admin
Resmio provides various APIs and widgets for businesses, particularly restaurants, to integrate...
Tokens:23,731
Snippets:85
Trust Score:9.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### CURL Example for Menu Widget Product API

Source: https://documentation.resmio.com/unauthenticatedapi

An example `curl` command demonstrating how to make a GET request to the Menu Widget Product API. It includes setting the Content-Type header and using query parameters for offset and limit.

```bash
curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/menu_widget_product/{product_id}?offset=20&limit=80" \
	-H "Content-Type: application/json"
```

--------------------------------

### GET Product Details API Endpoint and Example Response

Source: https://documentation.resmio.com/unauthenticatedapi

This entry documents the API endpoint used to retrieve comprehensive details for a specific product within a facility. It outlines the HTTP method, path, and provides a full example of a successful 200 OK JSON response, showcasing the structure of product data, including nested arrays for allergens, modifier groups, modifiers, and variations.

```APIDOC
GET /v1/facility/{facility_id}/menu_widget_product/{product_id}
  - Description: Retrieves comprehensive details for a single product.
  - Parameters:
    - facility_id: string (path) - The unique identifier of the facility.
    - product_id: integer (path) - The unique identifier of the product.
  - Response (200 OK):
    - Content-Type: application/json
    - Body: A JSON object representing the product and its related entities.
      - created: string (datetime) - Timestamp of creation.
      - description: string - Product description.
      - facility: string (URI) - URI to the parent facility.
      - id: integer - Product's unique ID.
      - image: string (URI) - URI to product image.
      - menu: string (URI) - URI to the associated menu.
      - menu_category: string (URI) - URI to the associated menu category.
      - online_order_enabled: boolean - Indicates if online ordering is enabled for this product.
      - price_gross: string (decimal) - Gross price of the product.
      - product_allergens: array of objects - List of allergens associated with the product.
        - id: integer - Allergen ID.
        - title: string - Allergen title (e.g., "Cereals containing gluten").
        - resource_uri: string (URI) - URI to the allergen resource.
      - product_identifier: string - Custom product identifier.
      - product_modifier_groups: array of objects - Groups of product modifiers.
        - id: integer - Modifier group ID.
        - title: string - Modifier group title (e.g., "Salad Dressings").
        - minimum_quantity: integer - Minimum modifiers required from this group.
        - maximum_quantity: integer - Maximum modifiers allowed from this group.
        - resource_uri: string (URI) - URI to the modifier group resource.
      - product_modifiers: array of objects - Individual product modifiers.
        - id: integer - Modifier ID.
        - title: string - Modifier title (e.g., "Vinegar and oil").
        - price_gross: string (decimal) - Price of the modifier.
        - priority: float - Display priority.
        - product_modifier_group: string (URI) - URI to the parent modifier group.
        - resource_uri: string (URI) - URI to the modifier resource.
      - product_variations: array of objects - Different variations of the product.
        - id: integer - Variation ID.
        - title: string - Variation title (e.g., "Medium").
        - price_gross: string (decimal) - Price of the variation.
        - modifier_price_multiplicator: string (decimal) - Multiplier for modifier prices.
        - priority: float - Display priority.
        - resource_uri: string (URI) - URI to the variation resource.
      - resource_uri: string (URI) - URI to the product resource itself.
      - title: string - Product title (e.g., "Cesar Salad").
      - updated: string (datetime) - Timestamp of last update.
```

```json
{
    "created": "2020-08-03T08:41:53.351387",
    "description": "Nice cesar salad\nNot for Brutus!",
    "facility": "/v1/facility/the-fish",
    "id": 13,
    "image": "",
    "menu": "/v1/facility/the-fish/menus/2",
    "menu_category": "/v1/facility/the-fish/menu_categories/9",
    "online_order_enabled": true,
    "price_gross": "3.99",
    "product_allergens": [{
            "created": "2020-08-03T08:41:53.248501",
            "facility": "/v1/facility/the-fish",
            "id": 7,
            "products": ["/v1/facility/the-fish/products/13"],
            "resource_uri": "/v1/facility/the-fish/product_allergens/7",
            "title": "Cereals containing gluten",
            "updated": "2020-08-03T12:19:37.564397"
        }
    ],
    "product_identifier": "1",
    "product_modifier_groups": [{
            "created": "2020-08-03T08:41:53.337791",
            "facility": "/v1/facility/the-fish",
            "id": 5,
            "maximum_quantity": 1,
            "menu": "/v1/facility/the-fish/menus/2",
            "minimum_quantity": 1,
            "resource_uri": "/v1/facility/the-fish/product_modifier_groups/5",
            "title": "Salad Dressings",
            "title_public": "Dressings",
            "updated": "2020-08-03T08:41:53.337817"
        }
    ],
    "product_modifiers": [{
            "created": "2020-08-03T08:41:53.354494",
            "facility": "/v1/facility/the-fish",
            "id": 34,
            "maximum_quantity": 1,
            "menu": "/v1/facility/the-fish/menus/2",
            "minimum_quantity": 0,
            "price_gross": "0.00",
            "priority": 1.0,
            "product": "/v1/facility/the-fish/products/13",
            "product_modifier_group": "/v1/facility/the-fish/product_modifier_groups/5",
            "resource_uri": "/v1/facility/the-fish/product_modifiers/34",
            "title": "Vinegar and oil",
            "updated": "2020-08-03T08:41:53.354520"
        }, {
            "created": "2020-08-03T08:41:53.357885",
            "facility": "/v1/facility/the-fish",
            "id": 35,
            "maximum_quantity": 1,
            "menu": "/v1/facility/the-fish/menus/2",
            "minimum_quantity": 0,
            "price_gross": "0.00",
            "priority": 2.0,
            "product": "/v1/facility/the-fish/products/13",
            "product_modifier_group": "/v1/facility/the-fish/product_modifier_groups/5",
            "resource_uri": "/v1/facility/the-fish/product_modifiers/35",
            "title": "Yoghurt",
            "updated": "2020-08-03T08:41:53.357912"
        }, {
            "created": "2020-08-03T08:41:53.361205",
            "facility": "/v1/facility/the-fish",
            "id": 36,
            "maximum_quantity": 1,
            "menu": "/v1/facility/the-fish/menus/2",
            "minimum_quantity": 0,
            "price_gross": "0.00",
            "priority": 3.0,
            "product": "/v1/facility/the-fish/products/13",
            "product_modifier_group": "/v1/facility/the-fish/product_modifier_groups/5",
            "resource_uri": "/v1/facility/the-fish/product_modifiers/36",
            "title": "Balsamico",
            "updated": "2020-08-03T08:41:53.361231"
        }
    ],
    "product_variations": [{
            "created": "2020-08-03T08:41:53.367070",
            "facility": "/v1/facility/the-fish",
            "id": 38,
            "menu": "/v1/facility/the-fish/menus/2",
            "modifier_price_multiplicator": "2.00",
            "price_gross": "5.99",
            "priority": 10.3,
            "product": "/v1/facility/the-fish/products/13",
            "resource_uri": "/v1/facility/the-fish/product_variations/38",
            "title": "Medium",
            "updated": "2020-08-03T12:18:25.364456"
        }, {
            "created": "2020-08-03T08:41:53.369598",
            "facility": "/v1/facility/the-fish",
            "id": 39,
            "menu": "/v1/facility/the-fish/menus/2",
            "modifier_price_multiplicator": "4.00",
            "price_gross": "7.99",
            "priority": 100.0,
            "product": "/v1/facility/the-fish/products/13",
            "resource_uri": "/v1/facility/the-fish/product_variations/39",
            "title": "Large",
            "updated": "2020-08-03T12:18:25.630464"
        }, {
            "created": "2020-08-03T08:41:53.363895",
            "facility": "/v1/facility/the-fish",
            "id": 37,
            "menu": "/v1/facility/the-fish/menus/2",
            "modifier_price_multiplicator": "1.00",
            "price_gross": "3.99",
            "priority": 5.0,
            "product": "/v1/facility/the-fish/products/13",
            "resource_uri": "/v1/facility/the-fish/product_variations/37",
            "title": "Small",
            "updated": "2020-08-03T12:18:25.150822"
        }
    ],
    "resource_uri": "/v1/facility/the-fish/menu_widget_product/13",
    "title": "Cesar Salad",
    "updated": "2020-08-03T12:19:37.393787"
}
```

--------------------------------

### Read Public Feedback cURL Example

Source: https://documentation.resmio.com/unauthenticatedapi

Example cURL command to retrieve public feedback for a facility using the `GET /facility/{facility_id}/feedback` endpoint. It demonstrates setting the `Content-Type` header and using `offset` and `limit` query parameters for pagination.

```bash
curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/feedback?offset=20&limit=80" \
	-H "Content-Type: application/json"
```

--------------------------------

### Create Booking cURL Example

Source: https://documentation.resmio.com/unauthenticatedapi

Example cURL command to create a new booking using the `POST /facility/{facility_id}/bookings` endpoint. It demonstrates setting the `Content-Type` header and providing the request body from a file named `request_body`.

```bash
curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/bookings" \
	-H "Content-Type: application/json" \
	-d @request_body
```

--------------------------------

### cURL Example: Get Public Facility Information

Source: https://documentation.resmio.com/unauthenticatedapi

A command-line example demonstrating how to make a GET request to the Resmio API's facility public information endpoint using cURL, specifying the required Content-Type header.

```curl
curl -X GET "https://api.resmio.com/v1/facility/{facility_id}" \
	-H "Content-Type: application/json"
```

--------------------------------

### CURL Example for Reading Facility Tickets

Source: https://documentation.resmio.com/unauthenticatedapi

Demonstrates how to make a GET request to the /facility/{facility_id}/tickets endpoint using cURL. The example includes specifying URI parameters, query parameters for filtering (type, is_active, offset, limit), and setting the Content-Type header.

```bash
curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/tickets?type=event&is_active=true&offset=20&limit=80" \
	-H "Content-Type: application/json"
```

--------------------------------

### cURL Example for Creating Menu Widget Order

Source: https://documentation.resmio.com/unauthenticatedapi

Demonstrates how to send a POST request using cURL to create a new menu widget order. This example includes setting the required `MENU-CART-UUID` and `Content-Type` headers, and referencing an external file for the request body.

```bash
curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/menu_widget_cart_order" \
	-H "MENU-CART-UUID: bc9c29e5-6137-45b5-b900-8be8812a82ba" \
	-H "Content-Type: application/json" \
	-d @request_body
```

--------------------------------

### Request Headers Example

Source: https://documentation.resmio.com/unauthenticatedapi

An example of the HTTP headers required for making a request to the Resmio API, specifically setting the Content-Type to application/json.

```http
Content-Type: application/json
```

--------------------------------

### Integrate resmio Menu Widget iFrame with Source Tracking

Source: https://documentation.resmio.com/menu-widget

Add a 'source' GET parameter to the iframe's 'src' URL to track the origin of orders, which is useful when integrating the widget on multiple websites. Replace 'SOURCE' with any URL-escaped string.

```HTML
<iframe src="https://app.resmio.com/FACILITY_ID/menu-widget?source=SOURCE" width="800" height="600"> </iframe>
```

--------------------------------

### Center and Set Width for resmio Reputation Widget Wrapper

Source: https://documentation.resmio.com/reputation-widget

This CSS example demonstrates how to center the `.resmio-reputation-badge-wrapper` and set its width. By applying `margin: 0 auto;` and a specific `width`, you can control the widget's horizontal alignment and size within its container.

```CSS
.resmio-reputation-badge-wrapper {
  margin: 0 auto;
  width: 350px;
}
```

--------------------------------

### cURL Example for GET /facility

Source: https://documentation.resmio.com/unauthenticatedapi

A cURL command demonstrating how to query the /facility endpoint with various filtering parameters, including network status, verification, automatic booking confirmation, location, distance, availability, and pagination.

```curl
curl -X GET "https://api.resmio.com/v1/facility?in_partner_network=true&verified=true&automatically_confirm_bookings=true&near=13.41053,52.52437&distance=20000&check_closed_date=2019-08-28&check_min_num=3&offset=20&limit=80" \
	-H "Content-Type: application/json"
```

--------------------------------

### Response Body Example: Get Public Facility Information (200 OK)

Source: https://documentation.resmio.com/unauthenticatedapi

A comprehensive sample JSON response body returned upon a successful GET request to the facility public information API. It includes various facility attributes, such as booking settings, contact details, opening hours, and crucially, the 'buttonCode' and 'widgetCode' for website integration.

```json
{
    "attributes": [],
    "booking_cancel_username_required": false,
    "booking_charge_username_required": false,
    "booking_create_username_required": false,
    "booking_deposits_enabled": false,
    "booking_edit_username_required": false,
    "buttonCode": "<script data-resmio-button=\"velez-huynh\">\n  (function(d, s) {\n    var js, rjs = d.getElementsByTagName(s)[0];\n    js = d.createElement(s);\n    js.src = \"//192.168.137.128:8000/static/en/button.js\";\n    js.async = true;\n   rjs.parentNode.insertBefore(js, rjs); }(document, \"script\")\n  );\n</script>",
    "cancel_without_fees": false,
    "cancel_without_fees_days": 0,
    "categories": [],
    "city": "Wilkinsonstad",
    "country": "NG",
    "currency": "EUR",
    "deposit_amount": 50.0,
    "deposit_option": "booking",
    "deposit_reference": null,
    "deposit_times_enabled": false,
    "deposits_certain_group_enabled": false,
    "deposits_certain_group_size": 0,
    "deposits_charge_automatically": false,
    "deposits_widget_description": "",
    "description": "Dignissimos ea nisi unde est vitae velit. Doloribus culpa quidem nihil corrupti nam nisi. Veniam ullam ipsa atque rem amet vero possimus laboriosam. Ex saepe sed velit vitae natus animi nobis.",
    "description_multilingual": {},
    "email": "velez-huynh@example.com",
    "facebook_page": "",
    "facebook_pixel": "",
    "feedback_average": null,
    "feedback_count": null,
    "feedback_enabled": true,
    "feedback_public": false,
    "feedback_stars_average": null,
    "id": "velez-huynh",
    "images": [],
    "in_partner_network": false,
    "instagram_page": "",
    "language": "en",
    "location": null,
    "logo": null,
    "max_num": 9,
    "min_book_in_advance_hours": 0,
    "min_num": 1,
    "name": "Velez-Huynh",
    "offers": [],
    "opening_hours": [
        {
            "begins": "09:00",
            "capacity": 10,
            "ends": "22:00",
            "weekdays": [
                0,
                1,
                2,
                3,
                4,
                5,
                6
            ]
        },
        {
            "begins": "09:00",
            "capacity": 10,
            "ends": "22:00",
            "weekdays": [
                0,
                1,
                2,
                3,
                4,
                5,
                6
            ]
        }
    ],
    "phone": "",
    "primary_review_channel": "resmio",
    "reachedBookingLimit": false,
    "resource_uri": "/v1/facility/velez-huynh",
    "short_description": "",
    "slug": "velez-huynh",
    "stars_atmosphere_enabled": false,
    "stars_atmosphere_orders_enabled": false,
    "stars_atmosphere_tickets_enabled": false,
    "stars_food_enabled": true,
    "stars_food_orders_enabled": true,
    "stars_food_tickets_enabled": true,
    "stars_satisfaction_enabled": false,
    "stars_satisfaction_orders_enabled": false,
    "stars_satisfaction_tickets_enabled": false,
    "stars_service_enabled": true,
    "stars_service_orders_enabled": true,
    "stars_service_tickets_enabled": true,
    "state": "Berlin",
    "street": "Allen Plains",
    "stripe_sepa_enabled": false,
    "timezone": "Europe/Berlin",
    "twitter_page": "",
    "type": "restaurant",
    "unique_deposit_hours": {},
    "verified": true,
    "visual_opening_hours": [],
    "website": "",
    "widgetCode": "<div id=\"resmio-velez-huynh\"></div>\n<script>(function(d, s) {\n    var js, rjs = d.getElementsByTagName(s)[0];\n    js = d.createElement(s);\n    js.src = \"//192.168.137.128:8000/static/en/widget.js#id=velez-huynh&width=275px&height=400px\";\n    rjs.parentNode.insertBefore(js, rjs);\n}(document, \"script\"));\n</script>",
    "widget_closed_text": "Sorry, we are closed on %s",
    "widget_custom_text": "",
    "youtube_page": "",
    "zip_code": "86881"
}
```

--------------------------------

### cURL Example for Creating Menu Widget Cart

Source: https://documentation.resmio.com/unauthenticatedapi

This cURL command demonstrates how to send a POST request to create a new menu widget cart. It includes setting the Content-Type header and providing a request body from a file.

```bash
curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/menu_widget_cart" \
	-H "Content-Type: application/json" \
	-d @request_body
```

--------------------------------

### Integrate resmio Menu Widget as a Basic Link

Source: https://documentation.resmio.com/menu-widget

This URL provides a direct link to the resmio menu widget for a specific facility. Replace `FACILITY_ID` with your unique identifier to enable direct access to your menu.

```text
https://app.resmio.com/FACILITY_ID/menu-widget
```

--------------------------------

### GET /facility API Endpoint Documentation

Source: https://documentation.resmio.com/unauthenticatedapi

Documents the GET method for the /facility endpoint, which retrieves a list of facilities (restaurants). It details all supported header and query parameters, their types, requirements, and examples for filtering and pagination.

```APIDOC
GET: /facility
Description: Get a list of facilities (restaurants)

Header Parameters:
  Content-Type:
    Description: The content type of the request. The API currently only understands application/json.
    Required: true
    Type: string
    Example: application/json

Query Parameters:
  in_partner_network:
    Description: Filters facilities whether they want to be listed in partner networks or not.
    Required: false
    Type: boolean
    Example: true
  verified:
    Description: These restaurants have been reviewed by an employee of resmios and are considered real restaurants. Setting verified to True will return only real restaurants and exclude for example test restaurants.
    Required: false
    Type: boolean
    Example: true
  automatically_confirm_bookings:
    Description: Filters facilities whether they have automatic confirmation enabled or not. Setting this filter to True will return only restaurants that automatically accept bookings.
    Required: false
    Type: boolean
    Example: true
  near:
    Description: Get a list of facilities ordered by location. By default facilities in a radius of 50 km will be shown. This value can be adjusted by adding the "radius" URL parameter and a kilometer (km) value. The parameter is a string with the comma separated longitude and latitude.
    Required: false
    Type: string
    Example: 13.41053,52.52437
  distance:
    Description: If "near" is provided then by default facilities in a radius of 50 km will be shown. This parameter here adjusts the radius. e.g. 20000 for 20km.
    Required: false
    Type: integer
    Example: 20000
  check_closed_date:
    Description: Get a list of facilities filtered by availability. By default if you specify a date in the check_closed_date parameter only facilities are returned that have at least 1 free seat available. You can adjust the required free seats by specifying the check_min_num field and ask the system for example to only return facilities that have "4" free seats available.
    Note: The request parameters described above can be combined with other parameters, e.g. location filters.
    Note: As the calculation of availabilities is quite complex and we return "real time data" we rely on the cached value for availabilities. In some cases it can be that we return a facility and when you request later the availability it says that no free spots are available.
    Required: false
    Type: string
    Example: 2019-08-28
  check_min_num:
    Description: This parameter allows you to filter facilities by the minimum required amount of free seats. It can only be used together with check_closed_date, otherwise it will be ignored.
    Note: As the calculation of availabilities is quite complex and we return "real time data" we rely on the cached value for availabilities. In some cases it can be that we return a facility and when you request later the availability it says that no free spots are available.
    Required: false
    Type: integer
    Example: 3
  booking_enabled:
    Description: Get facilities with booking functionality enabled or disabled.
    Required: false
    Type: boolean
  ordering_enabled:
    Description: Get facilities with ordering functionality enabled or disabled.
    Required: false
    Type: boolean
  offset:
    Description: Skip over a number of elements by specifying an offset value for the query.
    Required: false
    Type: integer
    Example: 20
  limit:
    Description: Limit the number of elements on the response.
    Required: false
    Type: integer
    Example: 80

Possible Responses:
  200: Success
```

--------------------------------

### Basic Reservation Widget Link Integration

Source: https://documentation.resmio.com/reservation-widget

Provides the base URL for linking to the resmio reservation widget. Users need to replace `FACILITY_ID` with their specific facility identifier to direct users to their booking page.

```URL
https://app.resmio.com/FACILITY_ID/widget
```

--------------------------------

### Create Booking Request Body JSON Example

Source: https://documentation.resmio.com/unauthenticatedapi

Example JSON structure for the request body when creating a new booking. It includes fields such as number of guests, date, facility resources, guest name, email, phone, comments, and various subscription/deposit flags.

```json
{
  "num": 2,
  "date": "2019-08-29T23:00:00.000Z",
  "facility_resources": [],
  "name": "Test Name",
  "email": "test@example.com",
  "phone": "016097230000",
  "comment": "Some example message for the restaurant owner",
  "price_change": 0,
  "checksum": "35d3a6247bc42942222f7d26820a432ee4923a9c27e6ba7810f7169779ecf591",
  "source": "",
  "fb_access_token": null,
  "newsletter_subscribe": false,
  "resource_group": "",
  "resmio_newsletter_subscribe": false,
  "booking_deposit": null,
  "send_email_receipt": true
}
```

--------------------------------

### Integrate resmio Menu Widget Link with Source Tracking

Source: https://documentation.resmio.com/menu-widget

This URL allows integrating the menu widget while tracking the source of the visit. Replace `FACILITY_ID` with your facility ID and `SOURCE` with a URL-escaped string to identify the origin of the link.

```text
https://app.resmio.com/FACILITY_ID/menu-widget?source=SOURCE
```

--------------------------------

### Example JSON Response for Reviews

Source: https://documentation.resmio.com/unauthenticatedapi

Illustrates the structure of a successful API response containing a list of review objects, including metadata for pagination. Each review includes creation timestamp, food/service positivity, ID, public comment, and average stars.

```JSON
{
  "meta": {
    "limit": 20,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": 2
  },
  "objects": [
    {
      "created": "2019-06-28T15:31:21Z",
      "food_positive": true,
      "id": 640056,
      "public_comment": "It was super, Thank you!",
      "service_positive": true,
      "stars_average": null
    },
    {
      "created": "2014-05-12T07:17:10Z",
      "food_positive": false,
      "id": 2004,
      "public_comment": "I think they are selling instant meals.",
      "service_positive": false,
      "stars_average": null
    }
  ]
}
```

--------------------------------

### resmio Widget Iframe Integration

Source: https://documentation.resmio.com/reservation-widget

These HTML iframe snippets demonstrate how to embed the resmio widget into a webpage. The basic integration requires a `FACILITY_ID`, while the extended version allows specifying a `source` for tracking purposes. Both examples show adjustable `width` and `height` attributes.

```html
<iframe src="https://app.resmio.com/FACILITY_ID/widget" width="275" height="400"> </iframe>
```

```html
<iframe src="https://app.resmio.com/FACILITY_ID/widget?source=SOURCE" width="275" height="400"> </iframe>
```

--------------------------------

### Reservation Widget Link with Source Tracking

Source: https://documentation.resmio.com/reservation-widget

Extends the basic reservation widget URL to include a `source` parameter, allowing tracking of the reservation's origin. Both `FACILITY_ID` and `SOURCE` placeholders must be replaced with the actual facility ID and a URL-escaped source string.

```URL
https://app.resmio.com/FACILITY_ID/widget?source=SOURCE
```

--------------------------------

### resmio Menu Widget Customization Parameters (Button & iFrame)

Source: https://documentation.resmio.com/menu-widget

This section details the available parameters for customizing the visual appearance of the resmio menu widget. These parameters can be used in the 'data-resmio-menu-options' attribute for button integration or as GET parameters in the 'src' URL for iframe integration. All color values must be in hex notation and URL-encoded.

```APIDOC
Parameters for data-resmio-menu-options (Button) or URL GET parameters (iFrame):

theme: string
  - Description: Sets the overall theme of the widget.
  - Values: 'light' (default), 'dark'

line_color: string (hex, URL-encoded)
  - Description: Color for all lines within the widget.
  - Example: '%23CD3B1C'

text_color: string (hex, URL-encoded)
  - Description: Default color for text.
  - Example: '%23000000'

error_color: string (hex, URL-encoded)
  - Description: Color used for error messages.
  - Example: '%23FF0000'

alert_color: string (hex, URL-encoded)
  - Description: Color used for alert messages.
  - Example: '%23FFFF00'

primary_color: string (hex, URL-encoded)
  - Description: Color for category headers and links in the left sidebar.
  - Example: '%23007BFF'

background_color: string (hex, URL-encoded)
  - Description: Background color of the widget.
  - Example: '%23FFFFFF'

gradient_top_color: string (hex, URL-encoded)
  - Description: Top color for the background gradient.
  - Example: '%23F8F9FA'

gradient_bottom_color: string (hex, URL-encoded)
  - Description: Bottom color for the background gradient.
  - Example: '%23E9ECEF'

menu_color: string (hex, URL-encoded)
  - Description: Background color of the left sidebar. (Requires iframe to be set to 1 for iframe integration, though not explicitly shown as a parameter here).
  - Example: '%23F0F0F0'

Note: For iframe integration, ensure special characters like '#' are URL-encoded (e.g., '#' becomes '%23').
```

--------------------------------

### Include resmio Reputation Widget JavaScript

Source: https://documentation.resmio.com/reputation-widget

This script asynchronously loads the resmio reputation widget JavaScript file into the webpage. It is recommended to place this script before the closing `<body>` tag to prevent blocking the rendering of your HTML content.

```HTML
<script>
  (function() {
    var script = document.createElement('script');
    script.async = true;
    script.src = 'https://static.resmio.com/static/reputation-widget.js';
    var entry = document.getElementsByTagName('script')[0];
    entry.parentNode.insertBefore(script, entry);
  })();
</script>
```

--------------------------------

### GET Menu Widget Product API Endpoint

Source: https://documentation.resmio.com/unauthenticatedapi

Documents the HTTP GET endpoint for retrieving specific menu widget product details. This endpoint allows fetching product information by ID, with options for pagination through query parameters and requires specific header content types.

```APIDOC
GET: /facility/{facility_id}/menu_widget_product/{product_id}
  Description: Get the details for a specific product specified by product_id with all variations, allergens and modifiers.
  URI Parameters:
    facility_id:
      type: string
      required: true
    product_id:
      type: string
      required: true
  Header Parameters:
    Content-Type:
      type: string
      required: true
      description: The content type of the request. The API currently only understands application/json.
      examples: ["application/json"]
  Query Parameters:
    offset:
      type: integer
      required: false
      description: Skip over a number of elements by specifying an offset value for the query.
      examples: ["20"]
    limit:
      type: integer
      required: false
      description: Limit the number of elements on the response.
      examples: ["80"]
  Possible Responses:
    200: Success
```

--------------------------------

### Customize resmio Menu Widget Button Colors Directly

Source: https://documentation.resmio.com/menu-widget

This example demonstrates how to override default theme colors by specifying individual color parameters within 'data-resmio-menu-options'. Colors must be provided in hex notation and URL-encoded (e.g., '#CD3B1C' becomes '%23CD3B1C').

```HTML
<script data-resmio-menu-button="FACILITY_ID" data-resmio-menu-options="theme=dark&line_color=%23CD3B1C">
...
```

--------------------------------

### Example Menu Widget Cart Item JSON Structure

Source: https://documentation.resmio.com/unauthenticatedapi

Illustrates the typical JSON structure of a single item within a menu widget cart. This object details product information, quantity, pricing, and references to related resources.

```json
{
    "created": "2020-08-03T12:49:09Z",
    "description": "Medium, Yoghurt",
    "facility": "/v1/facility/the-fish",
    "id": 3,
    "menu": "/v1/facility/the-fish/menus/2",
    "menu_widget_cart": "/v1/facility/the-fish/menu_widget_cart/6",
    "price_gross": "11.9800",
    "product": "/v1/facility/the-fish/menu_widget_product/13",
    "product_modifiers": ["/v1/facility/the-fish/product_modifiers/35"],
    "product_variation": "/v1/facility/the-fish/product_variations/38",
    "quantity": 2,
    "resource_uri": "/v1/facility/the-fish/menu_widget_cart_item/3",
    "title": "Cesar Salad",
    "updated": "2020-08-03T12:49:14Z"
}
```

--------------------------------

### Create Booking Deposit API Endpoint

Source: https://documentation.resmio.com/unauthenticatedapi

Defines the API for creating a new booking deposit for a facility. It specifies the POST method, URI parameters, required headers, and provides example request and response bodies.

```APIDOC
POST: /facility/{facility_id}/booking_deposit

Creates a new booking deposit for a facility.

URI Parameters:
  facility_id:
    required: true
    type: string

Header Parameters:
  Content-Type:
    required: true
    type: string
    examples: application/json

Possible Responses:
  201

Request Body:
{
  "owner_name": "some name",
  "owner_email": "some_email@test.com",
  "amount": 30.25,
  "currency":  "EUR"
}

Response Body (201):
{
  "amount": 30.25,
  "booking_description": null,
  "cancel_allowed_without_fees": false,
  "converted_amount": null,
  "currency": "EUR",
  "deposit_data": {},
  "deposit_email_date": null,
  "deposit_status": "",
  "email_date": null,
  "employee_name": null,
  "employee_resource_uri": null,
  "facility": "/v1/facility/the-fish",
  "id": 2,
  "obfuscated_payment_details": null,
  "owner_email": "some_email@test.com",
  "owner_name": "some name",
  "payment_type": "OUTSTANDING",
  "refund_amount": 0.0,
  "resource_uri": "/v1/facility/the-fish/booking_deposit/2"
}
```

```curl
curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/booking_deposit" \
	-H "Content-Type: application/json" \
	-d @request_body
```

```json
{
  "owner_name": "some name",
  "owner_email": "some_email@test.com",
  "amount": 30.25,
  "currency":  "EUR"
}
```

```json
{
  "amount": 30.25,
  "booking_description": null,
  "cancel_allowed_without_fees": false,
  "converted_amount": null,
  "currency": "EUR",
  "deposit_data": {},
  "deposit_email_date": null,
  "deposit_status": "",
  "email_date": null,
  "employee_name": null,
  "employee_resource_uri": null,
  "facility": "/v1/facility/the-fish",
  "id": 2,
  "obfuscated_payment_details": null,
  "owner_email": "some_email@test.com",
  "owner_name": "some name",
  "payment_type": "OUTSTANDING",
  "refund_amount": 0.0,
  "resource_uri": "/v1/facility/the-fish/booking_deposit/2"
}
```

--------------------------------

### Request Body for Menu Widget Cart Creation

Source: https://documentation.resmio.com/unauthenticatedapi

Example JSON payload for creating a new menu widget cart. The 'type' field specifies the cart's purpose, such as 'delivery'.

```json
{
  "type": "delivery"
}
```

--------------------------------

### Apply Essential CSS for resmio Reputation Widget Container

Source: https://documentation.resmio.com/reputation-widget

These CSS rules are recommended for the `.resmio-reputation-widget` class to ensure proper layering, positioning, and display behavior. Applying `z-index`, `position: relative`, and `display: inline-block` helps the widget interact correctly with other elements on the page.

```CSS
z-index: 10000;
position: relative;
display: inline-block;
```

--------------------------------

### Example JSON Response for Facility Tickets

Source: https://documentation.resmio.com/unauthenticatedapi

Illustrates the detailed structure of a successful API response for facility tickets, including metadata for pagination. Each ticket object contains comprehensive information such as amount paid, availability, dates, capacity, currency, price, and status.

```JSON
{
  "meta": {
    "limit": 20,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": 4
  },
  "objects": [
    {
      "amount_paid": 0,
      "available": 10,
      "begins": "2013-11-29T16:00:00Z",
      "capacity": 10,
      "conditions": "",
      "created": "2013-11-28T09:38:27Z",
      "currency": "EUR",
      "description": "",
      "duration": null,
      "ends": null,
      "facility": "/v1/facility/the-fish",
      "id": 49,
      "image": null,
      "is_active": false,
      "max_party_size": null,
      "max_purchases": null,
      "min_party_size": null,
      "name": "Silvester",
      "price": "10.00",
      "public_page_url": "https://app.resmio.com/t/1d",
      "resource_uri": "/v1/facility/the-fish/tickets/49",
      "status": "active",
      "tickets_claimed": 0,
      "tickets_sold": 0,
      "type": "event",
      "updated": "2014-03-12T15:47:07Z"
    },
    {
      "amount_paid": 0,
      "available": 10,
      "begins": "2013-11-29T16:00:00Z",
      "capacity": 10,
      "conditions": "",
      "created": "2013-11-28T09:55:20Z",
      "currency": "EUR",
      "description": "",
      "duration": null,
      "ends": null,
      "facility": "/v1/facility/the-fish",
      "id": 50,
      "image": null,
      "is_active": false,
      "max_party_size": null,
      "max_purchases": null,
      "min_party_size": null,
      "name": "Silvester",
      "price": "10.00",
      "public_page_url": "https://app.resmio.com/t/1e",
      "resource_uri": "/v1/facility/the-fish/tickets/50",
      "status": "active",
      "tickets_claimed": 0,
      "tickets_sold": 0,
      "type": "event",
      "updated": "2014-03-12T15:47:14Z"
    },
    {
      "amount_paid": 0,
      "available": 50,
      "begins": "2013-12-03T16:15:00Z",
      "capacity": 50,
      "conditions": "",
      "created": "2013-12-02T10:37:48Z",
      "currency": "EUR",
      "description": "Test",
      "duration": null,
      "ends": null,
      "facility": "/v1/facility/the-fish",
      "id": 51,
      "image": null,
      "is_active": false,
      "max_party_size": null,
      "max_purchases": null,
      "min_party_size": null,
      "name": "Test",
      "price": "40.00",
      "public_page_url": "https://app.resmio.com/t/1f",
      "resource_uri": "/v1/facility/the-fish/tickets/51",
      "status": "active",
      "tickets_claimed": 0,
      "tickets_sold": 0,
      "type": "event",
      "updated": "2014-03-12T15:47:27Z"
    }
  ]
}
```

--------------------------------

### Embed Resmio Reservation Widget with HTML and JavaScript

Source: https://documentation.resmio.com/reservation-widget

Provides the standard HTML and JavaScript code to embed the resmio reservation widget directly into a webpage. The `FACILITY_ID` placeholder must be replaced with the actual facility ID, and the code should be placed within the `<body></body>` tag.

```HTML
<div id="resmio-FACILITY_ID"></div>
<script>(function(d, s) {
 var js, rjs = d.getElementsByTagName(s)[0];
 js = d.createElement(s);
 js.src = "//static.resmio.com/static/de/widget.js#id=FACILITY_ID&width=275px&height=400px";
 rjs.parentNode.insertBefore(js, rjs);
}(document, "script"));
</script>
```

--------------------------------

### Create Waitlist Entry API Endpoint

Source: https://documentation.resmio.com/unauthenticatedapi

Defines the API for creating a new entry on the waitlist for a facility. It specifies the POST method, URI parameters, required headers, and provides example request and response bodies.

```APIDOC
POST: /facility/{facility_id}/waitlist

Creates a new entry on the waitlist

URI Parameters:
  facility_id:
    required: true
    type: string

Header Parameters:
  Content-Type:
    required: true
    type: string
    examples: application/json

Possible Responses:
  201

Request Body:
{
    "date": "2020-07-13T09:00:00Z",
    "name": "Test test",
    "num": 2,
    "email": "test@example.com",
    "phone": "016097230000",
    "is_online": true
}

Response Body (201):
{
    "created": "2020-07-13T08:09:38Z",
    "date": "2020-07-13T09:00:00Z",
    "email": "test@example.com",
    "facility": "/v1/facility/the-fish",
    "id": 3,
    "is_online": true,
    "is_walkin": false,
    "name": "Test test",
    "num": 2,
    "phone": "016097230000",
    "resource_uri": "/v1/facility/the-fish/waitlist/3"
}
```

```curl
curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/waitlist" \
	-H "Content-Type: application/json" \
	-d @request_body
```

```json
{
    "date": "2020-07-13T09:00:00Z",
    "name": "Test test",
    "num": 2,
    "email": "test@example.com",
    "phone": "016097230000",
    "is_online": true
}
```

```json
{
    "created": "2020-07-13T08:09:38Z",
    "date": "2020-07-13T09:00:00Z",
    "email": "test@example.com",
    "facility": "/v1/facility/the-fish",
    "id": 3,
    "is_online": true,
    "is_walkin": false,
    "name": "Test test",
    "num": 2,
    "phone": "016097230000",
    "resource_uri": "/v1/facility/the-fish/waitlist/3"
}
```

--------------------------------

### Get Facility Menu Widget API

Source: https://documentation.resmio.com/unauthenticatedapi

Documents the API endpoint for retrieving content for the menu widget. This endpoint is only available if enabled by the facility. It specifies URI, header, and query parameters, including pagination options.

```APIDOC
GET: /facility/{facility_id}/menu_widget
Description: Get the content for the menu widget, in general a list with all configured menus. This is only available when enabled by the facility.

URI Parameters:
  facility_id:
    required: true
    type: string

Header Parameters:
  Content-Type:
    description: The content type of the request. The API currently only understands `application/json`
    required: true
    type: string
    examples: `application/json`

Query Parameters:
  offset:
    description: Skip over a number of elements by specifying an offset value for the query
    required: false
    type: integer
    examples: `20`
  limit:
    description: Limit the number of elements on the response
    required: false
    type: integer
    examples: `80`

Possible Responses:
  200
```

```curl
curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/menu_widget?offset=20&limit=80" \
	-H "Content-Type: application/json"
```

--------------------------------

### Product Acceptance Hours Data Model

Source: https://documentation.resmio.com/unauthenticatedapi

Defines the common structure for time slots when products can be delivered, picked up, or ordered via QR code. This model includes start and end times, associated facility and menu, and applicable weekdays.

```APIDOC
ProductAcceptHours Object (used for delivery, pickup, and QR order):
  begins: string (time)
    The start time for the acceptance slot (e.g., "09:00:00").
  created: string (datetime)
    Timestamp of when this acceptance slot was created (e.g., "2020-08-03T08:41:53.188988").
  ends: string (time)
    The end time for the acceptance slot (e.g., "22:00:00").
  facility: string
    URI of the facility associated with these hours (e.g., "/v1/facility/the-fish").
  id: integer
    Unique identifier for this acceptance slot.
  menu: string
    URI of the menu associated with these hours (e.g., "/v1/facility/the-fish/menus/2").
  menu_categories: array of string (optional, only for QR order)
    List of URIs for menu categories applicable to these hours. Present in product_qr_order_accept_hours.
  resource_uri: string
    The unique resource identifier for this acceptance slot (e.g., "/v1/facility/the-fish/product_delivery_accept_hours/2").
  updated: string (datetime)
    Timestamp of the last update to this acceptance slot (e.g., "2020-08-03T08:41:53.189025").
  weekdays: array of integer
    List of integers representing days of the week (0=Monday, 6=Sunday) when these hours apply.
```

--------------------------------

### Get Facility Availabilities API

Source: https://documentation.resmio.com/unauthenticatedapi

Documents the API endpoint for retrieving facility availabilities for a specific day. It details the URI, header, and query parameters, along with a sample cURL request and the expected JSON response body structure.

```APIDOC
GET: /facility/{facility_id}/availability
Description: Get the availabilities for a facility for specific day. It will return the availabilities for today if no date is explicitely set.

URI Parameters:
  facility_id:
    required: true
    type: string

Header Parameters:
  Content-Type:
    description: The content type of the request. The API currently only understands `application/json`
    required: true
    type: string
    examples: `application/json`

Query Parameters:
  date__gte:
    description: Specify the date to filter. The date is understood to be in the timezone of the facility.
    required: false
    type: date-only
    examples: `2019-08-29`

Possible Responses:
  200
```

```curl
curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/availability?date__gte=2019-08-29" \
	-H "Content-Type: application/json"
```

```json
{
  "meta": {
    "limit": 1000,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": 19
  },
  "objects": [
    {
      "available": 20,
      "available_authenticated": 20,
      "checksum": "ada9108866fe1a84916a47ca06ea807e14f293f218f12df3c4b5e51fea0171d3",
      "date": "2019-08-29T10:00:00Z",
      "id": null,
      "local_date_formatted": "01. Oktober 2016 12:00",
      "local_time_formatted": "12:00",
      "message": null,
      "price_change": 0,
      "resource_uri": "\/v1\/facility\/the-fish\/availability\/1475316000"
    },
    ...
    {
      "available": 20,
      "available_authenticated": 20,
      "checksum": "8c7c910a178ce360271c5011b803fe87fac8001c93d3a443b4f0cbc8c8c605f9",
      "date": "2019-08-29T19:00:00Z",
      "id": null,
      "local_date_formatted": "01. Oktober 2016 21:00",
      "local_time_formatted": "21:00",
      "message": null,
      "price_change": 0,
      "resource_uri": "\/v1\/facility\/the-fish\/availability\/1475348400"
    }
  ]
}
```

--------------------------------

### Resmio Facility Object Data Structure

Source: https://documentation.resmio.com/unauthenticatedapi

This JSON object represents a sample structure for a Resmio facility, detailing various attributes such as enabled features, feedback statistics, contact information, opening hours, and integration keys. It serves as an example of the data returned for a facility.

```JSON
{
  "tableplan_enabled": true,
  "test_tariff": false,
  "ticket_fee": "0.06",
  "ticketing_enabled": true,
  "upgradable": false,
  "user_rights_management_enabled": true,
  "vectron_enabled": true,
  "weight": 5,
  "feedback_average": 83.0,
  "feedback_count": 9,
  "feedback_enabled": true,
  "feedback_public": false,
  "feedback_stars_average": null,
  "google_page": "",
  "google_places_id": null,
  "google_redirects_enabled": true,
  "id": "velez-huynh",
  "images": [],
  "in_partner_network": false,
  "instagram_page": "",
  "language": "en",
  "location": null,
  "logo": null,
  "max_discount": 30,
  "max_num": 9,
  "min_book_in_advance_hours": 0,
  "min_num": 1,
  "name": "Velez-Huynh",
  "offers": [],
  "opening_hours": [
    {
      "begins": "09:00",
      "capacity": 10,
      "ends": "22:00",
      "weekdays": [
        0,
        1,
        2,
        3,
        4,
        5,
        6
      ]
    },
    {
      "begins": "09:00",
      "capacity": 10,
      "ends": "22:00",
      "weekdays": [
        0,
        1,
        2,
        3,
        4,
        5,
        6
      ]
    }
  ],
  "ordering_enabled": true,
  "paypal_client_id": null,
  "paypal_secret_key": null,
  "phone": "",
  "pii_retention_period": "forever",
  "primary_review_channel": "resmio",
  "reachedBookingLimit": false,
  "receipt_extra_text": "",
  "resource_combination_by_combination": false,
  "resource_combination_by_group": true,
  "resource_uri": "/v1/facility/velez-huynh",
  "resources_enabled": true,
  "send_bookings_to_vectron": false,
  "send_reminders": false,
  "short_description": "",
  "show_tables_and_allow_allocation_of_bookings": false,
  "slug": "velez-huynh",
  "stars_atmosphere_enabled": false,
  "stars_atmosphere_orders_enabled": false,
  "stars_atmosphere_tickets_enabled": false,
  "stars_food_enabled": true,
  "stars_food_orders_enabled": true,
  "stars_food_tickets_enabled": true,
  "stars_satisfaction_enabled": false,
  "stars_satisfaction_orders_enabled": false,
  "stars_satisfaction_tickets_enabled": false,
  "stars_service_enabled": true,
  "stars_service_orders_enabled": true,
  "stars_service_tickets_enabled": true,
  "state": "Berlin",
  "street": "Allen Plains",
  "stripe_publish_key": null,
  "stripe_secret_key": null,
  "stripe_sepa_enabled": false,
  "timezone": "Europe/Berlin",
  "twitter_page": "",
  "type": "restaurant",
  "unavailable_booking_enabled": false,
  "unique_deposit_hours": {},
  "vat_id": "",
  "vat_rate": "0",
  "verified": true,
  "visual_opening_hours": [],
  "website": "",
  "widget_closed_text": "Sorry, we are closed on %s",
  "widget_custom_text": "",
  "youtube_page": "",
  "zip_code": "86881"
}
```

--------------------------------

### Customize Resmio Widget: Set Background and Font Colors

Source: https://documentation.resmio.com/reservation-widget

Enables customization of the embedded reservation widget's background and font colors using HEX representation. Modify the `backgroundColor` and `color` parameters in the JavaScript source. Remember to replace `FACILITY_ID`.

```JavaScript
...
 js.src = "//static.resmio.com/static/de/widget.js#id=FACILITY_ID&width=275px&height=400px&backgroundColor=60493b&color=ffffff";
...
```
Tokens:
Raw