Revel Systems

Supergood | Revel Systems API

Alex Klarfeld

Alex Klarfeld

— 6 min read

Programmatically access Revel Systems POS data—orders, menu items, inventory, and customer loyalty—with a stable REST API. Supergood builds and operates production-grade, unofficial Revel integrations so your team can automate front-of-house and back-office processes without heavy custom engineering.

Plain English: Revel Systems is a cloud-based point-of-sale (POS) platform used by restaurants and retail businesses to run in-store transactions, manage menus and modifiers, track inventory, process payments, handle discounts and taxes, and coordinate staff and customer loyalty across one or many locations. An unofficial API lets you programmatically pull order histories and tender details, items and modifiers, stock levels and purchase flows, customers and loyalty points—and push updates like price changes, inventory adjustments, or new customer profiles back into Revel.

For a tech company integrating with Revel, this means you can ingest real-time sales and customer data to power analytics, reconcile tenders and taxes to accounting (e.g., QuickBooks, Xero), automate inventory counts and purchasing, sync menu changes across channels (POS, online ordering, kiosk), manage loyalty accruals and redemptions, and keep your ERP, data warehouse, eCommerce, delivery aggregators, and workforce tools in lockstep.

What is Revel Systems?

Revel Systems (https://revelsystems.com/) is an iPad-based POS and commerce platform designed for restaurants, quick-service, coffee shops, pizza, and retail concepts. It centralizes transaction processing, menu management, inventory/purchasing, customer loyalty, and staff operations with real-time reporting, multi-location administration, and integrations to payments, online ordering, and accounting.

Core product areas include:

  • Point of Sale & Ordering (Checks/Tickets, Items, Modifiers, Discounts, Taxes, Tips, Split Checks, Kitchen Display System)
  • Menu & Pricing (Items, Variants, Modifier Groups, Combos, Price Levels, Dayparts)
  • Inventory & Purchasing (SKUs, Stock Levels, Counts, Transfers, Vendors, Purchase Orders)
  • Customers & Loyalty (Profiles, Contact Data, Points/Rewards, Marketing Opt-Ins)
  • Employee & Operations (Roles/Permissions, Timecards, Shifts, Schedules)
  • Reporting & Multi-Location Management (Dashboards, Financial Reports, Consolidated Data)

Common data entities:

  • Companies, Locations, Terminals, Roles/Permissions
  • Employees (cashiers, managers), Timecards/Shifts
  • Orders/Checks (tickets), Line Items, Modifiers, Discounts, Taxes, Tips, Tenders
  • Menu Items, Modifier Groups, Price Levels, Categories
  • SKUs/Products, Inventory Levels, Adjustments, Vendors, Purchase Orders, Transfers
  • Customers, Loyalty Accounts/Points, Marketing Preferences

The Revel Integration Challenge

POS systems like Revel are mission-critical, but turning store workflows and reports into API-driven automation is non-trivial:

  • Location-aware data: Multi-store menus, taxes, and inventory vary by location and daypart
  • Financial rigor: Tax rates, tips, discounts, voids/refunds, and split tenders must reconcile precisely
  • Real-time needs: Orders and stock changes require near-real-time ingestion and idempotent updates
  • Authentication complexity: Role-based access, device sessions, and password/MFA policies complicate headless automation
  • API access and costs: Teams report limited or add-on API access, per-location licensing, and costly professional services
  • Export limitations: CSV reports and batch downloads are common; consistent webhooks or granular APIs may be constrained

How Supergood Creates Revel APIs

Supergood reverse-engineers authenticated browser and device flows to deliver a resilient API endpoint layer for your Revel tenant.

  • Handles username/password, SSO/OAuth, and MFA (SMS, email, TOTP) securely
  • Maintains session continuity with automated refresh and change detection
  • Normalizes responses across orders, menus, inventory, customers, and employees
  • Aligns with customer entitlements and role-based permissions to ensure compliant access

Use Cases

Order, Tender & Customer Data Sync

  • Mirror orders, line items, modifiers, discounts, taxes, tips, and tenders to your data warehouse
  • Keep customer profiles and loyalty balances current across systems
  • Normalize tax codes and tender types for downstream analytics and ERP
  • Update item prices, availability, and modifier groups across locations and channels
  • Coordinate daypart pricing and promotions, propagate changes from your catalog/PIM
  • Validate menu consistency and route items correctly to KDS

Inventory & Purchasing Automation

  • Pull stock levels, counts, and movements to drive reorders and reduce stockouts
  • Post inventory adjustments for waste, receipts, or transfers with audit metadata
  • Create vendor purchase orders and reconcile received quantities

Financials: Accounting & Reconciliation

  • Reconcile daily sales, tenders, tips, taxes, and refunds to accounting (e.g., QuickBooks, Xero)
  • Compare POS settlement reports to payment processor deposits
  • Drive exception handling for voids, discounts, and out-of-balance days

Available Endpoints

Authentication

POST /sessions: Establish a session using credentials. Supergood manages MFA (SMS, email, TOTP) and SSO/OAuth when enabled. Returns a short-lived auth token maintained by the platform.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/sessions \
  --header 'Authorization: Basic <Base64 encoded token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "[email protected]",
    "password": "<password>",
    "mfa": { "type": "totp", "code": "123456" }
  }'

Example response

{
  "authToken": "eyJhbGciOi...",
  "expiresIn": 3600,
  "user": {
    "id": "u_revel_48b102",
    "name": "Store Manager",
    "entitlements": ["orders", "menu", "inventory", "customers"]
  }
}

POST /sessions/refresh: Refresh an existing token to keep sessions uninterrupted.

Orders

GET /orders: List orders with filters and summary details.

Query parameters

  • locationId: string
  • status: open | closed | refunded | voided
  • source: pos | online | kiosk | delivery
  • updatedFrom, updatedTo: ISO 8601 timestamps
  • page, pageSize: integers for pagination

Example response

{
  "items": [
    {
      "orderId": "ord_7f29a1",
      "checkNumber": "32415",
      "locationId": "loc_sf_01",
      "source": "pos",
      "status": "closed",
      "createdAt": "2026-01-20T17:45:03Z",
      "closedAt": "2026-01-20T18:02:11Z",
      "employeeId": "emp_9031",
      "customerId": "cust_224a",
      "currency": "USD",
      "subtotal": 28.50,
      "taxTotal": 2.47,
      "tipTotal": 4.50,
      "discountTotal": 0.00,
      "total": 35.47,
      "tenders": [
        {"type": "card", "amount": 35.47, "cardBrand": "Visa", "last4": "4242"}
      ],
      "items": [
        {
          "lineId": "li_1001",
          "itemId": "itm_burger",
          "sku": "BRG-001",
          "name": "Classic Burger",
          "quantity": 1,
          "unitPrice": 12.00,
          "modifiers": [
            {"modifierId": "mod_cheese", "name": "Cheddar", "price": 1.50},
            {"modifierId": "mod_no_onion", "name": "No Onion", "price": 0.00}
          ],
          "discounts": [],
          "taxRate": 8.66
        },
        {
          "lineId": "li_1002",
          "itemId": "itm_fries",
          "sku": "FRY-001",
          "name": "Fries",
          "quantity": 1,
          "unitPrice": 5.50,
          "modifiers": [],
          "discounts": [],
          "taxRate": 8.66
        }
      ],
      "notes": "Guest sat at bar",
      "externalRef": "kds-2341"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "total": 1
}

PATCH /menu/items/{itemId}: Update item metadata, price, availability, tax category, and modifier groups.

curl --request PATCH \
  --url https://api.supergood.ai/integrations/<integration_id>/menu/items/itm_burger \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Classic Burger",
    "price": 12.50,
    "priceLevelId": "pl_lunch",
    "available": true,
    "onlineAvailable": true,
    "categoryId": "cat_burgers",
    "taxCategoryId": "tax_food",
    "modifierGroupIds": ["mg_cheese", "mg_toppings"],
    "kitchenRoute": "grill"
  }'

Example response

{
  "itemId": "itm_burger",
  "updated": true,
  "updatedAt": "2026-01-21T10:03:11Z"
}

Inventory Adjustments

POST /inventory/adjustments: Create an inventory adjustment for a SKU at a location (receipt, waste, manual count, transfer).

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/inventory/adjustments \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "sku": "BRG-PATTY-80",
    "locationId": "loc_sf_01",
    "reason": "receipt",
    "quantityDelta": 50,
    "unit": "each",
    "vendorId": "ven_meatco",
    "referenceId": "po-7892",
    "notes": "Received 5 boxes of 10 patties"
  }'

Example response

{
  "adjustmentId": "adj_55c912",
  "sku": "BRG-PATTY-80",
  "locationId": "loc_sf_01",
  "previousOnHand": 120,
  "newOnHand": 170,
  "reason": "receipt",
  "createdAt": "2026-01-21T11:20:44Z"
}

Customers

POST /customers: Create or update a customer profile with loyalty and marketing preferences.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/customers \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "externalId": "crm-49210",
    "firstName": "Alex",
    "lastName": "Lee",
    "email": "[email protected]",
    "phone": "+1-415-555-1212",
    "birthday": "1990-07-18",
    "marketingConsent": true,
    "address": {
      "line1": "250 Market St",
      "city": "San Francisco",
      "region": "CA",
      "postalCode": "94105",
      "country": "US"
    },
    "loyalty": {"accountId": "loy_9822", "pointsDelta": 50},
    "tags": ["vip", "burger-fan"]
  }'

Example response

{
  "customerId": "cust_224a",
  "loyalty": {"accountId": "loy_9822", "points": 275},
  "created": true,
  "updatedAt": "2026-01-22T08:15:12Z"
}

Get full API Specs →

Technical Specifications

  • Authentication: Username/password with MFA (SMS, email, TOTP) and SSO/OAuth where enabled; supports service accounts or customer-managed credentials
  • Response format: JSON with consistent resource schemas and pagination across modules
  • Rate limits: Tuned for enterprise throughput while honoring customer entitlements and usage controls
  • Session management: Automatic reauth and cookie/session rotation with health checks
  • Data freshness: Near real-time retrieval of orders, menu items, inventory, and customer objects
  • Security: Encrypted transport, scoped tokens, and audit logging; respects Revel role-based permissions
  • Webhooks: Optional asynchronous delivery for long-running workflows (e.g., online orders, loyalty updates)

Performance Characteristics

  • Latency: Sub-second responses for list/detail queries under normal load
  • Throughput: Designed for high-volume order sync and inventory/menu updates across multi-location estates
  • Reliability: Retry logic, backoff, and idempotency keys minimize duplicate actions
  • Adaptation: Continuous monitoring for UI/API changes with rapid adapter updates

Getting Started

  1. Schedule Integration Assessment

Book a 30-minute session to confirm your modules, licensing, and authentication model.

  1. Supergood Builds and Validates Your API

We deliver a hardened Revel adapter tailored to your workflows and entitlements.

  1. Deploy with Monitoring

Go live with continuous monitoring and automatic adjustments as Revel evolves.

Schedule Integration Call →

Frequently Asked Questions

Q: Which Revel modules can this integration cover?

Supergood supports workflows across commonly used modules such as POS Orders (tickets, line items, modifiers, discounts, tips), Menu Management (items, categories, modifier groups, price levels), Inventory & Purchasing (SKUs, stock, adjustments, vendors), and Customers & Loyalty (profiles, points), subject to your licensing and entitlements. We scope coverage during integration assessment.

Q: How are MFA and SSO handled for automation?

We support username/password + MFA (SMS, email, TOTP) and can operate behind SSO/OAuth when enabled. Sessions are refreshed automatically with secure challenge handling.

Q: Can you sync daily sales and tenders to our accounting system?

Yes. We normalize orders, taxes, tips, discounts, and tender breakdowns to match your ERP/accounting schema and deliver updates via webhooks or polling while complying with rate and permission constraints. We commonly integrate with QuickBooks and Xero.

Q: Do you support inventory counts and purchase orders?

We support reading stock levels, posting inventory adjustments (receipts, waste, transfers), and can model vendor purchase flows to align with your supply chain. Adjustments include audit metadata and location context.

Ready to automate your Revel workflows?

Supergood can have your Revel integration live in days with no ongoing engineering maintenance.

Get Started →

Read more