Ordering Channel API (Beta)
Welcome to the OneTablet Ordering Channel API documentation. This API enables ordering platforms to receive menus from OneTablet and send customer orders to restaurants.
Overview
Become an ordering channel for OneTablet's restaurant network. Whether you're building:
- Mobile Apps - Native iOS/Android ordering applications
- Websites - Online ordering portals and e-commerce
- Kiosks - Self-service ordering terminals
- AI Agents - Voice ordering, chatbots, phone systems
- Third-Party Platforms - Food delivery and ordering services
OneTablet manages the restaurant menus, item availability, and order fulfillment. You display the menu to customers and send orders to us.
Integration Model
OneTablet owns and manages:
- Menus - We push menu updates to you, or you pull from us
- Item Availability - We notify you when items are 86'd
- Store Status - We control when stores are online/paused
- Order Acceptance - We confirm or reject orders from restaurants
Your platform handles:
- Customer Experience - Display menus, collect orders
- Order Submission - Send orders to OneTablet via API
- Order Cancellation - Request cancellations when needed
- Delivery - Manage delivery logistics (if applicable)
Integration Flow
┌─────────────────────┐ ┌─────────────────────┐ ┌─────────────────────┐
│ Your Platform │ │ OneTablet │ │ Restaurant │
│ (Ordering Channel) │ │ │ │ (Tablet/POS) │
└─────────────────────┘ └─────────────────────┘ └─────────────────────┘
│ │ │
│ 1. Menu Push (or Pull) │ │
│◄────────────────────────────────│ (Menu managed here) │
│ │ │
│ 2. Customer Places Order │ │
│─────────────────────────────────► 3. Route to Restaurant │
│ (POST /orders) │─────────────────────────────►│
│ │ │
│ 4. Order Accepted/Rejected │ 5. Kitchen Confirms │
│◄────────────────────────────────│◄─────────────────────────────│
│ (We call your webhook) │ │
│ │ │
│ 5. Order Ready │ 6. Kitchen Marks Ready │
│◄────────────────────────────────│◄─────────────────────────────│
│ (We call your webhook) │ │
│ │ │
│ 6. Item Availability Updates │ │
│◄────────────────────────────────│ (86ing from kitchen) │
│ (We call your webhook) │ │
What You Need to Implement
API Endpoints You Call (OneTablet's API)
Your platform calls these endpoints on our system:
| Endpoint | Purpose |
|---|---|
POST /orders | Submit a new customer order |
POST /orders/{id}/cancel | Request order cancellation |
POST /orders/{id}/delivery-status | Send delivery status updates (if you manage delivery) |
GET /pull/menus/{store_id} | Fetch current menu for a store (optional) |
Webhooks You Receive (Endpoints You Expose)
OneTablet calls these callback endpoints on your system:
| Webhook | Purpose |
|---|---|
| Order Confirmation | Receive accept/reject decisions for orders |
| Order Ready | Receive notification when order is ready for pickup |
| Order Cancellation | Receive cancellation from restaurant |
| Menu Push | Receive menu updates from OneTablet |
| Item Availability | Receive 86 updates (items going unavailable) |
| Store Status | Receive store online/offline status changes |
Authentication
- Your endpoints: Authenticate our calls using shared secrets or API keys (configured during integration)
- Our API endpoints: We provide authentication credentials during integration
Getting Started
- Contact OneTablet - Reach out to technical support to begin integration
- Implement Webhook Endpoints - Build the callback endpoints on your platform for receiving order confirmations, menu updates, etc.
- Integrate API Calls - Set up your system to call OneTablet's API for order submission
- Test Integration - Validate with test orders in sandbox environment
- Go Live - Launch with production credentials
Documentation Sections
- API Endpoints - OneTablet API endpoints you call
- Webhooks - Callback endpoints you expose for OneTablet to call
- Menu Pull API - Optional API for fetching menus
- Order Schema - Order data structure
- Menu Schema - Menu data structure
- Order Lifecycle - Order flow and states
Support
Contact OneTablet technical support for:
- Integration credentials and configuration
- Technical assistance
- Sandbox environment access