Skip to main content
The Merchant API provides authenticated endpoints for managing your business operations. All endpoints require authentication and operate within the context of the authenticated merchant.

​
Authentication

All Merchant API endpoints require authentication via the session token obtained during login. The endpoints automatically identify the merchant from the authenticated session context.

​
Base Path

All merchant endpoints are prefixed with: 
/api/v1/merchant

​
Role-Based Access Control

Many endpoints implement role-based access control with three levels:
  • Owner: Full access to all operations including deletion and name changes
  • Admin: Management access to most resources
  • Staff: Read access and limited write operations
Endpoints will return 403 Forbidden if the authenticated user lacks the required role.

​
Available Resources

The Merchant API is organized into several resource groups:

Settings

Manage merchant settings, business hours, and preferences

Locations

Manage business locations and addresses

Services

Create and manage services and service groups

Products

Track inventory products and stock levels

Team

Manage team members and their roles

Customers

Manage customer information and blacklists

Blocked Times

Create time blocks for unavailability

Integrations

Connect external calendar services

​
Common Patterns

​
Response Format

Successful responses return JSON with the appropriate status code: 
{
  "data": { /* response payload */ }
}
Errors return: 
{
  "error": {
    "message": "Error description"
  }
}

​
Timestamps

All timestamps are returned in RFC3339 format: 
2026-03-03T10:30:00Z

​
Currency

Prices are represented with both currency code and formatted display: 
{
  "price": {
    "amount": 5000,
    "currency": "USD",
    "formatted": "$50.00"
  }
}

​
Dashboard Endpoint

Get dashboard data including upcoming bookings, statistics, and low stock alerts: 
curl -X GET 'https://api.example.com/api/v1/merchant/dashboard?date=2026-03-03T00:00:00Z&period=7' \
  --cookie "session_token=your_session_token"
​
date
string
required
The reference date in RFC3339 format
​
period
integer
required
Number of days for the period
​
period_start
timestamp
Start of the reporting period
​
period_end
timestamp
End of the reporting period
​
upcoming_bookings
array
List of upcoming bookings with customer and service details
​
latest_bookings
array
Most recent bookings
​
low_stock_products
array
Products with low stock levels
​
statistics
object
Revenue, bookings, cancellations, and duration statistics with period-over-period changes

Build docs developers (and LLMs) love

Get started for freeTalk to us