Passive POS Integration Module

Introduction

The purpose of this integration is to build an integration module to link a restaurant POS app setup with a restaurant in Sinqro.

Target Developers

  • Internal developers from a POS software company
  • Developers from a restaurant chain or group having their own POS solution

Your company benefits

  • Your clients (restaurants and food shops using your software), will be able to manage their own web/mobile apps and external marketplaces orders/reservations, delivery services and many other Sinqro connected solutions, directly FROM YOUR POS.
  • You won’t have to integrate dozens of marketplaces or providers one by one. With one integration, your POS is connected to multiple external services.
  • Your software will be listed in our site as Sinqro-ready POS and this will accelerate your sales.

Sinqro benefits

  • Your clients will become Sinqro potential clients.
  • We can provide our current and incoming clients the possibility to work with a dedicated POS solution.

Passive integration

This guide is ONLY for passive integrations, understood as integrations in which Sinqro will consume your API services and listen your webhooks.

If you don't have your own API and webhook notifications and you are not planning to develop them, please go to POS active integration docs.

Integration level

In Sinqro we have different integration module types.
For a POS integration module, we have different module features in order to help the restaurant to understand the benefits of contracting the module and also, the benefits of using one POS software over others.

Main module features we show to restaurants:

  • Receive the order / reservation in your POS
  • Accept the order / reservation through your POS
  • Cancel the order / reservation through your POS
  • Update the order / reservation status through your POS
  • Get any order / reservation status update in your POS
  • Send products and menus to Sinqro through your POS
  • Close your restaurant temp. in Sinqro through your POS
  • Update your operating schedules through your POS

All features are optional and defined by the limits of the company developing the integration and the company providing API or services webhook.
As this guide is for passive integrations, your API and webhooks notifications will define the features of your POS module, because Sinqro will always integrate as many features as your platform allows.

Integration requirements

For a full integration, we would need all these API services and webhooks, but as explained before, we'll adapt the integration to what you already have working or you have decided to implement for us:

API SERVICES
  • POST Order / Reservation
    Service/s to inject to your POS an order or reservation we got from online channels
  • GET Order / Reservation
    Service/s to get an order or reservation information of a previously created order
  • GET Order / Reservation Status
    Service/s to get an order or reservation status of a previously created order
  • POST/PATCH Order / Reservation Status
    Service/s to change the status of a previously created order
  • GET Menus, menu sections, products, product variants, product option categories and product options
    Service/s to get a single entity or a collection of the entities defining the "online catalog" of the restaurant that must be loaded to Sinqro (and then sent to apps and marketplaces)
WEBHOOK NOTIFICATIONS

The webhook notifications are POST/PUT requests thrown by your system to a specific endpoint we provide.

  • Order / reservation status changed WEBHOOK
    Notification you send if an order or reservation status has changed
  • Product related element changed WEBHOOK
    Notification you send if a menu, menu section, product, productVariant, productOptionCategory or productOption has changed
  • Availability changed WEBHOOK
    Notification you send if the restaurant switched-off its online availability

We will provide two endpoints to receive your notifications. Example:
SANDBOX: https://sandbox-integrations.sinqro.com/{your-pos-code}/webhooks/{any-other-data}
PRODUCTION: https://integrations.sinqro.com/{your-pos-code}/webhooks/{any-other-data}

OTHER REQUIREMENTS
  • API and webhooks docs
    Document or whatever you normally use you document your API for third-party developers
  • Restaurant test account
    An account to test and ideally access your POS as the restaurant user normally does
  • Sandbox (test) and production environments credentials
    API keys or equivalent for production environment, and ideally, for sandbox/test environments

Data model

As this integration is passive, we adapt our data to your data model (to consume API services and understand the webhooks).

Despite this, in some cases we are asked to help you (developers) providing examples of what Sinqro understand as order, reservation, menu, menu section, product, productVariant, productOptionCategory or productOption, because maybe, you'd like to improve one of your existing services or create new ones.

In order to show you examples of these entities, and only for this purpose, we invite you to check the POS active integration docs.

Integration request

If you already have your API and webhooks docs and you want Sinqro to develop the integration module, please send us an email to integrations@sinqro.com

Integration validation

We’ll provide a document explaining which features have been integrated and which ones were not integrated and the reasons, and of course, we’ll attend any validation session if it’s considered in your workflow.

Guide & Examples

We show you some relevant use cases.

Managing new orders and reservations

New order / reservation workflow (passive integration)

Expected interactions for new orders and reservations
ACTIONDESCRIPTION
1. Place orderThe client places the order
2. API Post orderThe marketplace posts the order to Sinqro
3. Send order WEBHOOKSinqro sends the new order webhook to Sinqro Integrations server
4. API Post orderSinqro Integrations sends the new order to POS
5. Restaurant notificationThe POS notifies the restaurant
6. Accept or cancel the orderThe restaurant accepts or cancels the order
7. Send new order status WEBHOOKThe POS notifies the order status change to Sinqro Integrations
8. API Post new order statusSinqro Integrations POS posts the order status
9. New status WEBHOOKSinqro sends the new status webhook to the market
10. Client notificationThe marketplace notifies the client