Flipdish · Schema

OrderBatch

Order batch detailed information

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
OrderIds array Orders' ids on the batch
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-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-schema.json",
  "title": "OrderBatch",
  "description": "Order batch detailed information",
  "type": "object",
  "properties": {
    "OrderIds": {
      "description": "Orders' ids on the batch",
      "type": "array",
      "items": {
        "format": "int32",
        "type": "integer"
      },
      "example": [
        1
      ]
    },
    "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
    }
  }
}