PosMassScheduleOverride

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/grubhub/main/json-schema/grubhub-posmassscheduleoverride-schema.json",
  "title": "PosMassScheduleOverride",
  "x-generated": "2026-09-17",
  "x-method": "derived",
  "x-source": "openapi/grubhub-merchant-schedules-openapi.yml#/components/schemas/PosMassScheduleOverride",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The identifier of the mass override itself.",
      "format": "uuid"
    },
    "merchant_ids": {
      "uniqueItems": true,
      "type": "array",
      "description": "The IDs of the merchants affected by this mass blackout.",
      "items": {
        "type": "string",
        "description": "The IDs of the merchants affected by this mass blackout."
      }
    },
    "metadata": {
      "$ref": "#/$defs/MassScheduleOverrideMetadata"
    },
    "start_time_utc": {
      "type": "string",
      "description": "The date and time when this mass override begins in the UTC (Coordinated Universal Time) time zone.",
      "format": "date-time"
    },
    "end_time_utc": {
      "type": "string",
      "description": "The date and time when this mass override ends in the UTC (Coordinated Universal Time) time zone.",
      "format": "date-time"
    },
    "start_time_local": {
      "type": "string",
      "description": "The date and time when this mass override begins in the merchant's local time zone.",
      "format": "date-time"
    },
    "end_time_local": {
      "type": "string",
      "description": "The date and time when this mass override ends in the merchant's local time zone.",
      "format": "date-time"
    }
  },
  "description": "Information about a blackout that applies to multiple merchants; used for groups of merchants to halt online orders or pause ordering during a disaster (Grubhub administrative use only).",
  "$defs": {
    "MassScheduleOverrideMetadata": {
      "type": "object",
      "properties": {
        "name_filter": {
          "type": "string",
          "description": "Optional Java Regular Expression used to target specific RepeatingSchedules by name"
        },
        "override_type": {
          "type": "string",
          "description": "The type of a schedule override.  Describes whether the deviation is to open or close unexpectedly.",
          "enum": [
            "BLACKOUT",
            "WHITEIN"
          ]
        },
        "schedule_type": {
          "type": "string",
          "description": "The type of mass schedule override, whether timezones are applied",
          "enum": [
            "LOCAL",
            "ZONED"
          ]
        },
        "created_by": {
          "type": "string",
          "description": "The creator of the schedule"
        },
        "updated_by": {
          "type": "string",
          "description": "The last credential to update the schedule"
        },
        "created_date": {
          "type": "string",
          "description": "The creation date of the schedule",
          "format": "date-time"
        },
        "updated_date": {
          "type": "string",
          "description": "The last update date of the schedule",
          "format": "date-time"
        },
        "legacy_id": {
          "type": "string",
          "description": "The legacy ID of the schedule in MySQL"
        },
        "description": {
          "type": "string",
          "description": "The description for the schedule"
        }
      },
      "description": "Metadata associated to a merchant mass schedule override"
    }
  }
}