Orders API - Overview

Owned by Silva, Carlos
Last updated: Dec 16, 2024 by Benet, Anton
1 min read

Contents

Introduction

RBI’s Orders API is designed to allow guests to place orders using RBI mobile apps. Guests use 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 throughout the journey.

The high-level guest actions are mapped in the table below:

Guest Action

POS Action

Document

Guest Action

POS Action

Document

Guest select restaurants

  • Provide store availability.

Orders API - Restaurant Management

Guest navigates through menu

  • Provide updated pricing & availability per store.

Orders API - Menu Management

Guest goes to checkout

  • Calculate order price.

Orders API - Checkout | Price webhook and endpoint

Guest pays for the order

  • By default, no action needed.

Orders API - Payments

Order is placed

  • Commit order to the POS.

  • Provide order statuses.

Orders API - Checkout | Commit webhook and endpoint

Guest / Driver collects the order

  • Fire the order to the kitchen.

Orders API - Checkout | Fire webhook & endpoint

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.