Getting started for restaurants

This guide takes you through end-to-end integration setup: from initial authentication to go-live. This is for Restaurant Point of Sale (POS) and Middleware providers (MWP). 

POS

A Point of Sale (POS) system is the central software and hardware platform used by restaurants to manage a range of tasks from order taking to kitchen communication. It allows restaurants to create and modify their menu directly in POS and sync it with delivery channels.

MWP

A middleware provider acts as a bridge between the POS system and third-party services, such as online ordering platforms or delivery apps. Middleware solves compatibility and communication challenges between different systems. MWP can push order updates, manage venue availability and sync menu and item availability.

In the next steps you will see mandatory features as well as nice to haves.

Requirements

• A thorough understanding of the OAuth 2.0 method. Public explainers can be found here.

• You have a merchant ready and wanting to use this integration with your system and Wolt.

As a POS&MWP, we require that you use either self-service integration (SSIO) or Wolt-led integration (WIO) or both, and integrate towards our Order-, Venue- and Menu APIs to ensure the best merchant experience.

If you are a POS and cannot reach these requirements please reach out to a MWP and consider an integration there. Feel free to peruse our catalog here to find the right MWP for you.

Submit and integration request by using this form, after which Wolt will assess it and provide you with the needed credentials. You will be sent Terms and Conditions to sign as well.

Setup&Configuration

Use the following Wolt public Postman collection.

1. Authentication and onboarding preparation

• You selected the OAuth flow your system is going to use self-service (SSIO) and/or Wolt-led (WIO).

• Learned more about OAuth implementation and flow design.

• You've chosen an OAuth client library (you can find a list of recommended libraries here and here) or have implemented the OAuth framework yourself. 

2. Venue onboarding

2a. Venue onboarding: self-service integration (SSIO)

The self-service integration onboarding flow allows merchants to activate integrations for their venues via a UI available in your system. Create a page e.g. starting point in your system where Merchant can initiate the integration of their venues with Wolt.

Activation with SSIO

2b. Venue onboarding: Wolt-led integration (WIO)

The Wolt-led integration onboarding flow enables Wolt to onboard integrations for venues on behalf of integration partners. Your system can support both options SSIO&WIO, if needed.

This option is best if you don’t have a UI and/or want to keep the activation step between Wolt & you, without involvement of the merchant.

Activation with WIO

3. Order

• Setup a webhook server to receive order status webhook notifications.

Implement the following Order API endpoints: 

Required

Wolt's Order API uses webhook notifications and pull-based order retrieval, ensures that your system can accept, track, and acknowledge orders in real-time.

• Get order: pull the order details to your system

• Accept order: accept an order, and declare a preparation time

• Confirm pre-order: accept the preparation of an order in the future

• Mark order ready: signal that the order is ready for pick-up

• Reject order: decline the preparation of an order; can only be done before an order is accepted

Optional

• Mark order sent to POS: relevant for MWPs, inform Wolt that the order has been pushed to the POS

• Mark order delivered (takeaway): inform Wolt that the customer picked up their order in the restaurant, mandatory for takeaway

If you plan have merchants that have their own couriers delivering, please refer to the following list of endpoints.

Required

• Accept self-delivery order: accept an order, and declare total delivery time

Optional

• Pickup completed: inform Wolt that your courier has picked up the order from the merchant

• Courier tracking: send your courier's location to Wolt, and bring visibility to our customers

• Courier at customer: let the customer know an order is arriving soon

• Delivery ETA: inform customers of your ETA once you're closing in on the destination

4. Venue

Wolt’s Venue API allows partners to monitor and manage key operational settings, like online status and opening hours.

Required

• Get venue status: returns key metrics for the venue like opening times, and store status

• Update venue online status: set the store online or offline

• Update venue opening times: update the regular opening times

Optional

• Update special opening times: indicate any special opening times during holidays or other events

• Retrieve current delivery provider: returns whether the deliveries are done by Wolt or the merchant's own fleet

• Change delivery provider: change the current delivery provider for the venue

5. Menu

Required

With Wolt’s Menu API a partner can send and fetch full menu data, as well as update item details (e.g. price), and push real-time availability updates without managing full menu structures.

• Create menu: post the full menu on Wolt

• Update menu items: update individual item details, without having to push a full menu

• Update menu options: update individual option details, without having to push a full menu

Optional

• Get menu: pull the menu payload as-is from Wolt

6. Testing & Go Live

1. Deploy the solution to your staging environment.

2. Provide Wolt with staging access to your system.

3. Fill in the provided Solution scope document.

4. Schedule your QA Demo call with a Wolt Technical Account Manager.

5. Agree with Wolt on the launch date.

6. Prepare a pilot venue. Deploy your system to production.

Postman Collection

Use the following Wolt public Postman collection.