Flipdish · Schema

OrderBatchSummary

Order batch info

RestaurantOnline OrderingMobile AppsPoint-of-SaleOrderMenusPaymentsWebhook

Properties

Name Type Description
Id integer Order batch id
DisplayCode string Order batch 6-sign human readable code
CreateTime string Batch creation date and time
IsPublished boolean If the batch is already published
View JSON Schema on GitHub

JSON Schema

orders-order-batch-summary-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/orders-order-batch-summary-schema.json",
  "title": "OrderBatchSummary",
  "description": "Order batch info",
  "type": "object",
  "properties": {
    "Id": {
      "format": "int32",
      "description": "Order batch id",
      "type": "integer",
      "example": 500123
    },
    "DisplayCode": {
      "description": "Order batch 6-sign human readable code",
      "type": "string",
      "example": "string"
    },
    "CreateTime": {
      "format": "date-time",
      "description": "Batch creation date and time",
      "type": "string",
      "example": "2026-06-02T12:00:00Z"
    },
    "IsPublished": {
      "description": "If the batch is already published",
      "type": "boolean",
      "example": true
    }
  }
}