Channel Available Structure

Information about store availability

Type: object Properties: 2 Required: 1
Fortune 500FranchisingHospitalityNYSE QSRQuick Service RestaurantsRestaurants

Available is a JSON Structure definition published by Restaurant Brands International, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

isEnabled isOpen

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/restaurant-brands/refs/heads/main/json-structure/channel-available-structure.json",
  "name": "Available",
  "description": "Information about store availability",
  "type": "object",
  "properties": {
    "isEnabled": {
      "description": "Detailed availability per service mode.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/ServiceMode"
          },
          "value": {
            "type": "boolean",
            "description": "Returns true if the store is Operating Available.\n\n\"Operating Available\" considers the current date and time to calculate the current availability for the \nservice mode.\n"
          }
        }
      }
    },
    "isOpen": {
      "description": "True if the store is available for ordering.",
      "type": "boolean",
      "example": true
    }
  },
  "required": [
    "isOpen"
  ]
}