Resmio API (authenticated) Documentation

version v1
baseUri https://api.resmio.com/v1
protocols HTTPS

General

The Resmio API (authenticated) allowes restaurant owners or other software providers to interact with resmio's backend and provide a different UI. It is meant for restaurant owners that want to create a backend integration or for software providers that have a business relationship and receive the necessary authentication credentials to interact with the API. Each facility (restaurant) has an unique resmio ID in the system. For this documentation the resmio test facility The Fish (http://thefish.resmio.com) with the ID “the-fish“ is used. The resmio ID will not be changed when the name of the facility is edited by the user.

For any questions relating to the resmio API contact us via email at support@resmio.com.

Legal

Please note that you are accepting the terms of service of the resmio API by using the resmio API.

Facility API

Search Facility

GET: /facility

Get a list of facilities (restaurants)

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

in_partner_network

Filters facilities weather they want to be listed in partner networks or not. In addition those restaurants have been reviewed by resmio for their authenticity and should be integrated by partners. Add parameters as described in List of facilities to effect the number of shown facilities.

Property	Value
required	false
type	boolean
examples	`true`

near

Get a list of facilities ordered by location. By default facilites 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.

Property	Value
required	false
type	string
examples	`13.41053,52.52437`

distance

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

Property	Value
required	false
type	integer
examples	`20000`

check_closed_date

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.

Property	Value
required	false
type	string
examples	`2019-08-28`

check_min_num

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.

Property	Value
required	false
type	integer
examples	`3`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Search Facility

CURL EXAMPLE

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

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
    "meta": {
        "limit": 20,
        "next": "/v1/facility?limit=20&offset=20",
        "offset": 0,
        "previous": null,
        "total_count": 4
    },
    "objects": [
        {
            "active_plan": "/v1/facility/velez-huynh/monthly_subscriptions/1",
            "attributes": [],
            "automatically_confirm_bookings": true,
            "average_revenue_per_guest": "20.00",
            "average_revenue_per_guest_currency": "NGN",
            "booking_cancel_username_required": false,
            "booking_charge_username_required": false,
            "booking_create_username_required": false,
            "booking_deposits_enabled": false,
            "booking_edit_username_required": false,
            "booking_interval": 30,
            "booking_timespan": 60,
            "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",
            "combined_resources_enabled": true,
            "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_pages": null,
            "facebook_pixel": "",
            "features": {
                "addons_purchasable": true,
                "admin_name": "Premium",
                "adwords_enabled": false,
                "api_key_enabled": true,
                "booking_deposit_enabled": false,
                "booking_export_enabled": true,
                "booking_filter_enabled": true,
                "booking_note_enabled": true,
                "booking_receipt_custom_text_enabled": true,
                "booking_reminders_enabled": true,
                "booking_tags_enabled": true,
                "closed_days_widget_text_enabled": true,
                "custom_prints_enabled": true,
                "customers_enabled": true,
                "default_addons": [
                    "tickets",
                    "free_resmio_website",
                    "small_distribution_network",
                    "free_partner_integration"
                ],
                "detailed_booking_notification_email_enabled": true,
                "discounts_enabled": true,
                "distribution_network_enabled": true,
                "feedback_enabled": true,
                "gastrofix_enabled": true,
                "google_reviews_enabled": false,
                "graphical_table_plan_enabled": false,
                "hide_gastrofix": false,
                "hide_invoices": false,
                "hide_payment_details": false,
                "hide_prices": false,
                "hide_recommend_resmio": false,
                "hide_tickets": false,
                "id": "premium",
                "individual_widget_text_enabled": true,
                "invoicing_name": "resmio Premium Software",
                "marketing_enabled": false,
                "monthly_fee": "49.90",
                "name": "Premium",
                "newsletter_enabled": false,
                "notification_emails_enabled": true,
                "pages_enabled": true,
                "paied_tariff": true,
                "partner_cover": "0.00",
                "partner_network_enabled": false,
                "past_booking_overview_enabled": true,
                "payment_transactions_enabled": true,
                "plan_screen_name": "Premium",
                "recurrent_booking_enabled": true,
                "report_enabled": true,
                "reputation_widget_enabled": false,
                "resmiotables_enabled": false,
                "retention_period_switch_enabled": true,
                "shift_schedule_enabled": true,
                "slow_hours_enabled": true,
                "sms_guest_enabled": false,
                "sms_guest_reminder_enabled": false,
                "sms_waiter_enabled": false,
                "sms_waiter_max_waiters": 0,
                "standard_cover": "0.00",
                "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_change": 83.0,
            "feedback_count": 9,
            "feedback_enabled": true,
            "feedback_public": false,
            "feedback_this_month": true,
            "food_average": 66.0,
            "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
                    ]
                }
            ],
            "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,
            "service_average": 100.0,
            "short_description": "",
            "show_tables_and_allow_allocation_of_bookings": false,
            "slug": "velez-huynh",
            "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": "",
            "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"
        },
        ...
    ]
}

Type

any

Create Facility

POST: /facility

Create a new facility

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

201

Create Facility

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
  "name": "New Test Restaurant",
  "description": "Some nice description",
  "website": "",
  "street": "Teststreet 123",
  "city": "Testcity",
  "zip_code": "12345",
  "country": "DE",
  "timezone": "Europe/Berlin",
  "language": "de",
  "email": "something@example.com",
  "phone": "016097237000"
}

Type

any

RESPONSE BODY

Read Public Info

GET: /facility/{facility_id}

Get the information of one facility specified by facility_id As part of the response you will get the button and widget code for integration in to a website. The field name of the button code is “buttonCode”. The field name of the widget code is "widgetCode".

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

200

Read Public Info

CURL EXAMPLE

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

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
    "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_change": null,
    "feedback_count": null,
    "feedback_enabled": true,
    "feedback_public": false,
    "feedback_this_month": null,
    "food_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": "+49911123123",
    "price_range": 2,
    "primary_review_channel": "resmio",
    "reachedBookingLimit": false,
    "resource_uri": "/v1/facility/velez-huynh",
    "service_average": null,
    "short_description": "",
    "slug": "velez-huynh",
    "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"
}

Type

any

Read Availabilities

GET: /facility/{facility_id}/availability

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

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

date__gte

Specify the date to filter. The date is understood to be in the timezone of the facility.

Property	Value
required	false
type	date-only
examples	`2019-08-29`

Possible Responses

200

Read Availabilities

CURL EXAMPLE

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

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "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"
    }
  ]
}

Type

any

Read Bookings

GET: /facility/{facility_id}/bookings

Get all the bookings of one facility specified by facility_id filtered by a date

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

date__lt

Specify that the booking date should be "less than" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-09-05T22:00:00.000Z`

date__gte

Specify that the booking date should be "greater than or equal" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-09-04T22:00:00.000Z`

customer

Filters bookings for a customer by it's customer_id

Property	Value
required	false
type	integer
examples	`123`

facility_resources

Filters bookings for a facility resource (room) by it's facility_resource_id

Property	Value
required	false
type	integer
examples	`123`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Bookings

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/bookings?date__lt=2019-09-05T22:00:00.000Z&date__gte=2019-09-04T22:00:00.000Z&customer=123&facility_resources=123&offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "meta": {
    "limit": 200,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": null
  },
  "objects": [
    {
      "alias": null,
      "booking_deposit": null,
      "booking_request_parameters": {},
      "booking_timespan": 60,
      "comment": "",
      "created": "2019-09-05T13:07:32Z",
      "customer": "/v1/facility/the-fish/customer/20",
      "customer_bookings": 0,
      "customer_cancellations": 0,
      "customer_noshows": 0,
      "customer_notes": "",
      "customer_tags": [],
      "date": "2019-09-05T09:34:13Z",
      "email": "lynn-zimmerman@example.com",
      "email_confirmation_status": null,
      "email_verified": false,
      "facility": "/v1/facility/the-fish",
      "facility_resources": [
        "/v1/facility/the-fish/resources/51",
        "/v1/facility/the-fish/resources/52",
        "/v1/facility/the-fish/resources/53",
        "/v1/facility/the-fish/resources/54",
        "/v1/facility/the-fish/resources/55"
      ],
      "fb_access_token": "",
      "files": [],
      "id": 8,
      "last_multi_booking": null,
      "multi_booking": null,
      "name": "Lynn Zimmerman",
      "newsletter_subscribe": false,
      "notes": "",
      "num": 2,
      "phone": "1-320-878-2301x1805",
      "price_change": 0,
      "ref_num": "6em",
      "resource_uri": "/v1/facility/the-fish/bookings/8",
      "source": "",
      "status": "arrived",
      "status_code": "aed581da-7ff0-412b-8826-d2edafba2eb3",
      "tags": [
        "/v1/facility/the-fish/booking_tags/2",
        "/v1/facility/the-fish/booking_tags/14",
        "/v1/facility/the-fish/booking_tags/21"
      ],
      "updated": "2019-09-05T13:07:34Z",
      "user": null,
      "walk_in": true
    },
    {
      "alias": null,
      "booking_deposit": null,
      "booking_request_parameters": {},
      "booking_timespan": 60,
      "comment": "",
      "created": "2019-09-05T13:07:21Z",
      "customer": "/v1/facility/the-fish/customer/8",
      "customer_bookings": 0,
      "customer_cancellations": 0,
      "customer_noshows": 0,
      "customer_notes": "",
      "customer_tags": [],
      "date": "2019-09-05T13:27:15Z",
      "email": "brian-williams@example.com",
      "email_confirmation_status": null,
      "email_verified": false,
      "facility": "/v1/facility/the-fish",
      "facility_resources": [
        "/v1/facility/the-fish/resources/21",
        "/v1/facility/the-fish/resources/22",
        "/v1/facility/the-fish/resources/23",
        "/v1/facility/the-fish/resources/24",
        "/v1/facility/the-fish/resources/25"
      ],
      "fb_access_token": "",
      "files": [],
      "id": 2,
      "last_multi_booking": null,
      "multi_booking": null,
      "name": "Brian Williams",
      "newsletter_subscribe": false,
      "notes": "",
      "num": 2,
      "phone": "00346775449",
      "price_change": 0,
      "ref_num": "4uj",
      "resource_uri": "/v1/facility/the-fish/bookings/2",
      "source": "",
      "status": "confirmed",
      "status_code": "132d379f-a6ce-4417-ac55-4b8b61e99483",
      "tags": [
        "/v1/facility/the-fish/booking_tags/12",
        "/v1/facility/the-fish/booking_tags/14",
        "/v1/facility/the-fish/booking_tags/18"
      ],
      "updated": "2019-09-05T13:07:23Z",
      "user": null,
      "walk_in": false
    },
    {
      "alias": null,
      "booking_deposit": null,
      "booking_request_parameters": {},
      "booking_timespan": 60,
      "comment": "",
      "created": "2019-09-05T13:07:26Z",
      "customer": "/v1/facility/the-fish/customer/14",
      "customer_bookings": 0,
      "customer_cancellations": 0,
      "customer_noshows": 0,
      "customer_notes": "",
      "customer_tags": [],
      "date": "2019-09-05T14:39:49Z",
      "email": "daniel-valencia@example.com",
      "email_confirmation_status": null,
      "email_verified": false,
      "facility": "/v1/facility/the-fish",
      "facility_resources": [
        "/v1/facility/the-fish/resources/36",
        "/v1/facility/the-fish/resources/37",
        "/v1/facility/the-fish/resources/38",
        "/v1/facility/the-fish/resources/39",
        "/v1/facility/the-fish/resources/40"
      ],
      "fb_access_token": "",
      "files": [],
      "id": 5,
      "last_multi_booking": null,
      "multi_booking": null,
      "name": "Daniel Valencia",
      "newsletter_subscribe": false,
      "notes": "",
      "num": 2,
      "phone": "512-501-9750",
      "price_change": 0,
      "ref_num": "3ow",
      "resource_uri": "/v1/facility/the-fish/bookings/5",
      "source": "",
      "status": "finished",
      "status_code": "1ac2987c-8bdf-4fa0-84bb-172f3f1ee7d8",
      "tags": [
        "/v1/facility/the-fish/booking_tags/1",
        "/v1/facility/the-fish/booking_tags/8",
        "/v1/facility/the-fish/booking_tags/13"
      ],
      "updated": "2019-09-05T13:07:28Z",
      "user": null,
      "walk_in": false
    }
  ]
}

Type

any

Create Booking

POST: /facility/{facility_id}/bookings

Creates a new booking in a facility.

Transactional emails will be sent in the language specified using the Accept-Language HTTP header. If none of the specified languages are available, the default language, set in the restaurant settings, will be used. To send a notification to the guest the field 'send_email_receipt' must be set to 'true'.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

201

Create Booking

CURL EXAMPLE

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

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
  "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
}

Type

any

RESPONSE BODY

201

{
  "alias": null,
  "booking_deposit": null,
  "booking_request_parameters": {},
  "booking_timespan": 30,
  "checksum": "35d3a6247bc42942222f7d26820a432ee4923a9c27e6ba7810f7169779ecf591",
  "comment": "Some example message for the restaurant owner",
  "created": "2019-08-29T07:52:11Z",
  "customer": "/v1/facility/the-fish/customer/3342663",
  "customer_bookings": 8,
  "customer_cancellations": 2,
  "customer_noshows": 0,
  "customer_notes": "",
  "customer_tags": [],
  "date": "2019-08-29T23:00:00Z",
  "email": "test@example.com",
  "email_confirmation_status": null,
  "email_verified": false,
  "facility": "/v1/facility/the-fish",
  "facility_resources": [
    "/v1/facility/the-fish/resources/75027"
  ],
  "fb_access_token": "",
  "files": [],
  "id": 5348950,
  "last_multi_booking": null,
  "multi_booking": null,
  "name": "Test Name",
  "newsletter_subscribe": false,
  "notes": "",
  "num": 2,
  "phone": "016097230000",
  "price_change": 0,
  "ref_num": "64c",
  "resmio_newsletter_subscribe": false,
  "resource_group": "",
  "resource_uri": "/v1/facility/the-fish/bookings/5348950",
  "source": "",
  "status": "confirmed",
  "status_code": "11cebf21-ba8e-4ea3-9fe2-31d020d30c0a",
  "user_cancel_authentication_code": "6dea63df-2051-4cca-81e3-4fc3b0b7a67d",
  "restaurant_authentication_code": "3979a5a2-6a4e-4d1c-adc1-67c1796188e7",
  "tags": [],
  "updated": "2019-08-29T07:52:11Z",
  "user": null,
  "walk_in": false
}

Type

any

Update Booking (partially)

PATCH: /facility/{facility_id}/bookings/{booking_id}

Partial update of a booking (specified by 'booking_id') of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

booking_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

202

Update Booking (partially)

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/bookings/{booking_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
  "id": 2,
  "status": "cancelled",
  "message": "Called and cannot make it"
}

Type

any

RESPONSE BODY

202

{
  "alias": null,
  "booking_deposit": null,
  "booking_request_parameters": {},
  "booking_timespan": 60,
  "comment": "",
  "created": "2019-09-05T13:07:21Z",
  "customer": "/v1/facility/the-fish/customer/8",
  "customer_bookings": 0,
  "customer_cancellations": 0,
  "customer_noshows": 0,
  "customer_notes": "",
  "customer_tags": [],
  "date": "2019-09-05T13:27:15Z",
  "email": "brian-williams@example.com",
  "email_confirmation_status": null,
  "email_verified": false,
  "facility": "/v1/facility/the-fish",
  "facility_resources": [
    "/v1/facility/the-fish/resources/21",
    "/v1/facility/the-fish/resources/22",
    "/v1/facility/the-fish/resources/23",
    "/v1/facility/the-fish/resources/24",
    "/v1/facility/the-fish/resources/25"
  ],
  "fb_access_token": "",
  "files": [],
  "id": 2,
  "last_multi_booking": null,
  "message": "Called and cannot make it",
  "multi_booking": null,
  "name": "Brian Williams",
  "newsletter_subscribe": false,
  "notes": "",
  "num": 2,
  "phone": "00346775449",
  "price_change": 0,
  "ref_num": "4uj",
  "resource_uri": "/v1/facility/the-fish/bookings/2",
  "source": "",
  "status": "cancelled",
  "status_code": "132d379f-a6ce-4417-ac55-4b8b61e99483",
  "tags": [
    "/v1/facility/the-fish/booking_tags/12",
    "/v1/facility/the-fish/booking_tags/14",
    "/v1/facility/the-fish/booking_tags/18"
  ],
  "updated": "2019-09-05T14:00:26Z",
  "user": null,
  "walk_in": false
}

Type

any

Read Booking Deposits

GET: /facility/{facility_id}/booking_deposit

Get booking deposits for a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

date__lt

Specify that the booking deposit date should be "less than" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-09-03T22:00:00.000Z`

date__lte

Specify that the booking deposit date should be "less than or equal" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-09-04T22:00:00.000Z`

date__gte

Specify that the booking deposit date should be "greater than or equal" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-09-05T22:00:00.000Z`

date__gt

Specify that the booking deposit date should be "greater than" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-09-06T22:00:00.000Z`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Booking Deposits

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/booking_deposit?date__lt=2019-09-03T22:00:00.000Z&date__lte=2019-09-04T22:00:00.000Z&date__gte=2019-09-05T22:00:00.000Z&date__gt=2019-09-06T22:00:00.000Z&offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "meta": {
    "limit": 20,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": 1
  },
  "objects": [
    {
      "amount": 30.25,
      "booking_description": null,
      "cancel_allowed_without_fees": false,
      "converted_amount": null,
      "currency": "RUB",
      "deposit_data": {},
      "deposit_email_date": null,
      "deposit_status": "",
      "email_date": null,
      "employee_name": null,
      "employee_resource_uri": null,
      "facility": "/v1/facility/the-fish",
      "id": 1,
      "obfuscated_payment_details": null,
      "owner_email": "BBB",
      "owner_name": "AAAA",
      "payment_type": "OUTSTANDING",
      "refund_amount": 0.0,
      "resource_uri": "/v1/facility/the-fish/booking_deposit/1"
    }
  ]
}

Type

any

Create Booking Deposit

POST: /facility/{facility_id}/booking_deposit

Creates a new booking deposit for a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

201

Create Booking Deposit

CURL EXAMPLE

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

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

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

Type

any

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"
}

Type

any

Update Booking Deposit

PATCH: /facility/{facility_id}/booking_deposit/{booking_deposit_id}

Partial update of a booking deposit (specified by booking_deposit_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

booking_deposit_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

202

Update Booking Deposit

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/booking_deposit/{booking_deposit_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
  "amount": 30.33
}

Type

any

RESPONSE BODY

202

{
  "amount": 30.33,
  "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"
}

Type

any

Read Booking Tags

GET: /facility/{facility_id}/booking_tags

Get all the booking tags of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Booking Tags

CURL EXAMPLE

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

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "meta": {
    "limit": 200,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": null
  },
  "objects": [
    {
      "color": "",
      "enabled": true,
      "facility": "/v1/facility/the-fish",
      "id": 1,
      "name": "Notify the Chef",
      "resource_uri": "/v1/facility/the-fish/booking_tags/1"
    },
    {
      "color": "",
      "enabled": true,
      "facility": "/v1/facility/the-fish",
      "id": 2,
      "name": "Notify the Manager",
      "resource_uri": "/v1/facility/the-fish/booking_tags/2"
    },
    {
      "color": "",
      "enabled": true,
      "facility": "/v1/facility/the-fish",
      "id": 3,
      "name": "Anniversary",
      "resource_uri": "/v1/facility/the-fish/booking_tags/3"
    },
    {
      "color": "",
      "enabled": true,
      "facility": "/v1/facility/the-fish",
      "id": 4,
      "name": "Birthday",
      "resource_uri": "/v1/facility/the-fish/booking_tags/4"
    },
    {
      "color": "",
      "enabled": true,
      "facility": "/v1/facility/the-fish",
      "id": 5,
      "name": "Privacy",
      "resource_uri": "/v1/facility/the-fish/booking_tags/5"
    },
    {
      "color": "",
      "enabled": true,
      "facility": "/v1/facility/the-fish",
      "id": 6,
      "name": "Children",
      "resource_uri": "/v1/facility/the-fish/booking_tags/6"
    },
    {
      "color": "",
      "enabled": true,
      "facility": "/v1/facility/the-fish",
      "id": 7,
      "name": "Baby",
      "resource_uri": "/v1/facility/the-fish/booking_tags/7"
    },
    {
      "color": "",
      "enabled": true,
      "facility": "/v1/facility/the-fish",
      "id": 8,
      "name": "Smoking area",
      "resource_uri": "/v1/facility/the-fish/booking_tags/8"
    }
  ]
}

Type

any

Read Booking Timespans

GET: /facility/{facility_id}/booking_timespans

Get all the booking timespans of one facility specified by facility_id. Responsible to configure the dynamic booking timespan per group size

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Booking Timespans

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/booking_timespans?offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
  "meta": {
    "limit": 200,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": null
  },
  "objects": [{
    "booking_timespan": 45,
    "created": "2018-07-09T09:33:01Z",
    "facility": "/v1/facility/the-fish",
    "id": 27531,
    "num": 0,
    "resource_uri": "/v1/facility/the-fish/booking_timespans/27531",
    "updated": "2020-04-27T09:16:06Z"
  }]
}

Type

any

Create Booking Timespan

POST: /facility/{facility_id}/booking_timespans

Creates a new booking timespan for a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

201

Create Booking Timespan

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/booking_timespans" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
  num: 4,
  booking_timespan: 60
}

Type

any

RESPONSE BODY

201

{
  "booking_timespan": 60,
  "created": "2020-04-27T09:21:37Z",
  "facility": "/v1/facility/the-fish",
  "id": 29700,
  "num": 4,
  "resource_uri": "/v1/facility/the-fish/booking_timespans/29700",
  "updated": "2020-04-27T09:21:37Z"
}

Type

any

Update Booking Timespan

PATCH: /facility/{facility_id}/booking_timespans/{booking_timespan_id}

Partial update of a booking timespan (specified by booking_timespan_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

booking_timespan_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

202

Update Booking Timespan

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/booking_timespans/{booking_timespan_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
  num: 0,
  booking_timespan: 30,
  id: 27531
}

Type

any

RESPONSE BODY

202

{
    "booking_timespan": 30,
    "created": "2018-07-09T09:33:01Z",
    "facility": "/v1/facility/the-fish",
    "id": 27531,
    "num": 0,
    "resource_uri": "/v1/facility/the-fish/booking_timespans/27531",
    "updated": "2020-04-27T09:19:16Z"
}

Type

any

Read Customers

GET: /facility/{facility_id}/customer

Get customers of a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

name

It filters customers by name.

Property	Value
required	false
type	string
examples	`customer name`

email

It filters customers by email.

Property	Value
required	false
type	string
examples	`customer@email.address`

phone

It filters customers by phone number.

Property	Value
required	false
type	string
examples	`(670)103-1967`

email_verified

Specify that response should have customers with only verified or not verified email addresses.

Property	Value
required	false
type	boolean
examples	`false`

newsletter_subscribe

Specify that response should have only newsletter subscribed/unsubscribed customers.

Property	Value
required	false
type	boolean
examples	`false`

updated__lt

Specify that the customer update date should be "less than" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-09-03T22:00:00.000Z`

updated__lte

Specify that the customer update date should be "less than or equal" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-09-04T22:00:00.000Z`

updated__gt

Specify that the customer update date should be "greater than" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-09-06T22:00:00.000Z`

updated__gte

Specify that the customer update date should be "greater than or equal" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-09-07T22:00:00.000Z`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Customers

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/customer?name=customer name&email=customer@email.address&phone=(670)103-1967&email_verified=false&newsletter_subscribe=false&updated__lt=2019-09-03T22:00:00.000Z&updated__lte=2019-09-04T22:00:00.000Z&updated__gt=2019-09-06T22:00:00.000Z&updated__gte=2019-09-07T22:00:00.000Z&offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
  "meta": {
    "limit": 80,
    "next": null,
    "offset": 20,
    "previous": null,
    "total_count": 1
  },
  "objects": [
    {
      "anniversary": null,
      "birthday": null,
      "city": "",
      "country": "",
      "created": "2019-11-05T02:45:00Z",
      "email": "customer@email.address",
      "email_verification_allowed_after": "2019-11-04T02:47:23Z",
      "email_verification_last_request_time": null,
      "email_verified": false,
      "facility": "/v1/facility/the-fish",
      "feedback_score": null,
      "files": [],
      "google_user_id": null,
      "id": 116,
      "imported": false,
      "is_active": true,
      "name": "customer name",
      "newsletter_subscribe": false,
      "newsletter_subscription_refused": false,
      "notes": "",
      "phone": "(670)103-1967",
      "resmio_newsletter_subscribe": false,
      "resource_uri": "/v1/facility/the-fish/customer/116",
      "sex": "",
      "street": "",
      "tags": [],
      "updated": "2019-09-05T22:00:00.000Z",
      "uuid": "9003889a-3709-4326-be5e-bda482e9d7ad",
      "zip_code": ""
    }
  ]
}

Type

any

Create Customer

POST: /facility/{facility_id}/customer

Creates a new customer for a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

201

Create Customer

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/customer" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
  "name": "William Phillips",
  "email": "email@exanple.com"
}

Type

any

RESPONSE BODY

201

{
  "anniversary": null,
  "birthday": null,
  "city": "",
  "country": "",
  "created": "2019-10-31T06:36:53Z",
  "email": "email@exanple.com",
  "email_verification_allowed_after": "2019-10-30T06:36:53Z",
  "email_verification_last_request_time": null,
  "email_verified": false,
  "facility": "/v1/facility/the-fish",
  "feedback_score": null,
  "files": [],
  "google_user_id": null,
  "id": 116,
  "imported": false,
  "is_active": true,
  "name": "William Phillips",
  "newsletter_subscribe": false,
  "newsletter_subscription_refused": false,
  "notes": "",
  "phone": "",
  "resmio_newsletter_subscribe": false,
  "resource_uri": "/v1/facility/the-fish/customer/116",
  "sex": "",
  "street": "",
  "tags": [],
  "updated": "2019-10-31T06:36:53Z",
  "uuid": "0e3f1957-a9b0-4f63-85f0-44a1ecf86456",
  "zip_code": ""
}

Type

any

Update Customer

PATCH: /facility/{facility_id}/customer/{customer_id}

Partial update of a customer (specified by customer_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

customer_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

202

Update Customer

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/customer/{customer_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
  "city": "Berlin"
}

Type

any

RESPONSE BODY

202

{
  "anniversary": null,
  "birthday": null,
  "city": "Berlin",
  "country": "",
  "created": "2019-10-31T06:36:53Z",
  "email": "email@exanple.com",
  "email_verification_allowed_after": "2019-10-30T07:00:05Z",
  "email_verification_last_request_time": null,
  "email_verified": false,
  "facility": "/v1/facility/the-fish",
  "feedback_score": null,
  "files": [],
  "google_user_id": null,
  "id": 116,
  "imported": false,
  "is_active": true,
  "name": "William Phillips",
  "newsletter_subscribe": false,
  "newsletter_subscription_refused": false,
  "notes": "",
  "phone": "",
  "resmio_newsletter_subscribe": false,
  "resource_uri": "/v1/facility/the-fish/customer/116",
  "sex": "",
  "street": "",
  "tags": [],
  "updated": "2019-10-31T07:00:04Z",
  "uuid": "0e3f1957-a9b0-4f63-85f0-44a1ecf86456",
  "zip_code": ""
}

Type

any

Read Customer Tags

GET: /facility/{facility_id}/customer_tags

Get all the customer tags of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Customer Tags

CURL EXAMPLE

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

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "meta": {
    "limit": 20,
    "next": "/v1/facility/the-fish/customer_tags?disable_total_count=true&limit=20&offset=20",
    "offset": 0,
    "previous": null,
    "total_count": null
  },
  "objects": [
    {
      "facility": "/v1/facility/the-fish",
      "id": 256,
      "name": "Critic / Blogger",
      "resource_uri": "/v1/facility/the-fish/customer_tags/256"
    },
    {
      "facility": "/v1/facility/the-fish",
      "id": 255,
      "name": "Friend",
      "resource_uri": "/v1/facility/the-fish/customer_tags/255"
    },
    {
      "facility": "/v1/facility/the-fish",
      "id": 254,
      "name": "VIP",
      "resource_uri": "/v1/facility/the-fish/customer_tags/254"
    },
    {
      "facility": "/v1/facility/the-fish",
      "id": 253,
      "name": "Family",
      "resource_uri": "/v1/facility/the-fish/customer_tags/253"
    },
    {
      "facility": "/v1/facility/the-fish",
      "id": 252,
      "name": "Nuts allergy",
      "resource_uri": "/v1/facility/the-fish/customer_tags/252"
    }
  ]
}

Type

any

Read Statistics of the Facility

GET: /facility/{facility_id}/facility_statistics

Statisitcs can be in two versions. Common statistics are about bookings and revenue for last 30 days (request must have "stats" flag). Another statistics have booking coverage by days.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

stats

Specify that response can have common statistics about bookings and revenue for last 30 days

Property	Value
required	false
type	boolean
examples	`true`

date__lte

Specify that the booking coverage statistic dates should be "less than or equal" to the specified date filter.

Property	Value
required	false
type	datetime
examples	`2019-09-05`

date__gte

Specify that the booking coverage statistic dates should be "greater than or equal" to the specified date filter.

Property	Value
required	false
type	datetime
examples	`2019-09-04`

Possible Responses

200

Read Statistics of the Facility

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/facility_statistics?stats=true&date__lte=2019-09-05&date__gte=2019-09-04" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "id": "cruz-edwards",
  "points": [
    3,
    6,
    9
  ],
  "resource_uri": "/v1/facility/the-fish/facility_statistics",
  "start_date": "2019-09-04"
}
or with ?stats=true
{
  "covers_last_1_days": 0,
  "covers_last_1_days_diff": 0,
  "covers_last_30_days": 18,
  "covers_last_30_days_diff": 0,
  "covers_last_7_days": 18,
  "covers_last_7_days_diff": 0,
  "id": "cruz-edwards",
  "last_30_days_revenue": {
    "all": 360.0,
    "all_diff": null,
    "manual": 360.0,
    "manual_diff": null,
    "online": 0.0,
    "online_diff": null
  },
  "resource_uri": "/v1/facility/the-fish/facility_statistics",
  "sources": [
    {
      "name": "",
      "y": 1.0
    }
  ]
}

Type

any

Read Facility Users

GET: /facility/{facility_id}/facility_users

Get all the users that have access rights to the facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Facility Users

CURL EXAMPLE

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

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "meta": {
    "limit": 200,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": 1
  },
  "objects": [
    {
      "aliases": [],
      "email": "something@example.com",
      "first_name": "Erik",
      "id": 1,
      "last_name": "",
      "permission_groups": [
        "/v1/facility/the-fish/user-groups/2"
      ],
      "resource_uri": "/v1/facility/the-fish/facility_users/1",
      "username": "something@example.com"
    }
  ]
}

Type

any

Create Facility User

POST: /facility/{facility_id}/facility_users

Invites a user to join the facility. If the user with this email address does not exist it is created. The user will receive an email about the invite.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

201

Create Facility User

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/facility_users" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
  "first_name": "Anton Amazing",
  "email": "something@example.com",
  "permission_groups": [
    "/v1/facility/the-fish/user-groups/3"
  ]
}

Type

any

RESPONSE BODY

201

{
  "aliases": [],
  "email": "something@example.com",
  "first_name": "Anton Amazing",
  "id": 5,
  "last_name": "",
  "permission_groups": [
    "/v1/facility/the-fish/user-groups/3"
  ],
  "resource_uri": "/v1/facility/the-fish/facility_users/5",
  "username": "something@example.com"
}

Type

any

Read Public Feedback

GET: /facility/{facility_id}/feedback

Get a list of feedbacks and public comments for a facility with a total count of all available feedbacks. This is only available when enabled by the facility. Add parameter offset to skip a number of feedbacks. Add parameter limit to show more or less then the default number of feedbacks.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Public Feedback

CURL EXAMPLE

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

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "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
    },
    {
      "created": "2014-05-12T07:17:10Z",
      "food_positive": false,
      "id": 2004,
      "public_comment": "I think they are selling instant meals.",
      "service_positive": false
    }
  ]
}

Type

any

Read Notes

GET: /facility/{facility_id}/notes

Get all the notes of one facility specified by facility_id usually for a day

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

begins__lt

Specify that the begins date for the note should be "less than" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-09-07T22:00:00.000Z`

ends__gte

Specify that the ends date for the note should be "greater than or equal" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-08-31T22:00:00.000Z`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Notes

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/notes?begins__lt=2019-09-07T22:00:00.000Z&ends__gte=2019-08-31T22:00:00.000Z&offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
  "meta": {
    "limit": 1000,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": 1
  },
  "objects": [
    {
      "begins": "2019-09-04T22:00:00Z",
      "ends": "2019-09-04T22:00:00Z",
      "facility": "/v1/facility/the-fish",
      "id": 1,
      "resource_uri": "/v1/facility/the-fish/notes/1",
      "text": "Big Summer Party"
    }
  ]
}

Type

any

Create Note

POST: /facility/{facility_id}/notes

Creates a new note in a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

201

Create Note

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/notes" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
  "begins": "2019-09-04T22:00:00Z",
  "ends": "2019-09-04T22:00:00Z",
  "text": "Big Summer Party"
}

Type

any

RESPONSE BODY

201

{
  "begins": "2019-09-04T22:00:00Z",
  "ends": "2019-09-04T22:00:00Z",
  "facility": "/v1/facility/the-fish",
  "id": 1,
  "resource_uri": "/v1/facility/the-fish/notes/1",
  "text": "Big Summer Party"
}

Type

any

Delete Note

DELETE: /facility/{facility_id}/notes/{note_id}

Deletes a note (specified by note_id) of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

note_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

204

Delete Note

CURL EXAMPLE

curl -X DELETE "https://api.resmio.com/v1/facility/{facility_id}/notes/{note_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

GET: /facility/{facility_id}/menu_categories

Get all the menu categories of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/menu_categories?offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
    "meta": {
        "limit": 1000,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": null
    },
    "objects": [{
            "created": "2020-07-10T10:10:06.666062",
            "description": "",
            "facility": "/v1/facility/the-fish",
            "id": 31,
            "image": null,
            "menu": "/v1/facility/the-fish/menus/2",
            "name": "Pizzas",
            "online_order_enabled": true,
            "priority": 2.0,
            "products": ["/v1/facility/the-fish/products/57", "/v1/facility/the-fish/products/58", "/v1/facility/the-fish/products/59"],
            "resource_uri": "/v1/facility/the-fish/menu_categories/31",
            "show_products_in_menu": true,
            "updated": "2020-07-10T10:10:06.666089"
        }, {
            "created": "2020-07-10T11:34:18.632617",
            "description": "A category description",
            "facility": "/v1/facility/the-fish",
            "id": 36,
            "image": null,
            "menu": "/v1/facility/the-fish/menus/2",
            "name": "Category Name",
            "online_order_enabled": true,
            "priority": 0.28823092805105,
            "products": [],
            "resource_uri": "/v1/facility/the-fish/menu_categories/36",
            "show_products_in_menu": true,
            "updated": "2020-07-10T11:34:18.632647"
        }
    ]
}

Type

any

POST: /facility/{facility_id}/menu_categories

Creates a new category in a menu.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

201

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/menu_categories" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "menu": "/v1/facility/the-fish/menus/2",
    "name": "Category Name",
    "description": "A category description",
    "priority": 0.28823092805105
}

Type

any

RESPONSE BODY

201

{
    "created": "2020-07-10T11:34:18.632617",
    "description": "A category description",
    "facility": "/v1/facility/the-fish",
    "id": 36,
    "image": null,
    "menu": "/v1/facility/the-fish/menus/2",
    "name": "Category Name",
    "online_order_enabled": true,
    "priority": 0.28823092805105,
    "products": [],
    "resource_uri": "/v1/facility/the-fish/menu_categories/36",
    "show_products_in_menu": true,
    "updated": "2020-07-10T11:34:18.632647"
}

Type

any

DELETE: /facility/{facility_id}/menu_categories/{menu_category_id}

Deletes a menu category (specified by menu_category_id) of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

menu_category_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

204

CURL EXAMPLE

curl -X DELETE "https://api.resmio.com/v1/facility/{facility_id}/menu_categories/{menu_category_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

PATCH: /facility/{facility_id}/menu_categories/{menu_category_id}

Partial update of a menu category (specified by menu_category_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

menu_category_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

202

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/menu_categories/{menu_category_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "name": "Salad",
    "description": "Fine refined Salad"
}

Type

any

RESPONSE BODY

202

{
    "created": "2020-07-10T11:34:18.632617",
    "description": "Fine refined Salad",
    "facility": "/v1/facility/the-fish",
    "id": 36,
    "image": null,
    "menu": "/v1/facility/the-fish/menus/2",
    "name": "Salad",
    "online_order_enabled": true,
    "priority": 0.28823092805105,
    "products": [],
    "resource_uri": "/v1/facility/the-fish/menu_categories/36",
    "show_products_in_menu": true,
    "updated": "2020-07-10T11:40:02.094794"
}

Type

any

GET: /facility/{facility_id}/menus

Get all the menu settings of one facility specified by facility_id. There can only exist 1 menusetting per facility at the moment.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

CURL EXAMPLE

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

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [
        {
            "allow_cash": true,
            "allow_credit_card": false,
            "allow_delivery": true,
            "allow_paypal": false,
            "allow_pickup": true,
            "allow_qr_ordering": false,
            "allow_sepa_direct_debit": false,
            "created": "2020-06-29T10:00:07.280127",
            "delivery_area": null,
            "delivery_fee": "0.00",
            "delivery_lead_time": 60,
            "delivery_minimum_order_value": "0.00",
            "enabled": false,
            "facility": "/v1/facility/the-fish",
            "force_prepayment_order_value": null,
            "id": 2,
            "name": "default",
            "pickup_lead_time": 60,
            "qr_allow_cash": false,
            "qr_allow_credit_card": false,
            "qr_allow_paypal": false,
            "qr_allow_sepa_direct_debit": false,
            "qr_cash_payment_text": "",
            "qr_force_prepayment_order_value": null,
            "resource_uri": "/v1/facility/the-fish/menus/2",
            "updated": "2020-07-02T11:29:39.889783"
        }
    ]
}

Type

any

PATCH: /facility/{facility_id}/menus/{menu_id}

Partial update of the menu settings (specified by menu_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

menu_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

202

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/menus/{menu_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
    "allow_cash": true,
    "allow_credit_card": false,
    "allow_delivery": true,
    "allow_paypal": false,
    "allow_pickup": false,
    "allow_qr_ordering": false,
    "allow_sepa_direct_debit": false,
    "created": "2020-06-29T10:00:07.280127",
    "delivery_area": null,
    "delivery_fee": "0.00",
    "delivery_lead_time": 60,
    "delivery_minimum_order_value": "0.00",
    "enabled": false,
    "facility": "/v1/facility/the-fish",
    "force_prepayment_order_value": null,
    "id": 2,
    "name": "default",
    "pickup_lead_time": 60,
    "qr_allow_cash": false,
    "qr_allow_credit_card": false,
    "qr_allow_paypal": false,
    "qr_allow_sepa_direct_debit": false,he API key of a user. The information can be fo
    "qr_cash_payment_text": "",
    "qr_force_prepayment_order_value": null,
    "resource_uri": "/v1/facility/the-fish/menus/2",
    "updated": "2020-07-02T11:29:39.889783"
}

Type

any

RESPONSE BODY

202

{
    "allow_cash": true,
    "allow_credit_card": false,
    "allow_delivery": true,
    "allow_paypal": false,
    "allow_pickup": false,
    "allow_qr_ordering": false,
    "allow_sepa_direct_debit": false,
    "created": "2020-06-29T10:00:07.280127",
    "delivery_area": null,
    "delivery_fee": "0.00",
    "delivery_lead_time": 60,
    "delivery_minimum_order_value": "0.00",
    "enabled": false,
    "facility": "/v1/facility/the-fish",
    "force_prepayment_order_value": null,
    "id": 2,
    "name": "default",
    "pickup_lead_time": 60,
    "qr_allow_cash": false,
    "qr_allow_credit_card": false,
    "qr_allow_paypal": false,
    "qr_allow_sepa_direct_debit": false,
    "qr_cash_payment_text": "",
    "qr_force_prepayment_order_value": null,
    "resource_uri": "/v1/facility/the-fish/menus/2",
    "updated": "2020-07-02T14:41:59.881782"
}

Type

any

POST: /facility/{facility_id}/menus/export

Exports the menu of a facility. Will trigger an asynchron task that will send an email with a link to download the export.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

200

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/menus/export" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "email":"test@example.com"
}

Type

any

RESPONSE BODY

200

{}

Type

any

POST: /facility/{facility_id}/menus/import

Imports the menu of a facility. Will trigger an asynchron task that will actually import the menu and pase the provided file. The task will send an email once it finishes with the result. If you require an example file, please use the export function.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

200

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/menus/import" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "json_file_url":"https://example.com/export.json",
    "email":"test@example.com"
}

Type

any

RESPONSE BODY

200

{}

Type

any

Read Notification Recipients

GET: /facility/{facility_id}/notificationrecipients

Get all notification recipients of a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Notification Recipients

CURL EXAMPLE

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

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
    "meta": {
        "limit": 1000,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": null
    },
    "objects": [{
            "contact_info": "something@example.com",
            "contact_info_access_token": "",
            "contact_info_type": "email",
            "facility": "/v1/facility/the-fish",
            "id": 41400,
            "resource_uri": "/v1/facility/the-fish/notificationrecipients/41400"
        }, {
            "contact_info": "+4916012345678",
            "contact_info_access_token": "",
            "contact_info_type": "phone",
            "facility": "/v1/facility/the-fish",
            "id": 41401,
            "resource_uri": "/v1/facility/the-fish/notificationrecipients/41401"
        }
    ]
}

Type

any

Create Notification Recipients

POST: /facility/{facility_id}/notificationrecipients

Creates a new notification recipients for a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

201

Create Notification Recipients

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/notificationrecipients" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
    "contact_info": "something@example.com",
    "contact_info_type": "email"
}

Type

any

RESPONSE BODY

201

{
    "contact_info": "something@example.com",
    "contact_info_access_token": "",
    "contact_info_type": "email",
    "facility": "/v1/facility/the-fish",
    "id": 55113,
    "resource_uri": "/v1/facility/the-fish/notificationrecipients/55113"
}

Type

any

Delete Notification Recipients

DELETE: /facility/{facility_id}/notificationrecipients/{notificationrecipient_id}

Deletes a notification recipients (specified by notificationrecipient_id) of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

notificationrecipient_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

204

Delete Notification Recipients

CURL EXAMPLE

curl -X DELETE "https://api.resmio.com/v1/facility/{facility_id}/notificationrecipients/{notificationrecipient_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

Update Notification Recipients

PATCH: /facility/{facility_id}/notificationrecipients/{notificationrecipient_id}

Partial update of a notification recipients (specified by notificationrecipient_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

notificationrecipient_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

202

Update Notification Recipients

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/notificationrecipients/{notificationrecipient_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
    "contact_info_type": "email",
    "contact_info": "something@example2.com",
    "id": 55113
}

Type

any

RESPONSE BODY

202

{
    "contact_info": "something@example2.com",
    "contact_info_access_token": "",
    "contact_info_type": "email",
    "facility": "/v1/facility/the-fish",
    "id": 55113,
    "resource_uri": "/v1/facility/the-fish/notificationrecipients/55113"
}

Type

any

Read Booking Hours

GET: /facility/{facility_id}/openinghours

Lists all booking hours of a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Booking Hours

CURL EXAMPLE

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

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "meta": {
    "limit": 80,
    "next": null,
    "offset": 20,
    "previous": null,
    "total_count": 2
  },
  "objects": [
    {
      "begins": "09:00",
      "capacity": 10,
      "end_of_acceptance": null,
      "ends": "22:00",
      "facility": "/v1/facility/the-fish",
      "id": 1,
      "resource_uri": "/v1/facility/the-fish/openinghours/1",
      "weekdays": [
        0,
        1,
        2,
        3,
      ]
    },
    {
      "begins": "09:00",
      "capacity": 10,
      "end_of_acceptance": null,
      "ends": "23:00",
      "facility": "/v1/facility/the-fish",
      "id": 3,
      "resource_uri": "/v1/facility/the-fish/openinghours/3",
      "weekdays": [
        4,
        5,
        6
      ]
    }
  ]
}

Type

any

Create Booking Hours

POST: /facility/{facility_id}/openinghours

Creates a new booking hour for a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

201

Create Booking Hours

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/openinghours" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
  "begins": "08:00",
  "ends": "23:00",
  "capacity": 15,
  "weekdays": [
    0, 5
  ]
}

Type

any

RESPONSE BODY

201

{
  "begins": "08:00",
  "capacity": 15,
  "end_of_acceptance": null,
  "ends": "23:00",
  "facility": "/v1/facility/the-fish",
  "id": 1876,
  "resource_uri": "/v1/facility/the-fish/openinghours/1876",
  "weekdays": [
    0,
    5
  ]
}

Type

any

Update Booking Hours

PATCH: /facility/{facility_id}/openinghours/{openinghour_id}

Partial update of a booking hour (specified by openinghour_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

openinghour_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

202

Update Booking Hours

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/openinghours/{openinghour_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
  "weekdays": [
    0, 1, 2
  ]
}

Type

any

RESPONSE BODY

202

{
  "begins": "08:00",
  "capacity": 15,
  "end_of_acceptance": null,
  "ends": "23:00",
  "facility": "/v1/facility/the-fish",
  "id": 1876,
  "resource_uri": "/v1/facility/the-fish/openinghours/1876",
  "weekdays": [
    0,
    1,
    2
  ]
}

Type

any

Read Opening Hour Overrides

GET: /facility/{facility_id}/openinghouroverride

Get all the opening hour overrides of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

begins__lt

Specify that the begins date for the opening hour override should be "less than" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-09-07T22:00:00.000Z`

ends__gte

Specify that the ends date for the opening hour override should be "greater than or equal" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-08-31T22:00:00.000Z`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Opening Hour Overrides

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/openinghouroverride?begins__lt=2019-09-07T22:00:00.000Z&ends__gte=2019-08-31T22:00:00.000Z&offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "meta": {
    "limit": 1000,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": null
  },
  "objects": [
    {
      "begins": "2019-09-05T08:00:00Z",
      "capacity": 20,
      "capacity_only": true,
      "ends": "2019-09-05T10:00:00Z",
      "facility": "/v1/facility/the-fish",
      "id": 1,
      "is_open": false,
      "reason": "",
      "resource_uri": "/v1/facility/the-fish/openinghouroverride/1"
    }
  ]
}

Type

any

Read Payment Transactions

GET: /facility/{facility_id}/payment_transactions

Get all the payment transactions of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

date__gte

A date filter to return only payment transactions greater (or equal) than the specified datetime

Property	Value
required	false
type	datetime
examples	`2020-04-06T06:00:00.000Z`

date__lt

A date filter to return only payment transactions less than the specified datetime

Property	Value
required	false
type	datetime
examples	`2020-04-07T06:00:00.000Z`

order_by

Specify the order in which the results are returned

Property	Value
required	false
type	string
examples	`date`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Payment Transactions

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/payment_transactions?date__gte=2020-04-06T06:00:00.000Z&date__lt=2020-04-07T06:00:00.000Z&order_by=date&offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "meta": {
    "limit": 50,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_amount": 59.74,
    "total_count": 2
  },
  "objects": [{
      "amount": 39.75,
      "currency": "EUR",
      "date": "2020-04-06T07:00:00Z",
      "facility": "/v1/facility/the-fish",
      "guest_name": "Dow Jones",
      "id": 3,
      "num": 2,
      "resource_uri": "/v1/facility/the-fish/payment_transactions/3",
      "source": "amadeus360",
      "status": "completed",
      "table_names": ["Table 21"],
      "walk_in": false
    }, {
      "amount": 19.99,
      "currency": "EUR",
      "date": "2020-04-06T09:00:00Z",
      "facility": "/v1/facility/the-fish",
      "guest_name": null,
      "id": 2,
      "num": null,
      "resource_uri": "/v1/facility/the-fish/payment_transactions/2",
      "source": "amadeus360",
      "status": "completed",
      "table_names": ["T1", "T2"],
      "walk_in": null
    }
  ]
}

Type

any

Create Payment Transactions

POST: /facility/{facility_id}/payment_transactions

Creates a new payment transaction for a facility and the server will try to map a booking to the transaction by the specified facility, timestamp and table names.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

201

Create Payment Transactions

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/payment_transactions" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
  "amount":39.75,
  "currency":"EUR",
  "date":"2020-04-06T07:00:00Z",
  "source":"amadeus360",
  "status":"completed",
  "table_names":["Table 21", "T2"]
}

Type

any

RESPONSE BODY

201

{
    "amount": 39.75,
    "currency": "EUR",
    "date": "2020-04-06T07:00:00Z",
    "facility": "/v1/facility/the-fish",
    "guest_name": "Dow Jones",
    "id": 3,
    "num": 2,
    "resource_uri": "/v1/facility/the-fish/payment_transactions/3",
    "source": "amadeus360",
    "status": "completed",
    "table_names": [
        "Table 21"
    ],
    "walk_in": false
}

Type

any

Read Product Modifier Default

GET: /facility/{facility_id}/product_modifier_defaults

Get all the product modifier defaults of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

product_modifier_group

Filters product modifier defaults for a product_modifier_group by it's product_modifier_group_id

Property	Value
required	false
type	integer
examples	`123`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Product Modifier Default

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/product_modifier_defaults?product_modifier_group=123&offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
    "meta": {
        "limit": 1000,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": null
    },
    "objects": [{
            "created": "2020-07-10T12:10:20.968324",
            "facility": "/v1/facility/the-fish",
            "id": 43,
            "maximum_quantity": 1,
            "menu": "/v1/facility/the-fish/menus/2",
            "minimum_quantity": 0,
            "price_gross": "1.00",
            "priority": 0.0,
            "product_modifier_group": "/v1/facility/the-fish/product_modifier_groups/21",
            "resource_uri": "/v1/facility/the-fish/product_modifier_defaults/43",
            "title": "Sirup Dip",
            "updated": "2020-07-10T12:12:47.162838"
        }
    ]
}

Type

any

Create Product Modifier Default

POST: /facility/{facility_id}/product_modifier_defaults

Creates a new product modifier default in a modifier default group (and menu).

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

201

Create Product Modifier Default

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/product_modifier_defaults" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "menu": "/v1/facility/the-fish/menus/2",
    "title": "Sirup",
    "price_gross": "1.00",
    "currency": "EUR",
    "product_modifier_group": "/v1/facility/the-fish/product_modifier_groups/21"
}

Type

any

RESPONSE BODY

201

{
    "created": "2020-07-10T12:10:20.968324",
    "currency": "EUR",
    "facility": "/v1/facility/the-fish",
    "id": 43,
    "maximum_quantity": 1,
    "menu": "/v1/facility/the-fish/menus/2",
    "minimum_quantity": 0,
    "price_gross": "1.00",
    "priority": 0.0,
    "product_modifier_group": "/v1/facility/the-fish/product_modifier_groups/21",
    "resource_uri": "/v1/facility/the-fish/product_modifier_defaults/43",
    "title": "Sirup",
    "updated": "2020-07-10T12:10:20.968353"
}

Type

any

Delete Product Modifier Default

DELETE: /facility/{facility_id}/product_modifier_defaults/{product_modifier_default_id}

Deletes a product modifier default (specified by product_modifier_default_id) of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

product_modifier_default_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

204

Delete Product Modifier Default

CURL EXAMPLE

curl -X DELETE "https://api.resmio.com/v1/facility/{facility_id}/product_modifier_defaults/{product_modifier_default_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

Update Product Modifier Default

PATCH: /facility/{facility_id}/product_modifier_defaults/{product_modifier_default_id}

Partial update of a product modifier default (specified by product_modifier_default_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

product_modifier_default_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

202

Update Product Modifier Default

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/product_modifier_defaults/{product_modifier_default_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "currency": "EUR",
    "facility": "/v1/facility/the-fish",
    "maximum_quantity": 1,
    "menu": "/v1/facility/the-fish/menus/2",
    "minimum_quantity": 0,
    "price_gross": "1.00",
    "priority": 0,
    "product_modifier_group": "/v1/facility/the-fish/product_modifier_groups/21",
    "resource_uri": "/v1/facility/the-fish/product_modifier_defaults/43",
    "title": "Sirup Dip"
}

Type

any

RESPONSE BODY

202

{
    "created": "2020-07-10T12:10:20.968324",
    "currency": "EUR",
    "facility": "/v1/facility/the-fish",
    "id": 43,
    "maximum_quantity": 1,
    "menu": "/v1/facility/the-fish/menus/2",
    "minimum_quantity": 0,
    "price_gross": "1.00",
    "priority": 0.0,
    "product_modifier_group": "/v1/facility/the-fish/product_modifier_groups/21",
    "resource_uri": "/v1/facility/the-fish/product_modifier_defaults/43",
    "title": "Sirup Dip",
    "updated": "2020-07-10T12:12:47.162838"
}

Type

any

Read Delivery Hour

GET: /facility/{facility_id}/product_delivery_accept_hours

Get all the delivery hours of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Delivery Hour

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/product_delivery_accept_hours?offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": null
    },
    "objects": [{
            "begins": "18:00:00",
            "created": "2020-07-13T12:02:58Z",
            "ends": "22:00:00",
            "facility": "/v1/facility/the-fish",
            "id": 6,
            "menu": "/v1/facility/the-fish/menus/2",
            "resource_uri": "/v1/facility/the-fish/product_delivery_accept_hours/6",
            "updated": "2020-07-13T12:09:05Z",
            "weekdays": [0, 1, 2, 3, 4, 5]
        }, {
            "begins": "09:00:00",
            "created": "2020-06-29T10:00:07Z",
            "ends": "22:00:00",
            "facility": "/v1/facility/the-fish",
            "id": 2,
            "menu": "/v1/facility/the-fish/menus/2",
            "resource_uri": "/v1/facility/the-fish/product_delivery_accept_hours/2",
            "updated": "2020-06-29T10:00:07Z",
            "weekdays": [0, 1, 2, 3, 4, 5, 6]
        }
    ]
}

Type

any

Create Delivery Hour

POST: /facility/{facility_id}/product_delivery_accept_hours

Creates a new delivery hour for a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

201

Create Delivery Hour

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/product_delivery_accept_hours" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "ends": "22:00:00",
    "begins": "18:00:00",
    "weekdays": [0, 1, 2, 3, 4, 5, 6],
    "menu": "/v1/facility/the-fish/menus/2",
    "facility": "/v1/facility/the-fish"
}

Type

any

RESPONSE BODY

201

{
    "begins": "18:00:00",
    "created": "2020-07-13T12:02:58Z",
    "ends": "22:00:00",
    "facility": "/v1/facility/the-fish",
    "id": 6,
    "menu": "/v1/facility/the-fish/menus/2",
    "resource_uri": "/v1/facility/the-fish/product_delivery_accept_hours/6",
    "updated": "2020-07-13T12:02:58Z",
    "weekdays": [0, 1, 2, 3, 4, 5, 6]
}

Type

any

Delete Delivery Hour

DELETE: /facility/{facility_id}/product_delivery_accept_hours/{product_delivery_accept_hour_id}

Deletes a delivery hour(specified by product_delivery_accept_hour_id) of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

product_delivery_accept_hour_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

204

Delete Delivery Hour

CURL EXAMPLE

curl -X DELETE "https://api.resmio.com/v1/facility/{facility_id}/product_delivery_accept_hours/{product_delivery_accept_hour_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

Update Delivery Hour

PATCH: /facility/{facility_id}/product_delivery_accept_hours/{product_delivery_accept_hour_id}

Partial update of a delivery hour (specified by product_delivery_accept_hour_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

product_delivery_accept_hour_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

202

Update Delivery Hour

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/product_delivery_accept_hours/{product_delivery_accept_hour_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "ends": "22:00:00",
    "begins": "18:00:00",
    "weekdays": [0, 1, 2, 3, 4, 5],
    "menu": "/v1/facility/the-fish/menus/2",
    "facility": "/v1/facility/the-fish",
    "created": "2020-07-13T12:02:58Z",
    "id": 6,
    "resource_uri": "/v1/facility/the-fish/product_delivery_accept_hours/6",
    "updated": "2020-07-13T12:02:58Z"
}

Type

any

RESPONSE BODY

202

{
    "begins": "18:00:00",
    "created": "2020-07-13T12:02:58Z",
    "ends": "22:00:00",
    "facility": "/v1/facility/the-fish",
    "id": 6,
    "menu": "/v1/facility/the-fish/menus/2",
    "resource_uri": "/v1/facility/the-fish/product_delivery_accept_hours/6",
    "updated": "2020-07-13T12:09:05Z",
    "weekdays": [0, 1, 2, 3, 4, 5]
}

Type

any

Read Product Modifier Group

GET: /facility/{facility_id}/product_modifier_groups

Get all the product modifier groups of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Product Modifier Group

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/product_modifier_groups?offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
    "meta": {
        "limit": 1000,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": null
    },
    "objects": [{
            "created": "2020-07-10T10:10:06.684650",
            "facility": "/v1/facility/the-fish",
            "id": 20,
            "maximum_quantity": 1,
            "menu": "/v1/facility/the-fish/menus/2",
            "minimum_quantity": 1,
            "resource_uri": "/v1/facility/the-fish/product_modifier_groups/20",
            "title": "Salad Dressings",
            "title_public": "Dressings",
            "updated": "2020-07-10T10:10:06.684664"
        }, {
            "created": "2020-07-10T10:10:06.684710",
            "facility": "/v1/facility/the-fish",
            "id": 21,
            "maximum_quantity": 1,
            "menu": "/v1/facility/the-fish/menus/2",
            "minimum_quantity": 1,
            "resource_uri": "/v1/facility/the-fish/product_modifier_groups/21",
            "title": "Beverage Options",
            "title_public": "Options",
            "updated": "2020-07-10T10:10:06.684722"
        }
    ]
}

Type

any

Create Product Modifier Group

POST: /facility/{facility_id}/product_modifier_groups

Creates a new product modifier group in a menu.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

201

Create Product Modifier Group

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/product_modifier_groups" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "menu": "/v1/facility/the-fish/menus/2",
    "title": "Extras",
    "minimum_quantity": 0,
    "maximum_quantity": 1,
    "title_public": "Extras"
}

Type

any

RESPONSE BODY

201

{
    "created": "2020-07-10T12:05:13.131911",
    "facility": "/v1/facility/the-fish",
    "id": 22,
    "maximum_quantity": 1,
    "menu": "/v1/facility/the-fish/menus/2",
    "minimum_quantity": 0,
    "resource_uri": "/v1/facility/the-fish/product_modifier_groups/22",
    "title": "Extras",
    "title_public": "Extras",
    "updated": "2020-07-10T12:05:13.131942"
}

Type

any

Delete Product Modifier Group

DELETE: /facility/{facility_id}/product_modifier_groups/{product_modifier_group_id}

Deletes a product modifier group (specified by product_modifier_group_id) of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

product_modifier_group_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

204

Delete Product Modifier Group

CURL EXAMPLE

curl -X DELETE "https://api.resmio.com/v1/facility/{facility_id}/product_modifier_groups/{product_modifier_group_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

Update Product Modifier Group

PATCH: /facility/{facility_id}/product_modifier_groups/{product_modifier_group_id}

Partial update of a product modifier group (specified by product_modifier_group_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

product_modifier_group_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

202

Update Product Modifier Group

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/product_modifier_groups/{product_modifier_group_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "title": "Pizza Extras",
    "title_public": "Pizza Extras"
}

Type

any

RESPONSE BODY

202

{
    "created": "2020-07-10T12:05:13.131911",
    "facility": "/v1/facility/the-fish",
    "id": 22,
    "maximum_quantity": 1,
    "menu": "/v1/facility/the-fish/menus/2",
    "minimum_quantity": 0,
    "resource_uri": "/v1/facility/the-fish/product_modifier_groups/22",
    "title": "Pizza Extras",
    "title_public": "Pizza Extras",
    "updated": "2020-07-10T12:06:57.325480"
}

Type

any

Read Product Modifier

GET: /facility/{facility_id}/product_modifiers

Get all the product modifier of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

product

Filters product modifier for a product by it's product_id

Property	Value
required	false
type	integer
examples	`123`

product_modifier_group

Filters product modifier for a product_modifier_group by it's product_modifier_group_id

Property	Value
required	false
type	integer
examples	`123`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Product Modifier

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/product_modifiers?product=123&product_modifier_group=123&offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
    "meta": {
        "limit": 1000,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": null
    },
    "objects": [{
            "created": "2020-07-10T10:10:06.696723",
            "facility": "/v1/facility/the-fish",
            "id": 151,
            "maximum_quantity": 1,
            "menu": "/v1/facility/the-fish/menus/2",
            "minimum_quantity": 0,
            "price_gross": "1.50",
            "priority": 1.0,
            "product": "/v1/facility/the-fish/products/57",
            "product_modifier_group": "/v1/facility/the-fish/product_modifier_groups/19",
            "resource_uri": "/v1/facility/the-fish/product_modifiers/151",
            "title": "Extra Cheese",
            "updated": "2020-07-10T10:10:06.696755"
        }, {
            "created": "2020-07-10T10:10:06.696908",
            "facility": "/v1/facility/the-fish",
            "id": 152,
            "maximum_quantity": 1,
            "menu": "/v1/facility/the-fish/menus/2",
            "minimum_quantity": 0,
            "price_gross": "2.00",
            "priority": 2.0,
            "product": "/v1/facility/the-fish/products/57",
            "product_modifier_group": "/v1/facility/the-fish/product_modifier_groups/19",
            "resource_uri": "/v1/facility/the-fish/product_modifiers/152",
            "title": "Extra Onions",
            "updated": "2020-07-10T10:10:06.696926"
        }
    ]
}

Type

any

Create Product Modifier

POST: /facility/{facility_id}/product_modifiers

Creates a new product modifier in a modifier group (and menu).

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

201

Create Product Modifier

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/product_modifiers" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "menu": "/v1/facility/the-fish/menus/2",
    "title": "Tomatoes",
    "price_gross": "0.00",
    "currency": "EUR",
    "product_modifier_group": "/v1/facility/the-fish/product_modifier_groups/20",
    "product": "/v1/facility/the-fish/products/60",
    "priority": 4
}

Type

any

RESPONSE BODY

201

{
    "created": "2020-07-10T12:27:56.059521",
    "currency": "EUR",
    "facility": "/v1/facility/the-fish",
    "id": 175,
    "maximum_quantity": 1,
    "menu": "/v1/facility/the-fish/menus/2",
    "minimum_quantity": 0,
    "price_gross": "0.00",
    "priority": 4.0,
    "product": "/v1/facility/the-fish/products/60",
    "product_modifier_group": "/v1/facility/the-fish/product_modifier_groups/20",
    "resource_uri": "/v1/facility/the-fish/product_modifiers/175",
    "title": "Tomatoes",
    "updated": "2020-07-10T12:27:56.059552"
}

Type

any

Delete Product Modifier

DELETE: /facility/{facility_id}/product_modifiers/{product_modifier_id}

Deletes a product modifier (specified by product_modifier_id) of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

product_modifier_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

204

Delete Product Modifier

CURL EXAMPLE

curl -X DELETE "https://api.resmio.com/v1/facility/{facility_id}/product_modifiers/{product_modifier_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

Update Product Modifier

PATCH: /facility/{facility_id}/product_modifiers/{product_modifier_id}

Partial update of a product modifier (specified by product_modifier_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

product_modifier_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

202

Update Product Modifier

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/product_modifiers/{product_modifier_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "created": "2020-07-10T10:10:06.697338",
    "facility": "/v1/facility/the-fish",
    "maximum_quantity": 1,
    "menu": "/v1/facility/the-fish/menus/2",
    "minimum_quantity": 0,
    "price_gross": "2.50",
    "priority": 3,
    "product": "/v1/facility/the-fish/products/58",
    "product_modifier_group": "/v1/facility/the-fish/product_modifier_groups/19",
    "resource_uri": "/v1/facility/the-fish/product_modifiers/156",
    "title": "Extra Salami",
    "updated": "2020-07-10T10:10:06.697352"
}

Type

any

RESPONSE BODY

202

{
    "created": "2020-07-10T10:10:06.697338",
    "facility": "/v1/facility/the-fish",
    "id": 156,
    "maximum_quantity": 1,
    "menu": "/v1/facility/the-fish/menus/2",
    "minimum_quantity": 0,
    "price_gross": "2.50",
    "priority": 3.0,
    "product": "/v1/facility/the-fish/products/58",
    "product_modifier_group": "/v1/facility/the-fish/product_modifier_groups/19",
    "resource_uri": "/v1/facility/the-fish/product_modifiers/156",
    "title": "Extra Salami",
    "updated": "2020-07-10T12:30:38.836796"
}

Type

any

Read Product Order Fee

GET: /facility/{facility_id}/product_order_fees

Get all the product order fees (e.g tips, or delivery fees) potentially filtered by a product order id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

product_order

Specify the id of the product order to filter the product order fees

Property	Value
required	true
type	integer
examples	`6`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Product Order Fee

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/product_order_fees?product_order=6&offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
    "meta": {
        "limit": 1000,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [{
            "created": "2021-06-16T12:26:57Z",
            "currency": "EUR",
            "facility": "/v1/facility/the-fish",
            "fee_type": "delivery_fee",
            "fulfillment_time": "2021-06-16T11:30:00Z",
            "id": 2,
            "price_gross": "3.00",
            "product_order": "/v1/facility/the-fish/product_orders/6",
            "resource_uri": "/v1/facility/the-fish/product_order_fees/2",
            "updated": "2021-06-16T12:26:59Z"
        }, {
            "created": "2021-06-16T12:26:57Z",
            "currency": "EUR",
            "facility": "/v1/facility/the-fish",
            "fee_type": "tip",
            "fulfillment_time": "2021-06-16T11:30:00Z",
            "id": 1,
            "price_gross": "5.00",
            "product_order": "/v1/facility/the-fish/product_orders/6",
            "resource_uri": "/v1/facility/the-fish/product_order_fees/1",
            "updated": "2021-06-16T12:26:59Z"
        }
    ]
}

Type

any

Read Product Order Item

GET: /facility/{facility_id}/product_order_items

Get all the product order items potentially filtered by a product order id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

product_order

Specify the id of the product order to filter the product order items

Property	Value
required	true
type	integer
examples	`6`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Product Order Item

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/product_order_items?product_order=6&offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
    "meta": {
        "limit": 1000,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [{
            "created": "2021-06-16T10:16:27Z",
            "currency": "EUR",
            "description": "Large",
            "facility": "/v1/facility/the-fish",
            "fulfillment_time": "2021-06-16T11:30:00Z",
            "id": 1,
            "menu": "/v1/facility/the-fish/menus/2",
            "price_gross": "7.00",
            "product_order": "/v1/facility/the-fish/product_orders/6",
            "quantity": 1,
            "resource_uri": "/v1/facility/the-fish/product_order_items/1",
            "title": "Salami Pizza",
            "updated": "2021-06-16T10:16:27Z"
        }
    ]
}

Type

any

Read Product Order

GET: /facility/{facility_id}/product_orders

Get all the product orders of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

fulfillment_time__lt

Specify that the fulfillment time should be "less than" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-09-05T22:00:00.000Z`

fulfillment_time__gte

Specify that the fulfillment time should be "greater than or equal" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-09-04T22:00:00.000Z`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Product Order

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/product_orders?fulfillment_time__lt=2019-09-05T22:00:00.000Z&fulfillment_time__gte=2019-09-04T22:00:00.000Z&offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
    "meta": {
        "limit": 1000,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [{
            "address1": "",
            "address2": "",
            "city": "",
            "comment": "",
            "company": "",
            "country": "",
            "created": "2021-06-15T12:02:12Z",
            "currency": "EUR",
            "customer": "/v1/facility/the-fish/customer/76",
            "email": "test@example.com",
            "facility": "/v1/facility/the-fish",
            "fulfillment_time": "2021-06-15T13:15:00Z",
            "id": 6,
            "item_quantity": 1,
            "name": "test",
            "notes": "",
            "payment_type": "OUTSTANDING",
            "phone": "0160123456789",
            "price_gross": "7.00",
            "qr_order_type": null,
            "ref_num": "shk7bw",
            "resource_uri": "/v1/facility/the-fish/product_orders/6",
            "source": "app.resmio.com",
            "status": "new",
            "type": "pickup",
            "updated": "2021-06-15T12:02:14Z",
            "zip_code": ""
        }
    ]
}

Type

any

Update Product Order

PATCH: /facility/{facility_id}/product_orders/{product_order_id}

Partial update of a product modifier (specified by product_order_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

product_order_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

202

Update Product Order

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/product_orders/{product_order_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "id": 6,
    "status": "in_progress"
}

Type

any

RESPONSE BODY

202

{
    "address1": "",
    "address2": "",
    "city": "",
    "comment": "",
    "company": "",
    "country": "",
    "created": "2021-06-15T12:02:12Z",
    "currency": "EUR",
    "customer": "/v1/facility/the-fish/customer/76",
    "email": "test@example.com",
    "facility": "/v1/facility/the-fish",
    "fulfillment_time": "2021-06-15T13:15:00Z",
    "id": 6,
    "item_quantity": 1,
    "name": "test",
    "notes": "",
    "payment_type": "OUTSTANDING",
    "phone": "0160123456789",
    "price_gross": "7.00",
    "qr_order_type": null,
    "ref_num": "shk7bw",
    "resource_uri": "/v1/facility/the-fish/product_orders/6",
    "source": "app.resmio.com",
    "status": "in_progress",
    "type": "pickup",
    "updated": "2021-06-15T12:06:22Z",
    "zip_code": ""
}

Type

any

Read Pickup Hour

GET: /facility/{facility_id}/product_pickup_accept_hours

Get all the pickup hours of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Pickup Hour

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/product_pickup_accept_hours?offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": null
    },
    "objects": [{
            "begins": "09:00:00",
            "created": "2020-06-29T10:00:07Z",
            "ends": "22:00:00",
            "facility": "/v1/facility/the-fish",
            "id": 2,
            "menu": "/v1/facility/the-fish/menus/2",
            "resource_uri": "/v1/facility/the-fish/product_pickup_accept_hours/2",
            "updated": "2020-06-29T10:00:07Z",
            "weekdays": [0, 1, 2, 3, 4, 5, 6]
        }
    ]
}

Type

any

Create Pickup Hour

POST: /facility/{facility_id}/product_pickup_accept_hours

Creates a new pickup hour for a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

201

Create Pickup Hour

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/product_pickup_accept_hours" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "ends": "22:00:00",
    "begins": "18:00:00",
    "weekdays": [0, 1, 2, 3, 4, 5],
    "facility": "/v1/facility/the-fish",
    "menu": "/v1/facility/the-fish/menus/2"
}

Type

any

RESPONSE BODY

201

{
    "begins": "18:00:00",
    "created": "2020-07-13T12:17:30Z",
    "ends": "22:00:00",
    "facility": "/v1/facility/the-fish",
    "id": 6,
    "menu": "/v1/facility/the-fish/menus/2",
    "resource_uri": "/v1/facility/the-fish/product_pickup_accept_hours/6",
    "updated": "2020-07-13T12:17:30Z",
    "weekdays": [0, 1, 2, 3, 4, 5]
}

Type

any

Delete Pickup Hour

DELETE: /facility/{facility_id}/product_pickup_accept_hours/{product_pickup_accept_hour_id}

Deletes a pickup hour (specified by product_pickup_accept_hour_id) of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

product_pickup_accept_hour_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

204

Delete Pickup Hour

CURL EXAMPLE

curl -X DELETE "https://api.resmio.com/v1/facility/{facility_id}/product_pickup_accept_hours/{product_pickup_accept_hour_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

Update Pickup Hour

PATCH: /facility/{facility_id}/product_pickup_accept_hours/{product_pickup_accept_hour_id}

Partial update of a pickup hour (specified by product_pickup_accept_hour_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

product_pickup_accept_hour_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

202

Update Pickup Hour

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/product_pickup_accept_hours/{product_pickup_accept_hour_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "ends": "22:00:00",
    "begins": "09:00:00",
    "weekdays": [0, 1, 2, 3, 4],
    "facility": "/v1/facility/the-fish",
    "menu": "/v1/facility/the-fish/menus/2",
    "created": "2020-06-29T10:00:07Z",
    "id": 2,
    "resource_uri": "/v1/facility/the-fish/product_pickup_accept_hours/2",
    "updated": "2020-07-13T12:14:11Z"
}

Type

any

RESPONSE BODY

202

{
    "begins": "09:00:00",
    "created": "2020-06-29T10:00:07Z",
    "ends": "22:00:00",
    "facility": "/v1/facility/the-fish",
    "id": 2,
    "menu": "/v1/facility/the-fish/menus/2",
    "resource_uri": "/v1/facility/the-fish/product_pickup_accept_hours/2",
    "updated": "2020-07-13T12:19:27Z",
    "weekdays": [0, 1, 2, 3, 4]
}

Type

any

Read QR Order Hour

GET: /facility/{facility_id}/product_qr_order_accept_hours

Get all the qr order hours of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read QR Order Hour

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/product_qr_order_accept_hours?offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": null
    },
    "objects": [{
            "begins": "18:00:00",
            "created": "2020-07-13T12:21:47Z",
            "ends": "22:00:00",
            "facility": "/v1/facility/the-fish",
            "id": 6,
            "menu": "/v1/facility/the-fish/menus/2",
            "menu_categories": ["/v1/facility/the-fish/menu_categories/212", "/v1/facility/the-fish/menu_categories/213", "/v1/facility/the-fish/menu_categories/214", "/v1/facility/the-fish/menu_categories/215"],
            "resource_uri": "/v1/facility/the-fish/product_qr_order_accept_hours/6",
            "updated": "2020-07-13T12:25:53Z",
            "weekdays": [0, 1, 2, 3, 4, 5]
        }, {
            "begins": "09:00:00",
            "created": "2020-06-29T10:00:07Z",
            "ends": "22:00:00",
            "facility": "/v1/facility/the-fish",
            "id": 2,
            "menu": "/v1/facility/the-fish/menus/2",
            "menu_categories": [],
            "resource_uri": "/v1/facility/the-fish/product_qr_order_accept_hours/2",
            "updated": "2020-06-29T10:00:07Z",
            "weekdays": [0, 1, 2, 3, 4, 5, 6]
        }
    ]
}

Type

any

Create QR Order Hour

POST: /facility/{facility_id}/product_qr_order_accept_hours

Creates a new qr order hour for a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

201

Create QR Order Hour

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/product_qr_order_accept_hours" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "ends": "22:00:00",
    "begins": "18:00:00",
    "weekdays": [0, 1, 2, 3, 4, 5],
    "menu_categories": ["/v1/facility/the-fish/menu_categories/211", "/v1/facility/the-fish/menu_categories/212", "/v1/facility/the-fish/menu_categories/213", "/v1/facility/the-fish/menu_categories/214", "/v1/facility/the-fish/menu_categories/215"],
    "menu": "/v1/facility/the-fish/menus/2",
    "facility": "/v1/facility/the-fish"
}

Type

any

RESPONSE BODY

201

{
    "begins": "18:00:00",
    "created": "2020-07-13T12:21:47Z",
    "ends": "22:00:00",
    "facility": "/v1/facility/the-fish",
    "id": 6,
    "menu": "/v1/facility/the-fish/menus/2",
    "menu_categories": ["/v1/facility/the-fish/menu_categories/211", "/v1/facility/the-fish/menu_categories/212", "/v1/facility/the-fish/menu_categories/213", "/v1/facility/the-fish/menu_categories/214", "/v1/facility/the-fish/menu_categories/215"],
    "resource_uri": "/v1/facility/the-fish/product_qr_order_accept_hours/6",
    "updated": "2020-07-13T12:21:47Z",
    "weekdays": [0, 1, 2, 3, 4, 5]
}

Type

any

Delete QR Order Hour

DELETE: /facility/{facility_id}/product_qr_order_accept_hours/{product_qr_order_accept_hour_id}

Deletes a qr order hour (specified by product_qr_order_accept_hour_id) of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

product_qr_order_accept_hour_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

204

Delete QR Order Hour

CURL EXAMPLE

curl -X DELETE "https://api.resmio.com/v1/facility/{facility_id}/product_qr_order_accept_hours/{product_qr_order_accept_hour_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

Update QR Order Hour

PATCH: /facility/{facility_id}/product_qr_order_accept_hours/{product_qr_order_accept_hour_id}

Partial update of a qr order hour (specified by product_qr_order_accept_hour_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

product_qr_order_accept_hour_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

202

Update QR Order Hour

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/product_qr_order_accept_hours/{product_qr_order_accept_hour_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "ends": "22:00:00",
    "begins": "18:00:00",
    "weekdays": [0, 1, 2, 3, 4, 5],
    "menu_categories": ["/v1/facility/the-fish/menu_categories/212", "/v1/facility/the-fish/menu_categories/213", "/v1/facility/the-fish/menu_categories/214", "/v1/facility/the-fish/menu_categories/215"],
    "menu": "/v1/facility/the-fish/menus/2",
    "facility": "/v1/facility/the-fish",
    "created": "2020-07-13T12:21:47Z",
    "id": 6,
    "resource_uri": "/v1/facility/the-fish/product_qr_order_accept_hours/6",
    "updated": "2020-07-13T12:21:47Z"
}

Type

any

RESPONSE BODY

202

{
    "begins": "18:00:00",
    "created": "2020-07-13T12:21:47Z",
    "ends": "22:00:00",
    "facility": "/v1/facility/the-fish",
    "id": 6,
    "menu": "/v1/facility/the-fish/menus/2",
    "menu_categories": ["/v1/facility/the-fish/menu_categories/212", "/v1/facility/the-fish/menu_categories/213", "/v1/facility/the-fish/menu_categories/214", "/v1/facility/the-fish/menu_categories/215"],
    "resource_uri": "/v1/facility/the-fish/product_qr_order_accept_hours/6",
    "updated": "2020-07-13T12:25:53Z",
    "weekdays": [0, 1, 2, 3, 4, 5]
}

Type

any

Read Product Variation

GET: /facility/{facility_id}/product_variations

Get all the product variation of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

product

Filters product variations for a product by it's product_id

Property	Value
required	false
type	integer
examples	`123`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Product Variation

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/product_variations?product=123&offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
    "meta": {
        "limit": 1000,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": null
    },
    "objects": [{
            "created": "2020-07-13T11:50:17.176764",
            "facility": "/v1/facility/the-fish",
            "id": 811,
            "menu": "/v1/facility/the-fish/menus/2",
            "modifier_price_multiplicator": "1.00",
            "price_gross": "12.99",
            "priority": 101.0,
            "product": "/v1/facility/the-fish/products/265",
            "resource_uri": "/v1/facility/the-fish/product_variations/811",
            "title": "XXL",
            "updated": "2020-07-13T11:50:17.176788"
        }, {
            "created": "2020-07-02T11:29:39.837788",
            "facility": "/v1/facility/the-fish",
            "id": 784,
            "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/262",
            "resource_uri": "/v1/facility/the-fish/product_variations/784",
            "title": "Large",
            "updated": "2020-07-02T11:29:39.837823"
        }
    ]
}

Type

any

Create Product Variation

POST: /facility/{facility_id}/product_variations

Creates a new product variation for a product.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

201

Create Product Variation

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/product_variations" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "title": "XXL",
    "menu": "/v1/facility/the-fish/menus/2",
    "price_gross": "12.99",
    "currency": "EUR",
    "product": "/v1/facility/the-fish/products/265",
    "priority": 101
}

Type

any

RESPONSE BODY

201

{
    "created": "2020-07-13T11:50:17.176764",
    "currency": "EUR",
    "facility": "/v1/facility/the-fish",
    "id": 811,
    "menu": "/v1/facility/the-fish/menus/2",
    "modifier_price_multiplicator": "1",
    "price_gross": "12.99",
    "priority": 101.0,
    "product": "/v1/facility/the-fish/products/265",
    "resource_uri": "/v1/facility/the-fish/product_variations/811",
    "title": "XXL",
    "updated": "2020-07-13T11:50:17.176788"
}

Type

any

Delete Product Variation

DELETE: /facility/{facility_id}/product_variations/{product_variation_id}

Deletes a product variation (specified by product_variation_id) of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

product_variation_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

204

Delete Product Variation

CURL EXAMPLE

curl -X DELETE "https://api.resmio.com/v1/facility/{facility_id}/product_variations/{product_variation_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

Update Product Variation

PATCH: /facility/{facility_id}/product_variations/{product_variation_id}

Partial update of a product variation (specified by product_variation_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

product_variation_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

202

Update Product Variation

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/product_variations/{product_variation_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "created": "2020-07-10T10:10:06.697338",
    "facility": "/v1/facility/the-fish",
    "maximum_quantity": 1,
    "menu": "/v1/facility/the-fish/menus/2",
    "minimum_quantity": 0,
    "price_gross": "2.50",
    "priority": 3,
    "product": "/v1/facility/the-fish/products/58",
    "product_variation_group": "/v1/facility/the-fish/product_variation_groups/19",
    "resource_uri": "/v1/facility/the-fish/product_variations/156",
    "title": "Extra Salami",
    "updated": "2020-07-10T10:10:06.697352"
}

Type

any

RESPONSE BODY

202

{
    "created": "2020-07-10T10:10:06.697338",
    "facility": "/v1/facility/the-fish",
    "id": 156,
    "maximum_quantity": 1,
    "menu": "/v1/facility/the-fish/menus/2",
    "minimum_quantity": 0,
    "price_gross": "2.50",
    "priority": 3.0,
    "product": "/v1/facility/the-fish/products/58",
    "product_variation_group": "/v1/facility/the-fish/product_variation_groups/19",
    "resource_uri": "/v1/facility/the-fish/product_variations/156",
    "title": "Extra Salami",
    "updated": "2020-07-10T12:30:38.836796"
}

Type

any

Read Product

GET: /facility/{facility_id}/products

Get all the products of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

product

Filters allergens for a product by it's product_id

Property	Value
required	false
type	integer
examples	`123`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Product

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/products?product=123&offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
    "meta": {
        "limit": 1000,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": null
    },
    "objects": [{
            "created": "2020-07-10T10:10:06Z",
            "description": null,
            "facility": "/v1/facility/the-fish",
            "id": 65,
            "menu": "/v1/facility/the-fish/menus/2",
            "menu_category": "/v1/facility/the-fish/menu_categories/35",
            "online_order_enabled": true,
            "price_gross": "1.99",
            "priority": 3.0,
            "product_identifier": "9",
            "resource_uri": "/v1/facility/the-fish/products/65",
            "show_product_in_menu": true,
            "title": "Sprite",
            "updated": "2020-07-10T10:10:06Z"
        }, {
            "created": "2020-07-10T11:46:19Z",
            "description": "Pizza with delicious salami and cheese",
            "facility": "/v1/facility/the-fish",
            "id": 66,
            "menu": "/v1/facility/the-fish/menus/2",
            "menu_category": "/v1/facility/the-fish/menu_categories/31",
            "online_order_enabled": true,
            "price_gross": "10.00",
            "priority": 3.62103981761676,
            "product_identifier": "",
            "resource_uri": "/v1/facility/the-fish/products/66",
            "show_product_in_menu": true,
            "title": "Salami Pizza",
            "updated": "2020-07-10T11:49:30Z"
        }
    ]
}

Type

any

Create Product

POST: /facility/{facility_id}/products

Creates a new product in a menu.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

201

Create Product

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/products" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "priority": 3.6210398176167637,
    "menu": "/v1/facility/the-fish/menus/2",
    "menu_category": "/v1/facility/the-fish/menu_categories/31",
    "currency": "EUR",
    "title": "Salami Pizza",
    "description": "Pizza with delicious salami",
    "show_product_in_menu": true,
    "online_order_enabled": true,
    "price_gross": "10.00"
}

Type

any

RESPONSE BODY

201

{
    "created": "2020-07-10T11:46:19Z",
    "currency": "EUR",
    "description": "Pizza with delicious salami",
    "facility": "/v1/facility/the-fish",
    "id": 66,
    "menu": "/v1/facility/the-fish/menus/2",
    "menu_category": "/v1/facility/the-fish/menu_categories/31",
    "online_order_enabled": true,
    "price_gross": "10.00",
    "priority": 3.6210398176167637,
    "product_identifier": "",
    "resource_uri": "/v1/facility/the-fish/products/66",
    "show_product_in_menu": true,
    "title": "Salami Pizza",
    "updated": "2020-07-10T11:46:19Z"
}

Type

any

Delete Product

DELETE: /facility/{facility_id}/products/{product_id}

Deletes a product (specified by product_id) of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

product_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

204

Delete Product

CURL EXAMPLE

curl -X DELETE "https://api.resmio.com/v1/facility/{facility_id}/products/{product_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

Update Product

PATCH: /facility/{facility_id}/products/{product_id}

Partial update of a product (specified by product_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

product_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

202

Update Product

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/products/{product_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "description": "Pizza with delicious salami and cheese",
    "price_gross": "10.00"
}

Type

any

RESPONSE BODY

202

{
    "created": "2020-07-10T11:46:19Z",
    "description": "Pizza with delicious salami and cheese",
    "facility": "/v1/facility/the-fish",
    "id": 66,
    "menu": "/v1/facility/the-fish/menus/2",
    "menu_category": "/v1/facility/the-fish/menu_categories/31",
    "online_order_enabled": true,
    "price_gross": "10.00",
    "priority": 3.62103981761676,
    "product_identifier": "",
    "resource_uri": "/v1/facility/the-fish/products/66",
    "show_product_in_menu": true,
    "title": "Salami Pizza",
    "updated": "2020-07-10T11:49:30Z"
}

Type

any

Read Resources

GET: /facility/{facility_id}/resources

Get all the resources (usually tables) of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

resource_groups

The parameter is the id of a resource group. It filters the resources and only returns those that belong to this resource group

Property	Value
required	false
type	number
examples	`1`

resource_groups__in

The parameter is a comma separated list of resource_group ids. It filters the resources and only returns those that belong to these resource group.

Property	Value
required	false
type	string
examples	`1,2`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Resources

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/resources?resource_groups=1&resource_groups__in=1,2&offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "meta": {
    "limit": 1000,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": null
  },
  "objects": [
    {
      "capacity": 2,
      "created": "2019-09-05T13:07:18Z",
      "description": "",
      "facility": "/v1/facility/the-fish",
      "id": 1,
      "is_unlocated": true,
      "name": "Table 1",
      "resource_groups": [
        "/v1/facility/the-fish/resource_groups/1"
      ],
      "resource_uri": "/v1/facility/the-fish/resources/1",
      "table_location_horizontal": 1.0,
      "table_location_vertical": 1.0,
      "table_orientation": 0,
      "table_shape": "round",
      "table_size": "medium",
      "updated": "2019-09-05T13:07:18Z"
    },
    {
      "capacity": 5,
      "created": "2019-09-05T13:07:18Z",
      "description": "",
      "facility": "/v1/facility/the-fish",
      "id": 2,
      "is_unlocated": true,
      "name": "Table 2",
      "resource_groups": [
        "/v1/facility/the-fish/resource_groups/1"
      ],
      "resource_uri": "/v1/facility/the-fish/resources/2",
      "table_location_horizontal": 1.0,
      "table_location_vertical": 2.0,
      "table_orientation": 0,
      "table_shape": "round",
      "table_size": "medium",
      "updated": "2019-09-05T13:07:18Z"
    }
  ]
}

Type

any

Create Resource

POST: /facility/{facility_id}/resources

Creates a new resource (usually table) in a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

201

Create Resource

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/resources" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
  "name": "Table 100",
  "capacity": "5",
  "description": "An optional table description",
  "resource_groups": [
    "/v1/facility/the-fish/resource_groups/1"
  ]
}

Type

any

RESPONSE BODY

201

{
  "capacity": 5,
  "created": "2019-09-06T06:46:34Z",
  "description": "An optional table description",
  "facility": "/v1/facility/the-fish",
  "id": 301,
  "is_unlocated": true,
  "name": "Table 100",
  "resource_groups": [
    "/v1/facility/the-fish/resource_groups/1"
  ],
  "resource_uri": "/v1/facility/the-fish/resources/301",
  "table_location_horizontal": 1.0,
  "table_location_vertical": 1.0,
  "table_orientation": 0,
  "table_shape": "round",
  "table_size": "large",
  "updated": "2019-09-06T06:46:34Z"
}

Type

any

Update Resource

PATCH: /facility/{facility_id}/resources/{resource_id}

Partial update of a resource (specified by resource_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

resource_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

202

Update Resource

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/resources/{resource_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
  "capacity": 5,
  "description": "An optional table description",
  "id": 301,
  "is_unlocated": true,
  "name": "Table 100",
  "table_location_horizontal": 1.0,
  "table_location_vertical": 1.0,
  "table_orientation": 0,
  "table_shape": "round",
  "table_size": "large",
}

Type

any

RESPONSE BODY

202

{
    "capacity": 5,
    "created": "2019-09-30T13:03:05Z",
    "description": "",
    "facility": "/v1/facility/the-fish",
    "id": 76343,
    "is_unlocated": false,
    "name": "Test 72",
    "resource_groups": ["/v1/facility/the-fish/resource_groups/9197"],
    "resource_uri": "/v1/facility/the-fish/resources/76343",
    "table_location_horizontal": 2.07737456135847,
    "table_location_vertical": 2.41166728008833,
    "table_orientation": 0,
    "table_shape": "round",
    "table_size": "large",
    "updated": "2020-01-14T10:05:12Z"
}

Type

any

Read Rush Hour Stops

GET: /facility/{facility_id}/rush_hour_stops

Lists all rush hour stops of a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Rush Hour Stops

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/rush_hour_stops?offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
    "meta": {
        "limit": 200,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": null
    },
    "objects": [{
            "begins": "14:00",
            "capacity": 20,
            "ends": "22:00",
            "facility": "/v1/facility/the-fish",
            "id": 157,
            "resource_uri": "/v1/facility/the-fish/rush_hour_stops/157",
            "weekdays": [0, 1, 2, 3, 4, 5]
        }
    ]
}

Type

any

Create Rush Hour Stops

POST: /facility/{facility_id}/rush_hour_stops

Creates a new rush hour stops for a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

201

Create Rush Hour Stops

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/rush_hour_stops" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
    "begins": "14:00",
    "ends": "22:00",
    "weekdays": [0, 1, 2, 3, 4, 5],
    "capacity": 20
}

Type

any

RESPONSE BODY

201

{
    "begins": "14:00",
    "capacity": 20,
    "end_of_acceptance": null,
    "end_of_acceptance_enabled": false,
    "ends": "22:00",
    "facility": "/v1/facility/the-fish",
    "id": 158,
    "resource_uri": "/v1/facility/the-fish/rush_hour_stops/158",
    "weekdays": [0, 1, 2, 3, 4, 5]
}

Type

any

Delete Rush Hour Stops

DELETE: /facility/{facility_id}/rush_hour_stops/{rush_hour_stop_id}

Deletes a rush hour stops (specified by rush_hour_stop_id) of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

rush_hour_stop_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

204

Delete Rush Hour Stops

CURL EXAMPLE

curl -X DELETE "https://api.resmio.com/v1/facility/{facility_id}/rush_hour_stops/{rush_hour_stop_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

Update Rush Hour Stops

PATCH: /facility/{facility_id}/rush_hour_stops/{rush_hour_stop_id}

Partial update of a rush hour stops (specified by rush_hour_stop_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

rush_hour_stop_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

202

Update Rush Hour Stops

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/rush_hour_stops/{rush_hour_stop_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
    "begins": "14:00",
    "capacity": 20,
    "ends": "22:00",
    "weekdays": [0, 1, 2, 3, 4, 5]
}

Type

any

RESPONSE BODY

202

{
    "begins": "14:00",
    "capacity": 20,
    "ends": "22:00",
    "facility": "/v1/facility/the-fish",
    "id": 157,
    "resource_uri": "/v1/facility/the-fish/rush_hour_stops/157",
    "weekdays": [0, 1, 2, 3, 5]
}

Type

any

Read Combinations of Resources

GET: /facility/{facility_id}/resource_combinations

Get all combinations of resources (usually tables) of one facility specified by facility_id. Combinations need for example in case when need to put group of customers at several tables.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Combinations of Resources

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/resource_combinations?offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
  "meta": {
    "limit": 80,
    "next": null,
    "offset": 20,
    "previous": null,
    "total_count": 1
  },
  "objects": [
    {
      "created": "2019-11-01T08:49:05Z",
      "facility": "/v1/facility/the-fish",
      "id": 1,
      "max": 5,
      "resource_uri": "/v1/facility/the-fish/resource_combinations/1",
      "resources": [
        "/v1/facility/the-fish/resources/1",
        "/v1/facility/the-fish/resources/2"
      ],
      "updated": "2019-11-01T08:49:05Z"
    }
  ]
}

Type

any

Create Combination of Resources

POST: /facility/{facility_id}/resource_combinations

Creates a new combination of resources.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

201

Create Combination of Resources

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/resource_combinations" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
  "max": 5,
  "resources": [
    "/v1/facility/the-fish/resources/1",
    "/v1/facility/the-fish/resources/2"
  ]
}

Type

any

RESPONSE BODY

201

{
  "created": "2019-11-01T09:06:41Z",
  "facility": "/v1/facility/the-fish",
  "id": 2,
  "max": 5,
  "resource_uri": "/v1/facility/the-fish/resource_combinations/2",
  "resources": [
    "/v1/facility/the-fish/resources/1",
    "/v1/facility/the-fish/resources/2"
  ],
  "updated": "2019-11-01T09:06:41Z"
}

Type

any

Update Combination of Resources

PATCH: /facility/{facility_id}/resource_combinations/{resource_combination_id}

Partial update of a combination of resources (specified by resource_combination_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

resource_combination_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

202

Update Combination of Resources

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/resource_combinations/{resource_combination_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
  "max": 4
}

Type

any

RESPONSE BODY

202

{
  "created": "2019-11-01T09:06:41Z",
  "facility": "/v1/facility/the-fish",
  "id": 2,
  "max": 4,
  "resource_uri": "/v1/facility/the-fish/resource_combinations/2",
  "resources": [
    "/v1/facility/the-fish/resources/1",
    "/v1/facility/the-fish/resources/2"
  ],
  "updated": "2019-11-01T09:08:57Z"
}

Type

any

Read Resource Groups

GET: /facility/{facility_id}/resource_groups

Get all the resource groups (usually rooms) of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Resource Groups

CURL EXAMPLE

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

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "meta": {
    "limit": 1000,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": null
  },
  "objects": [
    {
      "created": "2019-09-05T13:07:18Z",
      "description": "",
      "facility": "/v1/facility/the-fish",
      "id": 1,
      "name": "Room 0",
      "resource_uri": "/v1/facility/the-fish/resource_groups/1",
      "resources": [
        "/v1/facility/the-fish/resources/1",
        "/v1/facility/the-fish/resources/2",
        "/v1/facility/the-fish/resources/3",
        "/v1/facility/the-fish/resources/4",
        "/v1/facility/the-fish/resources/5",
        "/v1/facility/the-fish/resources/6",
        "/v1/facility/the-fish/resources/7",
        "/v1/facility/the-fish/resources/8",
        "/v1/facility/the-fish/resources/9",
        "/v1/facility/the-fish/resources/10"
      ],
      "size_horizontal": 6,
      "size_vertical": 6,
      "updated": "2019-09-05T13:07:18Z"
    }
  ]
}

Type

any

Read Resource Overrides

GET: /facility/{facility_id}/resource_overrides

Get all the resource overrides (e.g. table or room blockings) of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

begins__lt

Specify that the begins date for the resource override should be "less than" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-09-07T22:00:00.000Z`

ends__gte

Specify that the ends date for the resource override should be "greater than or equal" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2019-08-31T22:00:00.000Z`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Resource Overrides

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/resource_overrides?begins__lt=2019-09-07T22:00:00.000Z&ends__gte=2019-08-31T22:00:00.000Z&offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "meta": {
    "limit": 1000,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": null
  },
  "objects": [
    {
      "begins": "2019-09-05T08:00:00Z",
      "created": "2019-09-05T13:50:59Z",
      "description": "",
      "ends": "2019-09-05T20:00:00Z",
      "facility": "/v1/facility/the-fish",
      "id": 1,
      "reason": "",
      "resource_groups": [],
      "resource_uri": "/v1/facility/the-fish/resource_overrides/1",
      "resources": [
        "/v1/facility/the-fish/resources/1"
      ],
      "updated": "2019-09-05T13:50:59Z"
    }
  ]
}

Type

any

Read Tickets

GET: /facility/{facility_id}/tickets

Get tickets for a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

type

Get tickets of specified type (coupon, event).

Property	Value
required	false
type	string
examples	`event`

is_active

Get only active/deactive tickets.

Property	Value
required	false
type	boolean
examples	`true`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Tickets

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/tickets?type=event&is_active=true&offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
  "meta": {
    "limit": 80,
    "next": null,
    "offset": 20,
    "previous": null,
    "total_count": 4
  },
  "objects": [
    {
      "amount_paid": 0,
      "available": 10,
      "begins": "2018-09-12T22:00:00Z",
      "capacity": 10,
      "conditions": "<br>",
      "created": "2016-01-14T10:44:03Z",
      "currency": "EUR",
      "description": "<p style=\"line-height: 18.5714px; background-color: rgb(255, 255, 255);\">Description</p>",
      "duration": null,
      "ends": "2018-09-24T21:59:59Z",
      "facility": "/v1/facility/the-fish",
      "id": 1241,
      "image": "https://resmio-static-files.s3.amazonaws.com/media/ticket/yyqm5scxctk8uxyp.jpg",
      "is_active": true,
      "max_party_size": 345,
      "max_purchases": 10,
      "min_party_size": 345,
      "name": "25€ Gutschein",
      "price": "20.00",
      "public_page_url": "https://app.resmio.com/t/yh",
      "resource_uri": "/v1/facility/the-fish/tickets/1241",
      "status": "active",
      "tickets_claimed": 0,
      "tickets_sold": 0,
      "type": "coupon",
      "updated": "2018-09-24T10:04:09Z"
    },
    {
      "amount_paid": 0,
      "available": 10,
      "begins": "2018-09-29T22:00:00Z",
      "capacity": 10,
      "conditions": "<br>",
      "created": "2016-01-14T10:44:59Z",
      "currency": "EUR",
      "description": "<p><span style=\"line-height: 18.5714px;\">Erwerben Sie hier einen Gutschein zum Beispiel für ein schönes Abendessen bei uns.&nbsp;</span></p><p><span style=\"line-height: 18.5714px;\">Ganz egal, ob für ein gemütliches Abendessen oder unser beliebtes Frühstücksbuffet/ Brunch, w</span><span style=\"line-height: 18.5714px;\">ir freuen uns auf Ihren Besuch.&nbsp;</span></p><p><span style=\"line-height: 18.5714px;\">Der Gutschein kann wie Bargeld eingelöst werden.</span></p><p><br></p>",
      "duration": null,
      "ends": "2018-10-28T22:59:59Z",
      "facility": "/v1/facility/the-fish",
      "id": 1242,
      "image": "https://resmio-static-files.s3.amazonaws.com/media/ticket/0hbp3f6mywu7mdq3.jpg",
      "is_active": true,
      "max_party_size": 3454,
      "max_purchases": 10,
      "min_party_size": 345345,
      "name": "50€ Gutschein",
      "price": "50.00",
      "public_page_url": "https://app.resmio.com/t/yi",
      "resource_uri": "/v1/facility/the-fish/tickets/1242",
      "status": "active",
      "tickets_claimed": 0,
      "tickets_sold": 0,
      "type": "coupon",
      "updated": "2018-09-24T10:02:56Z"
    },
    {
      "amount_paid": 0,
      "available": 10,
      "begins": "2018-09-10T22:00:00Z",
      "capacity": 10,
      "conditions": "<p>Test</p>",
      "created": "2017-02-09T12:59:36Z",
      "currency": "EUR",
      "description": "<p>test&nbsp;</p>",
      "duration": null,
      "ends": "2018-09-19T21:59:59Z",
      "facility": "/v1/facility/the-fish",
      "id": 2051,
      "image": "https://resmio-static-files.s3.amazonaws.com/media/ticket/qk5e3q5zsnnakhzg.jpg",
      "is_active": true,
      "max_party_size": null,
      "max_purchases": null,
      "min_party_size": null,
      "name": "Geburtstagsgutschein",
      "price": "20.00",
      "public_page_url": "https://app.resmio.com/t/1kz",
      "resource_uri": "/v1/facility/the-fish/tickets/2051",
      "status": "active",
      "tickets_claimed": 0,
      "tickets_sold": 0,
      "type": "coupon",
      "updated": "2018-09-24T10:03:28Z"
    },
    {
     "amount_paid": 0,
     "available": 10,
     "begins": "2016-01-22T16:00:00Z",
     "capacity": 10,
     "conditions": "sdfsdg",
     "created": "2016-01-14T15:11:48Z",
     "currency": "EUR",
     "description": "asfaf",
     "duration": null,
     "ends": null,
     "facility": "/v1/facility/the-fish",
     "id": 1254,
     "image": null,
     "is_active": false,
     "max_party_size": null,
     "max_purchases": null,
     "min_party_size": null,
     "name": "asfasfsdfg",
     "price": "0.00",
     "public_page_url": "https://app.resmio.com/t/yu",
     "resource_uri": "/v1/facility/the-fish/tickets/1254",
     "status": "active",
     "tickets_claimed": 0,
     "tickets_sold": 0,
     "type": "event",
     "updated": "2016-01-14T15:12:33Z"
    }
  ]
}

Type

any

Create Ticket

POST: /facility/{facility_id}/tickets

Creates a new ticket for a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

201

Create Ticket

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/tickets" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
  "amount_paid": 0,
  "begins": "2019-10-08T11:19:02Z",
  "capacity": 72,
  "conditions": "Something",
  "currency": "EUR",
  "description": "Some description",
  "duration": null,
  "ends": "2020-10-08T11:19:02Z",
  "image": null,
  "is_active": false,
  "max_party_size": null,
  "max_purchases": null,
  "min_party_size": null,
  "name": "Some name",
  "price": "0.00",
  "status": "active",
  "tickets_claimed": 0,
  "tickets_sold": 0,
  "type": "coupon"
}

Type

any

RESPONSE BODY

201

{
  "amount_paid": 0,
  "available": 72,
  "begins": "2019-10-08T11:19:02Z",
  "capacity": 72,
  "conditions": "Something",
  "created": "2019-10-30T05:14:03Z",
  "currency": "EUR",
  "description": "Some description",
  "duration": null,
  "ends": "2020-10-08T11:19:02Z",
  "facility": "/v1/facility/the-fish",
  "id": 11,
  "image": null,
  "is_active": false,
  "max_party_size": null,
  "max_purchases": null,
  "min_party_size": null,
  "name": "Some name",
  "price": "0.00",
  "public_page_url": "https://app.resmio.com/t/b",
  "resource_uri": "/v1/facility/the-fish/tickets/11",
  "status": "active",
  "tickets_claimed": 0,
  "tickets_sold": 0,
  "type": "coupon",
  "updated": "2019-10-30T05:14:03Z"
}

Type

any

Update Ticket (partially)

PATCH: /facility/{facility_id}/tickets/{tickets_id}

Partial update of a ticket (specified by ticket_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

tickets_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

202

Update Ticket (partially)

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/tickets/{tickets_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
  "is_active": false,
}

Type

any

RESPONSE BODY

202

{
  "amount_paid": 0,
  "available": 72,
  "begins": "2019-10-08T11:19:02Z",
  "capacity": 72,
  "conditions": "Explicabo veniam soluta non suscipit fugiat voluptatum dolorum. Aliquam nam mollitia vel hic quibusdam nobis. Dolore quisquam nisi repudiandae.",
  "created": "2019-10-08T11:19:02Z",
  "currency": "EUR",
  "description": "Ab consequuntur ullam quo laborum consequuntur. Dolorem laboriosam natus ex neque labore eos ea. Fuga quaerat ea consectetur quibusdam reprehenderit cum ex.",
  "duration": null,
  "ends": "2020-10-08T11:19:02Z",
  "facility": "/v1/facility/the-fish",
  "id": 1,
  "image": null,
  "is_active": false,
  "max_party_size": null,
  "max_purchases": null,
  "min_party_size": null,
  "name": "Multi-lateral local monitoring",
  "price": "0.00",
  "public_page_url": "https://app.resmio.com/t/1",
  "resource_uri": "/v1/facility/the-fish/tickets/1",
  "status": "active",
  "tickets_claimed": 0,
  "tickets_sold": 0,
  "type": "coupon",
  "updated": "2019-10-30T04:19:53Z"
}

Type

any

Read Purchases of a Ticket

GET: /facility/{facility_id}/tickets/{tickets_id}/purchases

Get purchases of a ticket (excluded unconfirmed purchases) for a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

tickets_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Purchases of a Ticket

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/tickets/{tickets_id}/purchases?offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "meta": {
    "limit": 80,
    "next": null,
    "offset": 20,
    "previous": null,
    "total_count": 1
  },
  "objects": [
    {
      "address1": "",
      "address2": "",
      "city": "",
      "comment": "",
      "country": "",
      "created": "2019-10-31T02:52:49Z",
      "email": "email@m.com",
      "id": 2,
      "name": "name",
      "notes": "",
      "num": 1,
      "payment": null,
      "phone": "",
      "ref_num": "3xnat6",
      "resource_uri": "",
      "source": "",
      "status": "confirmed",
      "ticket": "/v1/facility/the-fish/tickets/1",
      "zip_code": ""
    }
  ]
}

Type

any

Create Purchase of a Ticket

POST: /facility/{facility_id}/tickets/{tickets_id}/purchases

Creates a new purchase of a ticket for a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

tickets_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

201

Create Purchase of a Ticket

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/tickets/{tickets_id}/purchases" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
  "name": "name",
  "email": "email@m.com",
  "status": "confirmed"
}

Type

any

RESPONSE BODY

201

{
  "address1": "",
  "address2": "",
  "city": "",
  "comment": "",
  "country": "",
  "created": "2019-10-31T02:52:49Z",
  "email": "email@m.com",
  "id": 2,
  "name": "name",
  "notes": "",
  "num": 1,
  "payment": null,
  "phone": "",
  "ref_num": "3xnat6",
  "resource_uri": "",
  "source": "",
  "status": "confirmed",
  "ticket": "/v1/facility/the-fish/tickets/1",
  "zip_code": ""
}

Type

any

Update Purchase of a Ticket (partially)

PATCH: /facility/{facility_id}/tickets/{tickets_id}/purchases/{purchase_id}

Partial update of a purchase (specified by purchase_id) of a ticket (specified by ticket_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

tickets_id

Property	Value
required	true
type	string

purchase_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

202

Update Purchase of a Ticket (partially)

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/tickets/{tickets_id}/purchases/{purchase_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
  "status": "cancelled"
}

Type

any

RESPONSE BODY

202

{
  "address1": "",
  "address2": "",
  "city": "",
  "comment": "",
  "country": "",
  "created": "2019-10-31T02:52:49Z",
  "email": "email@m.com",
  "id": 2,
  "name": "name",
  "notes": "",
  "num": 1,
  "payment": null,
  "phone": "",
  "ref_num": "3xnat6",
  "resource_uri": "",
  "source": "",
  "status": "cancelled",
  "ticket": "/v1/facility/the-fish/tickets/1",
  "zip_code": ""
}

Type

any

Read User Aliases

GET: /facility/{facility_id}/user_aliases

Get all the aliases of users that have access rights to the facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read User Aliases

CURL EXAMPLE

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

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "meta": {
    "limit": 200,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": 1
  },
  "objects": [
    {
      "facility": "/v1/facility/the-fish",
      "id": 1,
      "name": "Max Testman",
      "resource_uri": "/v1/facility/the-fish/user_aliases/1",
      "user": "/v1/facility/the-fish/facility_users/1"
    }
  ]
}

Type

any

Read Opening Hours

GET: /facility/{facility_id}/visualopeninghours

Lists all opening hours of a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Opening Hours

CURL EXAMPLE

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

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "meta": {
    "limit": 80,
    "next": null,
    "offset": 20,
    "previous": null,
    "total_count": 2
  },
  "objects": [
    {
      "begins": "09:00",
      "end_of_acceptance": null,
      "ends": "22:00",
      "facility": "/v1/facility/the-fish",
      "id": 1,
      "resource_uri": "/v1/facility/the-fish/visualopeninghours/1",
      "weekdays": [
        0,
        1,
        2,
        3,
      ]
    },
    {
      "begins": "09:00",
      "end_of_acceptance": null,
      "ends": "23:00",
      "facility": "/v1/facility/the-fish",
      "id": 3,
      "resource_uri": "/v1/facility/the-fish/visualopeninghours/3",
      "weekdays": [
        4,
        5,
        6
      ]
    }
  ]
}

Type

any

Create Opening Hours

POST: /facility/{facility_id}/visualopeninghours

Creates a new opening hour for a facility.

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

201

Create Opening Hours

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/visualopeninghours" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
  "begins": "08:00",
  "ends": "23:00",
  "weekdays": [
    0, 5
  ]
}

Type

any

RESPONSE BODY

201

{
  "begins": "08:00",
  "end_of_acceptance": null,
  "ends": "23:00",
  "facility": "/v1/facility/the-fish",
  "id": 1876,
  "resource_uri": "/v1/facility/the-fish/visualopeninghours/1876",
  "weekdays": [
    0,
    5
  ]
}

Type

any

Update Opening Hours

PATCH: /facility/{facility_id}/visualopeninghours/{openinghour_id}

Partial update of a opening hour (specified by openinghour_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

openinghour_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

202

Update Opening Hours

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/visualopeninghours/{openinghour_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
  "weekdays": [
    0, 1, 2
  ]
}

Type

any

RESPONSE BODY

202

{
  "begins": "08:00",
  "end_of_acceptance": null,
  "ends": "23:00",
  "facility": "/v1/facility/the-fish",
  "id": 1876,
  "resource_uri": "/v1/facility/the-fish/visualopeninghours/1876",
  "weekdays": [
    0,
    1,
    2
  ]
}

Type

any

Read Waitlist Entries

GET: /facility/{facility_id}/waitlist

Get all the waitlist entries of one facility specified by facility_id usually for a day

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

begins__lt

Specify that the "date" for the waitlist entry should be "less than" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2020-07-01T22:00:00.000Z`

ends__gte

Specify that the "date" for the waitlist entry should be "greater than or equal" to the specified datetime filter.

Property	Value
required	false
type	datetime
examples	`2020-07-02T22:00:00.000Z`

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Waitlist Entries

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/waitlist?begins__lt=2020-07-01T22:00:00.000Z&ends__gte=2020-07-02T22:00:00.000Z&offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
    "meta": {
        "limit": 1000,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [{
            "created": "2020-07-02T14:49:00Z",
            "date": "2020-07-02T14:47:00Z",
            "email": "john.doe@example.com",
            "facility": "/v1/facility/the-fish",
            "id": 1,
            "is_walkin": true,
            "name": "John Doe",
            "num": 3,
            "phone": "+4916000000000",
            "resource_uri": "/v1/facility/the-fish/waitlist/1"
        }
    ]
}

Type

any

Create Waitlist Entry

POST: /facility/{facility_id}/waitlist

Creates a new entry on the waitlist

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

201

Create Waitlist Entry

CURL EXAMPLE

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

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
    "is_walkin": true,
    "date": "2020-07-02T14:47:00Z",
    "name": "John Doe",
    "phone": "+4916000000000",
    "email": "john.doe@example.com",
    "num": "3"
}

Type

any

RESPONSE BODY

201

{
    "created": "2020-07-02T14:49:00Z",
    "date": "2020-07-02T14:47:00Z",
    "email": "john.doe@example.com",
    "facility": "/v1/facility/the-fish",
    "id": 1,
    "is_walkin": true,
    "name": "John Doe",
    "num": 3,
    "phone": "+4916000000000",
    "resource_uri": "/v1/facility/the-fish/waitlist/1"
}

Type

any

Delete Waitlist Entry

DELETE: /facility/{facility_id}/waitlist/{waitlist_id}

Deletes a waitlist entry (specified by waitlist_id) of one facility specified by facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

waitlist_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

204

Delete Waitlist Entry

CURL EXAMPLE

curl -X DELETE "https://api.resmio.com/v1/facility/{facility_id}/waitlist/{waitlist_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

Updates Waitlist Entry

PATCH: /facility/{facility_id}/waitlist/{waitlist_id}

Partial update of a waitlist entry (specified by waitlist_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

waitlist_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

202

Updates Waitlist Entry

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/waitlist/{waitlist_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
    "id": 2,
    "date": "2020-07-02T15:04:00Z",
    "name": "John Doe",
    "phone": "+4916000000000",
    "email": "2john.doe@example.com",
    "num": 3
}

Type

any

RESPONSE BODY

202

{
    "created": "2020-07-02T15:04:40Z",
    "date": "2020-07-02T15:04:00Z",
    "email": "2john.doe@example.com",
    "facility": "/v1/facility/the-fish",
    "id": 2,
    "is_walkin": true,
    "name": "John Doe",
    "num": 3,
    "phone": "+4916000000000",
    "resource_uri": "/v1/facility/the-fish/waitlist/2"
}

Type

any

Read Webhooks

GET: /facility/{facility_id}/webhooks

Get all configured webhooks of one facility specified by its facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

offset

Skip over a number of elements by specifying an offset value for the query

Property	Value
required	false
type	integer
examples	`20`

limit

Limit the number of elements on the response

Property	Value
required	false
type	integer
examples	`80`

Possible Responses

200

Read Webhooks

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/facility/{facility_id}/webhooks?offset=20&limit=80" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
    "meta": {
        "limit": 1000,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": null
    },
    "objects": [
        {
            "actions": ["BOOKING_CREATED", "BOOKING_UPDATED", "BOOKING_DELETED"],
            "facility": "/v1/facility/the-fish",
            "id": 1,
            "pw": "*********",
            "resource_uri": "/v1/facility/the-fish/webhooks/1",
            "url": "https://example.com/some-api-endpoint",
            "username": "aUsername"
        }
    ]
}

Type

any

Create Webhook

POST: /facility/{facility_id}/webhooks

Creates a new webhook for certain actions

URI Parameters

facility_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

201

Create Webhook

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/facility/{facility_id}/webhooks" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "url": "https://example.com/some-api-endpoint",
    "actions": ["BOOKING_CREATED", "BOOKING_UPDATED", "BOOKING_DELETED"],
    "username": "aUsername",
    "password": "aPassword"
}

Type

any

RESPONSE BODY

201

{
    "actions": ["BOOKING_CREATED", "BOOKING_UPDATED", "BOOKING_DELETED"],
    "facility": "/v1/facility/the-fish",
    "id": 1,
    "pw": "*********",
    "resource_uri": "/v1/facility/the-fish/webhooks/1",
    "url": "https://example.com/some-api-endpoint",
    "username": "aUsername"
}

Type

any

Delete Webhook

DELETE: /facility/{facility_id}/webhooks/{webhook_id}

Deletes a webhook (specified by its webhook_id) of one facility specified by its facility_id

URI Parameters

facility_id

Property	Value
required	true
type	string

webhook_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

204

Delete Webhook

CURL EXAMPLE

curl -X DELETE "https://api.resmio.com/v1/facility/{facility_id}/webhooks/{webhook_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

Update Webhook

PATCH: /facility/{facility_id}/webhooks/{webhook_id}

Update of a webhook (specified by webhook_id) of a facility (specified by facility_id).

URI Parameters

facility_id

Property	Value
required	true
type	string

webhook_id

Property	Value
required	true
type	string

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Possible Responses

202

Update Webhook

CURL EXAMPLE

curl -X PATCH "https://api.resmio.com/v1/facility/{facility_id}/webhooks/{webhook_id}" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

REQUEST BODY

{
    "id": 1,
    "url": "https://example.com/some-api-endpoint2",
    "actions": ["BOOKING_CREATED", "BOOKING_UPDATED", "BOOKING_DELETED"],
    "username": "aUsername"
}

Type

any

RESPONSE BODY

202

{
    "actions": ["BOOKING_CREATED", "BOOKING_UPDATED", "BOOKING_DELETED"],
    "facility": "/v1/facility/the-fish",
    "id": 1,
    "pw": "*********",
    "resource_uri": "/v1/facility/the-fish/webhooks/1",
    "url": "https://example.com/some-api-endpoint2",
    "username": "aUsername"
}

Type

any

User API

Read Userinfo

GET: /users/me

Get data about the currently logged in user and the associated facilities.

WARNING: The facilities array currently provides additional data. Please only rely on the “resource_uri” and "id" fields. The additional fields are pending removal.

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

200

Read Userinfo

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/users/me" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

RESPONSE BODY

200

{
  "api_key": {
    "key": "5a6394b9f8e68164998754bb25ddbe71ec9b6fd6",
    "resource_uri": ""
  },
  "date_joined": "2019-09-05T13:07:16Z",
  "email": "something@example.com",
  "facilities": [
    {
      "city": "Port Michael",
      "country": "GR",
      "email": "the-fish@example.com",
      "features": {
        "addons_purchasable": true,
        "admin_name": "Premium",
        "adwords_enabled": false,
        "api_key_enabled": true,
        "booking_deposit_enabled": false,
        "booking_export_enabled": true,
        "booking_filter_enabled": true,
        "booking_note_enabled": true,
        "booking_receipt_custom_text_enabled": true,
        "booking_reminders_enabled": true,
        "booking_tags_enabled": true,
        "closed_days_widget_text_enabled": true,
        "custom_prints_enabled": true,
        "customers_enabled": true,
        "default_addons": [
          "tickets",
          "free_resmio_website",
          "small_distribution_network",
          "free_partner_integration"
        ],
        "detailed_booking_notification_email_enabled": true,
        "discounts_enabled": true,
        "distribution_network_enabled": true,
        "feedback_enabled": true,
        "gastrofix_enabled": true,
        "google_reviews_enabled": false,
        "graphical_table_plan_enabled": false,
        "hide_gastrofix": false,
        "hide_invoices": false,
        "hide_payment_details": false,
        "hide_prices": false,
        "hide_recommend_resmio": false,
        "hide_tickets": false,
        "id": "premium",
        "individual_widget_text_enabled": true,
        "invoicing_name": "resmio Premium Software",
        "marketing_enabled": false,
        "monthly_fee": "49.90",
        "name": "Premium",
        "newsletter_enabled": false,
        "notification_emails_enabled": true,
        "pages_enabled": true,
        "paied_tariff": true,
        "partner_cover": "0.00",
        "partner_network_enabled": false,
        "past_booking_overview_enabled": true,
        "payment_transactions_enabled": true,
        "plan_screen_name": "Premium",
        "recurrent_booking_enabled": true,
        "report_enabled": true,
        "reputation_widget_enabled": false,
        "resmiotables_enabled": false,
        "retention_period_switch_enabled": true,
        "shift_schedule_enabled": false,
        "slow_hours_enabled": true,
        "sms_guest_enabled": false,
        "sms_guest_reminder_enabled": false,
        "sms_waiter_enabled": false,
        "sms_waiter_max_waiters": 0,
        "standard_cover": "0.00",
        "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
      },
      "id": "the-fish",
      "name": "Daniels Inc",
      "phone": "",
      "resource_uri": "/v1/facility/the-fish",
      "short_description": "",
      "street": "Dennis Passage",
      "user_permission_groups": [
        "owner"
      ],
      "user_permissions": [
        "view_facility",
        "view_booking",
        "view_monthlysubscription",
        "view_subscriptionaddon",
        "change_booking",
        "delete_booking",
        "view_bookingfile",
        "change_bookingfile",
        "delete_bookingfile",
        "view_bookingtag",
        "change_bookingtag",
        "delete_bookingtag",
        "view_facilityresource",
        "view_facilityresourcegroup",
        "view_facilityresourcegroupdecoration",
        "change_facilityresourcegroupdecoration",
        "delete_facilityresourcegroupdecoration",
        "view_facilityresourcecombination",
        "view_activity",
        "view_facilityresourceoverride",
        "change_facilityresourceoverride",
        "delete_facilityresourceoverride",
        "view_openinghouroverride",
        "change_openinghouroverride",
        "delete_openinghouroverride",
        "view_note",
        "change_note",
        "delete_note",
        "view_employee",
        "view_employeeposition",
        "view_shiftschedule",
        "view_areagroup",
        "view_customer",
        "change_customer",
        "delete_customer",
        "view_customertag",
        "change_customertag",
        "delete_customertag",
        "view_customerfile",
        "change_customerfile",
        "delete_customerfile",
        "view_alias",
        "add_alias",
        "change_alias",
        "delete_alias",
        "change_facility",
        "view_facilityimage",
        "change_facilityimage",
        "delete_facilityimage",
        "view_feedback",
        "change_feedback",
        "delete_feedback",
        "view_facilitystatistic",
        "view_emailcampaign",
        "change_emailcampaign",
        "delete_emailcampaign",
        "view_ticket",
        "change_ticket",
        "delete_ticket",
        "view_ticketpurchase",
        "change_ticketpurchase",
        "delete_ticketpurchase",
        "change_employee",
        "delete_employee",
        "change_employeeposition",
        "delete_employeeposition",
        "change_areagroup",
        "delete_areagroup",
        "change_shiftschedule",
        "delete_shiftschedule",
        "view_notificationrecipient",
        "change_notificationrecipient",
        "delete_notificationrecipient",
        "view_openinghour",
        "change_openinghour",
        "delete_openinghour",
        "view_visualopeninghour",
        "change_visualopeninghour",
        "delete_visualopeninghour",
        "view_slowhour",
        "change_slowhour",
        "delete_slowhour",
        "change_facilityresource",
        "delete_facilityresource",
        "change_facilityresourcegroup",
        "delete_facilityresourcegroup",
        "change_facilityresourcecombination",
        "delete_facilityresourcecombination",
        "view_multibooking",
        "change_multibooking",
        "delete_multibooking",
        "view_deposithour",
        "change_deposithour",
        "delete_deposithour",
        "view_bookingdeposit",
        "change_bookingdeposit",
        "delete_bookingdeposit",
        "view_facilityintegrationcredentials",
        "change_facilityintegrationcredentials",
        "delete_facilityintegrationcredentials",
        "view_paymenttransaction",
        "view_innerpaymenttransaction",
        "view_facilitygroup",
        "view_user",
        "change_user",
        "delete_user",
        "add_subscriptionaddon",
        "change_subscriptionaddon"
      ],
      "website": "",
      "zip_code": "81417"
    },
    {
      "city": "Testcity",
      "country": "DE",
      "email": "something@example.com",
      "features": {
        "addons_purchasable": true,
        "admin_name": "Basic Soft Limit",
        "adwords_enabled": false,
        "api_key_enabled": false,
        "booking_deposit_enabled": false,
        "booking_export_enabled": false,
        "booking_filter_enabled": false,
        "booking_note_enabled": false,
        "booking_receipt_custom_text_enabled": false,
        "booking_reminders_enabled": false,
        "booking_tags_enabled": false,
        "closed_days_widget_text_enabled": false,
        "custom_prints_enabled": false,
        "customers_enabled": false,
        "default_addons": [
          "tickets",
          "free_resmio_website",
          "small_distribution_network"
        ],
        "detailed_booking_notification_email_enabled": false,
        "discounts_enabled": false,
        "distribution_network_enabled": true,
        "feedback_enabled": false,
        "gastrofix_enabled": false,
        "google_reviews_enabled": false,
        "graphical_table_plan_enabled": false,
        "hide_gastrofix": false,
        "hide_invoices": false,
        "hide_payment_details": false,
        "hide_prices": false,
        "hide_recommend_resmio": false,
        "hide_tickets": false,
        "id": "2018-01-free-softlimit",
        "individual_widget_text_enabled": false,
        "invoicing_name": "resmio Basic Soft Limit Software",
        "marketing_enabled": false,
        "monthly_fee": "0.00",
        "name": "Basic",
        "newsletter_enabled": false,
        "notification_emails_enabled": false,
        "pages_enabled": true,
        "paied_tariff": false,
        "partner_cover": "0.00",
        "partner_network_enabled": false,
        "past_booking_overview_enabled": false,
        "payment_transactions_enabled": false,
        "plan_screen_name": "Basic",
        "recurrent_booking_enabled": false,
        "report_enabled": false,
        "reputation_widget_enabled": false,
        "resmiotables_enabled": false,
        "retention_period_switch_enabled": true,
        "shift_schedule_enabled": false,
        "slow_hours_enabled": false,
        "sms_guest_enabled": false,
        "sms_guest_reminder_enabled": false,
        "sms_limit": 0,
        "sms_waiter_enabled": false,
        "sms_waiter_max_waiters": 0,
        "standard_cover": "0.00",
        "tableplan_enabled": false,
        "test_tariff": false,
        "ticket_fee": "0.06",
        "ticketing_enabled": true,
        "upgradable": true,
        "user_rights_management_enabled": false,
        "vectron_enabled": false,
        "weight": 1
      },
      "id": "new-test-restaurant",
      "name": "New Test Restaurant",
      "phone": "016097237000",
      "resource_uri": "/v1/facility/new-test-restaurant",
      "short_description": "",
      "street": "Teststreet 123",
      "user_permission_groups": [
        "owner"
      ],
      "user_permissions": [
        "view_facility",
        "view_booking",
        "view_monthlysubscription",
        "view_subscriptionaddon",
        "change_booking",
        "delete_booking",
        "view_bookingfile",
        "change_bookingfile",
        "delete_bookingfile",
        "view_bookingtag",
        "change_bookingtag",
        "delete_bookingtag",
        "view_facilityresource",
        "view_facilityresourcegroup",
        "view_facilityresourcegroupdecoration",
        "change_facilityresourcegroupdecoration",
        "delete_facilityresourcegroupdecoration",
        "view_facilityresourcecombination",
        "view_activity",
        "view_facilityresourceoverride",
        "change_facilityresourceoverride",
        "delete_facilityresourceoverride",
        "view_openinghouroverride",
        "change_openinghouroverride",
        "delete_openinghouroverride",
        "view_note",
        "change_note",
        "delete_note",
        "view_employee",
        "view_employeeposition",
        "view_shiftschedule",
        "view_areagroup",
        "view_customer",
        "change_customer",
        "delete_customer",
        "view_customertag",
        "change_customertag",
        "delete_customertag",
        "view_customerfile",
        "change_customerfile",
        "delete_customerfile",
        "view_alias",
        "add_alias",
        "change_alias",
        "delete_alias",
        "change_facility",
        "view_facilityimage",
        "change_facilityimage",
        "delete_facilityimage",
        "view_feedback",
        "change_feedback",
        "delete_feedback",
        "view_facilitystatistic",
        "view_emailcampaign",
        "change_emailcampaign",
        "delete_emailcampaign",
        "view_ticket",
        "change_ticket",
        "delete_ticket",
        "view_ticketpurchase",
        "change_ticketpurchase",
        "delete_ticketpurchase",
        "change_employee",
        "delete_employee",
        "change_employeeposition",
        "delete_employeeposition",
        "change_areagroup",
        "delete_areagroup",
        "change_shiftschedule",
        "delete_shiftschedule",
        "view_notificationrecipient",
        "change_notificationrecipient",
        "delete_notificationrecipient",
        "view_openinghour",
        "change_openinghour",
        "delete_openinghour",
        "view_visualopeninghour",
        "change_visualopeninghour",
        "delete_visualopeninghour",
        "view_slowhour",
        "change_slowhour",
        "delete_slowhour",
        "change_facilityresource",
        "delete_facilityresource",
        "change_facilityresourcegroup",
        "delete_facilityresourcegroup",
        "change_facilityresourcecombination",
        "delete_facilityresourcecombination",
        "view_multibooking",
        "change_multibooking",
        "delete_multibooking",
        "view_deposithour",
        "change_deposithour",
        "delete_deposithour",
        "view_bookingdeposit",
        "change_bookingdeposit",
        "delete_bookingdeposit",
        "view_facilityintegrationcredentials",
        "change_facilityintegrationcredentials",
        "delete_facilityintegrationcredentials",
        "view_paymenttransaction",
        "view_innerpaymenttransaction",
        "view_facilitygroup",
        "view_user",
        "change_user",
        "delete_user",
        "add_subscriptionaddon",
        "change_subscriptionaddon"
      ],
      "website": "",
      "zip_code": "12345"
    }
  ],
  "first_name": "Erik",
  "id": 1,
  "is_staff": true,
  "is_superuser": true,
  "last_name": "",
  "resource_uri": "/v1/users/1",
  "username": "something@example.com"
}

Type

any

POST: /login_url

This endpoint allows you to create a "login url" that will allow you to deeplink into app.resmio.com and bypass authentication. The 'redirect_url' is optional.

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Content-Type

The content type of the request. The API currently only understands application/json

Property	Value
required	true
type	string
examples	`application/json`

Possible Responses

201

CURL EXAMPLE

curl -X POST "https://api.resmio.com/v1/login_url" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6" \
	-H "Content-Type: application/json" \
	-d @request_body

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6
Content-Type: application/json

REQUEST BODY

{
    "redirect_url": "https://app.resmio.com/the-fish/bookings/edit/18"
}

Type

any

RESPONSE BODY

201

{
    "created": "2020-06-03T11:44:01Z",
    "id": "ee4ddaaf-c7ff-484b-b47b-dfc4c9dcc03e",
    "login_url": "https://app.resmio.com/login_url?auth_secret=ee4ddaaf-c7ff-484b-b47b-dfc4c9dcc03e&redirect_url=https%3A%2F%2Fapp.resmio.com%2Fthe-fish%2Fbookings%2Fedit%2F18",
    "updated": "2020-06-03T11:44:01Z",
    "valid_till": "2020-06-03T11:45:01Z"
}

Type

any

Api V2

Bookings by Statuses (v2 api)

GET: /v2/facility/stats/bookings_by_statuses

Group bookings by their respective statuses

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

date_gte

From date (gte)

Property	Value
required	true
type	datetime string (ISO 8601)
examples	`2024-01-25T23:59:00Z`

date_lte

To date (lte)

Property	Value
required	true
type	datetime string (ISO 8601)
examples	`2024-01-26T23:59:00Z`

date_booking

Date of the booking

Property	Value
required	false
type	datetime string (ISO 8601)
examples	`2024-01-26T20:00:00Z`

name

Customer name

Property	Value
required	false
type	str
examples	`John Doe`

room

Room title

Property	Value
required	false
type	str
examples	`room-1`

note

With or without note

Property	Value
required	false
type	boolean
examples	`true`

Possible Responses

200

Bookings by Statuses (v2 api)

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/v2/facility/stats/bookings_by_statuses?date_gte=2024-01-25T23:59:00Z&date_lte=2024-01-26T23:59:00Z&date_booking=2024-01-26T20:00:00Z&name=John Doe&room=room-1&note=true" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
  "data": [
    {
      "status_type": "confirmed",
      "count": 1
    },
    {
      "status_type": "seated",
      "count": 0
    },
    {
      "status_type": "arrived",
      "count": 0
    },
    {
      "status_type": "noshow",
      "count": 0
    },
    {
      "status_type": "finished",
      "count": 0
    },
    {
      "status_type": "unconfirmed",
      "count": 0
    },
    {
      "status_type": "cancelled",
      "count": 0
    }
  ],
  "status": "success"
}

Type

any

Booking IDs by Statuses (v2 api)

GET: /v2/facility/stats/booking_ids_by_statuses

Get booking IDs grouped by their booking status.

Header Parameters

Api-Key

The API key of a user. The information can be found here https://app.resmio.com/ under Settings -> Integration -> Resmio Api Details.

Property	Value
required	true
type	string
examples	`5a6394b9f8e68164998754bb25ddbe71ec9b6fd6`

Query Parameters

date_gte

From date

Property	Value
required	true
type	string
examples	`2024-01-20T23:59:00Z`

date_lte

To date

Property	Value
required	true
type	string
examples	`2024-01-21T23:59:00Z`

Possible Responses

200

Booking IDs by Statuses (v2 api)

CURL EXAMPLE

curl -X GET "https://api.resmio.com/v1/v2/facility/stats/booking_ids_by_statuses?date_gte=2024-01-20T23:59:00Z&date_lte=2024-01-21T23:59:00Z" \
	-H "Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6"

REQUEST HEADERS

Api-Key: 5a6394b9f8e68164998754bb25ddbe71ec9b6fd6

RESPONSE BODY

200

{
  "data": {
    "unconfirmed": [],
    "confirmed": [50, 51, 52],
    "arrived": [24, 60],
    "seated": [101],
    "finished": [],
    "cancelled": [],
    "noshow": []
  },
  "status": "success"
}

Type

any