Welcome to the NX Restaurant Cloud API

The NX Restaurant Cloud API is the primary gateway for developers and integrators looking to build powerful connections with the NX ecosystem. This RESTful API provides secure, programmatic access to the data and configuration settings stored within the NX Cloud infrastructure.

Whether you are building a custom enterprise dashboard, syncing labor data with an external payroll provider, or managing centralized menus for a franchise, this is the toolset you will use. 🚀

🛠️ What is this API for?

This API is designed for Cloud-to-Cloud or Server-to-Cloud interactions. It is the source of truth for your organization's data.

Common use cases include:

Reporting & Analytics: Pulling sales, labor, and product mix data for custom reporting.
Enterprise Configuration: Managing menus, prices, and employee profiles across multiple locations.
Third-Party Integrations: Syncing data with Inventory, Accounting, or Loyalty platforms.

⚠️ Important Distinction: Cloud vs. In-Store

Before you begin, it is critical to understand the architecture of the NX ecosystem.

This API (Cloud API): Interacts with the NX Cloud. It is used for configuration, reporting, and data management that happens above the store level. It requires internet connectivity.
In-Store API (Device API): There is a separate, siloed API for interacting directly with hardware and local functions inside the physical restaurant (e.g., triggering a specific printer, opening a cash drawer, or interacting with a payment terminal in real-time).

If your integration requires direct control over physical hardware or offline-capable local functions, please refer to the In-Store API documentation.

Ready to Build?

Explore the endpoints on the left to start building legendary solutions with NX. 💻