API reference

This reference is built from the OpenAPI specification that also describes the API itself. What is here is there, and the other way round. Field descriptions are in English, as in the specification.

Base URL

https://api.flavoso.com/v1

Authentication

Every request carries Authorization: Bearer <access_token>. How to get a token is explained under Authentication; to try things out, a test token is enough.

Specification

The whole API as OpenAPI 3.1 at https://api.flavoso.com/v1/openapi.json, as a Postman collection at https://api.flavoso.com/v1/postman.json. Both without authentication.

Connection

The connection between your app and one restaurant. GET /me is the first call of every integration: which restaurant, which scopes, test or live (livemode), which plan. DELETE /connection ends the connection from your side.

• get/meRetrieve the connection, its app and its restaurant
• delete/connectionDisconnect your app from the restaurant

Orders

Read, accept, reject, cancel and advance orders, and take them over with your own id. The lifecycle of an order is described under Order flow, taking orders into a till under POS integration.

• get/ordersList orders
• get/orders/{id}Retrieve an order
• post/orders/{id}/acceptAccept an order
• post/orders/{id}/rejectReject an order
• post/orders/{id}/cancelCancel an order
• post/orders/{id}/statusAdvance an order
• post/orders/{id}/acknowledgeAcknowledge an order

Menu

Read the whole menu, sync it in one call with PUT /menu, report sold-out items and create, change and delete categories, products, option groups and options one by one. More under Menu sync.

• get/menuRetrieve the full menu
• put/menuSync the whole menu from your system
• post/menu/availabilityMark many products and options sold out or available
• get/menu/categoriesList categories
• post/menu/categoriesCreate a category
• get/menu/categories/{id}Retrieve a category
• patch/menu/categories/{id}Update a category
• delete/menu/categories/{id}Delete a category
• get/menu/productsList products
• post/menu/productsCreate a product
• get/menu/products/{id}Retrieve a product
• patch/menu/products/{id}Update a product
• delete/menu/products/{id}Delete a product
• get/menu/option-groupsList option groups
• post/menu/option-groupsCreate an option group
• get/menu/option-groups/{id}Retrieve an option group
• patch/menu/option-groups/{id}Update an option group
• delete/menu/option-groups/{id}Delete an option group
• post/menu/option-groups/{id}/optionsAdd an option to an option group
• get/menu/optionsList options
• get/menu/options/{id}Retrieve an option
• patch/menu/options/{id}Update an option
• delete/menu/options/{id}Delete an option

Store

Opening status, opening and delivery hours, special days, lead times, order types and pausing online ordering.

• get/storeRetrieve the store
• patch/storeChange lead times, pre-orders and order types
• get/store/hoursRetrieve opening and delivery hours
• put/store/hoursReplace opening and/or delivery hours
• get/store/closuresList special days
• post/store/closuresCreate or replace a special day
• delete/store/closures/{date}Delete a special day
• post/store/pausePause online ordering
• post/store/resumeResume online ordering

Tables and areas

The restaurant's tables and areas, for example to assign a reservation to a table. Read only, with store:read or reservations:read. The key in a table's QR code is never included.

• get/tablesList tables
• get/areasList areas

Reservations

Read reservations, look up free times, create, change and move reservations through their statuses. Pro plan and up. More under Reservations.

• get/reservationsList reservations
• post/reservationsCreate a reservation
• get/reservations/availabilityFree reservation times of a day
• get/reservations/{id}Retrieve a reservation
• patch/reservations/{id}Change a reservation
• post/reservations/{id}/statusSet a reservation's status

Reports

Sales per day, week or month and sales per dish, by the same rules as the figures in the dashboard. More under Reports.

• get/reports/salesSales report
• get/reports/productsProduct sales report

Events

The same events that webhooks deliver, for you to fetch: for POS systems without a public address and for catching up after an outage. More under Fetching events.

• get/eventsList events
• get/events/{id}Retrieve an event

OAuth

The endpoints of the sign-in: authorization in the browser, token exchange, revocation and metadata. Authorization is a page at https://app.flavoso.com/oauth/authorize, because that is where the owner signs in; token exchange, revocation and metadata live at https://api.flavoso.com, outside /v1. The flow step by step is described under Authentication.

• get/oauth/authorizeAsk an owner to connect your app
• post/oauth/tokenExchange a code or a refresh token for tokens
• post/oauth/revokeRevoke a token
• get/.well-known/oauth-authorization-serverAuthorization server metadata