Faster Order POS API

The POS API is to be used by point of sales (POS) that wants to be able to share inventory with Faster Order and receive notifications on when transactions occur.

Introduction


Integrating a Point of Sale (POS) with Faster Order gives your own offering a boost by being able to offer online sales as well without the need to develop it on your own and maintain it. You decide if you want to offer the connection to Faster Order for free or add an additional fee, you're in full control of this. 

When integrating you need to do following:

  1. Send menu. You send your menu to Faster Order, if a restaurant wants to update prices or delete/add items they do that on your side.
  2. Receive transactions. Once orders come in to a restaurant Faster Order sends them to your POS.

What we offer restaurants

We offer a nice looking online shop they can link to from their own website. We're able to handle take away orders, room service orders, order from the table and home delivery orders.

The cost for the restaurant is 499 kr/month and they can cancel whenever they want to without any cancellation fee. We have a great deal with our payment partner in which they charge the restaurant starting from 0.40 % for card transactions and 1.80 kr for swish transactions.

Getting started

  1. Fill in a request form to access the API
  2. Within 5 days you will receive following from Faster Order:
    a) Credentials to a test profile
    b) Test code to make test reservations
    c) API key
  3. Login to your test profile via:
    https://app.fasterorder.se/backoffice/login
    This view is the same that the restaurants see and it shows you the data you've created via the API
  4. Try out the API using our Swagger:
    https://pos-api.fasterorder.se/swagger/index.html 

If you have questions please contact us at info@fasterorder.se

Managing the menu

image-1703105107104.png

image-1703105257249.png

At Faster Order we have following menu elements: 

  1. Menus: these create the headers in the menu and categorize items. For sample "Pizzas", "Starters", "Mains" are menus
  2. Menu Items: these are the actual items that a customer orders. "Pancake", "Margerita", "Chicken Dumplings" are samples of menu items
  3. Extras: extras can be extra toppings that you want to add to your pizza, or if you want a customer to in some way customize the menu item that they choose. If it's a hamburger meal it could be that they get to choose between fries and apple as a first choice, between a vegan burger or meat burger as a second choice and drink as a 3rd choice. Extras are just normal menu items. To configure the menus this is done in Faster Order's back office and can't be done via the API. Once you setup a group of different extras that can be setup for a menu item this is called an add-on menu.

The integration we have supports a 1 way sync, from your menu to ours and not vice versa. 

First time you and a menu or a menu item you can set the name/description. These fields are not available in the update of an article. The reason is that the restaurant can setup a name and a description in Faster Order's backoffice that is more oriented to the end customer and we won't want synchronizations to overwrite this.

API endpoints

The POS API can be found here:

https://pos-api.fasterorder.se/swagger/index.html

Receiving transactions

image-1703104150856.png

A Faster Order transaction consists of following things: 

  1. Delivery details: this shows how it's going to be delivered to the customer, either room service, table service, home delivery or room service and it also shows the time on when the customer expects the order to be ready/delivered
  2. Customer details:  how the customer is and if there is a delivery address or a table to server the order at it shows the table the order is to be delivered. For room service there is a room given
  3. Custom fields: the restaurant can choose if they want to add additional info that they want to collect from the customer before the customer places the order. It's up to the restaurant if they want to use this and what to put in the custom fields
  4. Menu item: the item that have been ordered by the customer
  5. Extras: defines how the customer wants to customize their menu item. Extras are child items to menu items.

In order for you to be able to receive transactions the most straight forward way for you is to expose a URL that Faster Order can send  HTTP POST request with the transaction. If your POS is not able to expose public endpoints let us know and we can try to work out workarounds for this.  Contact us at info@fasterorder.se. 

API endpoints

The POS API can be found here:

https://pos-api.fasterorder.se/swagger/index.html

Since transactions are posted to you via HTTP POST requests we've developed these endpoints to make it easier for you to develop:

  1. pos-api/commands/notify-transaction: this endpoint triggers the posting of a transaction to the URL that you have given us for the webhook.
  2. pos-api/transaction/{TRANSACTION_ID}: this endpoint returns a transaction in the same format as it's posted in the webhook to your URL

Once you receive a transaction don't forget to mark the transaction as received via the endpoint pos-api/commands/transaction-received giving Faster Order the ID/transaction reference from your system. By doing this Faster Order knows there is a problem with the connection and that we need to alert the restaurant via SMS about the transaction failed to notify