Overview

Menu Item Management includes several key endpoints that help businesses manage their food or product offerings:

Upload Menu Items Endpoint: This endpoint allows businesses to upload their menu items to the system. It makes the items available for customers to view and order by adding all necessary details such as names, prices, descriptions, and images.

Get Menu Items for Brand Endpoint: This endpoint lets businesses retrieve a list of all menu items associated with a specific brand. It helps businesses quickly view what’s available on the menu for a particular brand or restaurant.

Update Item Availability Endpoint: This endpoint enables businesses to update the availability status of menu items. For example, if an item is out of stock or temporarily unavailable, businesses can use this endpoint to change its status, ensuring customers only see items that are currently available.

Update Bulk Prices for Menu Endpoint: This endpoint allows businesses to update the prices of multiple menu items at once. It makes it easier to apply price changes to a group of items, rather than updating each one individually.

Get Status of a Specific Request Endpoint: This endpoint allows businesses to check the status of a specific request, such as uploading new menu items or updating prices. It helps businesses track whether their requests are still being processed or have been completed.

Upload Menu Items

This feature allows you to add new items or make changes to existing items for a specific store. Items can include things like food or products, and they can have options or customizations (called "modifiers") attached to them, such as size, toppings, or other choices. So, whether you're adding a new product to the store or updating an existing one with new options, this endpoint lets you manage that process easily.

How It Works

You can add new items to a store or update existing ones.
Each item can have "modifiers" attached, which are customizable options (like size, color, toppings, etc.).
The endpoint allows you to manage both the items and their associated modifiers.
The process is specific to one store at a time, so updates or additions only affect that store.
It enables you to keep the store’s inventory and item options up to date and customized as needed.

This endpoint allows you to easily add or update items and their customizable options (modifiers) for a specific store, streamlining inventory management, ensuring consistency, and improving the customer experience with real-time updates.

Refer our documentation on Upload Menu Items JSON payload and a detailed breakdown of its attributes for more details.

Get menu items for a brand

This endpoint lets you access a complete list of all the menu items available, along with any modifiers. "Menu items" refer to the individual dishes or products on the menu, and "modifiers" are the options that customers can choose to customize their order, like adding extra toppings or changing ingredients.

How It Works

The endpoint retrieves all available menu items (dishes or products) from the system.
It also retrieves all modifiers (customization options) linked to each menu item.
The menu items include details such as names, descriptions, and pricing.
The modifiers include options like extra toppings, ingredient swaps, or size variations.
This data can be used to display the menu to users or to allow them to customize their orders.

Integrating this endpoint allows you to easily retrieve and manage the entire menu, including all items and customization options (modifiers). It ensures real-time updates, improves the customer ordering experience, and streamlines menu management across platforms, ultimately boosting efficiency and sales opportunities.

Refer our documentation on Get Menu Items For a Brand JSON payload and a detailed breakdown of its attributes for more details.

Update Item Availability

This endpoint helps you manage the availability of items or modifiers in your system. You can use it to mark an item or modifier as "available" when it's in stock or ready to be used, or "unavailable" when it's out of stock or not ready for use. This allows you to update the status of your products or options in real time, making sure customers only see what is currently available.

How It Works

Allows you to set the availability of items or modifiers (like ingredients or options) in your system.
Mark an item or modifier as available when it's in stock or ready to be used.
Mark an item or modifier as unavailable when it's out of stock or temporarily not available.
Changes made are instantly reflected in your system, so customers only see what they can order.
You can update the availability of multiple items or modifiers as needed, ensuring accurate information is always shown.

Integrating this endpoint ensures real-time updates of item and modifier availability, improving customer experience, reducing errors, and enhancing inventory management. It streamlines operations, boosts sales by showing only available options, and provides flexibility to adjust to stock changes quickly.

Refer our documentation on Update Item Availability JSON payload and a detailed breakdown of its attributes for more details.

Update bulk prices for menu items and modifiers

This endpoint allows you to update the prices of both items and modifiers in the system. You can use it to adjust pricing based on various factors such as promotions, discounts, or regular price changes. The request typically includes item or modifier identifiers along with their updated prices. Once the request is processed, the new prices will be reflected in the system and applied accordingly to future transactions.

How It Works

Updates the prices of items and modifiers in the system.
Send a request with the item or modifier IDs.
Include the new price values in the request payload.
The system verifies the provided IDs and updates the prices in the database.
If successful, the system confirms the update. If there are errors (e.g., invalid IDs or missing data), an error message is returned.

This endpoint enables automated price updates for items and modifiers, ensuring accurate, real-time adjustments while improving efficiency and reducing manual errors.

Refer our documentation on Update bulk prices for menu items and modifiers JSON payload and a detailed breakdown of its attributes for more details.

Get status of a specific request

This endpoint allows you to check the progress of a request made to create or update an item or modifier. When you submit a request to add a new item or modifier or make changes to an existing one, the system processes it. You can use this endpoint to see whether the request is still being processed, has been successfully completed, or has failed due to an issue. This helps you track updates and ensure that changes are applied correctly.

How It Works

You send a request to create or update an item or modifier.
The system processes your request in the background.
You can use this endpoint to check the status of that request.
The endpoint will return the current status, which could be:

-- Processing – The request is still being worked on.

-- Completed – The request was successfully processed.

-- Failed – There was an issue, and the request could not be completed.

This helps you track your request and take action if needed.

Integrating this endpoint provides real-time tracking of item or modifier creation and updates, allowing you to monitor progress, quickly identify and resolve issues, and ensure smoother workflows. It enhances user experience with transparent status updates and improves system reliability by confirming successful updates.

Refer our documentation on Get status of a specific request JSON payload and a detailed breakdown of its attributes for more details.