Dashboard developer reference
Build operator workflows without coupling an integration to private Dashboard implementation details. Dashboard is a browser client: it composes operator routes and shared UI contexts, while the Ordering.co API authorizes data access and mutations. External providers remain responsible for their own credentials, availability, and results.
Choose the right reference
| Goal | Reference |
|---|---|
| Authenticate a client, call an Ordering.co API operation, or inspect request and response schemas | Use the canonical API Reference in the documentation header. Start with the public POST /auth contract. |
| Connect configuration, plugins, POS or sales channels, delivery services, payments, maps, notifications, or analytics | Integrations, API, and provider handoffs |
| Change Dashboard source, run it locally, test it, or prepare a release | Dashboard engineering guide |
The integration reference explains ownership and handoffs. The engineering guide explains the repository and contributor workflow. Neither page replaces the API Reference or a provider's approved documentation.
Architecture boundary
Dashboard combines:
- a Vite and React application that owns routing and page composition;
- an in-tree components layer that provides API, session, configuration, order, business, language, realtime, and UI contexts;
- runtime and build configuration that selects a project and backend boundary; and
- browser and third-party providers for capabilities such as maps, payments, analytics, support, notifications, and realtime delivery.
Client route visibility is not authorization. A configuration value, plugin record, feature flag, or rendered control shows that the client can attempt a workflow; the API and provider still decide whether the current actor and resource are eligible.
Provider availability and supported capabilities depend on the project's configuration and deployed Dashboard and API versions. Confirm the target project's setup before relying on an integration.
Product guidance
For operator-facing behavior, start with the Dashboard product documentation. Use developer references when you need to identify the technical owner of a handoff, configuration value, failure, or source change.