Restaurant Modules

Retrieve all modules configured for the restaurant, grouped by channel, then category, then module name. Note that the first-level keys of the data object are channel IDs as numeric strings, not an array. For example, data["2"]["ordering"]["flow"] is the ordering flow configuration of the web ordering channel. The ordering flow module is enriched with a computed isGroupingByTableNameEnabled field reflecting the kitchen display configuration.

{
  "status": 200,
  "code": "module_succeed",
  "data": {
    "2": {
      "ordering": {
        "flow": {
          "moduleId": 12,
          "channelId": 2,
          "restaurantId": 200,
          "is_enabled": true,
          "isOrderFollowUpEnabled": false,
          "isProductFollowUpEnabled": false,
          "isGroupingByTableNameEnabled": false
        }
      }
    },
    "5": {
      "ordering": {
        "flow": {
          "moduleId": 12,
          "channelId": 5,
          "restaurantId": 200,
          "is_enabled": true
        }
      }
    }
  }
}

Retrieve the configuration of a specific module of the restaurant for a given channel. The channelId query parameter is required even though it is passed in the query string - a 400 missing_parameters error is returned when it is missing. The shape of the returned configuration depends on the module type (ordering flow, payment...).

{
  "status": 200,
  "code": "module_succeed",
  "data": {
    "moduleId": 12,
    "channelId": 2,
    "restaurantId": 200,
    "is_enabled": true,
    "isOrderFollowUpEnabled": false,
    "isProductFollowUpEnabled": false
  }
}

Create or update the configuration of a module for a channel at restaurant level. Note that restaurantId must be repeated in the request body in addition to the path. The content of the module object depends on the module type. Side effects: setting module.isProductFollowUpEnabled to true forces isOrderFollowUpEnabled to false and disables the kitchen display; enabling a follow-up is rejected when the kitchen display has grouping by table name active; module.closeRestaurant creates an OPEN/CLOSE entry in the audit history; the web ordering configuration cache of the brand is invalidated; on first creation on the web ordering channel (channelId 2), the restaurant opening date is initialized as closed.

{
  "restaurantId": 200,
  "moduleId": 12,
  "channelId": 2,
  "module": {
    "is_enabled": true,
    "isOrderFollowUpEnabled": true,
    "isProductFollowUpEnabled": false
  }
}

{
  "status": 200,
  "code": "module_create_succeed",
  "message": "Module has been successfully created.",
  "data": {
    "moduleId": 12,
    "channelId": 2,
    "restaurantId": 200,
    "is_enabled": true,
    "isOrderFollowUpEnabled": true,
    "isProductFollowUpEnabled": false
  }
}