Welcome to the NX Restaurant In-Store API

The NX Restaurant In-Store API is a specialized, high-performance interface designed for the local restaurant environment. Unlike the Cloud API—which manages data organization-wide—this API operates strictly within the four walls of the restaurant, providing real-time access to the events occurring on the POS devices and local network.

This interface is the "pulse" of the restaurant, allowing local subsystems to react instantly to orders, payments, and status changes. ⚡

📡 Architecture: Emission & Broadcast Only

It is critical to understand the data flow of this API:

The In-Store API is a "Push-Only" interface.
It does not accept incoming requests, commands, or data modifications. Instead, it acts as a broadcaster that emits, posts, or streams data models as events occur in real-time.

• No Inbound Control: You cannot use this API to create orders or change prices (use the Cloud API for that).
• Real-Time Output: You listen to this API to receive immediate notifications about what is happening on the floor.

📦 Data Models & Structures

The documentation sections below outline the specific Data Models and JSON Structures emitted by the system. These payloads cover a wide range of operational events, including:

• Order Events: Creation, modification, and completion of checks.
• Payment Events: Authorization, settlement, and tender details.
• Device Status: Local connectivity and hardware health updates.

Integrators should configure their local listeners to accept these specific structures as defined in the schema reference.

Ready to Listen?

Explore the data definitions on the left to begin integrating with the real-time heartbeat of NX. 🎧