> For the complete documentation index, see [llms.txt](https://docs.ownchat.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ownchat.app/bot/utility/get-order-menu.md).

# 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.

{% embed url="<https://app.supademo.com/demo/cmn4hyq1h1cbtz3qmoigy5ah8?utm_source=link>" %}

### When to Use Get Order Menu &#x20;

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 &#x20;

* Restaurant order menus
* E-commerce product catalogs
* Real-time inventory display
* Dynamic pricing workflows
* Order processing automation
* Shopping cart integrations

**Example Interaction**&#x20;

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 &#x20;

Follow these steps to add the **Get Order Menu** action to your bot workflow.

1. Open **Bot Builder**
2. Click the **Add Node button**
3. Open the **Utilities** tab
4. Select **Get Order Menu**
5. Configure the API response mapping fields
6. Configure response variables
7. Click **Create**
8. Click **Publish** to deploy the workflow

The walkthrough demonstrates selecting the Get Order Menu action from the Utilities section.

### Accessing the Utilities Section &#x20;

To access the Get Order Menu action:

1. Click **Add Node**<br>

{% embed url="<https://app.supademo.com/demo/cmpb4d9as000mxy0jkhnsxvel?utm_source=link>" %}

2. Open the action panel
3. Click the Utilities tab

The Utilities section contains advanced workflow and automation actions.

### Selecting Get Order Menu &#x20;

Inside the Utilities tab:

1. Locate **Get Order Menu**<br>

{% embed url="<https://app.supademo.com/demo/cmpb4fmpa00qvu40j63rqnqb3?utm_source=link>" %}

2. 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 &#x20;

When configuring the Get Order Menu action, several fields must be completed.

### Action Name &#x20;

The **Action Name** identifies the order menu workflow inside the bot builder.<br>

{% embed url="<https://app.supademo.com/demo/cmpb4hdbt08jyxa0jpht692iv?utm_source=link>" %}

This name is visible only within the workflow editor.

**Example** &#x20;

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 &#x20;

The **Is Catalog Available** toggle confirms whether the catalog is accessible for fetching items from the API.[<br>](https://app.supademo.com/demo/cmpb4ibzz08kcxa0jntry81zi?utm_source=link)

{% embed url="<https://app.supademo.com/demo/cmpb4ibzz08kcxa0jntry81zi?utm_source=link>" %}

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 &#x20;

The **Variable Name** field specifies the variable that stores the extracted menu data.

To configure:

1. Open the Variable Name dropdown
2. Select the required variable

The walkthrough specifically selects:

orderMenuData

to store the menu response data.<br>

{% embed url="<https://app.supademo.com/demo/cmpb4j6kx08klxa0jbg2rd63s?utm_source=link>" %}

### Variable Path &#x20;

The **Variable Path** field defines the JSON path where the menu items are located inside the API response.<br>

{% embed url="<https://app.supademo.com/demo/cmpb4kbx90017xy0jsz4qh3a5?utm_source=link>" %}

**Example** &#x20;

data.menuItems

This path helps the chatbot extract menu items correctly from the API response structure.

### Variable Key for Retailer ID &#x20;

The **Variable Key for Retailer ID** field identifies which retailer the menu belongs to.<br>

{% embed url="<https://app.supademo.com/demo/cmpb4lo3a00qyu40jozm5vr1l?utm_source=link>" %}

**Example** &#x20;

retailerId

This key helps associate the retrieved menu with the correct retailer or store.

### Variable Key for Quantity &#x20;

The **Variable Key for Quantity** field specifies the quantity attribute inside the API response.<br>

{% embed url="<https://app.supademo.com/demo/cmpb4mpj3002sy60jcxhp5i0i?utm_source=link>" %}

**Example** &#x20;

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 &#x20;

The **Variable Key for Price** field defines the individual item price key from the API response.<br>

{% embed url="<https://app.supademo.com/demo/cmpb4nveg001bxy0j6a5ahzsi?utm_source=link>" %}

**Example** &#x20;

price

The chatbot uses this field to retrieve pricing details for each menu item.

### Grand Total &#x20;

The **Grand Total** field specifies the variable used for the overall order amount.<br>

{% embed url="<https://app.supademo.com/demo/cmpb4os6o001dxy0jzsge7sld?utm_source=link>" %}

Example &#x20;

totalAmount

This field stores the complete order value calculated from all selected items.

### Store Response in the Variable &#x20;

The **Store Response in the Variable** field determines where the extracted menu response should be saved.

To configure:

1. Open the dropdown menu
2. Select an existing variable\
   or
3. Create a new variable\ <br>

{% embed url="<https://app.supademo.com/demo/cmpb4q98t08knxa0jcitntdvp?utm_source=link>" %}

The walkthrough demonstrates creating:

order\_menu\_response

as the response storage variable.

### Creating a New Variable &#x20;

If a response variable does not exist:

1. Click **Create New Variable**
2. Enter the variable name
3. Save the variable configuration

**Example** &#x20;

order\_menu\_response

The walkthrough demonstrates creating this variable before finalizing the workflow.

### Creating the Get Order Menu Action &#x20;

After configuring all required fields:

1. Review the API mapping configuration
2. Click the **Create** button<br>

{% embed url="<https://app.supademo.com/demo/cmpb4s4pj001fxy0jyt677zx2?utm_source=link>" %}

The Get Order Menu node will now appear inside the workflow canvas.

### Workflow Behavior &#x20;

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 &#x20;

**Example Chatbot Workflow** &#x20;

Customer Opens Menu\
&#x20;       ↓\
Get Order Menu\
&#x20;       ↓\
Retrieve API Menu Data\
&#x20;       ↓\
Display Available Items

**Example Interaction** &#x20;

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 &#x20;

After configuring the Get Order Menu workflow:

1. Review all mapping fields
2. Click the **Publish** button
3. Deploy the updated workflow to production<br>

{% embed url="<https://app.supademo.com/demo/cmpb4t47507hxz80jhfvs71zd?utm_source=link>" %}

The final page of the walkthrough demonstrates publishing the configured Get Order Menu action successfully.

### Best Practices &#x20;

Follow these recommendations when using **Get Order Menu.**

#### Use accurate JSON paths &#x20;

Ensure the Variable Path matches the API response structure.

#### Store menu data properly &#x20;

Use meaningful variable names for menu responses.

#### Validate API responses &#x20;

Confirm that menu items and pricing are returned correctly.

#### Keep pricing dynamic &#x20;

Always fetch live pricing instead of hardcoding values.

#### Test menu retrieval workflows &#x20;

Verify that the chatbot correctly extracts all order details before publishing.

### Summary &#x20;

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.**