Flipdish · JSON Structure

Orders Order Batch Structure

Order batch detailed information

Type: object Properties: 5
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

OrderBatch is a JSON Structure definition published by Flipdish, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

OrderIds Id DisplayCode CreateTime IsPublished

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-structure/orders-order-batch-structure.json",
  "name": "OrderBatch",
  "description": "Order batch detailed information",
  "type": "object",
  "properties": {
    "OrderIds": {
      "description": "Orders' ids on the batch",
      "type": "array",
      "items": {
        "type": "int32"
      },
      "example": [
        1
      ]
    },
    "Id": {
      "description": "Order batch id",
      "type": "int32",
      "example": 500123
    },
    "DisplayCode": {
      "description": "Order batch 6-sign human readable code",
      "type": "string",
      "example": "string"
    },
    "CreateTime": {
      "description": "Batch creation date and time",
      "type": "datetime",
      "example": "2026-06-02T12:00:00Z"
    },
    "IsPublished": {
      "description": "If the batch is already published",
      "type": "boolean",
      "example": true
    }
  }
}