Versions Compared

Old Version 4

changes.mady.by.user Benet, Anton

Saved on

compared with

New Version Current

changes.mady.by.user Benet, Anton

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Guest Action

POS Action

Document

Guest select restaurants

  • Share store availability.

[Link to Restaurants]

Guest navigates through menu

  • Provide updated pricing & availability per store.

link to menu managementOrders API - Menu Management

Guest goes to checkout

  • Calculate order price.

link to checkouthttps://rbictg.atlassian.net/wiki/spaces/RDP/pages/5003083791/Order+API+-+Checkout#Price-webhook-and-endpoint

Guest pays for the order

  • By default, no action needed.

[link to payments]

Order is placed

  • Commit order to the POS.

  • Provide order statuses.

[ink to checkout]https://rbictg.atlassian.net/wiki/spaces/RDP/pages/5003083791/Order+API+-+Checkout#Commit-webhook-and-endpoint

Guest / Driver collects the order

  • Fire the order to the kitchen.

[link to checkout]https://rbictg.atlassian.net/wiki/spaces/RDP/pages/5003083791/Order+API+-+Checkout#Fire-webhook-%26-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.

Expand
titlePrevious content

Calculate basket price

Direct integration

When 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 Price Order Webhook, and respond with a call to the Price Webhook Callback (using the callbackUrl parameter sent with the original request).

Zenuml sequence macro lite
uuid39f104e4-5aa1-4c62-96a6-8af7c9c4a833
customContentId4718723073
updatedAt2024-05-15T12:44:12Z
With a translation service
Calls to the Price Order Webhook send the full basket contents under the cart request parameter. This parameter has a standard format, which must be translated to the format that each POS expects to receive. Typically this is accomplished with a service such as Khumbu. In case a translation service is used, communication between systems happens as follows:
 Zenuml sequence macro lite
uuid39f104e4-5aa1-4c62-96a6-8af7c9c4a833
customContentId4718723079
updatedAt2024-05-15T12:44:59Z
Place order
 Note
Work in progress