Available

Information about store availability

Fortune 500FranchisingHospitalityNYSE QSRQuick Service RestaurantsRestaurants

Properties

Name Type Description
isEnabled array Detailed availability per service mode.
isOpen boolean True if the store is available for ordering.
View JSON Schema on GitHub

JSON Schema

channel-available-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Available",
  "description": "Information about store availability",
  "$id": "https://raw.githubusercontent.com/api-evangelist/restaurant-brands/refs/heads/main/json-schema/channel-available-schema.json",
  "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"
  ]
}