Order menu item

Action ID
actions.intent.ORDER_MENU_ITEM
Description

Initiate an order for the specified menu item or cuisine type. Determine the menu item, if applicable. If the app serves more than one restaurant, determine the restaurant before the menu item.

We recommend that you specify entities for the menuItem.name parameter if you are developing single-restaurant apps (for example, an app for ordering from a national chain with a common menu), or apps that don't support menu search. If your menu items have add-ons, sizes, or other customizations, you currently need to provide a single entity for each unique combination.

Your app must confirm with the user before placing the order.

Locale support

Functionality Locales
Preview creation using App Actions test tool en-US, en-GB, en-CA, en-IN, en-BE, en-SG, en-AU, es-ES, pt-BR, id-ID
User invocation from Google Assistant en-US, en-GB, en-CA, en-IN, en-BE, en-SG, en-AU, es-ES, pt-BR, id-ID

Example queries

The following fields represent essential information that users often provide in queries that trigger this built-in intent:

menuItem.inMenuSection.inMenu.name
menuItem.inMenuSection.inMenu.forRestaurant.name
menuItem.name

Other supported fields

The following fields represent information that users often provide to disambiguate their needs or otherwise improve their results:

deliveryMethod
menuItem.@type
menuItem.inMenuSection.@type
menuItem.inMenuSection.inMenu.@type
menuItem.inMenuSection.inMenu.forRestaurant.@type
menuItem.inMenuSection.inMenu.forRestaurant.location.@type
menuItem.inMenuSection.inMenu.forRestaurant.location.geo.@type
menuItem.inMenuSection.inMenu.forRestaurant.location.geo.latitude
menuItem.inMenuSection.inMenu.forRestaurant.location.geo.longitude
menuItem.inMenuSection.inMenu.forRestaurant.location.name
menuItem.inMenuSection.inMenu.forRestaurant.servesCuisine
menuItem.inMenuSection.name

Supported text values by field








Inventory availability by field






Foreground app invocation

This built-in intent supports foreground app invocation.

Functionality Locales
Preview creation using App Actions test tool en-US, en-GB, en-CA, en-IN, en-BE, en-SG, en-AU
User invocation from Google Assistant

The following example queries are specific to intent matching for foreground app invocation:

Sample actions.xml

For information about the actions schema, read Create actions.xml.

Handle intent parameters as URL parameters

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
  <action intentName="actions.intent.ORDER_MENU_ITEM">
    <fulfillment urlTemplate="myapp://custom-deeplink{?deliveryMethodParam,menuItemName,inMenuSectionName,inMenuName,forRestaurantName,servesCuisine,locationName,latitude,longitude}">
      <!-- Eg. deliveryMethodParam = "DeliveryModeOwnFleet" -->
      <!-- (Optional) Require a field eg.deliveryMethodParam for fulfillment with required="true" -->
      <parameter-mapping urlParameter="deliveryMethodParam" intentParameter="deliveryMethod" required="true" />
      <!-- Eg. menuItemName = "pizza" -->
      <parameter-mapping urlParameter="menuItemName" intentParameter="menuItem.name" />
      <!-- Eg. inMenuSectionName = "dessert" -->
      <parameter-mapping urlParameter="inMenuSectionName" intentParameter="menuItem.inMenuSection.name" />
      <!-- Eg. inMenuName = "breakfast" -->
      <parameter-mapping urlParameter="inMenuName" intentParameter="menuItem.inMenuSection.inMenu.name" />
      <!-- Eg. forRestaurantName = "Example restaurant" -->
      <parameter-mapping urlParameter="forRestaurantName" intentParameter="menuItem.inMenuSection.inMenu.forRestaurant.name" />
      <!-- Eg. servesCuisine = "Example cuisine" -->
      <parameter-mapping urlParameter="servesCuisine" intentParameter="menuItem.inMenuSection.inMenu.forRestaurant.servesCuisine" />
      <!-- Eg. locationName = "brooklyn" -->
      <parameter-mapping urlParameter="locationName" intentParameter="menuItem.inMenuSection.inMenu.forRestaurant.location.name" />
      <!-- Eg. latitude = "40.6782" -->
      <parameter-mapping urlParameter="latitude" intentParameter="menuItem.inMenuSection.inMenu.forRestaurant.location.geo.latitude" />
      <!-- Eg. longitude = "-73.9442" -->
      <parameter-mapping urlParameter="longitude" intentParameter="menuItem.inMenuSection.inMenu.forRestaurant.location.geo.longitude" />
    </fulfillment>

    <!-- Provide a fallback fulfillment with no required parameters. For example, to your app search or router deeplink -->
    <fulfillment urlTemplate="myapp://deeplink" />
  </action>
</actions>

Use inline inventory to guide query matching

menuItem.inMenuSection.inMenu.name is a field that supports inline inventory. By defining an <entity-set> for menuItem.inMenuSection.inMenu.name, you can uniquely identify entities that are of interest to your app or restrict fulfillment to the set of supported entities.

In the following example, when the user query matches the inMenuName_one entity, Assistant provides the associated identifier, ID_ONE, as the URL parameter inMenuName to fulfillment.

If there is no inventory match, the text value received in the query for menuItem.inMenuSection.inMenu.name is passed as-is.

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
  <action intentName="actions.intent.ORDER_MENU_ITEM">
    <fulfillment urlTemplate="myapp://deeplink{?inMenuName}" >
      <!-- inMenuName = "ID_ONE" or "ID_TWO"  -->
      <!-- If no inventory match, inMenuName is a text value, such as "breakfast" -->
      <!-- (Optional) Use entityMatchRequired="true" to require inventory match for fulfillment -->
      <parameter-mapping urlParameter="inMenuName" intentParameter="menuItem.inMenuSection.inMenu.name" />
    </fulfillment>

    <!-- Define parameters with inventories here -->
    <parameter name="menuItem.inMenuSection.inMenu.name">
      <entity-set-reference entitySetId="inMenuNameEntitySet"/>
    </parameter>
  </action>

  <entity-set entitySetId="inMenuNameEntitySet">
    <!-- Provide an identifier per entity -->
    <entity identifier="ID_ONE" name="inMenuName_one" alternateName="@array/inMenuName_one_synonyms"/>
    <entity identifier="ID_TWO" name="inMenuName_two" alternateName="@array/inMenuName_two_synonyms"/>
  </entity-set>
</actions>

Derive fulfillment URL using inline inventory

The url attribute associated with the entity can be used to determine the fulfillment URL if there is an inventory match. In the following example, when the user query matches the inMenuName_one entity, Assistant provides myapp://deeplink/one as the fulfillment URL.

  <?xml version="1.0" encoding="utf-8"?>
  <!-- This is a sample actions.xml -->
  <actions>
    <action intentName="actions.intent.ORDER_MENU_ITEM">
      <!-- Use url from inventory match for deep link fulfillment -->
      <fulfillment urlTemplate="{@url}" />

      <!-- Provide a fallback fulfillment with no required parameters. For example, to your app search or router deeplink -->
      <fulfillment urlTemplate="myapp://deeplink" />

      <!-- Define parameters with inventories here -->
      <parameter name="menuItem.inMenuSection.inMenu.name">
        <entity-set-reference entitySetId="inMenuNameEntitySet"/>
      </parameter>
    </action>

    <entity-set entitySetId="inMenuNameEntitySet">
      <!-- Provide a URL per entity -->
      <entity url="myapp://deeplink/one" name="inMenuName_one" alternateName="@array/inMenuName_one_synonyms"/>
      <entity url="myapp://deeplink/two" name="inMenuName_two" alternateName="@array/inMenuName_two_synonyms"/>
    </entity-set>
  </actions>
  

Use web inventory to discover URLs for fulfillment

menuItem.name is a field that supports web inventory. In the following example, Google Assistant performs a web search for the user query and determines the fulfillment URL. Assistant filters for search results that match the provided urlFilter value of https://www.mywebsite.com/link1/.*.

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
  <action intentName="actions.intent.ORDER_MENU_ITEM">
    <!-- Use URL from entity match for deep link fulfillment -->
    <!-- Example: url = 'https://www.mywebsite.com/link1/item1' -->
    <fulfillment urlTemplate="{@url}" />

    <!-- Provide a fallback fulfillment with no required parameters. For example, to your app search or router deeplink -->
    <fulfillment urlTemplate="myapp://deeplink" />

    <!-- Define parameters with web inventories using urlFilter -->
    <parameter name="menuItem.name">
      <entity-set-reference urlFilter="https://www.mywebsite.com/link1/.*" />"/>
    </parameter>
  </action>
</actions>

JSON-LD sample

The following JSON-LD sample provides some example values that you can use in the App Actions test tool:

{
  "@context": "http://schema.googleapis.com",
  "@type": "MenuItem",
  "inMenuSection": {
    "@type": "MenuSection",
    "inMenu": {
      "@type": "Menu",
      "forRestaurant": {
        "@type": "Restaurant",
        "location": {
          "@type": "Place",
          "geo": {
            "@type": "GeoCoordinates",
            "latitude": "40.6782",
            "longitude": "-73.9442"
          },
          "name": "brooklyn"
        },
        "name": "Example restaurant",
        "servesCuisine": "Example cuisine"
      },
      "name": "breakfast"
    },
    "name": "dessert"
  },
  "name": "pizza"
}
"DeliveryModeOwnFleet"