v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB

Appointment

Retrieve an appointment

Retrieve an appointment for the specified business id, branch id and appointment id

get/api/business/{businessId}/branch/{branchId}/appointment/{appointmentId}

Path parameters

businessIdstring required

branchIdstring required

appointmentIdstring required

Response

Specified appointment retrieved

appointmentIdstring required

versioninteger required

appointmentDatestring

startTimestring required

endTimestring

If the staff/service is changed then the duration is calculated from the new staff/service and endTime is ignored. Otherwise the endTime given is used.

pricenumber

staffIdstring required

roomIdstring

machineIdstring

confirmedboolean

serviceIdstring

createdAtstring date-time

updatedAtstring date-time

staffRequestboolean

preferredStaffboolean

clientIdstring

serviceRewardIdstring

courseIdstring

courseNamestring

clientCourseIdstring

clientCourseItemIdstring

purchasingBranchIdstring

serviceGroupItemOptionIdstring

serviceGroupIdstring

parentServiceGroupIdstring

This is the id of a service group at a business level and corresponds to the service group id used in the booking apis

serviceNamestring

state'BOOKED' | 'CHECKED_IN' | 'PAID'

activationState'RESERVED' | 'ACTIVE' | 'CANCELED'

waitingListDateTimestring date-time

depositAmountnumber

depositDateTimestring date-time

bookingIdstring

sourcestring

groupBookingIdstring

deletedboolean

notesstring

branchIdstring

isFinishAppointmentboolean

Indicates if this appointment is the concluding segment of a split service.

Example response

{
  "appointmentId": "ab123",
  "version": 1,
  "appointmentDate": "2018-01-01",
  "startTime": "09:00:00",
  "endTime": "09:30:00",
  "price": 40,
  "staffId": "staffid",
  "roomId": "roomid",
  "machineId": "machineid",
  "confirmed": true,
  "serviceId": "serviceid",
  "staffRequest": true,
  "preferredStaff": true,
  "clientId": "clientid",
  "serviceRewardId": "servicerewardid",
  "courseId": "courseId",
  "courseName": "courseName",
  "clientCourseId": "clientCourseId",
  "clientCourseItemId": "clientcourseitemid",
  "purchasingBranchId": "purchasingBranchId",
  "serviceGroupItemOptionId": "servicegroupitemoptionid",
  "serviceGroupId": "servicegroupid",
  "parentServiceGroupId": "parentservicegroupid",
  "serviceName": "serviceName",
  "state": "BOOKED",
  "activationState": "ACTIVE",
  "depositAmount": 20,
  "bookingId": "bookingid",
  "source": "source",
  "groupBookingId": "groupbookingid",
  "deleted": true,
  "notes": "This is a note about the appointment",
  "internetServiceCategories": [
    {
      "id": "ab123",
      "name": "Cut & Style"
    }
  ],
  "branchId": "X9QpRsZ3bSvhJAaakg9TXQ"
}