Introduction

Welcome to the Innovorder Developer Hub. Innovorder is the leading omnichannel platform for modern foodservice, unifying POS, Kiosks, Online Ordering, and Kitchen Display Systems into a single, cohesive ecosystem. Our API is the heartbeat of this infrastructure, designed to empower developers, integrators, and partners to build custom solutions that extend our core capabilities. Whether you are building a bespoke loyalty app, integrating with a corporate ERP, or synchronizing inventory in real-time, our platform provides the robust, secure, and scalable foundation you need to digitize restaurant operations.

At the center of our ecosystem lies the Catalog (PIM) and Order Management System (OMS). Our API follows RESTful principles, offering predictable resource-oriented URLs, standard HTTP response codes, and JSON-encoded request/response bodies. This documentation provides a comprehensive reference for interacting with these core entities. You can programmatically manage complex menus with recursive options, retrieve real-time transaction history, and synchronize customer data across all sales channels seamlessly to ensure a unified customer experience.

Beyond raw endpoint references, we believe in "Recipe-based" documentation. Our Guides & Recipes section specifically targets common integration scenarios such as "Guest App Integration", "Accounting Exports", or "Web Ordering SSO". These recipes provide step-by-step workflows, from authentication to final execution, ensuring you understand not just how to call an endpoint, but why and when to use it within a business process to achieve your integration goals efficiently.

In the fast-paced world of foodservice, latency matters. That's why our platform is built for real-time interaction. Our Webhooks infrastructure allows your external systems to react instantly to events occurring in the restaurant - be it a new order placed on a Kiosk, a customer updating their profile, or a payment validation. Instead of inefficient polling, your applications can subscribe to specific events, ensuring data consistency across your entire tech stack with minimal overhead and maximum reliability.

Our ultimate objective is to provide a developer-first experience that accelerates innovation. This interactive documentation includes a built-in AI assistant to help answer your specific queries, copy-pasteable request/response examples for every endpoint, and detailed error codes to speed up debugging. We are constantly evolving our API to support new consumption modes and operational workflows. We invite you to explore, build, and innovate with us to redefine the future of the restaurant industry.

API Principles

Our API is designed around RESTful principles to provide a consistent and predictable experience for developers. By adhering to standard HTTP conventions, resource-oriented URLs, and JSON-based communication, we ensure that integrating with the Innovorder ecosystem is intuitive and efficient.

The API uses standard HTTP verbs and status codes to communicate.

HTTP Verbs

• GET - Read resources (catalog, data, etc.)
• POST - Create new resources (Orders, products, users)
• PUT - Update existing resources
• DELETE - Delete resources

JSON Response Contract

Most JSON endpoints use the standard Innovorder response envelope. The endpoint cards show the complete response example and list every property below it. Use code for programmatic handling, and treat message as display text only because it is localized.

{
  "status": 200,
  "code": "resource_succeed",
  "message": "The resource was retrieved successfully.",
  "data": {}
}

A small number of endpoints intentionally return a file, a redirect, or another non-standard response. Their endpoint cards state that behavior explicitly instead of implying this envelope.

Language Headers

The default language is English. You can specify the language by setting the io-locale header.

io-locale: fr