fayzfayz sdk
PTEN

← Plugin catalog

plugin-orders

Beta

@fayz-ai/plugin-orders

Orders are the heartbeat of an operations business. plugin-orders gives a restaurant — or any food vertical — a real-time order board: dine-in, takeout, and delivery flowing across a kanban, with history behind it. It's the surface the floor staff actually live in.

Preview of plugin-orders as the customer sees it

Overview

Orders for restaurant operations: a kanban of orders by status, with dine-in, takeout and delivery sources. It mounts the /orders page. It's a vertical plugin (scope: 'vertical') and declares a dependency on plugin-menu for the item catalog.

It packages no migrations. By default it runs on an in-memory mock provider and, to persist on the Fayz platform, uses createFayzOrdersProvider with configurable table names (ordersTable, orderItemsTable). Menu-item and staff lookups are injected by the app. The stable channel already pins ^0.3.0.

For AI, it exposes getOrdersSummary, getActiveOrders and createOrder. Status beta / partial capability.

When to use it

  • Restaurant operations that need to follow orders in real time.
  • Split orders by dine-in, takeout and delivery on a kanban.
  • Pair it with plugin-menu (a declared dependency) for the items.

Specs

Package@fayz-ai/plugin-orders
Version0.3.0
Statusbeta
CapabilityPartial capability
Stable channel^0.3.0
Migrationsnone
FactorycreateOrdersPlugin()

Data model

No tables of its own — this plugin uses the core / archetype library (same rule: tenant_id + RLS). See Data model.

AI tools

idmodedescription
orders.today-summaryreadReturns order count, revenue, and average ticket for today or a given period.
orders.active-ordersreadLists currently active (non-completed) orders.
orders.create-orderpersistCreates a new restaurant order with items.

Tools an agent can call against your app. Your app as a data layer.

Integrations

No hosted connector — external providers come in via the connector spine. integrations catalog.

Use this page as a skill. .md of this page is the agent-consumable contract — data model, tools and integrations in a single file an AI reads directly. Preview fayz skill add plugin-orders is coming soon to install this as a skill. See Skills.

Integrate

Add the plugin to surfaces.admin.plugins in your app's app.manifest.json and run the doctor to validate:

{
  "surfaces": {
    "admin": {
      "plugins": [
        { "id": "orders", "enabled": true }
      ]
    }
  }
}
npx fayz doctor

fayz doctor checks the manifest against the SDK catalog. See Configuration.