API reference
API reference
Explore every Trellis platform operation, grouped by product domain.
The API reference is generated from openapi/trellis.json. Choose a domain in the sidebar to inspect its endpoints, parameters, request bodies, response schemas, and runnable code samples.
Local requests
Start the Trellis platform on http://localhost:3000, then use the request builder on any domain page to compose and send an API request.
Browse by workflow
- Sell and fulfill: Catalog, Inventory, Orders, Payments, and Fulfillment
- Serve guests: Customers, Reservations, Restaurant, and Tables
- Run the business: Labor, Cash Management, Reporting, and Foundation
- Extend Trellis: Apps, Media, and Webhooks
Use search to jump directly to an operation name, route, or concept.