Revel Systems website screenshot

Revel Systems

Revel Systems is a cloud iPad-based POS for restaurants and retailers. The Revel Open API exposes products, orders, customers, employees, inventory, schedules, and reporting via a REST interface for partner integrations. The API follows Django Tastypie conventions (objects/meta list envelope, field-lookup filtering) and is complemented by an HMAC-signed webhook channel.

Revel Systems publishes 6 APIs on the APIs.io network, including Revel Webhooks, Customers API, Establishments API, and 3 more. Tagged areas include POS, Restaurant, Retail, and iPad.

The Revel Systems catalog on APIs.io includes 1 event-driven AsyncAPI specification, 2 JSON-LD contexts, and 3 Spectral governance rulesets.

Revel Systems’ developer surface includes authentication, FAQ, and 11 more developer resources.

🌐 Visit website 📡 Source on GitHub
43.1/100 developing ▼ -6.4 Agent 42/100 agent ready Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessSelf serve
6 APIs 5 Features 5 Use Cases
POSRestaurantRetailiPad

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 43.1/100 · developing
Contract Quality 18.6 / 25
Developer Ergonomics 2.2 / 20
Commercial Clarity 5.8 / 20
Operational Transparency 3.4 / 13
Governance 7.5 / 12
Discoverability 5.6 / 10
Agent readiness — 42/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 6 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/revel-systems: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 6

Individual APIs this provider publishes, each with its own machine-readable definition.

Revel Webhooks

Event-driven webhook channel that delivers POS events (order finalized, customer created/updated, stock changes, menu updates, timesheet changes, integration changes, reward car...

Revel Systems Customers API

Customer records and addresses.

Revel Systems Establishments API

Establishment (location) resources.

Revel Systems Orders API

Order and order-item resources.

Revel Systems Products API

Product catalog and modifier resources.

Revel Systems Scheduling API

Labor scheduling and timesheet resources.

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Revel Open API

OPEN COLLECTION

Pricing Plans 1

Published pricing tiers and plan structures.

Revel Systems Plans Pricing

1 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Revel Systems Rate Limits

2 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Revel Systems Finops

FINOPS

Features 5

Notable capabilities this provider offers.

Tastypie REST Conventions

List endpoints return an objects array with a meta pagination envelope (total_count, limit, offset, next, previous).

Field-Lookup Filtering

Filter resources with Django-style lookups (e.g. id__lt, created_date__range, name__icontains).

Field Selection and Expansion

Use the fields parameter to limit returned attributes and expand to inline one level of foreign-key relationships.

Batch Retrieval

Retrieve multiple records by ID in a single call using the set/id1;id2;id3 path form.

Signed Webhooks

Real-time event delivery secured with HMAC-SHA1 signatures and per-event-type endpoint registration.

Event Specifications 1

AsyncAPI definitions for this provider's event-driven and streaming APIs.

Revel Webhooks

Revel Systems delivers event notifications to partner-registered HTTPS endpoints via webhooks. Each event type is delivered by HTTP POST with a JSON body. Requests carry an HMAC...

ASYNCAPI

Semantic Vocabularies 2

JSON-LD contexts and semantic vocabularies used across these APIs.

Revel Open Api Context

10 classes · 50 properties

JSON-LD

Revel Webhooks Context

8 classes · 12 properties

JSON-LD

Spectral Rules 3

Spectral governance rulesets for linting and validating these APIs.

Revel Systems API Rules

5 rules · 5 warnings

SPECTRAL

Revel Systems API Rules

5 rules · 4 warnings 1 info

SPECTRAL

Revel Systems API Rules

34 rules · 8 errors 18 warnings 8 info

SPECTRAL

JSON Schema 18

Standalone JSON Schema definitions for this provider's data models.

CustomerList

2 properties

JSON SCHEMA

Customer

13 properties

JSON SCHEMA

EstablishmentList

2 properties

JSON SCHEMA

Establishment

7 properties

JSON SCHEMA

OrderList

2 properties

JSON SCHEMA

Order

22 properties

JSON SCHEMA

ProductList

2 properties

JSON SCHEMA

Product

19 properties

JSON SCHEMA

TimeScheduleList

2 properties

JSON SCHEMA

TimeSchedule

10 properties

JSON SCHEMA

CustomerEventPayload

4 properties

JSON SCHEMA

IntegrationChangedPayload

1 properties

JSON SCHEMA

MenuUpdatedPayload

1 properties

JSON SCHEMA

OrderFinalizedPayload

2 properties

JSON SCHEMA

PingPayload

1 properties

JSON SCHEMA

RewardCardEventPayload

2 properties

JSON SCHEMA

StockStatusPayload

4 properties

JSON SCHEMA

TimesheetEventPayload

4 properties

JSON SCHEMA

Scroll for all 18

JSON Structure 18

JSON Structure definitions describing this provider's data shapes.

Revel Open Api Customer List Structure

2 properties

JSON STRUCTURE

Revel Open Api Customer Structure

13 properties

JSON STRUCTURE

Revel Open Api Establishment List Structure

2 properties

JSON STRUCTURE

Revel Open Api Establishment Structure

7 properties

JSON STRUCTURE

Revel Open Api Order List Structure

2 properties

JSON STRUCTURE

Revel Open Api Order Structure

22 properties

JSON STRUCTURE

Revel Open Api Product List Structure

2 properties

JSON STRUCTURE

Revel Open Api Product Structure

19 properties

JSON STRUCTURE

Revel Open Api Time Schedule List Structure

2 properties

JSON STRUCTURE

Revel Open Api Time Schedule Structure

10 properties

JSON STRUCTURE

Revel Webhooks Customer Event Payload Structure

4 properties

JSON STRUCTURE

Revel Webhooks Integration Changed Payload Structure

1 properties

JSON STRUCTURE

Revel Webhooks Menu Updated Payload Structure

1 properties

JSON STRUCTURE

Revel Webhooks Order Finalized Payload Structure

2 properties

JSON STRUCTURE

Revel Webhooks Ping Payload Structure

1 properties

JSON STRUCTURE

Revel Webhooks Reward Card Event Payload Structure

2 properties

JSON STRUCTURE

Revel Webhooks Stock Status Payload Structure

4 properties

JSON STRUCTURE

Revel Webhooks Timesheet Event Payload Structure

4 properties

JSON STRUCTURE

Scroll for all 18

Examples 18

Example request and response payloads for these APIs.

Revel Open Api Customer Example

13 fields

EXAMPLE

Revel Open Api Customer List Example

2 fields

EXAMPLE

Revel Open Api Establishment Example

7 fields

EXAMPLE

Revel Open Api Establishment List Example

2 fields

EXAMPLE

Revel Open Api Order Example

22 fields

EXAMPLE

Revel Open Api Order List Example

2 fields

EXAMPLE

Revel Open Api Product Example

19 fields

EXAMPLE

Revel Open Api Product List Example

2 fields

EXAMPLE

Revel Open Api Time Schedule Example

10 fields

EXAMPLE

Revel Open Api Time Schedule List Example

2 fields

EXAMPLE

Revel Webhooks Customer Event Payload Example

4 fields

EXAMPLE

Revel Webhooks Integration Changed Payload Example

1 fields

EXAMPLE

Revel Webhooks Menu Updated Payload Example

1 fields

EXAMPLE

Revel Webhooks Order Finalized Payload Example

2 fields

EXAMPLE

Revel Webhooks Ping Payload Example

1 fields

EXAMPLE

Revel Webhooks Reward Card Event Payload Example

2 fields

EXAMPLE

Revel Webhooks Stock Status Payload Example

4 fields

EXAMPLE

Revel Webhooks Timesheet Event Payload Example

4 fields

EXAMPLE

Scroll for all 18

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Revel Systems Authentication

apiKey · 1 scheme

SECURITY

Revel Systems Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Revel Systems Agentic Access

13 operations · 5 acting

13 operations · 5 acting

AGENTIC

Use Cases 5

What developers build with this provider.

Order Synchronization

Sync finalized orders into accounting, ERP, or analytics systems via the Order resource and order.finalized webhook.

Catalog Management

Create and maintain products, modifiers, and combo sets across establishments.

Customer and Loyalty

Sync customer profiles and loyalty/reward data with marketing and CRM platforms.

Labor and Scheduling

Read and write employee shifts and timesheets via TimeSchedule, TimeScheduleRule, and TimeSheetEntry.

Inventory Monitoring

React to stock-status changes in real time via the inout.stock webhook.

Integrations 3

Pre-built integrations with other platforms and tools.

Accounting and ERP

Push order and sales data into accounting and ERP systems.

Payments

Establishment-level payment configuration including ACH for US establishments.

Marketing and CRM

Sync customer and loyalty data with marketing platforms.

Resources

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess
AgenticAccess

Design & Contract 2

Pagination, idempotency, versioning, errors, and events

SpectralRules
SpectralRules
 Vocabulary
Vocabulary

Build 1

SDKs, sample code, and the tooling you integrate with

GitHubOrganization
GitHubOrganization

Access & Security 2

Authentication, authorization, and security posture

DomainSecurity
DomainSecurity
 Authentication
Authentication

Operate 2

Status, limits, changes, and where to get help

FAQ
FAQ
 RateLimits
RateLimits

Commercial 2

Pricing, plans, and the legal terms of use

Plans
Plans
 FinOps
FinOps

Company 2

The organization behind the API

LinkedIn
LinkedIn
 Website
Website

Other 1

Properties that don't map to a standard resource type

Developer
Developer

Source (apis.yml)

apis.yml Raw ↑ 
aid: revel-systems
url: https://raw.githubusercontent.com/api-evangelist/revel-systems/refs/heads/main/apis.yml
name: Revel Systems
kind: company
description: Revel Systems is a cloud iPad-based POS for restaurants and retailers. The Revel Open API exposes products, orders,
  customers, employees, inventory, schedules, and reporting via a REST interface for partner integrations. The API follows
  Django Tastypie conventions (objects/meta list envelope, field-lookup filtering) and is complemented by an HMAC-signed webhook
  channel.
accessModel:
  pricing: unknown
  onboarding: self-serve
  trial: false
  try_now: false
  public: false
  label: Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/revel-systems.png
tags:
- POS
- Restaurant
- Retail
- iPad
created: '2026-05-08'
modified: '2026-06-03'
specificationVersion: '0.19'
apis:
- aid: revel:webhooks
  name: Revel Webhooks
  description: Event-driven webhook channel that delivers POS events (order finalized, customer created/updated, stock changes,
    menu updates, timesheet changes, integration changes, reward cards, and ping) to partner HTTPS endpoints via POST. Payloads
    are signed with an HMAC-SHA1 X-Revel-Signature header.
  humanURL: https://developer.revelsystems.com/revelsystems/docs/webhooks
  tags:
  - Webhooks
  - Events
  - POS
  properties:
  - type: Documentation
    url: https://developer.revelsystems.com/revelsystems/docs/webhooks
  - type: AsyncAPI
    url: asyncapi/revel-webhooks-asyncapi.yml
  - type: JSONSchema
    url: json-schema/revel-webhooks-order-finalized-payload-schema.json
    title: Order Finalized Payload
  - type: JSONSchema
    url: json-schema/revel-webhooks-customer-event-payload-schema.json
    title: Customer Event Payload
  - type: JSONSchema
    url: json-schema/revel-webhooks-stock-status-payload-schema.json
    title: Stock Status Payload
  - type: JSONLD
    url: json-ld/revel-webhooks-context.jsonld
  - type: Examples
    url: examples/revel-webhooks-order-finalized-payload-example.json
    title: Order Finalized Example
- aid: revel-systems:revel-systems-customers-api
  name: Revel Systems Customers API
  description: Customer records and addresses.
  humanURL: https://developer.revelsystems.com/revelsystems/reference/welcome
  baseURL: https://yoursubdomain.revelup.com/resources
  tags:
  - Customers
  properties:
  - type: OpenAPI
    url: openapi/revel-systems-customers-api-openapi.yml
  - type: Documentation
    url: https://developer.revelsystems.com/revelsystems/reference/welcome
  - type: APIReference
    url: https://developer.revelsystems.com/revelsystems/reference
  - type: GettingStarted
    url: https://developer.revelsystems.com/revelsystems/docs/how-to-make-an-api-call
  - type: Authentication
    url: https://developer.revelsystems.com/revelsystems/docs/how-to-make-an-api-call
  - type: ChangeLog
    url: https://developer.revelsystems.com/revelsystems/changelog/welcome-to-revelsystems
  - type: JSONSchema
    url: json-schema/revel-open-api-order-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-product-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-customer-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-establishment-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-time-schedule-schema.json
  - type: JSONStructure
    url: json-structure/revel-open-api-order-structure.json
  - type: JSONStructure
    url: json-structure/revel-open-api-product-structure.json
  - type: JSONStructure
    url: json-structure/revel-open-api-customer-structure.json
  - type: JSONLD
    url: json-ld/revel-open-api-context.jsonld
  - type: Examples
    url: examples/revel-open-api-order-example.json
  - type: Examples
    url: examples/revel-open-api-product-example.json
  - type: Examples
    url: examples/revel-open-api-customer-example.json
  - type: Plans
    url: plans/revel-systems-plans-pricing.yml
  - type: RateLimits
    url: rate-limits/revel-systems-rate-limits.yml
  - type: FinOps
    url: finops/revel-systems-finops.yml
- aid: revel-systems:revel-systems-establishments-api
  name: Revel Systems Establishments API
  description: Establishment (location) resources.
  humanURL: https://developer.revelsystems.com/revelsystems/reference/welcome
  baseURL: https://yoursubdomain.revelup.com/resources
  tags:
  - Establishments
  properties:
  - type: OpenAPI
    url: openapi/revel-systems-establishments-api-openapi.yml
  - type: Documentation
    url: https://developer.revelsystems.com/revelsystems/reference/welcome
  - type: APIReference
    url: https://developer.revelsystems.com/revelsystems/reference
  - type: GettingStarted
    url: https://developer.revelsystems.com/revelsystems/docs/how-to-make-an-api-call
  - type: Authentication
    url: https://developer.revelsystems.com/revelsystems/docs/how-to-make-an-api-call
  - type: ChangeLog
    url: https://developer.revelsystems.com/revelsystems/changelog/welcome-to-revelsystems
  - type: JSONSchema
    url: json-schema/revel-open-api-order-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-product-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-customer-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-establishment-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-time-schedule-schema.json
  - type: JSONStructure
    url: json-structure/revel-open-api-order-structure.json
  - type: JSONStructure
    url: json-structure/revel-open-api-product-structure.json
  - type: JSONStructure
    url: json-structure/revel-open-api-customer-structure.json
  - type: JSONLD
    url: json-ld/revel-open-api-context.jsonld
  - type: Examples
    url: examples/revel-open-api-order-example.json
  - type: Examples
    url: examples/revel-open-api-product-example.json
  - type: Examples
    url: examples/revel-open-api-customer-example.json
  - type: Plans
    url: plans/revel-systems-plans-pricing.yml
  - type: RateLimits
    url: rate-limits/revel-systems-rate-limits.yml
  - type: FinOps
    url: finops/revel-systems-finops.yml
- aid: revel-systems:revel-systems-orders-api
  name: Revel Systems Orders API
  description: Order and order-item resources.
  humanURL: https://developer.revelsystems.com/revelsystems/reference/welcome
  baseURL: https://yoursubdomain.revelup.com/resources
  tags:
  - Orders
  properties:
  - type: OpenAPI
    url: openapi/revel-systems-orders-api-openapi.yml
  - type: Documentation
    url: https://developer.revelsystems.com/revelsystems/reference/welcome
  - type: APIReference
    url: https://developer.revelsystems.com/revelsystems/reference
  - type: GettingStarted
    url: https://developer.revelsystems.com/revelsystems/docs/how-to-make-an-api-call
  - type: Authentication
    url: https://developer.revelsystems.com/revelsystems/docs/how-to-make-an-api-call
  - type: ChangeLog
    url: https://developer.revelsystems.com/revelsystems/changelog/welcome-to-revelsystems
  - type: JSONSchema
    url: json-schema/revel-open-api-order-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-product-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-customer-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-establishment-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-time-schedule-schema.json
  - type: JSONStructure
    url: json-structure/revel-open-api-order-structure.json
  - type: JSONStructure
    url: json-structure/revel-open-api-product-structure.json
  - type: JSONStructure
    url: json-structure/revel-open-api-customer-structure.json
  - type: JSONLD
    url: json-ld/revel-open-api-context.jsonld
  - type: Examples
    url: examples/revel-open-api-order-example.json
  - type: Examples
    url: examples/revel-open-api-product-example.json
  - type: Examples
    url: examples/revel-open-api-customer-example.json
  - type: Plans
    url: plans/revel-systems-plans-pricing.yml
  - type: RateLimits
    url: rate-limits/revel-systems-rate-limits.yml
  - type: FinOps
    url: finops/revel-systems-finops.yml
- aid: revel-systems:revel-systems-products-api
  name: Revel Systems Products API
  description: Product catalog and modifier resources.
  humanURL: https://developer.revelsystems.com/revelsystems/reference/welcome
  baseURL: https://yoursubdomain.revelup.com/resources
  tags:
  - Products
  properties:
  - type: OpenAPI
    url: openapi/revel-systems-products-api-openapi.yml
  - type: Documentation
    url: https://developer.revelsystems.com/revelsystems/reference/welcome
  - type: APIReference
    url: https://developer.revelsystems.com/revelsystems/reference
  - type: GettingStarted
    url: https://developer.revelsystems.com/revelsystems/docs/how-to-make-an-api-call
  - type: Authentication
    url: https://developer.revelsystems.com/revelsystems/docs/how-to-make-an-api-call
  - type: ChangeLog
    url: https://developer.revelsystems.com/revelsystems/changelog/welcome-to-revelsystems
  - type: JSONSchema
    url: json-schema/revel-open-api-order-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-product-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-customer-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-establishment-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-time-schedule-schema.json
  - type: JSONStructure
    url: json-structure/revel-open-api-order-structure.json
  - type: JSONStructure
    url: json-structure/revel-open-api-product-structure.json
  - type: JSONStructure
    url: json-structure/revel-open-api-customer-structure.json
  - type: JSONLD
    url: json-ld/revel-open-api-context.jsonld
  - type: Examples
    url: examples/revel-open-api-order-example.json
  - type: Examples
    url: examples/revel-open-api-product-example.json
  - type: Examples
    url: examples/revel-open-api-customer-example.json
  - type: Plans
    url: plans/revel-systems-plans-pricing.yml
  - type: RateLimits
    url: rate-limits/revel-systems-rate-limits.yml
  - type: FinOps
    url: finops/revel-systems-finops.yml
- aid: revel-systems:revel-systems-scheduling-api
  name: Revel Systems Scheduling API
  description: Labor scheduling and timesheet resources.
  humanURL: https://developer.revelsystems.com/revelsystems/reference/welcome
  baseURL: https://yoursubdomain.revelup.com/resources
  tags:
  - Scheduling
  properties:
  - type: OpenAPI
    url: openapi/revel-systems-scheduling-api-openapi.yml
  - type: Documentation
    url: https://developer.revelsystems.com/revelsystems/reference/welcome
  - type: APIReference
    url: https://developer.revelsystems.com/revelsystems/reference
  - type: GettingStarted
    url: https://developer.revelsystems.com/revelsystems/docs/how-to-make-an-api-call
  - type: Authentication
    url: https://developer.revelsystems.com/revelsystems/docs/how-to-make-an-api-call
  - type: ChangeLog
    url: https://developer.revelsystems.com/revelsystems/changelog/welcome-to-revelsystems
  - type: JSONSchema
    url: json-schema/revel-open-api-order-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-product-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-customer-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-establishment-schema.json
  - type: JSONSchema
    url: json-schema/revel-open-api-time-schedule-schema.json
  - type: JSONStructure
    url: json-structure/revel-open-api-order-structure.json
  - type: JSONStructure
    url: json-structure/revel-open-api-product-structure.json
  - type: JSONStructure
    url: json-structure/revel-open-api-customer-structure.json
  - type: JSONLD
    url: json-ld/revel-open-api-context.jsonld
  - type: Examples
    url: examples/revel-open-api-order-example.json
  - type: Examples
    url: examples/revel-open-api-product-example.json
  - type: Examples
    url: examples/revel-open-api-customer-example.json
  - type: Plans
    url: plans/revel-systems-plans-pricing.yml
  - type: RateLimits
    url: rate-limits/revel-systems-rate-limits.yml
  - type: FinOps
    url: finops/revel-systems-finops.yml
common:
- type: AgenticAccess
  url: agentic-access/revel-systems-agentic-access.yml
- type: DomainSecurity
  url: security/revel-systems-domain-security.yml
- type: Authentication
  url: authentication/revel-systems-authentication.yml
- type: GitHubOrganization
  url: https://github.com/RevelSystems
- type: LinkedIn
  url: https://www.linkedin.com/company/revel-systems
- type: Website
  url: https://revelsystems.com/
- type: Developer
  url: https://developer.revelsystems.com/
- type: FAQ
  url: https://developer.revelsystems.com/revelsystems/docs/frequently-asked-questions
- type: SpectralRules
  url: rules/revel-systems-rules.yml
- type: Vocabulary
  url: vocabulary/revel-systems-vocabulary.yml
- type: Plans
  url: plans/revel-systems-plans-pricing.yml
- type: RateLimits
  url: rate-limits/revel-systems-rate-limits.yml
- type: FinOps
  url: finops/revel-systems-finops.yml
- type: Features
  data:
  - name: Tastypie REST Conventions
    description: List endpoints return an objects array with a meta pagination envelope (total_count, limit, offset, next,
      previous).
  - name: Field-Lookup Filtering
    description: Filter resources with Django-style lookups (e.g. id__lt, created_date__range, name__icontains).
  - name: Field Selection and Expansion
    description: Use the fields parameter to limit returned attributes and expand to inline one level of foreign-key relationships.
  - name: Batch Retrieval
    description: Retrieve multiple records by ID in a single call using the set/id1;id2;id3 path form.
  - name: Signed Webhooks
    description: Real-time event delivery secured with HMAC-SHA1 signatures and per-event-type endpoint registration.
- type: UseCases
  data:
  - name: Order Synchronization
    description: Sync finalized orders into accounting, ERP, or analytics systems via the Order resource and order.finalized
      webhook.
  - name: Catalog Management
    description: Create and maintain products, modifiers, and combo sets across establishments.
  - name: Customer and Loyalty
    description: Sync customer profiles and loyalty/reward data with marketing and CRM platforms.
  - name: Labor and Scheduling
    description: Read and write employee shifts and timesheets via TimeSchedule, TimeScheduleRule, and TimeSheetEntry.
  - name: Inventory Monitoring
    description: React to stock-status changes in real time via the inout.stock webhook.
- type: Integrations
  data:
  - name: Accounting and ERP
    description: Push order and sales data into accounting and ERP systems.
  - name: Payments
    description: Establishment-level payment configuration including ACH for US establishments.
  - name: Marketing and CRM
    description: Sync customer and loyalty data with marketing platforms.
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com