TheFork · JSON Structure

Thefork Pos Order Structure

Type: object Properties: 9 Required: 5
RestaurantReservationsBookingDiningPoint Of SaleMarketplace

Order is a JSON Structure definition published by TheFork, describing 9 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

orderId createdAt reservationStatus partySize startTime customer prepayment offer tables

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

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "Order",
  "type": "object",
  "required": [
    "orderId",
    "createdAt",
    "reservationStatus",
    "partySize",
    "startTime"
  ],
  "properties": {
    "orderId": {
      "type": "uuid",
      "description": "TheFork's UUID for the order.",
      "example": "2c1f7e90-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
    },
    "createdAt": {
      "type": "datetime",
      "description": "ISO 8601 timestamp when the order was opened.",
      "example": "2026-06-20T20:35:00Z"
    },
    "reservationStatus": {
      "$ref": "./thefork-pos-reservation-status-schema.json"
    },
    "partySize": {
      "type": "int32",
      "description": "Number of guests.",
      "example": 4
    },
    "startTime": {
      "type": "datetime",
      "description": "Scheduled meal start time (ISO 8601).",
      "example": "2026-06-20T20:30:00Z"
    },
    "customer": {
      "$ref": "./thefork-pos-customer-schema.json"
    },
    "prepayment": {
      "$ref": "./thefork-pos-money-schema.json"
    },
    "offer": {
      "$ref": "./thefork-pos-offer-schema.json"
    },
    "tables": {
      "type": "array",
      "items": {
        "$ref": "./thefork-pos-table-schema.json"
      }
    }
  }
}