Getting Started

Everything you need to install payload-reserve and have it running in your Payload CMS project.

Installation

pnpm add payload-reserve

npm install payload-reserve

yarn add payload-reserve

Peer dependencies: payload ^3.79.0, @payloadcms/ui ^3.79.0, @payloadcms/translations ^3.79.0

Quick Start

import { buildConfig } from 'payload'
import { payloadReserve } from 'payload-reserve'

export default buildConfig({
  collections: [
    // Your existing collections including your users/auth collection
  ],
  plugins: [
    payloadReserve(),
  ],
})

What Gets Created

By default, with no options set, the plugin creates:

5 collections:

• services — what can be booked (treatments, room types, service offerings)
• resources — who/what performs the service (staff, rooms, equipment)
• schedules — when resources are available (recurring weekly patterns + manual dates)
• customers — a standalone auth collection for customers to log in
• reservations — the core booking records

3 admin UI components:

• Calendar view replacing the default reservations list (month/week/day/lanes/pending, with availability shading and click-to-book)
• Dashboard widget showing today's booking stats
• Availability overview at /admin/reservation-availability

6 public REST endpoints:

• GET /api/reserve/availability — available slots for a date (guest-count and multi-resource aware)
• GET /api/reserve/slots — slots with richer metadata + guest count support
• GET /api/reserve/resource-availability — a resource's shift windows, time-off, and busy intervals over a date range (backs the calendar shading)
• POST /api/reserve/book — create a booking (supports account-less guest bookings and multi-resource items)
• POST /api/reserve/cancel — cancel a booking (authenticated owner/admin, or guest via cancellation token)
• GET /api/reservation-customer-search — customer search (privileged staff/admin only)

Using Your Existing Users Collection

By default the plugin creates a standalone customers auth collection. To extend your own users collection instead, set the userCollection option:

payloadReserve({
  userCollection: 'users', // your existing auth collection slug
})

When userCollection is set, the plugin injects name, phone, notes, and a bookings join field into your existing collection rather than creating a separate Customers collection. Existing fields with the same name are preserved (the plugin only injects what's missing). See Collections → Customers for details.