Version 1.11.0

POST /api/business/{businessId}/branch/{branchId}/booking/{bookingId}/appendnote

Request:

Changed content type : application/json

• Changed property note (string)

  The appointment note to append

POST /api/business/{businessId}/branch/{branchId}/booking/{bookingId}/activate

Request:

Changed content type : application/json

• Changed property depositAmount (number)

  The deposit amount paid by the client to confirm the booking. Deposit can only be set when activating an already reserved booking. When creating a new booking with state ACTIVE deposit is set to 0 by default.

GET /api/business/{businessId}/voucher/{voucherId}

Return Type:

Changed response : 200 OK

Specified voucher retrieved

• Changed content type : application/json

  • Changed property voucherId (string)

  • Changed property remainingBalance (number)

PUT /api/business/{businessId}/voucher/{voucherId}

Request:

Changed content type : application/json

• Changed property remainingBalance (number)

  Removed enum value:

  • null

Return Type:

Changed response : 200 OK

Voucher updated successfully

• Changed content type : application/json

  • Changed property voucherId (string)

  • Changed property remainingBalance (number)

GET /api/business/{businessId}/clientcourse/{clientCourseId}

Return Type:

Changed response : 200 OK

Specified client course retrieved

• Changed content type : application/json

  • Changed property clientCourseId (string)

PUT /api/business/{businessId}/clientcourse/{clientCourseId}

Return Type:

Changed response : 200 OK

Client course updated successfully

• Changed content type : application/json

  • Changed property clientCourseId (string)

GET /api/business/{businessId}/client/{clientId}

Return Type:

Changed response : 200 OK

Specified client retrieved

• Changed content type : application/json

  • Changed property clientId (string)

  • Changed property photoUrl (string)

  • Changed property mergedToClientId (string)

  • Changed property deleted (boolean)

  • Changed property clientCategoryIds (array)

    The list of client category IDs associated with this client

    Changed items (string):

  • Changed property firstVisit (string)

  • Changed property lastVisit (string)

  • Changed property creditAccount (object)

  • Changed property loyaltyCard (object)

    • Changed property serial (string)

    • Changed property points (integer)

PUT /api/business/{businessId}/client/{clientId}

Request:

Changed content type : application/json

• Deleted property createdAt (string)

• Deleted property updatedAt (string)

• Deleted property creditAccount (object)

• Deleted property loyaltyCard (object)

• Changed property clientId (string)

• Changed property clientCategoryIds (array)

  The list of client category IDs associated with this client

  Changed items (string):

• Changed property firstVisit (string)

Return Type:

Changed response : 200 OK

Client updated successfully

• Changed content type : application/json

  • Changed property clientId (string)

  • Changed property photoUrl (string)

  • Changed property mergedToClientId (string)

  • Changed property deleted (boolean)

  • Changed property clientCategoryIds (array)

    The list of client category IDs associated with this client

    Changed items (string):

  • Changed property firstVisit (string)

  • Changed property lastVisit (string)

  • Changed property creditAccount (object)

  • Changed property loyaltyCard (object)

    • Changed property serial (string)

    • Changed property points (integer)

GET /api/business/{businessId}/voucher

Return Type:

Changed response : 200 OK

Vouchers listed

• Changed content type : */*

  • Changed property _embedded (array)

    Changed items (object):

    • Changed property voucherId (string)

    • Changed property remainingBalance (number)

POST /api/business/{businessId}/voucher

Request:

Changed content type : application/json

• Deleted property createdAt (string)

• Deleted property updatedAt (string)

Return Type:

Changed response : 201 Created

Voucher created successfully

• Changed content type : application/json

  • Changed property voucherId (string)

  • Changed property remainingBalance (number)

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

Request:

Changed content type : application/json

• Changed property schedules (array)

  Deprecated - Use clientAppointmentSchedules instead. The list of services to schedule in one booking

  Changed items (object):
  > Details of the schedule for the client's chosen set of services

  • Changed property appointmentId (string)

    The unique identifier of the appointment that this service is scheduled for.

  • Changed property roomId (string)

    The unique identifier of the room where the service would be performed

  • Changed property machineId (string)

    The unique identifier of the machine which would be used to perform this service, if applicable for the service

Return Type:

Changed response : 201 Created

Booking created successfully

• Changed content type : application/json

  • Changed property bookingId (string)

  • Changed property schedules (array)

    Deprecated - Use clientAppointmentSchedules instead. The list of services to schedule in one booking

    Changed items (object):
    > Details of the schedule for the client's chosen set of services

    • Changed property appointmentId (string)

      The unique identifier of the appointment that this service is scheduled for.

    • Changed property roomId (string)

      The unique identifier of the room where the service would be performed

    • Changed property machineId (string)

      The unique identifier of the machine which would be used to perform this service, if applicable for the service

POST /api/business/{businessId}/client

Request:

Changed content type : application/json

• Deleted property createdAt (string)

• Deleted property updatedAt (string)

• Deleted property creditAccount (object)

• Deleted property loyaltyCard (object)

• Changed property version (integer)

• Changed property clientCategoryIds (array)

  The list of client category IDs associated with this client

  Changed items (string):

Return Type:

Changed response : 201 Created

Client created successfully

• Changed content type : application/json

  • Changed property clientId (string)

  • Changed property photoUrl (string)

  • Changed property mergedToClientId (string)

  • Changed property deleted (boolean)

  • Changed property clientCategoryIds (array)

    The list of client category IDs associated with this client

    Changed items (string):

  • Changed property firstVisit (string)

  • Changed property lastVisit (string)

  • Changed property creditAccount (object)

  • Changed property loyaltyCard (object)

    • Changed property serial (string)

    • Changed property points (integer)

GET /api/business/{businessId}/client

Return Type:

Changed response : 200 OK

Clients listed

• Changed content type : */*

  • Changed property _embedded (array)

    Changed items (object):

    • Changed property clientId (string)

    • Changed property photoUrl (string)

    • Changed property mergedToClientId (string)

    • Changed property deleted (boolean)

    • Changed property clientCategoryIds (array)

      The list of client category IDs associated with this client

      Changed items (string):

    • Changed property firstVisit (string)

    • Changed property lastVisit (string)

    • Changed property creditAccount (object)

    • Changed property loyaltyCard (object)

      • Changed property serial (string)

      • Changed property points (integer)

GET /api/business/{businessId}/clientcourse

Return Type:

Changed response : 200 OK

Client courses listed

• Changed content type : */*

  • Changed property _embedded (array)

    Changed items (object):

    • Changed property clientCourseId (string)

GET /api/business/{businessId}/client-batch

Return Type:

Changed response : 200 OK

Batch of clients retrieved

• Changed content type : */*

  • Changed property _embedded (array)

    Changed items (object):

    • Changed property clientId (string)

    • Changed property photoUrl (string)

    • Changed property mergedToClientId (string)

    • Changed property deleted (boolean)

    • Changed property clientCategoryIds (array)

      The list of client category IDs associated with this client

      Changed items (string):

    • Changed property firstVisit (string)

    • Changed property lastVisit (string)

    • Changed property creditAccount (object)

    • Changed property loyaltyCard (object)

      • Changed property serial (string)

      • Changed property points (integer)

PUT /api/business/{businessId}/branch/{branchId}/break/{breakId}

Request:

Changed content type : application/json

• Changed property breakId (string)

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

Request:

Changed content type : application/json

New required properties:

• staffId
• startTime

Return Type:

Changed response : 200 OK

Appointment updated successfully

• Changed content type : application/json

  New required properties:

  • appointmentId
  • version
  • Changed property appointmentId (string)

POST /api/business/{businessId}/branch/{branchId}/purchase

Request:

Changed content type : application/json

• Changed property items (array)

  The items being purchased

  Changed items (object):
  > The items being purchased

  • Changed property voucher (object)

    The voucher purchase item

    • Changed property voucherRef (string)

POST /api/business/{businessId}/branch/{branchId}/appointments/availability

Return Type:

Changed response : 200 OK

Appointment availabilities listed

• Changed content type : application/json

  • Changed property data (array)

    List of available appointment slots from which an appointment can chosen

    Changed items (object):
    > List of available appointment slots from which an appointment can chosen

    • Changed property clientSchedules (array)

      List of the appointment schedules, grouped by client, for this appointment slot

      Changed items (object):
      > List of the appointment schedules, grouped by client, for this appointment slot

      • Changed property serviceSchedules (array)

        Details of the schedule for the client's chosen set of services

        Changed items (object):
        > Details of the schedule for the client's chosen set of services

        • Changed property appointmentId (string)

          The unique identifier of the appointment that this service is scheduled for.

        • Changed property roomId (string)

          The unique identifier of the room where the service would be performed

        • Changed property machineId (string)

          The unique identifier of the machine which would be used to perform this service, if applicable for the service

POST /api/business/{businessId}/branch/{branchId}/break

Request:

Changed content type : application/json

• Changed property version (integer)

POST /api/business/{businessId}/branch/{branchId}/appointment/{appointmentId}/checkin

Return Type:

Changed response : 200 OK

Appointment checked in successfully

• Changed content type : */*

  • Changed property _embedded (array)

    Changed items (object):

    New required properties:

    • appointmentId
    • version
    • Changed property appointmentId (string)

POST /api/business/{businessId}/branch/{branchId}/appointment/confirm

Return Type:

Changed response : 200 OK

Appointments confirmed successfully

• Changed content type : */*

  • Changed property _embedded (array)

    Changed items (object):

    New required properties:

    • appointmentId
    • version
    • Changed property appointmentId (string)

GET /api/business/{businessId}/branch/{branchId}/appointment

Return Type:

Changed response : 200 OK

Appointments listed

• Changed content type : */*

  • Changed property _embedded (array)

    Changed items (object):

    New required properties:

    • appointmentId
    • version
    • Changed property appointmentId (string)