Get Order Menu
The Get Order Menu action allows chatbot builders to dynamically retrieve real-time menu items, pricing, quantities, and order details from an API.
This utility action helps businesses display accurate and up-to-date product or menu information directly inside chatbot workflows. The action automatically extracts menu details from API responses and stores them in variables for further processing.
The walkthrough demonstrates configuring API response mapping, retailer identification, quantity handling, price extraction, total amount calculation, and variable storage configuration.
When to Use Get Order Menu
Use the Get Order Menu action when your chatbot needs to fetch and process menu or order details dynamically from an external API.
Common Use Cases
Restaurant order menus
E-commerce product catalogs
Real-time inventory display
Dynamic pricing workflows
Order processing automation
Shopping cart integrations
Example Interaction
Bot: 🍔 Please select items from today's available menu. Menu: 1. Burger - ₹120 2. Pizza - ₹250 3. Sandwich - ₹90
The chatbot dynamically retrieves menu details from the connected API.
How to Add Get Order Menu
Follow these steps to add the Get Order Menu action to your bot workflow.
Open Bot Builder
Click the Add Node button
Open the Utilities tab
Select Get Order Menu
Configure the API response mapping fields
Configure response variables
Click Create
Click Publish to deploy the workflow
The walkthrough demonstrates selecting the Get Order Menu action from the Utilities section.
Accessing the Utilities Section
To access the Get Order Menu action:
Click Add Node
Open the action panel
Click the Utilities tab
The Utilities section contains advanced workflow and automation actions.
Selecting Get Order Menu
Inside the Utilities tab:
Locate Get Order Menu
Click the action to open the configuration dialog
The walkthrough highlights the Get Order Menu element used for configuring API-driven order menu retrieval.
Get Order Menu Configuration
When configuring the Get Order Menu action, several fields must be completed.
Action Name
The Action Name identifies the order menu workflow inside the bot builder.
This name is visible only within the workflow editor.
Example
Order Menu Fetch Restaurant Menu Get Product Catalog
The walkthrough demonstrates renaming the default value to:
Order menu
before saving the configuration.
Is Catalog Available
The Is Catalog Available toggle confirms whether the catalog is accessible for fetching items from the API.
When enabled:
The chatbot retrieves live menu data
Menu items remain dynamically updated
Customers receive accurate item availability
The walkthrough demonstrates enabling the catalog availability toggle.
Variable Name
The Variable Name field specifies the variable that stores the extracted menu data.
To configure:
Open the Variable Name dropdown
Select the required variable
The walkthrough specifically selects:
orderMenuData
to store the menu response data.
Variable Path
The Variable Path field defines the JSON path where the menu items are located inside the API response.
Example
data.menuItems
This path helps the chatbot extract menu items correctly from the API response structure.
Variable Key for Retailer ID
The Variable Key for Retailer ID field identifies which retailer the menu belongs to.
Example
retailerId
This key helps associate the retrieved menu with the correct retailer or store.
Variable Key for Quantity
The Variable Key for Quantity field specifies the quantity attribute inside the API response.
Example
quantity
This value represents:
Available inventory or
Ordered item quantity
The walkthrough specifically notes that this field represents the number of items available or ordered.
Variable Key for Price
The Variable Key for Price field defines the individual item price key from the API response.
Example
price
The chatbot uses this field to retrieve pricing details for each menu item.
Grand Total
The Grand Total field specifies the variable used for the overall order amount.
Example
totalAmount
This field stores the complete order value calculated from all selected items.
Store Response in the Variable
The Store Response in the Variable field determines where the extracted menu response should be saved.
To configure:
Open the dropdown menu
Select an existing variable or
Create a new variable
The walkthrough demonstrates creating:
order_menu_response
as the response storage variable.
Creating a New Variable
If a response variable does not exist:
Click Create New Variable
Enter the variable name
Save the variable configuration
Example
order_menu_response
The walkthrough demonstrates creating this variable before finalizing the workflow.
Creating the Get Order Menu Action
After configuring all required fields:
Review the API mapping configuration
Click the Create button
The Get Order Menu node will now appear inside the workflow canvas.
Workflow Behavior
Once triggered, the Get Order Menu action:
Fetches live menu details from APIs
Retrieves real-time pricing and availability
Extracts order-related information dynamically
Stores structured order data in variables
Supports automated order processing workflows
The walkthrough specifically notes:
The Get Order Menu action dynamically retrieves real-time item details, prices, and availability from your API, ensuring customers always see an accurate and up-to-date menu.
Example Workflow
Example Chatbot Workflow
Customer Opens Menu ↓ Get Order Menu ↓ Retrieve API Menu Data ↓ Display Available Items
Example Interaction
Bot: 🍕 Today's Available Menu Pizza - ₹250 Burger - ₹120 Pasta - ₹180 Please select your items.
The chatbot dynamically retrieves and displays the latest menu information from the connected API.
Publishing the Bot Changes
After configuring the Get Order Menu workflow:
Review all mapping fields
Click the Publish button
Deploy the updated workflow to production
The final page of the walkthrough demonstrates publishing the configured Get Order Menu action successfully.
Best Practices
Follow these recommendations when using Get Order Menu.
Use accurate JSON paths
Ensure the Variable Path matches the API response structure.
Store menu data properly
Use meaningful variable names for menu responses.
Validate API responses
Confirm that menu items and pricing are returned correctly.
Keep pricing dynamic
Always fetch live pricing instead of hardcoding values.
Test menu retrieval workflows
Verify that the chatbot correctly extracts all order details before publishing.
Summary
The Get Order Menu action allows chatbot builders to dynamically retrieve and process real-time menu and order information from APIs.
With Get Order Menu, you can:
Fetch live menu items dynamically
Retrieve real-time pricing and availability
Extract structured order data from APIs
Store menu responses in variables
Automate ordering workflows inside chatbot conversations
This utility action helps businesses create powerful API-driven ordering experiences and real-time chatbot commerce workflows within Ownchat.
Last updated