API Reference

Create a check

post
https://prod.api.nxapp.net/public/v1/checks

Requires scope checks:write. Minimal, non-NX-specific payload — omit seats for a single implicit seat. Third-party-supplied price is honored per item; omit it to use the menu item's default price.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
number
string
string
enum

Default OPEN (live immediately, normal kitchen routing). QUEUED = pending staff acceptance.

Allowed:
items
array of objects

Single-seat convenience. Mutually exclusive with seats.

items
seats
array of objects
seats
Headers
string
length ≤ 255

Optional. Makes a retry safe: the same key with the same body within 24 hours returns the original response (header X-Idempotent-Replayed: true) instead of repeating the action. The same key with a different body returns 422; a request still in flight returns 409. Only 2xx responses are remembered. Scoped to your client, venue and route.

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?