Flipdish · Schema

StoreOrderCapacityPeriod

Represents a single order capacity period

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
MaxOrderNumberPerStoreInterval integer The maximum number of orders per each store order interval in this order capacity period. E.g. for a period from 9:00 till 11:00, if the store's interval is 10 minutes, and MaxOrderNumberPerStoreInter
DayOfTheWeek string Day of the week the period pertains to
PeriodStartHour integer The hour the period starts at
PeriodStartMinutes integer The minutes after the hour the period starts at
PeriodEndHour integer The hour the period ends at
PeriodEndMinutes integer The minutes after the hour the period ends at
View JSON Schema on GitHub

JSON Schema

stores-store-order-capacity-period-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/stores-store-order-capacity-period-schema.json",
  "title": "StoreOrderCapacityPeriod",
  "description": "Represents a single order capacity period",
  "type": "object",
  "properties": {
    "MaxOrderNumberPerStoreInterval": {
      "format": "int32",
      "description": "The maximum number of orders per each store order interval in this order capacity period.\r\nE.g. for a period from 9:00 till 11:00, if the store's interval is 10 minutes, and MaxOrderNumberPerStoreInterval is set to 5,\r\nit means that within each 10-minute interval between 9:00 and 11:00 (i.e. 9:00-9:10, 9:10-9:20, .. , 10:50-11:00) it will be possible to\r\nrequest at most 5 orders.",
      "type": "integer",
      "example": 3
    },
    "DayOfTheWeek": {
      "description": "Day of the week the period pertains to",
      "enum": [
        "Sunday",
        "Monday",
        "Tuesday",
        "Wednesday",
        "Thursday",
        "Friday",
        "Saturday"
      ],
      "type": "string",
      "example": "Sunday"
    },
    "PeriodStartHour": {
      "format": "int32",
      "description": "The hour the period starts at",
      "type": "integer",
      "example": 1
    },
    "PeriodStartMinutes": {
      "format": "int32",
      "description": "The minutes after the hour the period starts at",
      "type": "integer",
      "example": 1
    },
    "PeriodEndHour": {
      "format": "int32",
      "description": "The hour the period ends at",
      "type": "integer",
      "example": 1
    },
    "PeriodEndMinutes": {
      "format": "int32",
      "description": "The minutes after the hour the period ends at",
      "type": "integer",
      "example": 1
    }
  }
}