API Use Cases

Khumbu's APIs are designed to bridge the gap between restaurant POS systems and integration partners like UberEats and DoorDash. These APIs enable seamless operations across multiple systems, ensuring efficiency and consistency. Below are the detailed use cases and scenarios where Khumbu APIs are instrumental:


Order Management

1. Validate Cart

Scenario: Before finalizing an order, a customer selects items from a restaurant's menu on a food delivery platform (e.g., UberEats). The platform needs to verify the accuracy of the selected items, prices, and availability with the restaurant’s system to ensure the order is valid.

API Role:

  • The delivery platform sends a request to Khumbu's API with the selected menu items and their quantities.
  • Khumbu validates the cart by:
    • Checking the availability of each item in the restaurant’s menu.
    • Confirming that item prices match the latest menu data.
    • Verifying that no restrictions (e.g., out-of-stock items or time-specific menu items) apply.
  • Khumbu responds with:
    • A confirmation of valid items and prices.
    • Details about any discrepancies, such as unavailable items, price changes, or substitutions.
  • The delivery platform updates the customer’s cart based on the API response.

Outcome: The cart is validated, ensuring accurate pricing and item availability, which minimizes errors during the order process and improves the customer experience.

2. New Order Creation

Scenario: A customer places an order through a food delivery platform (e.g., UberEats).

API Role:

  • The delivery platform sends the order details to Khumbu's API.
  • Khumbu forwards the order to the restaurant’s POS system for preparation.
  • Khumbu updates the Order Status back to delivery Platform

Outcome: The order is successfully registered in the restaurant’s system for processing.

3. Fire Order Creation

Scenario: A customer places an order through a food delivery platform (e.g., UberEats). Delivery platform will send order as HOLD initially and later confirms the order by calling fire order API

API Role:

  • The delivery platform sends the order to Khumbu's API with HOLD status. The order is then sent to the POS as HOLD, ensuring it is not yet sent to the kitchen.
  • Delivery platform will call fire order API to confirm/execute the order. At this point, order will be sent to kitchen.
  • Khumbu updates the Order Status back to delivery Platform

Outcome: The order is successfully registered in the restaurant’s system for processing.

4. Order Cancellation

Scenario: A customer cancels an order or the restaurant declines it.

API Role:

  • Khumbu notifies the restaurant POS and delivery platform about the cancellation.

Outcome: The cancellation is reflected promptly in all connected systems.


Menu Synchronization

1. Initial Menu Setup

Scenario: A restaurant partners with a new delivery platform and needs to synchronize its menu.
API Role: Khumbu’s API pulls the restaurant’s menu data from the POS system and shares it with the delivery platform.
Outcome: The restaurant’s menu appears accurately on the delivery platform.

2. Real-Time Menu Updates

Scenario: A restaurant updates its menu to reflect changes like new items, price modifications, or stock availability.

API Role:

  • The restaurant’s POS sends updated menu details to Khumbu's API, or the delivery platform directly calls Khumbu's APIs to fetch the updates.
  • Khumbu’s API sends updates to the delivery platform in real-time.
  • Changes are reflected on the platform's interface.

Outcome: Customers see the most current menu when placing orders.


Store Synchronization

1. Real-Time Store Update

Scenario: A restaurant updates its operational details, such as availability status, operating hours, or service options. These updates must be synchronized with food delivery platforms to ensure accurate information for customers.

API Role:

  • The restaurant’s POS sends updated store details to Khumbu's API, or the delivery platform directly calls Khumbu's APIs to fetch the updates.
  • Khumbu processes and syncs the updates (e.g., operating hours, availability) with delivery platforms.
  • Platforms reflect the changes, ensuring accurate display of store availability and hours.

Outcome: The store's operational details are successfully updated across platforms, ensuring consistent and accurate customer-facing information.