API Reference

REST API Reference

Integrate Digital Dineway into your own systems using our REST API. Available on Business and Enterprise plans.

Watch: API integration walkthrough

Video tutorial coming soon

We're producing a walkthrough for this guide. In the meantime, the written steps below cover everything.

A developer-focused tour of authentication, endpoints, and webhooks.

Authentication

All API requests must include your API key in the Authorization header using the Bearer scheme.

Example request

curl https://api.dineway.io/v1/outlets \
  -H "Authorization: Bearer dd_live_xxxxxxxxxxxx" \
  -H "Content-Type: application/json"

Generate your API key from Settings → API → Generate Key. Keep it secret — treat it like a password.

Base URL

https://api.dineway.io

All endpoints are versioned under /v1/. We will give 6 months notice before deprecating any version.

Endpoints

Outlets

GET/v1/outletsList all outlets for your account

POST/v1/outletsCreate a new outlet

GET/v1/outlets/{id}Retrieve a specific outlet

PATCH/v1/outlets/{id}Update outlet details

DELETE/v1/outlets/{id}Delete an outlet

Menus

GET/v1/outlets/{id}/menuRetrieve the full menu for an outlet

POST/v1/menus/categoriesCreate a menu category

POST/v1/menus/itemsCreate a menu item

PATCH/v1/menus/items/{id}Update a menu item

DELETE/v1/menus/items/{id}Remove a menu item

Orders

GET/v1/ordersList orders (supports filters)

GET/v1/orders/{id}Retrieve a specific order

PATCH/v1/orders/{id}/statusUpdate order status

GET/v1/orders/exportExport orders as CSV

Analytics

GET/v1/analytics/summaryOverview metrics for a date range

GET/v1/analytics/peak-hoursHourly order distribution

GET/v1/analytics/itemsPer-item performance metrics

Webhooks

GET/v1/webhooksList registered webhook endpoints

POST/v1/webhooksRegister a new webhook endpoint

DELETE/v1/webhooks/{id}Remove a webhook endpoint

Webhook Events

order.createdFired when a guest places a new order

order.updatedFired when an order status changes

order.completedFired when an order is marked complete

menu.updatedFired when menu content is modified

outlet.createdFired when a new outlet is added

Rate Limits

Business600 requests / minute

EnterpriseCustom — contact sales

Rate limit headers are returned on every response: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

Resources

API access

Available on Business and Enterprise plans.

View plans →