Readylert
API Reference

Integrate Readylert into your POS.

A simple REST API for reading session state, triggering order updates, and building custom integrations with your existing point-of-sale system.

Base URL

https://readylert.com/api

All API endpoints are served over HTTPS. The base URL is the same for all environments — use your vendor credentials to authenticate.

Authentication

Vendor API endpoints use session-based authentication. Log in with your vendor email and password to receive a session cookie, then include that cookie with subsequent requests.

POST
/auth/login

Authenticate as a vendor. Returns a session cookie valid for 7 days.

Parameters

emailstringrequiredVendor email address
passwordstringrequiredVendor account password

Example request

curl -X POST https://readylert.com/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"you@restaurant.com","password":"yourpassword"}' \
  -c cookies.txt

Response

{
  "vendorId": 42,
  "name": "The Burger Bar",
  "email": "you@restaurant.com"
}

Customer sessions

A customer session is created when a customer scans your QR code. Sessions track the order lifecycle from connection through to completion.

GET
/vendors/:vendorId/sessions

List all active customer sessions for a vendor.

Requires authentication

Example request

curl https://readylert.com/api/vendors/42/sessions \
  -b cookies.txt

Response

[
  {
    "id": "uuid-1234",
    "orderNumber": "ORD-007",
    "status": "preparing",
    "orderAssignedAt": "2026-07-12T14:32:00Z",
    "createdAt": "2026-07-12T14:30:00Z"
  }
]
POST
/vendors/:vendorId/sessions/:sessionId/ready

Mark a customer's order as ready. Triggers an immediate alert on the customer's device.

Requires authentication

Example request

curl -X POST https://readylert.com/api/vendors/42/sessions/uuid-1234/ready \
  -b cookies.txt

Response

{
  "ok": true,
  "sessionId": "uuid-1234",
  "status": "ready",
  "readyAt": "2026-07-12T14:47:00Z"
}
POST
/vendors/:vendorId/sessions

Create a new customer session (optional — sessions are usually created by the customer scanning the QR code). Useful for POS integrations that pre-register orders.

Requires authentication

Parameters

orderNumberstringPOS order reference

Example request

curl -X POST https://readylert.com/api/vendors/42/sessions \
  -H "Content-Type: application/json" \
  -b cookies.txt \
  -d '{"orderNumber":"ORD-008"}'

Response

{
  "id": "uuid-5678",
  "orderNumber": "ORD-008",
  "status": "connected",
  "qrUrl": "https://readylert.com/wait/uuid-5678",
  "createdAt": "2026-07-12T14:50:00Z"
}

Status codes

200Success
400Bad request — check your request body
401Unauthenticated — log in first
403Forbidden — your session doesn't have access to this resource
404Not found — the session or vendor doesn't exist
500Server error — contact support@readylert.com

Need help with an integration?

Our team can help you connect Readylert to your existing POS system — whether that's Square, Lightspeed, Zettle, or a custom setup.

Contact our API team