API Documentation

# Brand API Resources v1.0

Each resource used in the Restaurant API version 1.0 is listed below.

# Brand

Describes a brand that restaurants are a member of.

Name Required Type Description
key false string The unique key for the brand.
name false string The full, official name of the brand.
displayName true string The display name for the brand.
enabled true boolean Indicates if the brand is enabled.
menus false Menu[] The array of menus available to the brand.
restaurants false Restaurant[] The array of restaurants for the brand.
createdOn true date-time The date and time the brand was created.
modifiedOn true date-time The date and time the brand was modified.

# Sample

{
    "key": "ROCO",
    "name": "RocoMamas",
    "displayName": "RocoMamas",
    "enabled": true,
    "menus": [],
    "restaurants": [],
    "createdOn": "2015-03-26T20:22:35.17",
    "modifiedOn": "2021-02-02T19:55:08.3733333"
}

Describes a menu that will be linked to restaurants.

Name Required Type Description
key true string The unique key for the menu.
version true int The menu version. The same menu will have multiple versions over time. Each version will contain different items, pricing and so on.
name true string The name of the menu.
displayName true string A display name for the menu for use within apps and websites.
description true string A description for the menu.
brandKey true string The brand key of brand that the menu is for.
defaultForBrand true boolean Indicates if the menu is the default menu for the brand. The sit down menu in each brand would typically be marked as default.
status false string The current status of the menu.
publishStatus false string The current published status of the menu.
countryCode true string The ISO 3166-1 Alpha-2 code for the country that the menu is intended to be used in.
enabled true boolean Indicates if the menu is enabled.
effectiveFrom true date The date the menu version is effective from.
effectiveTo true date The date the menu version is effective to.
createdOn true date-time The date and time the menu was created.
modifiedOn true date-time The date and time the menu was modified.

# Sample

{
    "key": "ROCO-ZA-3",
    "version": 202012,
    "name": "Roco - Standard - Take-away - 1st Party",
    "displayName": "Take-Away",
    "description": "Standard Menu available for brand app",
    "brandKey": "ROCO",
    "defaultForBrand": false,
    "status": "Approved",
    "publishStatus": "Published",
    "countryCode": "ZA",
    "enabled": true,
    "effectiveFrom": "2020-12-01T00:00:00",
    "effectiveTo": "2021-06-30T23:59:59.9999999",
    "createdOn": "2019-06-28T18:01:15.9733333",
    "modifiedOn": "2020-12-01T00:00:00"
}

# Restaurant

Describes the restaurant that is a member of the brand.

Name Required Type Description
key true int The unique key for the restaurant.
name true string The name for the restaurant. Should not be displayed to customers. Use displayName rather.
displayName true string The display name for the restaurant. Suitable for displaying to customers.
brandKey true string The brand key for the restaurant.
outletType true string The type of outlet the restaurant is classified as. Values are either Restaurant or Virtual Kitchen
tradingStatus true string Describes the current trading status of the restaurant.
countryCode true string The ISO 3166-1 Alpha-2 code of the country that the restaurant trades in.
createdOn true date-time The date and time the restaurant was created.
modifiedOn true date-time The date and time the restaurant was modified.

# Sample

{
    "key": 1179,
    "name": "RM Randburg",
    "displayName": "RocoMamas Randburg",
    "brandKey": "ROCO",
    "outletType": "Restaurant",
    "tradingStatus": "Open",
    "countryCode": "ZA",
    "createdOn": "2015-03-31T11:35:31.8633333",
    "modifiedOn": "2021-05-07T11:20:00.9636405"
}

← List Brands →