Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

This page documents the checkout customer journey and associated API actions.

Contents

What is checkout?

Checkout is the final step in the shopping process, where the customer reviews their cart, sees the total price, enters payment information, and confirms the order.

In our platform checkout consists currently of three steps: the cart page, the payment page and the order confirmation page.

image-20240821-115250.png

This document focuses on the cart page and order confirmation page.

How do you interact with the API?

Our ordering API uses endpoint 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.

API Actions

Make sure all this actions are performant and responses are provided within milliseconds. Long response times will translate into long loading times for guests.

Once guests have added items to cart, they will go to the cart page to understand total price and proceed with the order.

Price webhook & endpoint

When a guest goes to the cart page, the contents of their cart are priced against the POS and the final price is displayed to the customer.

To do that, we trigger the Price Order webhook, which signals that an order needs to be priced by the POS. The payload of that webhook includes the order contents for the selected store id and service mode. The POS must return the price and availability for each item in the order, the total price and any errors using the Price Webhook Callback endpoint.

These pricing actions will be triggered every time guests access the cart page.

Once guests are happy with their order, they will click on Continue and proceed to the payment page, where they will select their preferred payment method and proceed. The RBI platform takes care of the payment step.

Our API offers some control over payments, but these actions are typically not needed. You can learn more about payments here: [link to payments page].

Commit webhook & endpoint

Once guest have inputted their payment information, the order will be

When guests place an order, it must be registered in the POS.

To do that, we trigger the Commit Order webhook which includes the order id, total order price and customer details.

  • This doesn’t mean the order should be prepared immediately.

    • In the commit order body we include fireOrderInSeconds field which indicates when order should be “fired” to the kitchen.

    • Value of 60 indicates the order should be fired in a minute from the commit, a value of null indicates the order should be hold in the POS until receiving fire command.

Fire webhook & endpoint

[ ]

Order event webhook & endpoint

[ ]

  • No labels