Trellis Platform API
Build restaurant, retail, payments, and guest experiences on the Trellis platform.
Trellis exposes a typed REST API for restaurant and retail operations. The platform combines catalog, customer, order, payment, dining room, labor, cash management, and integration workflows behind one tenant-aware contract.
Contract coverage
This site is generated from the current Trellis OpenAPI 3.0 contract. Endpoint schemas, parameters, responses, and code samples stay tied to the server implementation.
Start here
Quickstart
Run the API and documentation locally.
Request context
Understand authentication, tenants, locations, and staff resolution.
Resource map
Choose the right API domain for your workflow.
API reference
Browse every operation in the OpenAPI contract.
Base URL
During local development, requests are served from:
http://localhost:3000Use the interactive request builder on any reference page to inspect request bodies, response shapes, and generated examples.
Documentation workflow
Narrative guides live in content/docs. Endpoint pages are generated from openapi/trellis.json with pnpm docs:generate. When the platform contract changes, sync the exported schema and regenerate the reference before publishing.