---
sidebar_label: 'Overview'
sidebar_position: 1
---

# Rules API

Rules are used to control products, product categories, stores, upsell offers, and stockouts across your stores.

By creating rules you can, for example:

- Disable a product or category outside certain hours (e.g. a lunch menu only available 11:00–14:00)
- Mark a product as stocked out at a specific store
- Trigger an upsell screen when the guest adds certain products to the basket
- Close a store over a holiday

This API offers both HTTP endpoints for managing rules and events for reacting to rule changes. By subscribing to events an effective, event-driven integration can be created without polling.

## In this section

- [API reference](./api-reference.md) — Full reference for all rule fields and filter options
- [Events](./events.md) — Event types emitted when rules are created, updated, or deleted
- [Examples](./example-rules.md) — Ready-to-use JSON examples for common rule types
- [Stockout](./stockout.md) — Requirements and batching guidance specific to stockout rules