EveryBite Public API

Welcome to the official EveryBite Public API documentation!

Contact

API Support

http://www.example.com/support

License

ISC

Terms of Service

https://www.example.com/terms

API Endpoints
https://api.everybite-stage.com/graphql

Queries

chain

Description

Returns info about the chain.

Response

Returns a Chain!

Example

Query
query chain {
  chain {
    id
    name
    restaurants {
      ...RestaurantConnectionFragment
    }
  }
}
Response
{
  "data": {
    "chain": {
      "id": "4",
      "name": "abc123",
      "restaurants": RestaurantConnection
    }
  }
}
Queries

dish

Description

Returns info about a specific dish in a chains restaurant location.

Response

Returns a Dish!

Arguments
Name Description
input - DishInput!

Example

Query
query dish($input: DishInput!) {
  dish(input: $input) {
    id
    name
    description
    imageUrl
    caloriesTotal
    caloriesFromFat
    fatTotal
    fatSaturated
    fatTrans
    cholesterol
    sodium
    dietaryFiber
    carbohydrates
    sugar
    protein
    vitaminA
    vitaminC
    calcium
    iron
    servingSize
    servingSizeInGrams
    createdAt
    updatedAt
    cuisines {
      ...CuisineFragment
    }
    allergens {
      ...AllergenFragment
    }
    diets {
      ...DietFragment
    }
    preparationTypes {
      ...PreparationTypeFragment
    }
    styles {
      ...StyleFragment
    }
    addedIngredients {
      ...IngredientFragment
    }
    removedIngredients {
      ...IngredientFragment
    }
    substitutions {
      ...DishFragment
    }
    menu {
      ...MenuFragment
    }
  }
}
Variables
{"input": DishInput}
Response
{
  "data": {
    "dish": {
      "id": "4",
      "name": "xyz789",
      "description": "abc123",
      "imageUrl": "xyz789",
      "caloriesTotal": "abc123",
      "caloriesFromFat": "abc123",
      "fatTotal": "xyz789",
      "fatSaturated": "xyz789",
      "fatTrans": "xyz789",
      "cholesterol": "abc123",
      "sodium": "xyz789",
      "dietaryFiber": "xyz789",
      "carbohydrates": "xyz789",
      "sugar": "abc123",
      "protein": "abc123",
      "vitaminA": "xyz789",
      "vitaminC": "abc123",
      "calcium": "xyz789",
      "iron": "abc123",
      "servingSize": "xyz789",
      "servingSizeInGrams": 987.65,
      "createdAt": "2007-12-03T10:15:30Z",
      "updatedAt": "2007-12-03T10:15:30Z",
      "cuisines": [Cuisine],
      "allergens": [Allergen],
      "diets": [Diet],
      "preparationTypes": [PreparationType],
      "styles": [Style],
      "addedIngredients": [Ingredient],
      "removedIngredients": [Ingredient],
      "substitutions": [Dish],
      "menu": Menu
    }
  }
}
Queries

restaurant

Description

Returns info about a specific chain restaurant location.

Response

Returns a Restaurant!

Arguments
Name Description
id - ID!

Example

Query
query restaurant($id: ID!) {
  restaurant(id: $id) {
    id
    street
    city
    zipCode
    state
    stateCode
    country
    countryCode
    latitude
    longitude
    phoneNumber
    logoUrl
    websiteUrl
    isPermanentlyClosed
    description
    createdAt
    updatedAt
    operatingHours {
      ...WorkingHoursFragment
    }
    menus {
      ...MenuFragment
    }
    cuisines {
      ...CuisineFragment
    }
    dishes {
      ...DishConnectionFragment
    }
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "restaurant": {
      "id": "4",
      "street": "abc123",
      "city": "xyz789",
      "zipCode": "xyz789",
      "state": "xyz789",
      "stateCode": "abc123",
      "country": "abc123",
      "countryCode": "xyz789",
      "latitude": 123.45,
      "longitude": 123.45,
      "phoneNumber": "abc123",
      "logoUrl": "xyz789",
      "websiteUrl": "abc123",
      "isPermanentlyClosed": true,
      "description": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "updatedAt": "2007-12-03T10:15:30Z",
      "operatingHours": [WorkingHours],
      "menus": [Menu],
      "cuisines": [Cuisine],
      "dishes": DishConnection
    }
  }
}
Queries

widget

Description

Returns a single widget.

Response

Returns a Widget!

Arguments
Name Description
id - ID!

Example

Query
query widget($id: ID!) {
  widget(id: $id) {
    id
    name
    slug
    orderUrl
    createdAt
    updatedAt
    publishedAt
    lastSyncedAt
    isActive
    isSyncEnabled
    backgroundColor
    highlightColor
    primaryBrandColor
    fontFamily
    layout
    displayImages
    displayFeedbackButton
    displaySoftSignUp
    displayDishDetailsLink
    displayGiveFeedbackBanner
    displayNotifyMeBanner
    displayIngredients
    displayMacronutrients
    displayNutrientPreferences
    isByoEnabled
    isOrderButtonEnabled
    usePagination
    displayFooter
    displayNavbar
    supportedDietaryPreferences
    supportedAllergens
    navbarFont
    navbarFontSize
    navbarBackgroundColor
    logoUrl
    logoWidth
    faviconUrl
    htmlTitleText
    pageTitleText
    pageTitleTextColor
    menuItems {
      ...MenuItemFragment
    }
    menuItemsTextColor
    menuItemsTextHoverColor
    buttonFont
    buttonBackgroundColor
    buttonTextColor
    buttonBorderRadius
    subheaderFont
    subheaderLocationTextColor
    subheaderAdditionalTextColor
    contentAreaGlobalColor
    contentAreaColumnHeaderColor
    categoryTitleFont
    categoryTitleTextColor
    footerText
    numberOfLocations
    numberOfLocationsSource
    widgetLogoUrl
    widgetUrl
    banners {
      ...BannerFragment
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "widget": {
      "id": "4",
      "name": "string",
      "slug": Slug,
      "orderUrl": "http://www.test.com/",
      "createdAt": "2007-12-03T10:15:30Z",
      "updatedAt": "2007-12-03T10:15:30Z",
      "publishedAt": "2007-12-03T10:15:30Z",
      "lastSyncedAt": "2007-12-03T10:15:30Z",
      "isActive": true,
      "isSyncEnabled": true,
      "backgroundColor": Color,
      "highlightColor": Color,
      "primaryBrandColor": Color,
      "fontFamily": Font,
      "layout": "Table",
      "displayImages": true,
      "displayFeedbackButton": true,
      "displaySoftSignUp": true,
      "displayDishDetailsLink": false,
      "displayGiveFeedbackBanner": true,
      "displayNotifyMeBanner": false,
      "displayIngredients": true,
      "displayMacronutrients": false,
      "displayNutrientPreferences": false,
      "isByoEnabled": true,
      "isOrderButtonEnabled": true,
      "usePagination": true,
      "displayFooter": false,
      "displayNavbar": true,
      "supportedDietaryPreferences": ["Vegan"],
      "supportedAllergens": ["Dairy"],
      "navbarFont": Font,
      "navbarFontSize": 123,
      "navbarBackgroundColor": Color,
      "logoUrl": "http://www.test.com/",
      "logoWidth": 987,
      "faviconUrl": "http://www.test.com/",
      "htmlTitleText": "string",
      "pageTitleText": "string",
      "pageTitleTextColor": Color,
      "menuItems": [MenuItem],
      "menuItemsTextColor": Color,
      "menuItemsTextHoverColor": Color,
      "buttonFont": Font,
      "buttonBackgroundColor": Color,
      "buttonTextColor": Color,
      "buttonBorderRadius": 987,
      "subheaderFont": Font,
      "subheaderLocationTextColor": Color,
      "subheaderAdditionalTextColor": Color,
      "contentAreaGlobalColor": Color,
      "contentAreaColumnHeaderColor": Color,
      "categoryTitleFont": Font,
      "categoryTitleTextColor": Color,
      "footerText": "xyz789",
      "numberOfLocations": 987,
      "numberOfLocationsSource": "abc123",
      "widgetLogoUrl": "http://www.test.com/",
      "widgetUrl": "http://www.test.com/",
      "banners": [Banner]
    }
  }
}
Queries

widgetAllergens

Description

Returns the allergens configuration for a specific widget. This includes which allergen filters are enabled and available.

Response

Returns [WidgetAllergen!]!

Arguments
Name Description
widgetId - ID!

Example

Query
query widgetAllergens($widgetId: ID!) {
  widgetAllergens(widgetId: $widgetId) {
    type
    displayName
    description
    isEnabled
    ordinal
    icon
  }
}
Variables
{"widgetId": "4"}
Response
{
  "data": {
    "widgetAllergens": [
      {
        "type": "Dairy",
        "displayName": "xyz789",
        "description": "abc123",
        "isEnabled": false,
        "ordinal": 123,
        "icon": "abc123"
      }
    ]
  }
}
Queries

widgetCategories

Description

Returns available menu categories for a widget, optionally filtered by restaurant.

Response

Returns [WidgetCategory!]!

Arguments
Name Description
widgetId - ID!
restaurantId - ID

Example

Query
query widgetCategories(
  $widgetId: ID!,
  $restaurantId: ID
) {
  widgetCategories(
    widgetId: $widgetId,
    restaurantId: $restaurantId
  ) {
    name
    count
    ordinal
  }
}
Variables
{"widgetId": "4", "restaurantId": 4}
Response
{
  "data": {
    "widgetCategories": [
      {
        "name": "abc123",
        "count": 987,
        "ordinal": 987
      }
    ]
  }
}
Queries

widgetDietaryPreferences

Description

Returns the dietary preferences configuration for a specific widget. This includes which dietary preference filters are enabled and available.

Response

Returns [WidgetDietaryPreference!]!

Arguments
Name Description
widgetId - ID!

Example

Query
query widgetDietaryPreferences($widgetId: ID!) {
  widgetDietaryPreferences(widgetId: $widgetId) {
    type
    displayName
    description
    isEnabled
    ordinal
  }
}
Variables
{"widgetId": 4}
Response
{
  "data": {
    "widgetDietaryPreferences": [
      {
        "type": "Vegan",
        "displayName": "abc123",
        "description": "abc123",
        "isEnabled": false,
        "ordinal": 987
      }
    ]
  }
}
Queries

widgetDishes

Description

Returns dishes for a specific widget with advanced filtering and search capabilities. Supports pagination, search, dietary filters, allergen exclusions, and nutrient ranges.

Response

Returns a WidgetDishConnection!

Arguments
Name Description
widgetId - ID!
criteria - WidgetDishCriteria
pagination - PaginationArgs
sortBy - DishSortBy Default = Featured

Example

Query
query widgetDishes(
  $widgetId: ID!,
  $criteria: WidgetDishCriteria,
  $pagination: PaginationArgs,
  $sortBy: DishSortBy
) {
  widgetDishes(
    widgetId: $widgetId,
    criteria: $criteria,
    pagination: $pagination,
    sortBy: $sortBy
  ) {
    edges {
      ...WidgetDishEdgeFragment
    }
    nodes {
      ...DishFragment
    }
    total
    matchesCount
    partialMatchesCount
    pageInfo {
      ...PageInfoFragment
    }
  }
}
Variables
{
  "widgetId": 4,
  "criteria": WidgetDishCriteria,
  "pagination": PaginationArgs,
  "sortBy": "Featured"
}
Response
{
  "data": {
    "widgetDishes": {
      "edges": [WidgetDishEdge],
      "nodes": [Dish],
      "total": 987,
      "matchesCount": 123,
      "partialMatchesCount": 123,
      "pageInfo": PageInfo
    }
  }
}
Queries

widgetDishesCount

Description

Returns the total count of dishes matching the given criteria. Useful for displaying result counts before pagination.

Response

Returns an Int!

Arguments
Name Description
widgetId - ID!
criteria - WidgetDishCriteria

Example

Query
query widgetDishesCount(
  $widgetId: ID!,
  $criteria: WidgetDishCriteria
) {
  widgetDishesCount(
    widgetId: $widgetId,
    criteria: $criteria
  )
}
Variables
{
  "widgetId": "4",
  "criteria": WidgetDishCriteria
}
Response
{"data": {"widgetDishesCount": 987}}
Queries

widgetNutrientPreferences

Description

Returns the nutrient preferences configuration for a specific widget. This includes which nutrient filters are enabled and their default ranges.

Response

Returns [WidgetNutrientPreference!]!

Arguments
Name Description
widgetId - ID!

Example

Query
query widgetNutrientPreferences($widgetId: ID!) {
  widgetNutrientPreferences(widgetId: $widgetId) {
    nutrientType
    displayName
    unit
    isEnabled
    defaultMin
    defaultMax
    recommendedMin
    recommendedMax
    ordinal
  }
}
Variables
{"widgetId": 4}
Response
{
  "data": {
    "widgetNutrientPreferences": [
      {
        "nutrientType": "Calories",
        "displayName": "abc123",
        "unit": "xyz789",
        "isEnabled": false,
        "defaultMin": 123.45,
        "defaultMax": 123.45,
        "recommendedMin": 123.45,
        "recommendedMax": 987.65,
        "ordinal": 987
      }
    ]
  }
}
Queries

widgets

Description

Returns available widgets.

Response

Returns [Widget]!

Arguments
Name Description
term - String

Example

Query
query widgets($term: String) {
  widgets(term: $term) {
    id
    name
    slug
    orderUrl
    createdAt
    updatedAt
    publishedAt
    lastSyncedAt
    isActive
    isSyncEnabled
    backgroundColor
    highlightColor
    primaryBrandColor
    fontFamily
    layout
    displayImages
    displayFeedbackButton
    displaySoftSignUp
    displayDishDetailsLink
    displayGiveFeedbackBanner
    displayNotifyMeBanner
    displayIngredients
    displayMacronutrients
    displayNutrientPreferences
    isByoEnabled
    isOrderButtonEnabled
    usePagination
    displayFooter
    displayNavbar
    supportedDietaryPreferences
    supportedAllergens
    navbarFont
    navbarFontSize
    navbarBackgroundColor
    logoUrl
    logoWidth
    faviconUrl
    htmlTitleText
    pageTitleText
    pageTitleTextColor
    menuItems {
      ...MenuItemFragment
    }
    menuItemsTextColor
    menuItemsTextHoverColor
    buttonFont
    buttonBackgroundColor
    buttonTextColor
    buttonBorderRadius
    subheaderFont
    subheaderLocationTextColor
    subheaderAdditionalTextColor
    contentAreaGlobalColor
    contentAreaColumnHeaderColor
    categoryTitleFont
    categoryTitleTextColor
    footerText
    numberOfLocations
    numberOfLocationsSource
    widgetLogoUrl
    widgetUrl
    banners {
      ...BannerFragment
    }
  }
}
Variables
{"term": "xyz789"}
Response
{
  "data": {
    "widgets": [
      {
        "id": 4,
        "name": "string",
        "slug": Slug,
        "orderUrl": "http://www.test.com/",
        "createdAt": "2007-12-03T10:15:30Z",
        "updatedAt": "2007-12-03T10:15:30Z",
        "publishedAt": "2007-12-03T10:15:30Z",
        "lastSyncedAt": "2007-12-03T10:15:30Z",
        "isActive": true,
        "isSyncEnabled": true,
        "backgroundColor": Color,
        "highlightColor": Color,
        "primaryBrandColor": Color,
        "fontFamily": Font,
        "layout": "Table",
        "displayImages": true,
        "displayFeedbackButton": false,
        "displaySoftSignUp": true,
        "displayDishDetailsLink": true,
        "displayGiveFeedbackBanner": true,
        "displayNotifyMeBanner": true,
        "displayIngredients": false,
        "displayMacronutrients": false,
        "displayNutrientPreferences": true,
        "isByoEnabled": false,
        "isOrderButtonEnabled": false,
        "usePagination": true,
        "displayFooter": false,
        "displayNavbar": false,
        "supportedDietaryPreferences": ["Vegan"],
        "supportedAllergens": ["Dairy"],
        "navbarFont": Font,
        "navbarFontSize": 987,
        "navbarBackgroundColor": Color,
        "logoUrl": "http://www.test.com/",
        "logoWidth": 987,
        "faviconUrl": "http://www.test.com/",
        "htmlTitleText": "string",
        "pageTitleText": "string",
        "pageTitleTextColor": Color,
        "menuItems": [MenuItem],
        "menuItemsTextColor": Color,
        "menuItemsTextHoverColor": Color,
        "buttonFont": Font,
        "buttonBackgroundColor": Color,
        "buttonTextColor": Color,
        "buttonBorderRadius": 123,
        "subheaderFont": Font,
        "subheaderLocationTextColor": Color,
        "subheaderAdditionalTextColor": Color,
        "contentAreaGlobalColor": Color,
        "contentAreaColumnHeaderColor": Color,
        "categoryTitleFont": Font,
        "categoryTitleTextColor": Color,
        "footerText": "abc123",
        "numberOfLocations": 123,
        "numberOfLocationsSource": "abc123",
        "widgetLogoUrl": "http://www.test.com/",
        "widgetUrl": "http://www.test.com/",
        "banners": [Banner]
      }
    ]
  }
}

Mutations

activateWidget

Description

Activates a widget, making it publicly accessible.

Response

Returns a Widget

Arguments
Name Description
id - ID!

Example

Query
mutation activateWidget($id: ID!) {
  activateWidget(id: $id) {
    id
    name
    slug
    orderUrl
    createdAt
    updatedAt
    publishedAt
    lastSyncedAt
    isActive
    isSyncEnabled
    backgroundColor
    highlightColor
    primaryBrandColor
    fontFamily
    layout
    displayImages
    displayFeedbackButton
    displaySoftSignUp
    displayDishDetailsLink
    displayGiveFeedbackBanner
    displayNotifyMeBanner
    displayIngredients
    displayMacronutrients
    displayNutrientPreferences
    isByoEnabled
    isOrderButtonEnabled
    usePagination
    displayFooter
    displayNavbar
    supportedDietaryPreferences
    supportedAllergens
    navbarFont
    navbarFontSize
    navbarBackgroundColor
    logoUrl
    logoWidth
    faviconUrl
    htmlTitleText
    pageTitleText
    pageTitleTextColor
    menuItems {
      ...MenuItemFragment
    }
    menuItemsTextColor
    menuItemsTextHoverColor
    buttonFont
    buttonBackgroundColor
    buttonTextColor
    buttonBorderRadius
    subheaderFont
    subheaderLocationTextColor
    subheaderAdditionalTextColor
    contentAreaGlobalColor
    contentAreaColumnHeaderColor
    categoryTitleFont
    categoryTitleTextColor
    footerText
    numberOfLocations
    numberOfLocationsSource
    widgetLogoUrl
    widgetUrl
    banners {
      ...BannerFragment
    }
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "activateWidget": {
      "id": "4",
      "name": "string",
      "slug": Slug,
      "orderUrl": "http://www.test.com/",
      "createdAt": "2007-12-03T10:15:30Z",
      "updatedAt": "2007-12-03T10:15:30Z",
      "publishedAt": "2007-12-03T10:15:30Z",
      "lastSyncedAt": "2007-12-03T10:15:30Z",
      "isActive": false,
      "isSyncEnabled": false,
      "backgroundColor": Color,
      "highlightColor": Color,
      "primaryBrandColor": Color,
      "fontFamily": Font,
      "layout": "Table",
      "displayImages": true,
      "displayFeedbackButton": true,
      "displaySoftSignUp": true,
      "displayDishDetailsLink": false,
      "displayGiveFeedbackBanner": false,
      "displayNotifyMeBanner": false,
      "displayIngredients": false,
      "displayMacronutrients": false,
      "displayNutrientPreferences": false,
      "isByoEnabled": false,
      "isOrderButtonEnabled": true,
      "usePagination": true,
      "displayFooter": false,
      "displayNavbar": false,
      "supportedDietaryPreferences": ["Vegan"],
      "supportedAllergens": ["Dairy"],
      "navbarFont": Font,
      "navbarFontSize": 123,
      "navbarBackgroundColor": Color,
      "logoUrl": "http://www.test.com/",
      "logoWidth": 987,
      "faviconUrl": "http://www.test.com/",
      "htmlTitleText": "string",
      "pageTitleText": "string",
      "pageTitleTextColor": Color,
      "menuItems": [MenuItem],
      "menuItemsTextColor": Color,
      "menuItemsTextHoverColor": Color,
      "buttonFont": Font,
      "buttonBackgroundColor": Color,
      "buttonTextColor": Color,
      "buttonBorderRadius": 123,
      "subheaderFont": Font,
      "subheaderLocationTextColor": Color,
      "subheaderAdditionalTextColor": Color,
      "contentAreaGlobalColor": Color,
      "contentAreaColumnHeaderColor": Color,
      "categoryTitleFont": Font,
      "categoryTitleTextColor": Color,
      "footerText": "xyz789",
      "numberOfLocations": 123,
      "numberOfLocationsSource": "xyz789",
      "widgetLogoUrl": "http://www.test.com/",
      "widgetUrl": "http://www.test.com/",
      "banners": [Banner]
    }
  }
}
Mutations

activateWidgetSync

Description

Activates a widget synchronously with validation.

Response

Returns a Widget

Arguments
Name Description
id - ID!

Example

Query
mutation activateWidgetSync($id: ID!) {
  activateWidgetSync(id: $id) {
    id
    name
    slug
    orderUrl
    createdAt
    updatedAt
    publishedAt
    lastSyncedAt
    isActive
    isSyncEnabled
    backgroundColor
    highlightColor
    primaryBrandColor
    fontFamily
    layout
    displayImages
    displayFeedbackButton
    displaySoftSignUp
    displayDishDetailsLink
    displayGiveFeedbackBanner
    displayNotifyMeBanner
    displayIngredients
    displayMacronutrients
    displayNutrientPreferences
    isByoEnabled
    isOrderButtonEnabled
    usePagination
    displayFooter
    displayNavbar
    supportedDietaryPreferences
    supportedAllergens
    navbarFont
    navbarFontSize
    navbarBackgroundColor
    logoUrl
    logoWidth
    faviconUrl
    htmlTitleText
    pageTitleText
    pageTitleTextColor
    menuItems {
      ...MenuItemFragment
    }
    menuItemsTextColor
    menuItemsTextHoverColor
    buttonFont
    buttonBackgroundColor
    buttonTextColor
    buttonBorderRadius
    subheaderFont
    subheaderLocationTextColor
    subheaderAdditionalTextColor
    contentAreaGlobalColor
    contentAreaColumnHeaderColor
    categoryTitleFont
    categoryTitleTextColor
    footerText
    numberOfLocations
    numberOfLocationsSource
    widgetLogoUrl
    widgetUrl
    banners {
      ...BannerFragment
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "activateWidgetSync": {
      "id": 4,
      "name": "string",
      "slug": Slug,
      "orderUrl": "http://www.test.com/",
      "createdAt": "2007-12-03T10:15:30Z",
      "updatedAt": "2007-12-03T10:15:30Z",
      "publishedAt": "2007-12-03T10:15:30Z",
      "lastSyncedAt": "2007-12-03T10:15:30Z",
      "isActive": true,
      "isSyncEnabled": false,
      "backgroundColor": Color,
      "highlightColor": Color,
      "primaryBrandColor": Color,
      "fontFamily": Font,
      "layout": "Table",
      "displayImages": false,
      "displayFeedbackButton": false,
      "displaySoftSignUp": true,
      "displayDishDetailsLink": true,
      "displayGiveFeedbackBanner": true,
      "displayNotifyMeBanner": true,
      "displayIngredients": true,
      "displayMacronutrients": false,
      "displayNutrientPreferences": false,
      "isByoEnabled": true,
      "isOrderButtonEnabled": false,
      "usePagination": false,
      "displayFooter": true,
      "displayNavbar": true,
      "supportedDietaryPreferences": ["Vegan"],
      "supportedAllergens": ["Dairy"],
      "navbarFont": Font,
      "navbarFontSize": 987,
      "navbarBackgroundColor": Color,
      "logoUrl": "http://www.test.com/",
      "logoWidth": 123,
      "faviconUrl": "http://www.test.com/",
      "htmlTitleText": "string",
      "pageTitleText": "string",
      "pageTitleTextColor": Color,
      "menuItems": [MenuItem],
      "menuItemsTextColor": Color,
      "menuItemsTextHoverColor": Color,
      "buttonFont": Font,
      "buttonBackgroundColor": Color,
      "buttonTextColor": Color,
      "buttonBorderRadius": 123,
      "subheaderFont": Font,
      "subheaderLocationTextColor": Color,
      "subheaderAdditionalTextColor": Color,
      "contentAreaGlobalColor": Color,
      "contentAreaColumnHeaderColor": Color,
      "categoryTitleFont": Font,
      "categoryTitleTextColor": Color,
      "footerText": "abc123",
      "numberOfLocations": 123,
      "numberOfLocationsSource": "xyz789",
      "widgetLogoUrl": "http://www.test.com/",
      "widgetUrl": "http://www.test.com/",
      "banners": [Banner]
    }
  }
}
Mutations

deactivateWidget

Description

Deactivates a widget, making it inaccessible to the public.

Response

Returns a Widget

Arguments
Name Description
id - ID!

Example

Query
mutation deactivateWidget($id: ID!) {
  deactivateWidget(id: $id) {
    id
    name
    slug
    orderUrl
    createdAt
    updatedAt
    publishedAt
    lastSyncedAt
    isActive
    isSyncEnabled
    backgroundColor
    highlightColor
    primaryBrandColor
    fontFamily
    layout
    displayImages
    displayFeedbackButton
    displaySoftSignUp
    displayDishDetailsLink
    displayGiveFeedbackBanner
    displayNotifyMeBanner
    displayIngredients
    displayMacronutrients
    displayNutrientPreferences
    isByoEnabled
    isOrderButtonEnabled
    usePagination
    displayFooter
    displayNavbar
    supportedDietaryPreferences
    supportedAllergens
    navbarFont
    navbarFontSize
    navbarBackgroundColor
    logoUrl
    logoWidth
    faviconUrl
    htmlTitleText
    pageTitleText
    pageTitleTextColor
    menuItems {
      ...MenuItemFragment
    }
    menuItemsTextColor
    menuItemsTextHoverColor
    buttonFont
    buttonBackgroundColor
    buttonTextColor
    buttonBorderRadius
    subheaderFont
    subheaderLocationTextColor
    subheaderAdditionalTextColor
    contentAreaGlobalColor
    contentAreaColumnHeaderColor
    categoryTitleFont
    categoryTitleTextColor
    footerText
    numberOfLocations
    numberOfLocationsSource
    widgetLogoUrl
    widgetUrl
    banners {
      ...BannerFragment
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "deactivateWidget": {
      "id": "4",
      "name": "string",
      "slug": Slug,
      "orderUrl": "http://www.test.com/",
      "createdAt": "2007-12-03T10:15:30Z",
      "updatedAt": "2007-12-03T10:15:30Z",
      "publishedAt": "2007-12-03T10:15:30Z",
      "lastSyncedAt": "2007-12-03T10:15:30Z",
      "isActive": true,
      "isSyncEnabled": false,
      "backgroundColor": Color,
      "highlightColor": Color,
      "primaryBrandColor": Color,
      "fontFamily": Font,
      "layout": "Table",
      "displayImages": true,
      "displayFeedbackButton": true,
      "displaySoftSignUp": true,
      "displayDishDetailsLink": true,
      "displayGiveFeedbackBanner": true,
      "displayNotifyMeBanner": false,
      "displayIngredients": true,
      "displayMacronutrients": true,
      "displayNutrientPreferences": true,
      "isByoEnabled": true,
      "isOrderButtonEnabled": false,
      "usePagination": false,
      "displayFooter": true,
      "displayNavbar": true,
      "supportedDietaryPreferences": ["Vegan"],
      "supportedAllergens": ["Dairy"],
      "navbarFont": Font,
      "navbarFontSize": 123,
      "navbarBackgroundColor": Color,
      "logoUrl": "http://www.test.com/",
      "logoWidth": 123,
      "faviconUrl": "http://www.test.com/",
      "htmlTitleText": "string",
      "pageTitleText": "string",
      "pageTitleTextColor": Color,
      "menuItems": [MenuItem],
      "menuItemsTextColor": Color,
      "menuItemsTextHoverColor": Color,
      "buttonFont": Font,
      "buttonBackgroundColor": Color,
      "buttonTextColor": Color,
      "buttonBorderRadius": 987,
      "subheaderFont": Font,
      "subheaderLocationTextColor": Color,
      "subheaderAdditionalTextColor": Color,
      "contentAreaGlobalColor": Color,
      "contentAreaColumnHeaderColor": Color,
      "categoryTitleFont": Font,
      "categoryTitleTextColor": Color,
      "footerText": "xyz789",
      "numberOfLocations": 987,
      "numberOfLocationsSource": "xyz789",
      "widgetLogoUrl": "http://www.test.com/",
      "widgetUrl": "http://www.test.com/",
      "banners": [Banner]
    }
  }
}
Mutations

deactivateWidgetSync

Description

Deactivates a widget synchronously with validation.

Response

Returns a Widget

Arguments
Name Description
id - ID!

Example

Query
mutation deactivateWidgetSync($id: ID!) {
  deactivateWidgetSync(id: $id) {
    id
    name
    slug
    orderUrl
    createdAt
    updatedAt
    publishedAt
    lastSyncedAt
    isActive
    isSyncEnabled
    backgroundColor
    highlightColor
    primaryBrandColor
    fontFamily
    layout
    displayImages
    displayFeedbackButton
    displaySoftSignUp
    displayDishDetailsLink
    displayGiveFeedbackBanner
    displayNotifyMeBanner
    displayIngredients
    displayMacronutrients
    displayNutrientPreferences
    isByoEnabled
    isOrderButtonEnabled
    usePagination
    displayFooter
    displayNavbar
    supportedDietaryPreferences
    supportedAllergens
    navbarFont
    navbarFontSize
    navbarBackgroundColor
    logoUrl
    logoWidth
    faviconUrl
    htmlTitleText
    pageTitleText
    pageTitleTextColor
    menuItems {
      ...MenuItemFragment
    }
    menuItemsTextColor
    menuItemsTextHoverColor
    buttonFont
    buttonBackgroundColor
    buttonTextColor
    buttonBorderRadius
    subheaderFont
    subheaderLocationTextColor
    subheaderAdditionalTextColor
    contentAreaGlobalColor
    contentAreaColumnHeaderColor
    categoryTitleFont
    categoryTitleTextColor
    footerText
    numberOfLocations
    numberOfLocationsSource
    widgetLogoUrl
    widgetUrl
    banners {
      ...BannerFragment
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "deactivateWidgetSync": {
      "id": "4",
      "name": "string",
      "slug": Slug,
      "orderUrl": "http://www.test.com/",
      "createdAt": "2007-12-03T10:15:30Z",
      "updatedAt": "2007-12-03T10:15:30Z",
      "publishedAt": "2007-12-03T10:15:30Z",
      "lastSyncedAt": "2007-12-03T10:15:30Z",
      "isActive": true,
      "isSyncEnabled": false,
      "backgroundColor": Color,
      "highlightColor": Color,
      "primaryBrandColor": Color,
      "fontFamily": Font,
      "layout": "Table",
      "displayImages": true,
      "displayFeedbackButton": false,
      "displaySoftSignUp": false,
      "displayDishDetailsLink": false,
      "displayGiveFeedbackBanner": false,
      "displayNotifyMeBanner": true,
      "displayIngredients": false,
      "displayMacronutrients": true,
      "displayNutrientPreferences": false,
      "isByoEnabled": false,
      "isOrderButtonEnabled": true,
      "usePagination": true,
      "displayFooter": true,
      "displayNavbar": true,
      "supportedDietaryPreferences": ["Vegan"],
      "supportedAllergens": ["Dairy"],
      "navbarFont": Font,
      "navbarFontSize": 123,
      "navbarBackgroundColor": Color,
      "logoUrl": "http://www.test.com/",
      "logoWidth": 123,
      "faviconUrl": "http://www.test.com/",
      "htmlTitleText": "string",
      "pageTitleText": "string",
      "pageTitleTextColor": Color,
      "menuItems": [MenuItem],
      "menuItemsTextColor": Color,
      "menuItemsTextHoverColor": Color,
      "buttonFont": Font,
      "buttonBackgroundColor": Color,
      "buttonTextColor": Color,
      "buttonBorderRadius": 123,
      "subheaderFont": Font,
      "subheaderLocationTextColor": Color,
      "subheaderAdditionalTextColor": Color,
      "contentAreaGlobalColor": Color,
      "contentAreaColumnHeaderColor": Color,
      "categoryTitleFont": Font,
      "categoryTitleTextColor": Color,
      "footerText": "xyz789",
      "numberOfLocations": 123,
      "numberOfLocationsSource": "xyz789",
      "widgetLogoUrl": "http://www.test.com/",
      "widgetUrl": "http://www.test.com/",
      "banners": [Banner]
    }
  }
}
Mutations

syncWidget

Description

Triggers a synchronization of widget data from the source.

Response

Returns a Boolean

Arguments
Name Description
id - ID!

Example

Query
mutation syncWidget($id: ID!) {
  syncWidget(id: $id)
}
Variables
{"id": 4}
Response
{"data": {"syncWidget": false}}
Mutations

updateBanner

Description

Updates banner configuration including scheduling and display settings.

Response

Returns a Banner

Arguments
Name Description
input - UpdateBanner!

Example

Query
mutation updateBanner($input: UpdateBanner!) {
  updateBanner(input: $input) {
    id
    position
    isEnabled
    startDate
    endDate
    day
    hourStart
    minutesStart
    hourEnd
    minutesEnd
  }
}
Variables
{"input": UpdateBanner}
Response
{
  "data": {
    "updateBanner": {
      "id": "4",
      "position": "AboveThePreferenceBar",
      "isEnabled": true,
      "startDate": "2007-12-03T10:15:30Z",
      "endDate": "2007-12-03T10:15:30Z",
      "day": "Monday",
      "hourStart": Hours,
      "minutesStart": Minutes,
      "hourEnd": Hours,
      "minutesEnd": Minutes
    }
  }
}
Mutations

updateWidget

Description

Updates widget configuration and styling options.

Response

Returns a Widget

Arguments
Name Description
input - UpdateWidget!

Example

Query
mutation updateWidget($input: UpdateWidget!) {
  updateWidget(input: $input) {
    id
    name
    slug
    orderUrl
    createdAt
    updatedAt
    publishedAt
    lastSyncedAt
    isActive
    isSyncEnabled
    backgroundColor
    highlightColor
    primaryBrandColor
    fontFamily
    layout
    displayImages
    displayFeedbackButton
    displaySoftSignUp
    displayDishDetailsLink
    displayGiveFeedbackBanner
    displayNotifyMeBanner
    displayIngredients
    displayMacronutrients
    displayNutrientPreferences
    isByoEnabled
    isOrderButtonEnabled
    usePagination
    displayFooter
    displayNavbar
    supportedDietaryPreferences
    supportedAllergens
    navbarFont
    navbarFontSize
    navbarBackgroundColor
    logoUrl
    logoWidth
    faviconUrl
    htmlTitleText
    pageTitleText
    pageTitleTextColor
    menuItems {
      ...MenuItemFragment
    }
    menuItemsTextColor
    menuItemsTextHoverColor
    buttonFont
    buttonBackgroundColor
    buttonTextColor
    buttonBorderRadius
    subheaderFont
    subheaderLocationTextColor
    subheaderAdditionalTextColor
    contentAreaGlobalColor
    contentAreaColumnHeaderColor
    categoryTitleFont
    categoryTitleTextColor
    footerText
    numberOfLocations
    numberOfLocationsSource
    widgetLogoUrl
    widgetUrl
    banners {
      ...BannerFragment
    }
  }
}
Variables
{"input": UpdateWidget}
Response
{
  "data": {
    "updateWidget": {
      "id": 4,
      "name": "string",
      "slug": Slug,
      "orderUrl": "http://www.test.com/",
      "createdAt": "2007-12-03T10:15:30Z",
      "updatedAt": "2007-12-03T10:15:30Z",
      "publishedAt": "2007-12-03T10:15:30Z",
      "lastSyncedAt": "2007-12-03T10:15:30Z",
      "isActive": true,
      "isSyncEnabled": false,
      "backgroundColor": Color,
      "highlightColor": Color,
      "primaryBrandColor": Color,
      "fontFamily": Font,
      "layout": "Table",
      "displayImages": true,
      "displayFeedbackButton": true,
      "displaySoftSignUp": true,
      "displayDishDetailsLink": true,
      "displayGiveFeedbackBanner": false,
      "displayNotifyMeBanner": false,
      "displayIngredients": true,
      "displayMacronutrients": true,
      "displayNutrientPreferences": true,
      "isByoEnabled": true,
      "isOrderButtonEnabled": false,
      "usePagination": false,
      "displayFooter": false,
      "displayNavbar": true,
      "supportedDietaryPreferences": ["Vegan"],
      "supportedAllergens": ["Dairy"],
      "navbarFont": Font,
      "navbarFontSize": 987,
      "navbarBackgroundColor": Color,
      "logoUrl": "http://www.test.com/",
      "logoWidth": 123,
      "faviconUrl": "http://www.test.com/",
      "htmlTitleText": "string",
      "pageTitleText": "string",
      "pageTitleTextColor": Color,
      "menuItems": [MenuItem],
      "menuItemsTextColor": Color,
      "menuItemsTextHoverColor": Color,
      "buttonFont": Font,
      "buttonBackgroundColor": Color,
      "buttonTextColor": Color,
      "buttonBorderRadius": 123,
      "subheaderFont": Font,
      "subheaderLocationTextColor": Color,
      "subheaderAdditionalTextColor": Color,
      "contentAreaGlobalColor": Color,
      "contentAreaColumnHeaderColor": Color,
      "categoryTitleFont": Font,
      "categoryTitleTextColor": Color,
      "footerText": "abc123",
      "numberOfLocations": 123,
      "numberOfLocationsSource": "xyz789",
      "widgetLogoUrl": "http://www.test.com/",
      "widgetUrl": "http://www.test.com/",
      "banners": [Banner]
    }
  }
}

Types

Allergen

Description

Represents a dish allergen.

Fields
Field Name Description
id - ID!
name - String!
description - String
confidence - Float
Example
{
  "id": 4,
  "name": "abc123",
  "description": "abc123",
  "confidence": 987.65
}
Types

AllergenFilter

Description

Filter to exclude allergens.

Fields
Input Field Description
names - [AllergenType!]! List of allergen types to exclude.
Example
{"names": ["Dairy"]}
Types

AllergenType

Description

Common allergen types.

Values
Enum Value Description

Dairy

Egg

Fish

Shellfish

Wheat

TreeNut

Peanut

Sesame

Soy
Example
"Dairy"
Types

Banner

Description

Banner interface for widget promotional content.

Fields
Field Name Description
id - ID!
position - BannerPosition!
isEnabled - Boolean!
startDate - DateTime
endDate - DateTime
day - Day
hourStart - Hours
minutesStart - Minutes
hourEnd - Hours
minutesEnd - Minutes
Possible Types
Banner Types

BasicBanner

ImageBanner

CarouselBanner

SurveyBanner
Example
{
  "id": 4,
  "position": "AboveThePreferenceBar",
  "isEnabled": true,
  "startDate": "2007-12-03T10:15:30Z",
  "endDate": "2007-12-03T10:15:30Z",
  "day": "Monday",
  "hourStart": Hours,
  "minutesStart": Minutes,
  "hourEnd": Hours,
  "minutesEnd": Minutes
}
Types

BannerPosition

Description

Banner position options.

Values
Enum Value Description

AboveThePreferenceBar

BelowThePreferenceBar
Example
"AboveThePreferenceBar"
Types

BasicBanner

Description

Basic text and button banner.

Fields
Field Name Description
id - ID!
position - BannerPosition!
isEnabled - Boolean!
startDate - DateTime
endDate - DateTime
day - Day
hourStart - Hours
minutesStart - Minutes
hourEnd - Hours
minutesEnd - Minutes
backgroundColor - Color
iconURL - URL
iconColor - Color
text - String
textColor - Color
textFont - String
ctaButtonText - String
ctaButtonBackgroundColor - Color
ctaButtonTextColor - Color
ctaButtonTextFont - String
ctaButtonAction - String
secondaryButtonText - String
secondaryButtonBackgroundColor - Color
secondaryButtonTextColor - Color
secondaryButtonTextFont - String
secondaryButtonAction - String
Example
{
  "id": 4,
  "position": "AboveThePreferenceBar",
  "isEnabled": false,
  "startDate": "2007-12-03T10:15:30Z",
  "endDate": "2007-12-03T10:15:30Z",
  "day": "Monday",
  "hourStart": Hours,
  "minutesStart": Minutes,
  "hourEnd": Hours,
  "minutesEnd": Minutes,
  "backgroundColor": Color,
  "iconURL": "http://www.test.com/",
  "iconColor": Color,
  "text": "abc123",
  "textColor": Color,
  "textFont": "abc123",
  "ctaButtonText": "xyz789",
  "ctaButtonBackgroundColor": Color,
  "ctaButtonTextColor": Color,
  "ctaButtonTextFont": "xyz789",
  "ctaButtonAction": "abc123",
  "secondaryButtonText": "xyz789",
  "secondaryButtonBackgroundColor": Color,
  "secondaryButtonTextColor": Color,
  "secondaryButtonTextFont": "abc123",
  "secondaryButtonAction": "abc123"
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

CarouselBanner

Description

Carousel banner for multiple items.

Fields
Field Name Description
id - ID!
position - BannerPosition!
isEnabled - Boolean!
startDate - DateTime
endDate - DateTime
day - Day
hourStart - Hours
minutesStart - Minutes
hourEnd - Hours
minutesEnd - Minutes
backgroundColor - Color
text - String
textColor - Color
textFont - String
subtext - String
subtextColor - Color
subtextFont - String
fwdBwdColor - Color
fwdBwdIconColor - Color
Example
{
  "id": 4,
  "position": "AboveThePreferenceBar",
  "isEnabled": false,
  "startDate": "2007-12-03T10:15:30Z",
  "endDate": "2007-12-03T10:15:30Z",
  "day": "Monday",
  "hourStart": Hours,
  "minutesStart": Minutes,
  "hourEnd": Hours,
  "minutesEnd": Minutes,
  "backgroundColor": Color,
  "text": "xyz789",
  "textColor": Color,
  "textFont": "xyz789",
  "subtext": "abc123",
  "subtextColor": Color,
  "subtextFont": "abc123",
  "fwdBwdColor": Color,
  "fwdBwdIconColor": Color
}
Types

Chain

Description

Represents a restaurant chain.

Fields
Field Name Description
id - ID!
name - String! The name of the restaurant chain.
restaurants - RestaurantConnection The list of restaurants in the chain.
Arguments
args - PaginationArgs
Example
{
  "id": "4",
  "name": "xyz789",
  "restaurants": RestaurantConnection
}
Types

Color

Description

RGB or HEX color value.

Example
Color
Types

Cuisine

Description

Represents a cuisine type.

Fields
Field Name Description
id - ID!
name - String!
parent - ParentCuisine
Example
{
  "id": "4",
  "name": "xyz789",
  "parent": ParentCuisine
}
Types

DateTime

Description

ISO 8601 date-time string.

Example
"2007-12-03T10:15:30Z"
Types

Day

Description

Days of the week.

Values
Enum Value Description

Monday

Tuesday

Wednesday

Thursday

Friday

Saturday

Sunday
Example
"Monday"
Types

Diet

Description

Represents a dietary category.

Fields
Field Name Description
id - ID!
name - String!
description - String
confidence - Float
Example
{
  "id": "4",
  "name": "abc123",
  "description": "xyz789",
  "confidence": 123.45
}
Types

DietFilter

Description

Filter by dietary preferences.

Fields
Input Field Description
names - [DietType!]! List of dietary types to include.
Example
{"names": ["Vegan"]}
Types

DietType

Description

Dietary preference types.

Values
Enum Value Description

Vegan

Vegetarian

Pescatarian
Example
"Vegan"
Types

Dish

Description

Represents a restaurant dish.

Fields
Field Name Description
id - ID!
name - String!
description - String
imageUrl - String
caloriesTotal - String
caloriesFromFat - String
fatTotal - String
fatSaturated - String
fatTrans - String
cholesterol - String
sodium - String
dietaryFiber - String
carbohydrates - String
sugar - String
protein - String
vitaminA - String
vitaminC - String
calcium - String
iron - String
servingSize - String
servingSizeInGrams - Float
createdAt - DateTime
updatedAt - DateTime
cuisines - [Cuisine]! A list of dish cuisines.
allergens - [Allergen]! A list of dish allergens.
diets - [Diet]! A list of dish diets.
preparationTypes - [PreparationType]! A list of dish preparation types.
styles - [Style]! A list of dish styles.
addedIngredients - [Ingredient]! A list of added ingredients.
removedIngredients - [Ingredient]! A list of removed ingredients.
substitutions - [Dish]! A list of dish substitutions.
menu - Menu Dish menu.
Example
{
  "id": "4",
  "name": "abc123",
  "description": "xyz789",
  "imageUrl": "abc123",
  "caloriesTotal": "xyz789",
  "caloriesFromFat": "abc123",
  "fatTotal": "xyz789",
  "fatSaturated": "xyz789",
  "fatTrans": "abc123",
  "cholesterol": "xyz789",
  "sodium": "abc123",
  "dietaryFiber": "abc123",
  "carbohydrates": "abc123",
  "sugar": "abc123",
  "protein": "abc123",
  "vitaminA": "abc123",
  "vitaminC": "xyz789",
  "calcium": "xyz789",
  "iron": "xyz789",
  "servingSize": "xyz789",
  "servingSizeInGrams": 987.65,
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "cuisines": [Cuisine],
  "allergens": [Allergen],
  "diets": [Diet],
  "preparationTypes": [PreparationType],
  "styles": [Style],
  "addedIngredients": [Ingredient],
  "removedIngredients": [Ingredient],
  "substitutions": [Dish],
  "menu": Menu
}
Types

DishConnection

Description

Connection type for paginated dishes.

Fields
Field Name Description
edges - [DishEdge!] A list of dish edges.
nodes - [Dish!] A list of dish nodes.
total - Int! Identifies the total count of a restaurants dishes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [DishEdge],
  "nodes": [Dish],
  "total": 123,
  "pageInfo": PageInfo
}
Types

DishCriteria

Description

General dish criteria for restaurant queries.

Fields
Input Field Description
category - MenuFilter
diets - DietFilter
allergens - AllergenFilter
styles - StyleFilter
calories - RangeFilter Range of total calories for a dish.
nutrients - NutrientsFilter
term - String Search term that matches keywords in dish name.
Example
{
  "category": MenuFilter,
  "diets": DietFilter,
  "allergens": AllergenFilter,
  "styles": StyleFilter,
  "calories": RangeFilter,
  "nutrients": NutrientsFilter,
  "term": "xyz789"
}
Types

DishEdge

Description

Edge type for dishes.

Fields
Field Name Description
node - Dish! The dish at the end of Edge.
cursor - String! A cursor for use in pagination. Generated using Base64 encoding the tag's ID.
Example
{
  "node": Dish,
  "cursor": "abc123"
}
Types

DishInput

Description

Input for querying a specific dish.

Fields
Input Field Description
restaurant - ID!
dish - ID!
Example
{"restaurant": "4", "dish": 4}
Types

DishSortBy

Description

Sorting options for dishes.

Values
Enum Value Description

Featured

 Featured/recommended dishes first.

Relevance

 Sort by relevance to search query.

Newest

 Newest dishes first.

CaloriesAsc

 Lowest calories first.

CaloriesDesc

 Highest calories first.
Example
"Featured"
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65
Types

Font

Description

Font family name.

Example
Font
Types

Hours

Description

Hour value (0-23).

Example
Hours
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
"4"
Types

ImageBanner

Description

Image-based banner with text overlay.

Fields
Field Name Description
id - ID!
position - BannerPosition!
isEnabled - Boolean!
startDate - DateTime
endDate - DateTime
day - Day
hourStart - Hours
minutesStart - Minutes
hourEnd - Hours
minutesEnd - Minutes
backgroundColor - Color
text - String
textColor - Color
textFont - String
subtext - String
subtextColor - Color
subtextFont - String
buttonText - String
buttonBackgroundColor - Color
buttonTextColor - Color
buttonTextFont - String
buttonAction - String
imageURL - URL
Example
{
  "id": 4,
  "position": "AboveThePreferenceBar",
  "isEnabled": true,
  "startDate": "2007-12-03T10:15:30Z",
  "endDate": "2007-12-03T10:15:30Z",
  "day": "Monday",
  "hourStart": Hours,
  "minutesStart": Minutes,
  "hourEnd": Hours,
  "minutesEnd": Minutes,
  "backgroundColor": Color,
  "text": "xyz789",
  "textColor": Color,
  "textFont": "abc123",
  "subtext": "abc123",
  "subtextColor": Color,
  "subtextFont": "xyz789",
  "buttonText": "abc123",
  "buttonBackgroundColor": Color,
  "buttonTextColor": Color,
  "buttonTextFont": "abc123",
  "buttonAction": "abc123",
  "imageURL": "http://www.test.com/"
}
Types

Ingredient

Description

Represents a dish ingredient.

Fields
Field Name Description
id - ID!
name - String!
brand - String
description - String
supplier - String
caloriesTotalPer100g - String
caloriesFromFatPer100g - String
fatTotalPer100g - String
fatSaturatedPer100g - String
fatTransPer100g - String
cholesterolPer100g - String
carbohydratesPer100g - String
sugarPer100g - String
proteinPer100g - String
vitaminAPer100g - String
vitaminCPer100g - String
calciumPer100g - String
ironPer100g - String
containsEgg - Boolean
containsFish - Boolean
containsMilk - Boolean
containsSesame - Boolean
containsShellfish - Boolean
containsWheat - Boolean
isKeyIngredient - Boolean!
quantity - String!
unit - String!
amountGrams - Int!
Example
{
  "id": "4",
  "name": "abc123",
  "brand": "xyz789",
  "description": "xyz789",
  "supplier": "xyz789",
  "caloriesTotalPer100g": "xyz789",
  "caloriesFromFatPer100g": "xyz789",
  "fatTotalPer100g": "abc123",
  "fatSaturatedPer100g": "xyz789",
  "fatTransPer100g": "xyz789",
  "cholesterolPer100g": "abc123",
  "carbohydratesPer100g": "abc123",
  "sugarPer100g": "abc123",
  "proteinPer100g": "xyz789",
  "vitaminAPer100g": "xyz789",
  "vitaminCPer100g": "xyz789",
  "calciumPer100g": "xyz789",
  "ironPer100g": "abc123",
  "containsEgg": false,
  "containsFish": false,
  "containsMilk": true,
  "containsSesame": true,
  "containsShellfish": false,
  "containsWheat": false,
  "isKeyIngredient": true,
  "quantity": "xyz789",
  "unit": "abc123",
  "amountGrams": 987
}
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987
Types

Layout

Description

Widget layout options.

Values
Enum Value Description

Table

Card
Example
"Table"
Types

MatchInfo

Description

Information about how well a dish matches the search criteria.

Fields
Field Name Description
score - Float! Match score (0-1, where 1 is perfect match).
matchType - MatchType! Type of match (exact, partial, suggested).
matchedFields - [String!] Fields that contributed to the match.
label - String Human-readable label describing the match.
Example
{
  "score": 123.45,
  "matchType": "Match",
  "matchedFields": ["xyz789"],
  "label": "abc123"
}
Types

MatchType

Description

Match quality types.

Values
Enum Value Description

Match

NotMatch

Partial
Example
"Match"
Types

Menu

Description

Represents a restaurant menu.

Fields
Field Name Description
id - ID!
name - String!
Example
{"id": 4, "name": "xyz789"}
Types

MenuFilter

Description

Filter by menu category.

Fields
Input Field Description
id - ID!
Example
{"id": 4}
Types

MenuItem

Description

Represents a menu item link in the widget navbar.

Fields
Field Name Description
name - NonEmptyString!
url - URL!
Example
{
  "name": "string",
  "url": "http://www.test.com/"
}
Types

MenuItemInput

Description

Input for menu item creation.

Fields
Input Field Description
name - NonEmptyString!
url - URL!
Example
{
  "name": "string",
  "url": "http://www.test.com/"
}
Types

Minutes

Description

Minute value (0-59).

Example
Minutes
Types

Node

Description

Node interface for objects with a unique ID.

Fields
Field Name Description
id - ID!
Possible Types
Node Types

Widget

Chain

Restaurant

Menu

Cuisine

ParentCuisine

Dish

Allergen

Diet

PreparationType

Style

Ingredient
Example
{"id": 4}
Types

NonEmptyString

Description

Non-empty string value.

Example
"string"
Types

NutrientType

Description

Nutrient types for filtering.

Values
Enum Value Description

Calories

FatTotal

FatSaturated

FatTrans

Cholesterol

Sodium

Carbohydrates

DietaryFiber

Sugar

Protein

VitaminA

VitaminC

Calcium

Iron
Example
"Calories"
Types

NutrientsFilter

Description

Range filters for various dish nutrients.

Fields
Input Field Description
fats - RangeFilter Total fat range in grams.
carbohydrates - RangeFilter Total carbohydrates range in grams.
proteins - RangeFilter Total protein range in grams.
cholesterol - RangeFilter Cholesterol range in milligrams.
sodium - RangeFilter Sodium range in milligrams.
fiber - RangeFilter Dietary fiber range in grams.
sugar - RangeFilter Sugar range in grams.
Example
{
  "fats": RangeFilter,
  "carbohydrates": RangeFilter,
  "proteins": RangeFilter,
  "cholesterol": RangeFilter,
  "sodium": RangeFilter,
  "fiber": RangeFilter,
  "sugar": RangeFilter
}
Types

PageInfo

Description

Information about pagination in a connection.

Fields
Field Name Description
startCursor - String When paginating backwards, the cursor to continue.
endCursor - String When paginating forwards, the cursor to continue.
hasNextPage - Boolean! When paginating forwards, are there more items?
hasPreviousPage - Boolean! When paginating backwards, are there more items?
Example
{
  "startCursor": "xyz789",
  "endCursor": "abc123",
  "hasNextPage": false,
  "hasPreviousPage": false
}
Types

Pageable

Description

Pageable union type.

Types
Union Types

Restaurant

Dish
Example
Restaurant
Types

PagedConnection

Description

Connection interface for pagination.

Fields
Field Name Description
edges - [PagedEdge!] A list of edges.
nodes - [Pageable!] A list of nodes.
total - Int! Identifies the total count of items in the connection.
pageInfo - PageInfo! Information to aid in pagination.
Possible Types
PagedConnection Types

RestaurantConnection

DishConnection

WidgetDishConnection
Example
{
  "edges": [PagedEdge],
  "nodes": [Restaurant],
  "total": 123,
  "pageInfo": PageInfo
}
Types

PagedEdge

Description

Edge interface for pagination.

Fields
Field Name Description
node - Pageable! The item at the end of Edge.
cursor - String! A cursor for use in pagination. Generated using Base64 encoding the tag's ID.
Possible Types
PagedEdge Types

RestaurantEdge

DishEdge

WidgetDishEdge
Example
{
  "node": Restaurant,
  "cursor": "xyz789"
}
Types

PaginationArgs

Description

Pagination arguments for cursor-based pagination.

Fields
Input Field Description
first - Int Fetch the first N items after the cursor.
last - Int Fetch the last N items before the cursor.
after - String Cursor to fetch items after.
before - String Cursor to fetch items before.
Example
{
  "first": 123,
  "last": 123,
  "after": "xyz789",
  "before": "abc123"
}
Types

ParentCuisine

Description

Represents a parent cuisine category.

Fields
Field Name Description
id - ID!
name - String!
Example
{"id": 4, "name": "xyz789"}
Types

PreparationType

Description

Represents a dish preparation type.

Fields
Field Name Description
id - ID!
name - String!
confidence - Float
Example
{
  "id": "4",
  "name": "xyz789",
  "confidence": 987.65
}
Types

RangeFilter

Description

Range filter for numeric values.

Fields
Input Field Description
min - Float Minimum value (inclusive).
max - Float Maximum value (inclusive).
Example
{"min": 987.65, "max": 987.65}
Types

Restaurant

Description

Represents a restaurant location.

Fields
Field Name Description
id - ID!
street - String!
city - String!
zipCode - String!
state - String
stateCode - String
country - String!
countryCode - String
latitude - Float!
longitude - Float!
phoneNumber - String
logoUrl - String
websiteUrl - String
isPermanentlyClosed - Boolean
description - String
createdAt - DateTime!
updatedAt - DateTime!
operatingHours - [WorkingHours]! Operating hours for the restaurant.
menus - [Menu]! A list of restaurant menus.
cuisines - [Cuisine]! A list of restaurant cuisines.
dishes - DishConnection A list of restaurant dishes. Can be filtered by menu.
Arguments
criteria - DishCriteria
args - PaginationArgs
Example
{
  "id": 4,
  "street": "xyz789",
  "city": "abc123",
  "zipCode": "abc123",
  "state": "xyz789",
  "stateCode": "xyz789",
  "country": "xyz789",
  "countryCode": "abc123",
  "latitude": 123.45,
  "longitude": 123.45,
  "phoneNumber": "xyz789",
  "logoUrl": "abc123",
  "websiteUrl": "xyz789",
  "isPermanentlyClosed": false,
  "description": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "operatingHours": [WorkingHours],
  "menus": [Menu],
  "cuisines": [Cuisine],
  "dishes": DishConnection
}
Types

RestaurantConnection

Description

Connection type for paginated restaurants.

Fields
Field Name Description
edges - [RestaurantEdge!] A list of restaurant edges.
nodes - [Restaurant!] A list of restaurant nodes.
total - Int! Identifies the total count of restaurants.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [RestaurantEdge],
  "nodes": [Restaurant],
  "total": 123,
  "pageInfo": PageInfo
}
Types

RestaurantEdge

Description

Edge type for restaurants.

Fields
Field Name Description
node - Restaurant! The restaurant at the end of Edge.
cursor - String! A cursor for use in pagination. Generated using Base64 encoding the tag's ID.
Example
{
  "node": Restaurant,
  "cursor": "xyz789"
}
Types

ScaleLabels

Description

Scale labels for survey questions.

Fields
Field Name Description
start - String!
end - String!
Example
{
  "start": "xyz789",
  "end": "xyz789"
}
Types

Slug

Description

URL-safe slug string.

Example
Slug
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"xyz789"
Types

Style

Description

Represents a dish style.

Fields
Field Name Description
id - ID!
name - String!
description - String
confidence - Float
Example
{
  "id": 4,
  "name": "abc123",
  "description": "abc123",
  "confidence": 987.65
}
Types

StyleFilter

Description

Filter by dish styles.

Fields
Input Field Description
ids - [ID!]! List of style IDs to include.
Example
{"ids": [4]}
Types

SurveyBanner

Description

Survey banner for collecting user feedback.

Fields
Field Name Description
id - ID!
position - BannerPosition!
isEnabled - Boolean!
startDate - DateTime
endDate - DateTime
day - Day
hourStart - Hours
minutesStart - Minutes
hourEnd - Hours
minutesEnd - Minutes
type - String
scaleLabels - ScaleLabels
options - [SurveyOption!]
backgroundColor - Color
text - String
textColor - Color
textFont - String
subtext - String
subtextColor - Color
subtextFont - String
buttonText - String
buttonBackgroundColor - Color
buttonTextColor - Color
buttonTextFont - String
buttonAction - String
Example
{
  "id": "4",
  "position": "AboveThePreferenceBar",
  "isEnabled": false,
  "startDate": "2007-12-03T10:15:30Z",
  "endDate": "2007-12-03T10:15:30Z",
  "day": "Monday",
  "hourStart": Hours,
  "minutesStart": Minutes,
  "hourEnd": Hours,
  "minutesEnd": Minutes,
  "type": "xyz789",
  "scaleLabels": ScaleLabels,
  "options": [SurveyOption],
  "backgroundColor": Color,
  "text": "xyz789",
  "textColor": Color,
  "textFont": "xyz789",
  "subtext": "abc123",
  "subtextColor": Color,
  "subtextFont": "abc123",
  "buttonText": "xyz789",
  "buttonBackgroundColor": Color,
  "buttonTextColor": Color,
  "buttonTextFont": "abc123",
  "buttonAction": "abc123"
}
Types

SurveyOption

Description

Survey option with label and value.

Fields
Field Name Description
label - String!
value - Int!
Example
{"label": "xyz789", "value": 123}
Types

TimePeriod

Description

Represents a time period with from/to times.

Fields
Field Name Description
from - [Int]!
to - [Int]!
Example
{"from": [987], "to": [123]}
Types

URL

Description

Valid URL string.

Example
"http://www.test.com/"
Types

UpdateBanner

Description

Input for updating banner configuration.

Fields
Input Field Description
id - ID!
isEnabled - Boolean
startDate - DateTime
endDate - DateTime
day - Day
hourStart - Hours
minutesStart - Minutes
hourEnd - Hours
minutesEnd - Minutes
Example
{
  "id": 4,
  "isEnabled": false,
  "startDate": "2007-12-03T10:15:30Z",
  "endDate": "2007-12-03T10:15:30Z",
  "day": "Monday",
  "hourStart": Hours,
  "minutesStart": Minutes,
  "hourEnd": Hours,
  "minutesEnd": Minutes
}
Types

UpdateWidget

Description

Input for updating widget configuration.

Fields
Input Field Description
id - ID!
name - NonEmptyString
slug - Slug
orderUrl - URL
publishedAt - DateTime
backgroundColor - Color
highlightColor - Color
primaryBrandColor - Color
displayImages - Boolean
displayFeedbackButton - Boolean
displaySoftSignUp - Boolean
displayDishDetailsLink - Boolean
displayGiveFeedbackBanner - Boolean
displayNotifyMeBanner - Boolean
displayIngredients - Boolean
displayMacronutrients - Boolean
displayNutrientPreferences - Boolean
supportedDietaryPreferences - [DietType!]
supportedAllergens - [AllergenType!]
isByoEnabled - Boolean
isOrderButtonEnabled - Boolean
fontFamily - Font
layout - Layout
displayNavbar - Boolean
navbarFont - Font
navbarFontSize - Int
navbarBackgroundColor - Color
logoUrl - URL
logoWidth - Int
faviconUrl - URL
htmlTitleText - NonEmptyString
pageTitleText - NonEmptyString
pageTitleTextColor - Color
menuItems - [MenuItemInput!]
menuItemsTextColor - Color
menuItemsTextHoverColor - Color
buttonFont - Font
buttonBackgroundColor - Color
buttonTextColor - Color
buttonBorderRadius - Int
subheaderFont - Font
subheaderLocationTextColor - Color
subheaderAdditionalTextColor - Color
contentAreaGlobalColor - Color
contentAreaColumnHeaderColor - Color
categoryTitleFont - Font
categoryTitleTextColor - Color
usePagination - Boolean
displayFooter - Boolean
footerText - String
numberOfLocations - Int
numberOfLocationsSource - String
widgetLogoUrl - URL
widgetUrl - URL
Example
{
  "id": 4,
  "name": "string",
  "slug": Slug,
  "orderUrl": "http://www.test.com/",
  "publishedAt": "2007-12-03T10:15:30Z",
  "backgroundColor": Color,
  "highlightColor": Color,
  "primaryBrandColor": Color,
  "displayImages": false,
  "displayFeedbackButton": true,
  "displaySoftSignUp": true,
  "displayDishDetailsLink": true,
  "displayGiveFeedbackBanner": true,
  "displayNotifyMeBanner": false,
  "displayIngredients": true,
  "displayMacronutrients": true,
  "displayNutrientPreferences": true,
  "supportedDietaryPreferences": ["Vegan"],
  "supportedAllergens": ["Dairy"],
  "isByoEnabled": true,
  "isOrderButtonEnabled": false,
  "fontFamily": Font,
  "layout": "Table",
  "displayNavbar": true,
  "navbarFont": Font,
  "navbarFontSize": 987,
  "navbarBackgroundColor": Color,
  "logoUrl": "http://www.test.com/",
  "logoWidth": 987,
  "faviconUrl": "http://www.test.com/",
  "htmlTitleText": "string",
  "pageTitleText": "string",
  "pageTitleTextColor": Color,
  "menuItems": [MenuItemInput],
  "menuItemsTextColor": Color,
  "menuItemsTextHoverColor": Color,
  "buttonFont": Font,
  "buttonBackgroundColor": Color,
  "buttonTextColor": Color,
  "buttonBorderRadius": 123,
  "subheaderFont": Font,
  "subheaderLocationTextColor": Color,
  "subheaderAdditionalTextColor": Color,
  "contentAreaGlobalColor": Color,
  "contentAreaColumnHeaderColor": Color,
  "categoryTitleFont": Font,
  "categoryTitleTextColor": Color,
  "usePagination": true,
  "displayFooter": true,
  "footerText": "abc123",
  "numberOfLocations": 123,
  "numberOfLocationsSource": "abc123",
  "widgetLogoUrl": "http://www.test.com/",
  "widgetUrl": "http://www.test.com/"
}
Types

Widget

Description

Represents a customizable widget for displaying restaurant menu information.

Fields
Field Name Description
id - ID!
name - NonEmptyString
slug - Slug
orderUrl - URL
createdAt - DateTime!
updatedAt - DateTime!
publishedAt - DateTime
lastSyncedAt - DateTime!
isActive - Boolean!
isSyncEnabled - Boolean!
backgroundColor - Color
highlightColor - Color
primaryBrandColor - Color
fontFamily - Font
layout - Layout!
displayImages - Boolean!
displayFeedbackButton - Boolean!
displaySoftSignUp - Boolean!
displayDishDetailsLink - Boolean!
displayGiveFeedbackBanner - Boolean!
displayNotifyMeBanner - Boolean!
displayIngredients - Boolean!
displayMacronutrients - Boolean!
displayNutrientPreferences - Boolean!
isByoEnabled - Boolean!
isOrderButtonEnabled - Boolean!
usePagination - Boolean!
displayFooter - Boolean!
displayNavbar - Boolean
supportedDietaryPreferences - [DietType!]!
supportedAllergens - [AllergenType!]!
navbarFont - Font
navbarFontSize - Int
navbarBackgroundColor - Color
logoUrl - URL
logoWidth - Int
faviconUrl - URL
htmlTitleText - NonEmptyString!
pageTitleText - NonEmptyString
pageTitleTextColor - Color
menuItems - [MenuItem!]
menuItemsTextColor - Color
menuItemsTextHoverColor - Color
buttonFont - Font
buttonBackgroundColor - Color
buttonTextColor - Color
buttonBorderRadius - Int
subheaderFont - Font
subheaderLocationTextColor - Color
subheaderAdditionalTextColor - Color
contentAreaGlobalColor - Color
contentAreaColumnHeaderColor - Color
categoryTitleFont - Font
categoryTitleTextColor - Color
footerText - String
numberOfLocations - Int
numberOfLocationsSource - String
widgetLogoUrl - URL
widgetUrl - URL
banners - [Banner]!
Example
{
  "id": "4",
  "name": "string",
  "slug": Slug,
  "orderUrl": "http://www.test.com/",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "publishedAt": "2007-12-03T10:15:30Z",
  "lastSyncedAt": "2007-12-03T10:15:30Z",
  "isActive": false,
  "isSyncEnabled": true,
  "backgroundColor": Color,
  "highlightColor": Color,
  "primaryBrandColor": Color,
  "fontFamily": Font,
  "layout": "Table",
  "displayImages": true,
  "displayFeedbackButton": true,
  "displaySoftSignUp": true,
  "displayDishDetailsLink": false,
  "displayGiveFeedbackBanner": true,
  "displayNotifyMeBanner": false,
  "displayIngredients": true,
  "displayMacronutrients": false,
  "displayNutrientPreferences": false,
  "isByoEnabled": true,
  "isOrderButtonEnabled": true,
  "usePagination": false,
  "displayFooter": false,
  "displayNavbar": true,
  "supportedDietaryPreferences": ["Vegan"],
  "supportedAllergens": ["Dairy"],
  "navbarFont": Font,
  "navbarFontSize": 123,
  "navbarBackgroundColor": Color,
  "logoUrl": "http://www.test.com/",
  "logoWidth": 123,
  "faviconUrl": "http://www.test.com/",
  "htmlTitleText": "string",
  "pageTitleText": "string",
  "pageTitleTextColor": Color,
  "menuItems": [MenuItem],
  "menuItemsTextColor": Color,
  "menuItemsTextHoverColor": Color,
  "buttonFont": Font,
  "buttonBackgroundColor": Color,
  "buttonTextColor": Color,
  "buttonBorderRadius": 123,
  "subheaderFont": Font,
  "subheaderLocationTextColor": Color,
  "subheaderAdditionalTextColor": Color,
  "contentAreaGlobalColor": Color,
  "contentAreaColumnHeaderColor": Color,
  "categoryTitleFont": Font,
  "categoryTitleTextColor": Color,
  "footerText": "xyz789",
  "numberOfLocations": 987,
  "numberOfLocationsSource": "abc123",
  "widgetLogoUrl": "http://www.test.com/",
  "widgetUrl": "http://www.test.com/",
  "banners": [Banner]
}
Types

WidgetAllergen

Description

Represents an allergen filter configuration for a widget.

Fields
Field Name Description
type - AllergenType! The type of allergen (Dairy, Egg, Fish, etc.).
displayName - String! Display name for the allergen.
description - String Description of the allergen.
isEnabled - Boolean! Whether this allergen filter is enabled for the widget.
ordinal - Int Display order in the UI.
icon - String Icon or emoji to represent this allergen.
Example
{
  "type": "Dairy",
  "displayName": "abc123",
  "description": "abc123",
  "isEnabled": true,
  "ordinal": 123,
  "icon": "abc123"
}
Types

WidgetCategory

Description

Represents a menu category available in a widget.

Fields
Field Name Description
name - String! The name of the category (e.g., "Breakfast", "Lunch", "Dinner").
count - Int Number of dishes in this category (may be affected by filters).
ordinal - Int Display order in the UI.
Example
{
  "name": "abc123",
  "count": 123,
  "ordinal": 987
}
Types

WidgetDietaryPreference

Description

Represents a dietary preference filter configuration for a widget.

Fields
Field Name Description
type - DietType! The type of dietary preference (Vegan, Vegetarian, Pescatarian).
displayName - String! Display name for the dietary preference.
description - String Description of what this dietary preference means.
isEnabled - Boolean! Whether this filter is enabled for the widget.
ordinal - Int Display order in the UI.
Example
{
  "type": "Vegan",
  "displayName": "abc123",
  "description": "xyz789",
  "isEnabled": false,
  "ordinal": 123
}
Types

WidgetDishConnection

Description

Connection type for paginated widget dishes.

Fields
Field Name Description
edges - [WidgetDishEdge!] A list of dish edges.
nodes - [Dish!] A list of dish nodes.
total - Int! Total count of dishes matching the criteria (before pagination).
matchesCount - Int Number of dishes that fully match all criteria.
partialMatchesCount - Int Number of dishes that partially match criteria.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [WidgetDishEdge],
  "nodes": [Dish],
  "total": 123,
  "matchesCount": 123,
  "partialMatchesCount": 987,
  "pageInfo": PageInfo
}
Types

WidgetDishCriteria

Description

Comprehensive criteria for filtering widget dishes.

Fields
Input Field Description
term - String Search term that matches keywords in dish name, description, or ingredients.
restaurantId - ID Filter by specific restaurant within the widget.
category - MenuFilter Filter by menu category.
diets - DietFilter Dietary preferences that dishes must satisfy (e.g., Vegan, Vegetarian).
allergens - AllergenFilter Allergens to exclude from results.
styles - StyleFilter Dish styles to include.
calories - RangeFilter Range filter for total calories.
nutrients - NutrientsFilter Range filters for specific nutrients (fats, carbs, proteins, etc.).
Example
{
  "term": "xyz789",
  "restaurantId": "4",
  "category": MenuFilter,
  "diets": DietFilter,
  "allergens": AllergenFilter,
  "styles": StyleFilter,
  "calories": RangeFilter,
  "nutrients": NutrientsFilter
}
Types

WidgetDishEdge

Description

Edge type for widget dishes with matching metadata.

Fields
Field Name Description
node - Dish! The dish at this edge.
cursor - String! Cursor for pagination.
match - MatchInfo Match quality score and details.
Example
{
  "node": Dish,
  "cursor": "xyz789",
  "match": MatchInfo
}
Types

WidgetNutrientPreference

Description

Represents a nutrient preference filter configuration for a widget.

Fields
Field Name Description
nutrientType - NutrientType! The nutrient type (calories, protein, carbohydrates, fats, etc.).
displayName - String! Display name for the nutrient.
unit - String! Unit of measurement (g, mg, kcal, etc.).
isEnabled - Boolean! Whether this nutrient filter is enabled for the widget.
defaultMin - Float Default minimum value for the range filter.
defaultMax - Float Default maximum value for the range filter.
recommendedMin - Float Recommended minimum value.
recommendedMax - Float Recommended maximum value.
ordinal - Int Display order in the UI.
Example
{
  "nutrientType": "Calories",
  "displayName": "abc123",
  "unit": "abc123",
  "isEnabled": true,
  "defaultMin": 123.45,
  "defaultMax": 987.65,
  "recommendedMin": 123.45,
  "recommendedMax": 987.65,
  "ordinal": 987
}
Types

WorkingHours

Description

Represents working hours for a restaurant.

Fields
Field Name Description
day - Day!
period - TimePeriod
Example
{"day": "Monday", "period": TimePeriod}