Lunchbox · Schema

Order

Order schema from Lunchbox Core API

RestaurantOnline OrderingGuest EngagementCateringMenusOrdersLoyaltyEnterprise

Properties

Name Type Description
ordersid integer
restaurant_id integer
is_cancelable boolean
is_editable boolean
ordering_status string
comments_to_restaurant string
internal_notes string
tip_percentages array
customer object
charges object
View JSON Schema on GitHub

JSON Schema

core-order-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Order",
  "description": "Order schema from Lunchbox Core API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lunchbox/refs/heads/main/json-schema/core-order-schema.json",
  "type": "object",
  "properties": {
    "ordersid": {
      "type": "integer",
      "example": 1234
    },
    "restaurant_id": {
      "type": "integer",
      "example": 1234
    },
    "is_cancelable": {
      "type": "boolean",
      "example": true
    },
    "is_editable": {
      "type": "boolean",
      "example": true
    },
    "ordering_status": {
      "type": "string",
      "example": "string"
    },
    "comments_to_restaurant": {
      "type": "string",
      "example": "string"
    },
    "internal_notes": {
      "type": "string",
      "example": "string"
    },
    "tip_percentages": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "example": []
    },
    "customer": {
      "$ref": "#/components/schemas/Customer"
    },
    "charges": {
      "$ref": "#/components/schemas/Charges"
    }
  }
}