Data Management | Getting Started

Create a Menu Using Data Management Menu Features

Describes the methods used to retrieve menu data and define the data objects Data Management uses for menu elements.

Create a Menu from Data Management Product Objects

Describes how to use the Online Ordering product resource to get details about products and how to organize those products into a typical online menu structure.

effective_date

Defines the valid, effective date of returned entities. For /current routes, the effective_date returns entities dated on the specified date. For /list routes, the effective_date returns entities dated after the specified date.

Example:

effective_date=20YY-07-26T14:04:42.766Z

$filter

The response only includes entities matching the criteria defined by the $filter.

Example:

$filter=product_entity_id eq objectid(586e6e9fc21cbd000119bd14)

$top

Defines the number of returned entities. Useful for navigating large data sets.

Example:

$top=10

$skip

Defines the number of entities to skip before returning entities. Useful for navigating large data sets.

Example:

$skip=10

$orderby

Defines the data sorting property. Useful for locating recent updates or new menu items.

Example:

$orderby=last_updated desc

include_entities

Defines the properties of the returned entities. Useful for retrieving specific entities. For example, using include_entities['product_price'] in a /product request returns the product definition and price details.

Example:

include_entities=['product-price','time-period']

entity_ids

Defines the ID of the returned entities. Useful for locating specific menu pages or add-on items.

Example:

entity_ids=['5a591e77fcacfe00019a8067','5a591ae8fcacfe00019a802e']

/master

The /master route returns a list of valid entities independent of site. Sometimes, variations of the entities are displayed based on specific dates. The example is a request to the /product/master endpoint:

{{dm_url}}/product/master

/current

The /current route returns a list of valid entities dated on the requested date, for specified sites. The example is the expected date format for the /current route:

{{dm_url}}/product/current?effective_date=20YY-07-26T14:04:42.766Z

/list

The /list route returns a list of valid entities dated after the specified date. An effective_date parameter is required. Use the /list route to get properties required to build menus that take effect in the future, such as upcoming promotions. The example is a /list route request with the required effective_date parameter:

{{dm_url}}/product/list?effective_date=20YY-07-26T14:04:42.766Z