DishControl Integration Server Documentation

Authentication

Admin issues a Client ID and Client Secret in the admin portal. Exchange those credentials at POST /authorisation/v1/accesstoken.

Send the returned access token as Authorization: Bearer {access_token}.

Supplier tokens can only access /supplier/..., customer tokens can only access /customer/..., and admin tokens can access all namespaces.

Versioning

All partner APIs are grouped by namespace and version, for example /supplier/v1/api/....

Breaking changes should get a new version path.

System endpoints

GET/
Human-readable documentation website.
GET/v1
Machine-readable namespace index.
GET/health
Service health check.
POST/authorisation/v1/accesstoken
Exchange admin-issued client credentials for a short-lived bearer access token.
GET/openapi.yaml
OpenAPI 3.1 contract. Keep this file updated with every API change.

Supplier API

GET/supplier/v1/api
Supplier API index.
GET/supplier/v1/api/orders
List supplier orders for the authenticated supplier.
GET/supplier/v1/api/orders/{id}
Get supplier order details including lines.
PATCH/supplier/v1/api/orders/{id}/status
Update supplier order status.
GET/supplier/v1/api/assortments
List supplier assortments for the authenticated supplier.
GET/supplier/v1/api/assortments/{id}
Get supplier assortment details including articles.
POST/supplier/v1/api/articles
Create or update a supplier article.

Supplier EDI

POST/supplier/v1/edi/inbound
Reserved for supplier inbound EDI messages.

Admin API

GET/admin/v1
Admin API index.
GET/admin/v1/integration-logs
Reserved for integration logs.

Customer API

GET/customer/v1/orders
Reserved for customer order integrations.
GET/customer/v1/recipes
Reserved for customer recipe integrations.

Maintenance rule

When an API route, request body, response, authentication rule, or status code changes, update this documentation and public_html/openapi.yaml in the same commit.