Developer documentation
License required
This section is for customers with an active WooCommerce Appointments license. You reached it after signing in at Developer login.
Evaluating the product? Start with the public Developers overview.
Terminology
Merchant docs use appointable product (the WooCommerce product type label). REST/API responses use product_id on products with type: appointment. Same bookable product; different labels by audience.
Extend WooCommerce Appointments with the REST API, WordPress hooks, webhooks, and storefront customization. Prefer v2 (/wp-json/wc-appointments/v2/) for new work.
Start here
| Goal | Go to |
|---|---|
| Authenticate and make a first request | Authentication |
| Create, list, or update appointments | Appointments (start / end fields) |
| Build a custom booking UI | Slots · AJAX |
| Recurring packages (5.4+) | Series |
| Locations & rooms (5.5+) | Locations & resources |
| Change PHP behavior | Hooks & filters |
| React to create/update events | Webhooks |
| Live admin calendar updates | SSE |
| Form layout, CSS, GCal edge cases | Customization recipes |
REST API
Base URL:
https://your-site.com/wp-json/wc-appointments/v2/
| Resource | Typical use |
|---|---|
| Appointments | CRUD for bookings |
| Series | Recurring packages (5.4+) |
| Slots | Available times for a product |
| Calendar | Same feed as Appointments → Calendar |
| Availabilities · Staff · Products | Rules and catalog behind the booking form |
| SSE | Server-sent events for the admin calendar |
- API overview - endpoint map and first request
- Authentication - Application Passwords and WooCommerce API keys
- Error handling - status codes and common failures
- Code examples - JavaScript, PHP, cURL
- Orders extension - appointment data on
wc/v3/orders - Legacy v1 remains under
/wp-json/wc-appointments/v1/
Extending in PHP and JS
| Surface | When to use |
|---|---|
| Hooks & filters | Statuses, availability, emails, Google Calendar, series, cart |
| Webhooks | Push appointment events to an external URL |
| Emails | Template overrides and email classes |
| Style the appointment form | CSS and template paths |
Where to add code
Use a child theme functions.php or a small site-specific plugin. Do not edit plugin files. See Where to add code.
Architecture notes
Read these when integrating schedule or staff logic:
- Timezone architecture - how
start/endrelate to site wall time andstart_utc - Staff IDs -
staff_idsis canonical;staff_idis a convenience - Slots & day_data migration - 5.3.9+ slot payload shape
- Performance - indexing and query guidance
Getting help
- Support: bookingwp.com/support
- Forums: bookingwp.com/forums