API Integrations – Access, Policy & Privacy
Current version: v3.6 (read-only)
v3.8 is in development (beta), only available upon request and review.
1. Access to the API
- API access is available for restaurants themselves (own use).
- Access applies exclusively to reading data (read-only) for that specific restaurant.
- Reading data from multiple restaurants at once is currently not possible.
- External integration partners may gain access, provided explicit permission from the restaurant and within the scope of API v3.6.
Available Environments
- Production Environment: live data, read-only access only.
- Test Environment (UAT): suitable for technical validation and required testing steps.
➤ SwaggerHub API documentation is available for this test environment.
2. Available API Endpoints
Orders
| Endpoint | v3.6 | v3.8 | Description |
|---|---|---|---|
| /orders/recent | ✅ | ✅ | Retrieve recent orders |
| /orders/recent/{platform} | ✅ | ✅ | Specified by platform |
| /orders/archived | ✅ | ✅ | Retrieve archived orders |
| /orders/archived/{platform} | ✅ | ✅ | Specified by platform |
| /orders/unconfirmed | ✅ | ✅ | Unconfirmed orders |
| /orders/unconfirmed/{platform} | ✅ | ✅ | Specified by platform |
| /orders/deleted | ✅ | ✅ | Deleted orders |
| /orders/preordered | ✅ | ✅ | Pre-ordered orders |
| /orders/preordered/{platform} | ✅ | ✅ | Specified by platform |
| /order/{platform}/{id} (GET) | ✅ | ✅ | Order details |
| /order/create/{platform} (POST) | ❌ | ✅ | Only in v3.8 (write, beta) Create Order |
| /order/{platform}/{id} (PUT) | ❌ | ✅ | Only in v3.8 (write, beta) Update order status |
Accounting
| Endpoint | v3.6 | v3.8 | Description |
|---|---|---|---|
| /accounting/turnover | ✅ | ✅ | Retrieve turnover |
Restaurant Info
| Endpoint | v3.6 | v3.8 | Description |
|---|---|---|---|
| /restaurant | ✅ | ✅ | Basic information |
| /restaurant/menu | ✅ | ✅ | Retrieve menu |
| /restaurant/discounts | ✅ | ✅ | Retrieve discounts |
| /restaurant/reviews | ✅ | ✅ | Retrieve customer reviews |
Restaurant Tables
| Endpoint | v3.6 | v3.8 | Description |
|---|---|---|---|
| /restaurant/tables | ✅ | ✅ | Overview of tables |
| /restaurant/table/{tableId} (GET) | ✅ | ✅ | Table details |
| /restaurant/table (POST) | ✅ | ✅ | Add new table |
| /restaurant/table/{tableId} (PUT) | ✅ | ✅ | Edit table |
| /restaurant/table/{tableId} (DELETE) | ✅ | ✅ | Delete table |
Lookup & POS
| Endpoint | v3.6 | v3.8 | Description |
|---|---|---|---|
| /lookup/{zipcode}/{streetNumber} | ✅ | ✅ | Address lookup |
| /pos/client/info (POST) | ✅ | ✅ | POS information |
3. Privacy & Customer Data Protection
- Only data necessary for order processing is shared.
- Customer data such as email or phone number is not shared via the API.
- The API is explicitly not intended for marketing, analytics or other uses.
- Exception: Restaurant owners may request access to email addresses of customers who have actually placed an order via support. This is GDPR-compliant.
4. Terms & Usage Types
| Usage Type | Read-only | Write orders | Conditions |
|---|---|---|---|
| Own use (restaurant) | ✅ | ❌ | Access via support |
| Integration partner (within API v3.6 scope) | ✅ | ❌ | Restaurant consent required |
| Integration partner (outside scope) | ❌ | ❌ | Review by Sitedish required |
- External parties must have a data processing agreement when accessing customer data.
- Requests outside standard scope are evaluated individually for necessity, privacy compliance, and feasibility.
5. Request Process
We are developing a request form. A request should include at least:
- API version (v3.6, v3.8 beta or other)
- Applicant’s name
- Restaurant name
- Usage type (own restaurant / integration partner)
- Explanation/justification
- Used test environment? (yes/no)
💡 Tip: Reading via v3.6 can usually be approved directly.
Write actions or beta (v3.8) require mandatory test validation.
