Update Store Status

• To Online

Authenticated user inputs restaurant address on restaurant search in App.

Update Store Status to Online (docs).

→ Partners API reports store is online through Get Store Status call.

→ Ordering buttons become eligible for the store.

Image Removed

Note: Store ordering availability is not only affected by the POS status, as there are other configurations required to activate stores.

→ RBI admins have access to the Store Diagnostics and can verify that isRestaurantPosOnline: true

Image Removed

Update Store Status

• To Offline

Authenticated user inputs restaurant address on restaurant search in App.

Update Store Status to Offline (docs).

→ Partners API reports store is offline through Get Store Status call.

→ Ordering buttons become grayed out for the store. Mobile ordering is not available at this store warning appears.

Image Removed

Note: Store ordering availability is not only affected by the POS status, as there are other configurations required to activate stores.

→ RBI admins have access to the Store Diagnostics and can verify that isRestaurantPosOnline: false

Image Removed

Update store status

• To Online

User inputs restaurant address in the store locator in RBI’s platform.

Update store status to online via Update Store Status endpoint.

→ Partners API reports store is online through Get Store Status endpoint.

→ Select button is available and not grayed out.

Image Added

→ RBI admins have access to the Store Diagnostics and can verify that isRestaurantPosOnline: true

Image Added

Update store status

• To Offline

User inputs restaurant address in the store locator in RBI’s platform.

Update store status to offline via Update Store Status endpoint.

→ Partners API reports store is offline through Get Store Status endpoint.

→ Ordering buttons become grayed out for the store. Mobile ordering is not available at this store warning appears.

Image Added

→ RBI admins have access to the Store Diagnostics and can verify that isRestaurantPosOnline: false

Image Added

Make an item available for a certain store

User selects ordering for the corresponding store and navigates to the menu section of the item.

Make a request with price and availability : true for the respective PLU using the Update Store Menu PLUs endpoint.

→ Partners API GET Store Menu PLUs endpoint returns the PLUs with the corresponding price and availability.

→ Item appears in App Menu section with correct price.

Make an item unavailable for a certain store

User selects ordering for the corresponding store and navigates to the menu section of the item.

Make a request with price and availability : false for the respective PLU using the Update Store Menu PLUs endpoint.

→ Partners API GET Store Menu PLUs endpoint returns the PLUs with the corresponding price and availability.

→ Item disappears from App Menu section.

Make a combo available for a certain store

User selects ordering for the corresponding store and navigates to the menu section of the combo.

Make a request with price and availability : true for the respective PLU(s) using the Update Store Menu PLUs endpoint.

→ Partners API GET Store Menu PLUs endpoint returns the PLUs with the corresponding price and availability.

→ Combo appears in App Menu section with correct price.

Make a combo unavailable for a certain store

User selects ordering for the corresponding store and navigates to the menu section of the combo.

Make a request with price and availability : false for the respective PLU(s) using the Update Store Menu PLUs endpoint.

→ Partners API GET Store Menu PLUs endpoint returns the PLUs with the corresponding price and availability.

→ Combo disappears from App Menu section.

Make a modifier multiplier available for a certain store

User selects ordering for the corresponding store and navigates to the menu section of the itemitem containing the modifier multiplier.

Make a request with price and availability : true for the respective PLU (s) to Partner’s API using the Update Store Menu PLUs endpoint.

→ Partners API GET Store Menu PLUs endpoint returns the PLUs with the corresponding price and availability.

→ Item appears in App Menu section with correct price.

• Consider a cache of up to 1 minute for updates to reflect in FE.

Make an item → Modifier Multiplier appears in App Menu section with correct price.

Make a modifier multiplier unavailable for a certain store

Authenticated user User selects ordering for the corresponding store and navigates to the menu section of the itemitem containing the modifier multiplier.

Make a request with price and availability : false for the respective PLU (s) to Partner’s API using the Update Store Menu PLUs endpoint.

→ Partners API GET Store Menu PLUs endpoint returns the PLUs with the corresponding price and availability.

→ Item Modifier Multiplier disappears from App Menu section.

.

Make a combo Systemwide Offer available for a certain store

Authenticated user User selects ordering for the corresponding store and navigates to the menu section of the combooffers page.

Make a request with price and availability : true for the respective PLU(s) to Partner’s API using the Update Store Menu PLUs endpoint.

→ Partners API GET Store Menu PLUs endpoint returns the PLUs with the corresponding price and availability.

→ Combo appears in App Menu section Offer appears in App Offers page and is available for Mobile redemption with correct price.

• Consider a cache of up to 1 minute for updates to reflect in FE.

Make a combo Systemwide Offer unavailable for a certain store

Authenticated user User selects ordering for the corresponding store and navigates to the menu section of the combooffers page.

Make a request with price and availability : false for the respective PLU(s) to Partner’s API using the Update Store Menu PLUs endpoint.

→ Partners API GET Store Menu PLUs endpoint returns the PLUs with the corresponding price and availability.

→ Combo disappears from App Menu section.

• Consider a cache of up to 1 minute for updates to reflect in FE.

Make a modifier multiplier available for a certain store

Authenticated user selects ordering for the corresponding store and navigates to the item containing the modifier multiplierOffer button for Mobile redemption is grayed out. Offer displays text indicating that it isn't available at the selected location.

Make a premium item (within a comboslot) available as part of a combo

Image Added

User selects ordering for the corresponding store and navigates to the combo containing the premium item.

• Internal configurations should be applied to serve Composite PLU for the given POS Vendor / market.

Make a request with price and availability : true for the respective PLU(s) to Partner’s API using the Update Store Menu PLUs endpointPLU(s) to Partner’s API using the Update Store Menu PLUs endpoint.

• The PLU for the premium comboslot option should follow the pattern comboPlu-itemPlu. E.g. for the whopper meal medium (PLU=123) to have onion rings (PLU=456) as a premium comboslot option, the price would have to be posted using the plu 123-456.

→ Partners API GET Store Menu PLUs endpoint returns the PLUs with the corresponding price and availability.

→ Modifier Multiplier appears in App Menu section with correct Item appears inside the Combo with the desired premium price.

• Consider a cache of up to 1 minute for updates to reflect in FE.

Make a modifier multiplier unavailable for a certain store

Authenticated user Make a premium item (within a comboslot) unavailable as part of a combo

Image Added

User selects ordering for the corresponding store and navigates to the item containing the modifier multipliercombo containing the premium item.

• Internal configurations should be applied to serve Composite PLU for the given POS Vendor / market.

Make a request with price and availability : false for the respective PLU(s) to Partner’s API using the Update Store Menu PLUs endpointfalse for the respective PLU(s) to Partner’s API using the Update Store Menu PLUs endpoint.

• The PLU for the premium comboslot option should follow the pattern comboPlu-itemPlu. E.g. for the whopper meal medium (PLU=123) to have onion rings (PLU=456) as a premium comboslot option, the price would have to be posted using the plu 123-456.

→ Partners API GET Store Menu PLUs endpoint returns the PLUs with the corresponding price and availability.

→ Modifier Multiplier Item disappears from App Menu section.

• Consider a cache of up to 1 minute for updates to reflect in FE.

Make a Systemwide Offer the Combo.

Make a Reward available for a certain store

Authenticated user selects ordering for the corresponding store and navigates to the offers pageand navigates to the rewards page.

User must have enough points to redeem applicable reward.

Make a request with price and availability : true for the respective PLU(s) to Partner’s API using the Update Store Menu PLUs endpoint.

→ Partners API GET Store Menu PLUs endpoint returns the PLUs with the corresponding price and availability.

→ Offer Reward appears in App Offers Rewards page and is available for Mobile redemption with correct price.

• Consider a cache of up to 1 minute for updates to reflect in FE.

Make a Systemwide Offer Reward unavailable for a certain store

Authenticated user selects ordering for the corresponding store and navigates to the offers rewards page.

User must have enough points to redeem applicable reward.

Make a request with price and availability : false for the respective PLU(s) to Partner’s API using the Update Store Menu PLUs endpoint.

→ Partners API GET Store Menu PLUs endpoint returns the PLUs with the corresponding price and availability.

→ Offer Reward button for Mobile redemption is grayed out.

• Consider a cache of up to 1 minute for updates to reflect in FE.

Make a premium item (within a comboslot) available as part of a combo

Image Removed

Authenticated user selects ordering for the corresponding store and navigates to the combo containing the premium item.

is grayed out. Rewards displays text indicating that it isn't available at the selected location.

Change price for an item

User navigates through App Menu.

Make a request with updated price

for the respective PLU

using the Update Store Menu PLUs endpoint

.

→ Partners API GET Store Menu PLUs endpoint returns the PLUs with the corresponding updated price

.

→ Item price appears

updated in the App Menu section with correct price.

Pricing Order

Authenticated user selects ordering for the corresponding store, adds items to cart and navigates to checkout.

All available Cart Structures must be tested:

• Item

• Item with modifiers

• Combo

• Combo with items with modifiers

• Systemwide Offer Item

• Systemwide Offer Combo

• Systemwide Offer Combo with modifiers

• Reward Item

• Reward Combo

• Reward Combo with modifiers

• Promo Codes - Amount Discount

• Promo Codes - Percentage Discount

Partner is subscribed to the Price Order webhook. The payload of the webhook includes the order contents for the selected store ID, service mode, and other details.

Partner must return the price and availability for each item in the order, the total price and any errors using the Price Webhook Callback endpoint.

Error Handling must follow the message and code standards:

• Message: Include a clear and concise error message. Include information that would lead to the fixing and understanding of the error occurred. (e.g.: Offending PLUs, store status, etc.).
  Do not include redundant information like: Error occurred while processing request.

• Code Enum: "MENU" "STORE" "TIMEOUT" "UNKNOWN"

→ /cart page loads total price of the cart, corresponding to the sum of all products within.

→ Loading time does not exceed 3 seconds for p99.

→ Tax, Subtotal, and Total are visible at checkout

→ (OPTIONAL) Fees, such as “Bag Fee”, are visible in the /cart page, separately from total cart amount.

Commit Order

After pricing an order, an authenticated user pays, and continues with the placement the order.

All available Cart Structures must be tested in this category:

• Item

• Item w/ modifiers

• Combo

• Combo with items w/ modifiers

• Systemwide Offer Item

• Systemwide Offer Combo

• Systemwide Offer Combo w/ modifiers

• Promo Codes - Amount Discount

• Promo Codes - Percentage Discount

• Reward Item

• Reward Combo

• Reward Combo with modifier

Partner is subscribed to the ORDER_PRICE webhook (docs), which provides details about a new order to be priced.Partner utilizes the Price Webhook Callback to answer the Price requestCommit Order webhook. The payload of the webhook includes the order id, total order price and customer details, among other details.

The POS must respond to the webhook request by using the Commit Webhook callback endpoint.

Error Handling to must follow the message and code standards:

• Message: include Include a clear and concise error message, mentioning the PLUs responsible for the failure and the designated store. Do not include unhelpful information like . Include information that would lead to the fixing and understanding of the error occurred. (e.g.: Offending PLUs, store status, etc.).
  Do not include redundant information like: Error occurred while processing request.

• Code Enum: "MENU" "STORE" "TIMEOUT" "UNKNOWN"

→ /cart page loads total price of the user cart, corresponding to the sum of all products within.

→ loading time does not exceed 3 seconds for p99.

→ Tax, Subtotal, and Total are visible at checkout (as applicable according to local regulation).

→ [OPTIONAL] Fees, such as “Bag Fee”, are visible in the /cart page, separately from total cart amount.

Commit Order

• After successfully pricing and payment, order is injected in the POS.

Authenticated user selects ordering for the corresponding store, builds a cart, navigates to the checkout and places an order.

All Cart Structures must be tested in this category:

• Item

• Item w/ modifiers

• Combo

• Combo with items w/ modifiers

• Systemwide Offer Item

• Systemwide Offer Combo

• Systemwide Offer Combo w/ modifiers

• Promo Codes - Amount Discount

• Promo Codes - Percentage Discount

• Reward Item

• Reward Combo

• Reward Combo with modifier

Partner is subscribed to the ORDER_COMMIT webhook (docs), which provides details about a new order to be injected in the POS.

Partner utilizes the Commit Webhook Callback to answer the Commit request.

Error Handling to follow the message and code standards:

• Message: include a clear error message, mentioning the PLUs responsible for the failure and the designated store. Do not include unhelpful information like Error occurred while processing request

• Code Enum: "MENU" "STORE" "TIMEOUT" "UNKNOWN"

→ Order is injected in the POS.

(further details included below, as per service mode and payment method)

Cancel Order

→ Check whether the status has been changed to cancel

→ Check whether the automatic refund has been processed (if applicable)

→ Check whether the cancellation email was triggered

→ Check whether delivery has been cancelled (if applicable)

→ When the order is canceled in the POS the payment should be refunded.

Order is registered in the POS.

Cancel Order – Initiated by guests or delivery fulfillment providers

• Initiated by guest: for pick up order, guest selects the Cancel Order option.

Image Added

• Initiated by delivery provider: order is canceled by the delivery provider in their Driver Management Portal.

Partner is subscribed to the Order Event webhook. Upon cancelation, the webhook will return an event with status CANCELED.

The POS must acknowledge the cancelation and mark the order as canceled in the POS.

→ Order status is changed to CANCELED. You can check it using the GET Order endpoint.

→ An automatic refund is processed (if applicable).

→ A cancellation email is triggered.

Cancel Order – Initiated by POS

Restaurant team member cancels order in the POS.

Partner send status CANCELED using the Order Event endpoint.

→ Order status is changed to cancel. You can check it using the GET Order endpoint or in the Order Event webhook.

→ An automatic refund is processed (if applicable).

→ A cancellation email is triggered.

Place a Dine In / Pickup

• Immediate order (Now)

Authenticated user selects ordering for the corresponding store, builds a cart and navigates to checkout.

User selects service mode Dine In or Pick Up and order time Now.User inputs the desired table number.

Image Added

Partner collects injects order the POS using the service mode (serviceMode) from the GET Order endpoint (TABLE_SERVICE) and injects in the POS.Partner collects the order number (number) corresponding service Mode and number.

The Partner would’ve received all relevant information to the order previously via the pricing webhook: service mode (TAKEOUT) , order number, etc.

All order information can also be fetched from the GET Order endpoint and injects in the POS, at any time.

fireOrderInSeconds: 0 indicates the order should be fired to the kitchen immediately.

→ Order is injected in the POS with reference to the table number.

→ KDS identifies the service mode.

→ KDS identifies the table number.

→ DSS ticket printed according to the service mode.

→ DSS ticket printed with the table number.

→ Receipt DSS ticket printed with the table numberaccording to the service mode.

→ Receipt printed with order number from RBI, though at a less relevant place, since table number should take precedence to the order number.

• RBI’s order number is expected to substitute the POS order number.

• RBI’s order number is configurable, allowing numerical interval restriction and / or utilization of an alphanumerical prefix.

Place a Curbside Order Number from RBI.

→ ORB displays Order Number from RBI.

Place a Drive-Thru order

• Immediate order (Now)

Authenticated user selects ordering for the corresponding store, builds a cart and navigates to checkout.

User selects service mode and order time Now.

User inputs the car plate number.

Partner collects the service mode (serviceMode) from the GET Order endpoint (CURBSIDE) and injects in the POS.

Partner collects the order number (number) from the GET Order endpoint and injects in the POS.

• fireOrderInSeconds: 0 indicates the order should be fired to the kitchen immediately.

→ Order is injected in the POS with reference to the table number.

→ KDS identifies the service mode.

→ KDS identifies the table number.

→ DSS ticket printed according to the service mode.

→ DSS ticket printed with the table number.

→ Receipt printed with the car plate.

→ Receipt printed with order number from RBI, though at a less relevant place, since car plate should take precedence to the order number.

• RBI’s order number is expected to substitute the POS order number.

• RBI’s order number is configurable, allowing numerical interval restriction and / or utilization of an alphanumerical prefix.

Place a Dine In / Pickup / Drive-Thru order

.

User selects Drive Thru. No time selection appears at checkout.

Partner injects order the POS using the corresponding service Mode and number.

The Partner would’ve received all relevant information to the order previously via the from pricing webhook: service mode (DRIVE_THRU) , order number, etc.

All order information can also be fetched from the GET Order endpoint, at any time.

fireOrderInSeconds: null indicates the order should be held in the POS until the order is released.

→ Order is registered in the POS but not sent to the kitchen.

→ When the guest arrives at the restaurant, a team member manually fires the order to the kitchen from the POS.

At that point,

→ DSS ticket printed.

→ Receipt printed with Order Number from RBI.

→ ORB displays Order Number from RBI.

Place a Table Service order

• Immediate order (Now)

Authenticated user selects ordering for the corresponding store, builds a cart and navigates to checkout.

User selects service mode and order time equivalent to any slot in the future.

Partner collects the service mode (serviceMode) from the GET Order endpoint (EAT_IN TAKEOUT DRIVE_THRU) and injects in the POS.

Partner collects the order number (number) from the GET Order endpoint and injects in the POS.

Table Service and inputs the desired table number.

Image Added

No time selection appears.

Partner injects order the POS using the corresponding service Mode and number.

The Partner would’ve received all relevant information to the order previously via the from pricing webhook: service mode (TABLE_SERVICE) , order number, etc. The table service is provided under the instructions field.

All order information can also be fetched from the GET Order endpoint, at any time.

fireOrderInSeconds: 0 indicates the order should be fired to the kitchen

immediately.

→ Order is injected in the POS.→ Order appears in the KDS X seconds after POS order injectionPOS with reference to the table number.

→ KDS identifies the service mode.

→ KDS identifies the table number.

→ DSS ticket printed according to the service mode.

→ Receipt DSS ticket printed with Order Number from RBIthe table number.

→ ORB displays Order Number from RBI.

Receipt printed with the table number.

→ Receipt printed with order number from RBI, though at a less relevant place, since table number should take precedence to the order number.

Place a Table Service Dine In / Pickup order

• Future order (Scheduled)

Authenticated user selects ordering for the corresponding store, builds a cart and navigates to checkout.

User selects service mode Dine In or Pick Up and order time equivalent to any slot in the future.User inputs the desired table number.

Image Added

Partner collects injects order the POS using the service mode (serviceMode) from the GET Order endpoint (TABLE_SERVICE) and injects in the POS.Partner collects the order number (number) corresponding service Mode and number.

The Partner would’ve received all relevant information to the order previously via the pricing webhook: service mode (TAKEOUT) , order number, etc.

All order information can also be fetched from the GET Order endpoint and injects in the POS, at any time.

fireOrderInSeconds: X indicates the order should be fired to the kitchen X seconds after the order is placed.

→ Order is injected in the POS with reference to the table number.

→ Order appears in the KDS X seconds after POS order injection.

→ KDS identifies the service mode.

→ KDS identifies the table number.→ DSS ticket printed according to the service mode.

→ DSS ticket printed with the table number.

→ Receipt printed with the table number.

→ Receipt printed with order number from RBI, though at a less relevant place, since table number should take precedence to the order number.

• RBI’s order number is expected to substitute the POS order number.

• RBI’s order number is configurable, allowing numerical interval restriction and / or utilization of an alphanumerical prefix.

Place a Cash cash (or any other Unpaid in-restaurant orderAs per above.unpaid) in-restaurant order

Same process described in previous table for any service mode (Dine In, Pick Up, Table Service…).

User selects cash in the payment page.

Image Added

Partner collects the payment method from the GET Order endpoint (CASH or UNPAID) and injects in the appropriate POS field.

Typically, POS systems define Tender IDs for this purpose.

→ Order is injected in the POS.

→ Order is not injected in KDS (Kitchen Display System), i.e. it is not sent to the kitchen.

→ Order is injected in KDS after user performs the paymentsent to the kitchen after user performs the payment.

E.g. guest places a Pick Up order for 5:30pm and pays with cash. Guest arrives at the restaurant and pays for order at front counter, team member sendd order to the kitchen.

Place an online payment (paid) in-restaurant order

As per above.Same process described in previous table for any service mode (Dine In, Pick Up, Table Service…).

In the payment page, user selects credit card or any other alternative payment method that leaves the order paid.

Image Added

Partner collects the payment method from the GET Order endpoint and injects in the appropriate POS field.

Typically, POS systems define Tender IDs for this purpose.

Any payment method besides CASH and UNPAID falls under this category.

→ Order is injected in the POS and in KDSsent to the kitchen, following the fireOrderInSeconds logic explained in the table above.

Place a Delivery order

Authenticated user inputs address within delivery area on restaurant search in App, builds a cart and navigates to checkout.

Authenticated user clicks on “Continue” on the checkout page, and confirms selecting any payment method by clicking “Place Secure Order”.

Partner collects the service mode (serviceMode) from the GET Order endpoint (DELIVERY) and injects in the POS.

• fireOrderInSeconds: null indicates the order should not be fired to the kitchen, and instead be injected to the POS in suspended mode.

Partner collects the order number (number) from the GET Order endpoint and injects in the POS.

→ Order is injected in the POS.

→ Order does not appear in the KDS (not fired into the kitchen).

Fire a Delivery order into the kitchen

Delivery vendor request to move the order to kitchen

• Based on driver’s geolocation OR driver’s ETA to the restaurant.

Partner is subscribed to the ORDER_FIRE webhook, which triggers a request to fire an order into the kitchen.

Partner fires the order through a POST call to the Fire Order endpoint.

• Firing is expected to happen when the driver is at a distance / time from the restaurant equal or lower to the preparation time (prep time). The POS vendor is not required to compute any logic, as RBI is responsible for informing the POS vendor when to fire orders.

→ Order appears in the KDS (is fired into the kitchen).

→ KDS identifies the service mode.

→ DSS ticket printed according to the service mode.

→ Receipt printed with Order Number from RBI.

• RBI’s order number is expected to substitute the POS order number.

• RBI’s order number is configurable, allowing numerical interval restriction and / or utilization of an alphanumerical prefix.

Cancel a Delivery order

Delivery cancelation

→ Delivery Order successfully sent and placed in Partner’s POS.

→ If a delivery cancellation is requested:

• The order should be canceled in the POS.