v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
Booking

Create a booking

Create and return a booking with appointments for specified services

post/api/business/{businessId}/branch/{branchId}/booking

Path parameters

businessIdstring required
branchIdstring required

Query parameters

force_selected_timeboolean

force a booking to be created at the selected time

Request body

bookingStatus'ACTIVE' | 'RESERVED' | 'CANCELED'
clientIdstring required

The unique identifier of the client for which this booking applies.

notestring

The service/colour note to append for the client on the booking date. This is a write-only property

bookingIdstring

Example request

{
  "clientId": "dbNZRQHDqAn6VlVoL2c-iA",
  "schedules": [
    {
      "serviceId": "C-FYeVKIwfwL3av2WYcYjA",
      "appointmentId": "TZcha-e8oanJ2KXwSIYkuA",
      "staffId": "G4iZa1VHaKCPcyv6Lt3BoA",
      "roomId": "G4iZa1VHaKCPcyv6Lt3BoA",
      "machineId": "cFoBTXLnUrYNf1uM8HfDcR",
      "branchServiceGroupId": "VsB-vaCGhhnKuOSONFWcHgH1UNXM21Qvb_bJPOAI5QI",
      "serviceGroupItemOptionId": "VsB-vaCGhhnKuOSONFWcHgH1UNXM21Qvb_bJPOAI5QI"
    }
  ],
  "clientAppointmentSchedules": [
    {
      "clientId": "dbNZRQHDqAn6VlVoL2c-iA",
      "serviceSchedules": [
        {
          "serviceId": "C-FYeVKIwfwL3av2WYcYjA",
          "appointmentId": "TZcha-e8oanJ2KXwSIYkuA",
          "staffId": "G4iZa1VHaKCPcyv6Lt3BoA",
          "roomId": "G4iZa1VHaKCPcyv6Lt3BoA",
          "machineId": "cFoBTXLnUrYNf1uM8HfDcR",
          "branchServiceGroupId": "VsB-vaCGhhnKuOSONFWcHgH1UNXM21Qvb_bJPOAI5QI",
          "serviceGroupItemOptionId": "VsB-vaCGhhnKuOSONFWcHgH1UNXM21Qvb_bJPOAI5QI"
        }
      ]
    }
  ],
  "bookingId": "ab123"
}

Response

Booking created successfully

bookingStatus'ACTIVE' | 'RESERVED' | 'CANCELED'
clientIdstring required

The unique identifier of the client for which this booking applies.

notestring

The service/colour note to append for the client on the booking date. This is a write-only property

bookingIdstring

Example response

{
  "clientId": "dbNZRQHDqAn6VlVoL2c-iA",
  "schedules": [
    {
      "serviceId": "C-FYeVKIwfwL3av2WYcYjA",
      "appointmentId": "TZcha-e8oanJ2KXwSIYkuA",
      "staffId": "G4iZa1VHaKCPcyv6Lt3BoA",
      "roomId": "G4iZa1VHaKCPcyv6Lt3BoA",
      "machineId": "cFoBTXLnUrYNf1uM8HfDcR",
      "branchServiceGroupId": "VsB-vaCGhhnKuOSONFWcHgH1UNXM21Qvb_bJPOAI5QI",
      "serviceGroupItemOptionId": "VsB-vaCGhhnKuOSONFWcHgH1UNXM21Qvb_bJPOAI5QI"
    }
  ],
  "clientAppointmentSchedules": [
    {
      "clientId": "dbNZRQHDqAn6VlVoL2c-iA",
      "serviceSchedules": [
        {
          "serviceId": "C-FYeVKIwfwL3av2WYcYjA",
          "appointmentId": "TZcha-e8oanJ2KXwSIYkuA",
          "staffId": "G4iZa1VHaKCPcyv6Lt3BoA",
          "roomId": "G4iZa1VHaKCPcyv6Lt3BoA",
          "machineId": "cFoBTXLnUrYNf1uM8HfDcR",
          "branchServiceGroupId": "VsB-vaCGhhnKuOSONFWcHgH1UNXM21Qvb_bJPOAI5QI",
          "serviceGroupItemOptionId": "VsB-vaCGhhnKuOSONFWcHgH1UNXM21Qvb_bJPOAI5QI"
        }
      ]
    }
  ],
  "bookingId": "ab123"
}