...
RBI’s Orders API is designed to allow guests to place orders using RBI mobile apps. Guests select the items they want to order via the appuse the RBI app to select a restaurant, add items to cart and pay for the order, and the RBI platform communicates with the restaurant’s POS system to calculate the basket price and place the order.This document explains how the integration works between RBI systems, the POS and optional payload translation services.throughout the journey.
The high-level guest actions are mapped in the table below:
Guest Action | POS Action | Document |
|---|---|---|
Guest select restaurants |
| [Link to Restaurants] |
Guest navigates through menu |
| |
Guest goes to checkout |
| |
Guest pays for the order |
| [link to payments] |
Order is placed |
| |
Guest / Driver collects the order |
|
How do you interact with the API?
Our ordering API uses endpoints and webhooks, which follow this principle:
We broadcast all changes that impact orders via our webhooks.
We make available all information on orders via our endpoints.
Some webhooks require actions to be performed by the POS via our endpoints.
| Expand | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Calculate basket priceDirect integrationWhen a guest loads the checkout page, the RBI mobile app communicates with the RBI platform to request the basket price by indicating the full basket contents. In turn, the RBI platform sends the full basket contents to the POS using the Price Order Webhook. The POS must have previously developed the ability to accept calls from the
With a translation serviceCalls to the
Place order
|