Welcome to the Quick Start guide for our Appointments API. If you're setting up a shop on the platform and want to get your system live as quickly as possible, this section is for you. We'll walk you through the most essential endpoints in the exact order you'll need them—starting with requesting and generating a Shop Key, and then moving on to building out your shop's full setup. Here's what you'll cover: Request a Shop Key, Generate a Shop Key, Add a Shop, Add a Shop Schedule, Add a Catalog, Add a Stylist, Create an Order Session, Add an Appointment, and Submit the Order Session. Each section includes example requests, responses, and common errors so you can implement with confidence. Whether you're handling the frontend or wiring up the backend, this guide is your launchpad to getting appointments up and running quickly.
That’s it—you’ve officially made it through the Quick Start! You now know how to request and generate a ShopKey, add your shop and schedule, publish catalog items, add stylists, create an order session, create an appointment, and submit the order session. These are the core building blocks to get your client-side app up and running fast. Whether you're building a basic booking tool or something more advanced, this flow gives you a strong foundation to build on. If you're ready to go deeper—like updating data, canceling appointments, retrieving schedules, or analyzing activity—head over to the Full API Reference. It contains all the available endpoints, their expected input/output, and helpful error response examples so you can create a more robust and polished experience for your users. If you want to receive notifications for when an appointment begins, head over to Webhook Notifications.