catalog-service (1.0.1)

Download OpenAPI specification:Download

The service provides capabilities to interact with the catalog’s stored data inside of BEAUTY_OS Core in MongoDB. This is used throughout the website to retrieve information about the catalog and interact with the catalog’s settings.

ClientSalonService

CreateOrUpdateClientSalonService

Creates or updates a client salon service If a record with matching salonId, stylistSingleSalonId, serviceId, and clientId exists, updates it Otherwise, creates a new record

Authorizations:

jwt

Request Body schema: application/json

The client salon service data

salonId required	string
stylistSingleSalonId required	string
serviceId required	string
clientId required	string
cost	number <double>
rememberCost	boolean
duration	number <double>
rememberDuration	boolean

Responses

Request samples

Payload

Content type

application/json

{"salonId": "string",
"stylistSingleSalonId": "string",
"serviceId": "string",
"clientId": "string",
"cost": 0.1,
"rememberCost": true,
"duration": 0.1,
"rememberDuration": true
}

Response samples

Content type

application/json

"string"

GetClientSalonServices

Retrieves all client salon services with optional filtering

Authorizations:

jwt

query Parameters

salonId	string Optional salon ID filter
stylistSingleSalonId	string Optional single salon ID filter
serviceId	string Optional service ID filter
clientId	string Optional client ID filter

header Parameters

user-id

required

string

Responses

Response samples

200
401
422
500

Content type

application/json

[{"id": "string",
"salonId": "string",
"stylistSingleSalonId": "string",
"serviceId": "string",
"clientId": "string",
"cost": 0.1,
"duration": 0.1
}
]

GetClientSalonServiceById

Retrieves a client salon service by ID

Authorizations:

jwt

path Parameters

id

required

string

The ID of the client salon service

header Parameters

user-id

required

string

Responses

Response samples

200
401
404
422
500

Content type

application/json

{"id": "string",
"salonId": "string",
"stylistSingleSalonId": "string",
"serviceId": "string",
"clientId": "string",
"cost": 0.1,
"duration": 0.1
}

DeleteClientSalonService

Deletes a client salon service by ID

Authorizations:

jwt

path Parameters

id

required

string

The ID of the client salon service to delete

header Parameters

user-id

required

string

Responses

Response samples

Content type

application/json

"string"

GetClientSalonServicesByClientId

Retrieves client salon services by client ID

Authorizations:

jwt

path Parameters

clientId

required

string

The client ID

header Parameters

user-id

required

string

Responses

Response samples

200
401
404
422
500

Content type

application/json

[{"id": "string",
"salonId": "string",
"stylistSingleSalonId": "string",
"serviceId": "string",
"clientId": "string",
"cost": 0.1,
"duration": 0.1
}
]

GetClientSalonServicesBySalonId

Retrieves client salon services by salon ID

Authorizations:

jwt

path Parameters

salonId

required

string

The salon ID

header Parameters

user-id

required

string

Responses

Response samples

200
401
404
422
500

Content type

application/json

[{"id": "string",
"salonId": "string",
"stylistSingleSalonId": "string",
"serviceId": "string",
"clientId": "string",
"cost": 0.1,
"duration": 0.1
}
]

SalonCategory

CreateSalonCategory

Creates a new salon category

Authorizations:

jwt

header Parameters

user-id

required

string

Request Body schema: application/json

Represents the salon category data that is being created.

name required	string
hex required	string
salonId required	string
stylistSingleSalonId	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"hex": "string",
"salonId": "string",
"stylistSingleSalonId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"order": 0.1,
"active": true,
"groupId": "string",
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string"
}

GetSalonCategoryById

Retrieves salon category's data by given ID.

Authorizations:

jwt

path Parameters

userId

required

string

header Parameters

user-id

required

string

Responses

Response samples

200
401
404
422
500

Content type

application/json

{"id": "string",
"name": "string",
"order": 0.1,
"active": true,
"groupId": "string",
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string"
}

UpdateSalonCategory

Updates a salon category

Authorizations:

jwt

path Parameters

salonCategoryId

required

string

The ID of the salon category to update

header Parameters

user-id

required

string

Request Body schema: application/json

The request body containing the updated salon category data

name required	string
hex required	string
salonId required	string
stylistSingleSalonId	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"hex": "string",
"salonId": "string",
"stylistSingleSalonId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"order": 0.1,
"active": true,
"groupId": "string",
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string"
}

DeleteSalonCategory

Deletes a salon category

Authorizations:

jwt

path Parameters

salonCategoryId

required

string

The ID of the salon category to delete

header Parameters

user-id

required

string

Responses

Response samples

Content type

application/json

"string"

ActivateSalonCategory

Activates a salon category

Authorizations:

jwt

path Parameters

salonCategoryId

required

string

The ID of the salon category to activate

header Parameters

user-id

required

string

Responses

Response samples

Content type

application/json

"string"

DeactivateSalonCategory

Deactivates a salon category

Authorizations:

jwt

path Parameters

salonCategoryId

required

string

The ID of the salon category to deactivate

header Parameters

user-id

required

string

Responses

Response samples

Content type

application/json

"string"

UpdateCategoryOrder

Updates the order of a salon category

Authorizations:

jwt

path Parameters

salonCategoryId

required

string

The ID of the salon category to update

header Parameters

user-id

required

string

Request Body schema: application/json

The request body containing the updated salon category data

newOrderIndex

required

number <double>

Responses

Request samples

Payload

Content type

application/json

{"newOrderIndex": 0.1
}

Response samples

Content type

application/json

"string"

(Internal)

GetSalonCategories

Retrieves all salon categories

Authorizations:

jwt

Responses

Response samples

200
401
422
500

Content type

application/json

[{"id": "string",
"name": "string",
"order": 0.1,
"active": true,
"groupId": "string",
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string"
}
]

GetSalonCategoryById

Retrieves salon category's data by given ID.

path Parameters

id

required

string

Represents the given ID for a salon category.

Responses

Response samples

200
404
422
500

Content type

application/json

{"id": "string",
"name": "string",
"order": 0.1,
"active": true,
"groupId": "string",
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string"
}

GetSalonGroupById

Retrieves salon group's data by given ID.

path Parameters

id

required

string

Represents the given ID for a salon group.

Responses

Response samples

200
404
422
500

Content type

application/json

{"id": "string",
"name": "string",
"active": true,
"order": 0.1
}

GetSalonIdsByServiceIds

Get all salon ids that have a service with the given ids

query Parameters

salonIds required	Array of strings
serviceIds required	Array of strings

Responses

Response samples

200
404
422
500

Content type

application/json

{"stylistSingleSalonIds": ["string"
]
}

GetServicesByServiceIds

Get all services with the given ids

query Parameters

serviceIds

required

Array of strings

Responses

Response samples

200
404
422
500

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfterMinutes": 0.1,
"active": true,
"order": 0.1,
"categoryId": "string",
"groupId": "string",
"type": "SERVICE",
"parentServiceId": "string",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
},
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string",
"templateName": "string"
}
]

GetStylistSingleSalonIdsByTemplateId

Get all stylist single salon ids by template id

query Parameters

salonId required	string
templateId required	string

Responses

Response samples

200
404
422
500

Content type

application/json

["string"
]

GetStylistSingleSalonIdsByTemplateIds

Get all stylist single salon ids by template ids

query Parameters

salonId required	string
templateIds required	Array of strings

Responses

Response samples

200
404
422
500

Content type

application/json

["string"
]

GetServicesByStylistSingleSalonIdAndTemplateIds

Get services by stylist single salon id and template ids

query Parameters

stylistSingleSalonId required	string
templateIds required	Array of strings

Responses

Response samples

200
404
422
500

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfterMinutes": 0.1,
"active": true,
"order": 0.1,
"categoryId": "string",
"groupId": "string",
"type": "SERVICE",
"parentServiceId": "string",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
},
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string",
"templateName": "string"
}
]

DeleteStylistServicesAtSalon

Delete all services for a stylist at a salon (when they leave)

path Parameters

stylistSingleSalonId required	string
salonId required	string

Responses

Response samples

404
422
500

Content type

application/json

{"name": "string",
"message": "string",
"code": "string",
"status": 0.1
}

GetSalonServicesBySalonAndStylist

Get services by salon and stylist

query Parameters

salonId required	string
stylistSingleSalonId required	string

Responses

Response samples

200
404
422
500

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfterMinutes": 0.1,
"active": true,
"order": 0.1,
"categoryId": "string",
"groupId": "string",
"type": "SERVICE",
"parentServiceId": "string",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
},
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string",
"templateName": "string"
}
]

GetTemplateCategories

Retrieves all template categories

Authorizations:

jwt

Responses

Response samples

200
401
422
500

Content type

application/json

[{"id": "string",
"name": "string",
"order": 0.1,
"groupId": "string",
"deleted": true
}
]

GetTemplateCategoryById

Retrieves template category's data by given ID.

path Parameters

id

required

string

Represents the given ID for a template category.

Responses

Response samples

200
404
422
500

Content type

application/json

{"id": "string",
"name": "string",
"order": 0.1,
"groupId": "string",
"deleted": true
}

GetTemplateGroupById

Retrieves service group's data by given ID.

path Parameters

id

required

string

Represents the given ID for a service group.

Responses

Response samples

200
404
422
500

Content type

application/json

{"id": "string",
"name": "string",
"active": true,
"order": 0.1
}

GetTemplateServiceById

Retrieves template service's data by given ID.

path Parameters

id

required

string

Represents the given ID for a template service.

Responses

Response samples

200
404
422
500

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfterMinutes": 0.1,
"active": true,
"order": 0.1,
"categoryId": "string",
"groupId": "string",
"type": "SERVICE",
"parentServiceId": "string",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
}
}

SalonGroup

GetServiceGroupById

Retrieves service's data by given ID.

Authorizations:

jwt

path Parameters

id

required

string

Represents the given ID for a service group.

header Parameters

user-id

required

string

Responses

Response samples

200
401
404
422
500

Content type

application/json

{"id": "string",
"name": "string",
"active": true,
"order": 0.1
}

GetSalonGroups

Retrieves all service groups

Authorizations:

jwt

Responses

Response samples

200
401
422
500

Content type

application/json

[{"id": "string",
"name": "string",
"active": true,
"order": 0.1
}
]

SalonService

CreateSalonService

Creates a new salon service

Authorizations:

jwt

header Parameters

user-id

required

string

Request Body schema: application/json

Represents the salon service data that is being created.

name required	string
description	string
cost required	number <double>
costMax	number <double>
smartPrice	boolean
smartPriceValue	number <double>
smartDuration	boolean
required	object (DurationRequest)
hasBreak required	boolean
canBookOnline required	boolean
doubleBooking required	boolean
bookScheduleBefore	boolean
bookScheduleBeforeMinutes	number <double>
bookScheduleAfter	boolean
bookScheduleAfterMinutes	number <double>
type required	string (ServiceType) Enum: "SERVICE" "ADD_ON"
	object (BackbarRequest)
categoryId required	string
parentServiceId	string
salonId required	string
stylistSingleSalonId	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"smartPrice": true,
"smartPriceValue": 0.1,
"smartDuration": true,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBefore": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfter": true,
"bookScheduleAfterMinutes": 0.1,
"type": "SERVICE",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
},
"categoryId": "string",
"parentServiceId": "string",
"salonId": "string",
"stylistSingleSalonId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfterMinutes": 0.1,
"active": true,
"order": 0.1,
"categoryId": "string",
"groupId": "string",
"type": "SERVICE",
"parentServiceId": "string",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
},
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string",
"templateName": "string"
}

GetSalonServices

Retrieves all salon services If clientId is provided, applies client-specific pricing and duration from ClientSalonService records

Authorizations:

jwt

query Parameters

salonId required	string The salon ID to filter services
stylistSingleSalonId	string
clientId	string Optional client ID to apply client-specific pricing

Responses

Response samples

200
401
422
500

Content type

application/json

{"categories": [{"id": "string",
"name": "string",
"order": 0.1,
"active": true,
"groupId": "string",
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string",
"services": [{"id": "string",
"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfterMinutes": 0.1,
"active": true,
"order": 0.1,
"categoryId": "string",
"groupId": "string",
"type": "SERVICE",
"parentServiceId": "string",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
},
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string",
"templateName": "string",
"addons": [{ }
]
}
]
}
],
"recommended": [{"id": "string",
"name": "string",
"order": 0.1,
"active": true,
"groupId": "string",
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string",
"services": [{"id": "string",
"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfterMinutes": 0.1,
"active": true,
"order": 0.1,
"categoryId": "string",
"groupId": "string",
"type": "SERVICE",
"parentServiceId": "string",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
},
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string",
"templateName": "string",
"addons": [{ }
]
}
]
}
]
}

GetSalonServiceById

Retrieves service's data by given ID.

Authorizations:

jwt

path Parameters

id

required

string

Represents the given ID for a salon service.

header Parameters

user-id

required

string

Responses

Response samples

200
401
404
422
500

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfterMinutes": 0.1,
"active": true,
"order": 0.1,
"categoryId": "string",
"groupId": "string",
"type": "SERVICE",
"parentServiceId": "string",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
},
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string",
"templateName": "string",
"addons": [{ }
]
}

UpdateSalonService

Updates a salon service

Authorizations:

jwt

path Parameters

id

required

string

The ID of the salon service to update

header Parameters

user-id

required

string

Request Body schema: application/json

The updated salon service data

name required	string
description	string
cost required	number <double>
costMax	number <double>
smartPrice	boolean
smartPriceValue	number <double>
smartDuration	boolean
required	object (DurationRequest)
hasBreak required	boolean
canBookOnline required	boolean
doubleBooking required	boolean
bookScheduleBefore	boolean
bookScheduleBeforeMinutes	number <double>
bookScheduleAfter	boolean
bookScheduleAfterMinutes	number <double>
type required	string (ServiceType) Enum: "SERVICE" "ADD_ON"
	object (BackbarRequest)
categoryId required	string
parentServiceId	string
salonId required	string
stylistSingleSalonId	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"smartPrice": true,
"smartPriceValue": 0.1,
"smartDuration": true,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBefore": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfter": true,
"bookScheduleAfterMinutes": 0.1,
"type": "SERVICE",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
},
"categoryId": "string",
"parentServiceId": "string",
"salonId": "string",
"stylistSingleSalonId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfterMinutes": 0.1,
"active": true,
"order": 0.1,
"categoryId": "string",
"groupId": "string",
"type": "SERVICE",
"parentServiceId": "string",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
},
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string",
"templateName": "string"
}

DeleteSalonService

Deletes a salon service

Authorizations:

jwt

path Parameters

id

required

string

The ID of the salon service to delete

header Parameters

user-id

required

string

Responses

Response samples

Content type

application/json

"string"

GetStylistServices

Retrieves all services for a stylist

Authorizations:

jwt

path Parameters

stylistSingleSalonId

required

string

The stylist ID to filter services

query Parameters

salonId required	string The salon ID to filter services
templateId required	string The template ID to filter services
clientId	string The client ID to filter services

header Parameters

user-id

required

string

Responses

Response samples

200
401
422
500

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfterMinutes": 0.1,
"active": true,
"order": 0.1,
"categoryId": "string",
"groupId": "string",
"type": "SERVICE",
"parentServiceId": "string",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
},
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string",
"templateName": "string",
"addons": [{ }
]
}

ActivateSalonService

Activates a salon service

Authorizations:

jwt

path Parameters

id

required

string

The ID of the salon service to activate

header Parameters

user-id

required

string

Responses

Response samples

Content type

application/json

"string"

DeactivateSalonService

Deactivates a salon service

Authorizations:

jwt

path Parameters

id

required

string

The ID of the salon service to deactivate

header Parameters

user-id

required

string

Responses

Response samples

Content type

application/json

"string"

UpdateServiceOrder

Updates the order of a salon service

Authorizations:

jwt

path Parameters

id

required

string

The ID of the salon service to update

header Parameters

user-id

required

string

Request Body schema: application/json

The updated salon service data

parentServiceId	string or null
categoryId	string or null
newOrderIndex required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"parentServiceId": "string",
"categoryId": "string",
"newOrderIndex": 0.1
}

Response samples

Content type

application/json

"string"

AttachSalonServices

Attaches salon services to a salon

Authorizations:

jwt

header Parameters

user-id

required

string

Request Body schema: application/json

The request body containing the salon ID and the service IDs to attach

salonId required	string
stylistSingleSalonId	string
templateServiceIds required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"salonId": "string",
"stylistSingleSalonId": "string",
"templateServiceIds": ["string"
]
}

Response samples

Content type

application/json

"string"

AttachSalonServicesToStylist

Attaches salon services from a main salon to a stylist's single salon

Authorizations:

jwt

header Parameters

user-id

required

string

Request Body schema: application/json

The request body containing the salon ID, stylist salon ID, and the service IDs to attach

salonId required	string
stylistSingleSalonId	string
templateServiceIds required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"salonId": "string",
"stylistSingleSalonId": "string",
"templateServiceIds": ["string"
]
}

Response samples

Content type

application/json

"string"

Public

GetSalonServices

Retrieves all salon services for a salon

query Parameters

salonId

required

string

Responses

Response samples

200
401
422
500

Content type

application/json

{"categories": [{"id": "string",
"name": "string",
"order": 0.1,
"active": true,
"groupId": "string",
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string",
"services": [{"id": "string",
"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfterMinutes": 0.1,
"active": true,
"order": 0.1,
"categoryId": "string",
"groupId": "string",
"type": "SERVICE",
"parentServiceId": "string",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
},
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string",
"templateName": "string",
"addons": [{ }
]
}
]
}
],
"recommended": [{"id": "string",
"name": "string",
"order": 0.1,
"active": true,
"groupId": "string",
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string",
"services": [{"id": "string",
"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfterMinutes": 0.1,
"active": true,
"order": 0.1,
"categoryId": "string",
"groupId": "string",
"type": "SERVICE",
"parentServiceId": "string",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
},
"salonId": "string",
"stylistSingleSalonId": "string",
"templateId": "string",
"templateName": "string",
"addons": [{ }
]
}
]
}
]
}

TemplateCategory

CreateTemplateCategory

Creates a new template category

Authorizations:

jwt

header Parameters

user-id

required

string

Request Body schema: application/json

Represents the template category data that is being created.

name required	string
hex required	string
groupId required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"hex": "string",
"groupId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"order": 0.1,
"groupId": "string",
"deleted": true
}

GetTemplateServiceById

Retrieves template category's data by given ID.

Authorizations:

jwt

path Parameters

userId

required

string

header Parameters

user-id

required

string

Responses

Response samples

200
401
404
422
500

Content type

application/json

{"id": "string",
"name": "string",
"order": 0.1,
"groupId": "string",
"deleted": true
}

UpdateTemplateCategory

Updates a template category

Authorizations:

jwt

path Parameters

templateCategoryId

required

string

The ID of the template category to update

header Parameters

user-id

required

string

Request Body schema: application/json

The request body containing the updated template category data

name required	string
hex required	string
groupId required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"hex": "string",
"groupId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"order": 0.1,
"groupId": "string",
"deleted": true
}

DeleteTemplateCategory

Deletes a template category

Authorizations:

jwt

path Parameters

templateCategoryId

required

string

The ID of the template category to delete

header Parameters

user-id

required

string

Responses

Response samples

Content type

application/json

"string"

DeactivateTemplateCategory

Deactivates a template category

Authorizations:

jwt

path Parameters

templateCategoryId

required

string

The ID of the template category to deactivate

header Parameters

user-id

required

string

Responses

Response samples

Content type

application/json

"string"

UpdateCategoryOrder

Updates the order of a template category

Authorizations:

jwt

path Parameters

templateCategoryId

required

string

The ID of the template category to update

header Parameters

user-id

required

string

Request Body schema: application/json

The request body containing the updated template category data

newOrderIndex

required

number <double>

Responses

Request samples

Payload

Content type

application/json

{"newOrderIndex": 0.1
}

Response samples

Content type

application/json

"string"

TemplateGroup

CreateTemplateGroup

Creates a new group service

Authorizations:

jwt

header Parameters

user-id

required

string

Request Body schema: application/json

Represents the template service data that is being created.

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"active": true,
"order": 0.1
}

GetTemplateGroups

Retrieves all service groups

Authorizations:

jwt

Responses

Response samples

200
401
422
500

Content type

application/json

[{"id": "string",
"name": "string",
"active": true,
"order": 0.1
}
]

GetServiceGroupById

Retrieves service's data by given ID.

Authorizations:

jwt

path Parameters

id

required

string

Represents the given ID for a service group.

header Parameters

user-id

required

string

Responses

Response samples

200
401
404
422
500

Content type

application/json

{"id": "string",
"name": "string",
"active": true,
"order": 0.1
}

UpdateTemplateGroup

Updates a template group

Authorizations:

jwt

path Parameters

id

required

string

Represents the given ID for a template group.

header Parameters

user-id

required

string

Request Body schema: application/json

Represents the template group data that is being updated.

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"active": true,
"order": 0.1
}

DeleteTemplateGroup

Deletes a template group

Authorizations:

jwt

path Parameters

id

required

string

Represents the given ID for a template group.

header Parameters

user-id

required

string

Responses

Response samples

Content type

application/json

"string"

DeactivateTemplateGroup

Deactivates a template group

Authorizations:

jwt

path Parameters

id

required

string

Represents the given ID for a template group.

header Parameters

user-id

required

string

Responses

Response samples

Content type

application/json

"string"

TemplateService

CreateTemplateService

Creates a new template service

Authorizations:

jwt

header Parameters

user-id

required

string

Request Body schema: application/json

Represents the template service data that is being created.

name required	string
description	string
cost required	number <double>
costMax	number <double>
smartPrice	boolean
smartPriceValue	number <double>
smartDuration	boolean
required	object (DurationRequest)
hasBreak required	boolean
canBookOnline required	boolean
doubleBooking required	boolean
bookScheduleBefore	boolean
bookScheduleBeforeMinutes	number <double>
bookScheduleAfter	boolean
bookScheduleAfterMinutes	number <double>
type required	string (ServiceType) Enum: "SERVICE" "ADD_ON"
	object (BackbarRequest)
categoryId required	string
parentServiceId	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"smartPrice": true,
"smartPriceValue": 0.1,
"smartDuration": true,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBefore": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfter": true,
"bookScheduleAfterMinutes": 0.1,
"type": "SERVICE",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
},
"categoryId": "string",
"parentServiceId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfterMinutes": 0.1,
"active": true,
"order": 0.1,
"categoryId": "string",
"groupId": "string",
"type": "SERVICE",
"parentServiceId": "string",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
}
}

GetTemplateServices

Authorizations:

jwt

query Parameters

groupIds

Array of strings

Optional array of group IDs to filter template services by

Responses

Response samples

200
401
422
500

Content type

application/json

{"categories": [{"id": "string",
"name": "string",
"order": 0.1,
"groupId": "string",
"deleted": true,
"services": [{"id": "string",
"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfterMinutes": 0.1,
"active": true,
"order": 0.1,
"categoryId": "string",
"groupId": "string",
"type": "SERVICE",
"parentServiceId": "string",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
},
"addons": [{ }
]
}
]
}
]
}

GetTemplateServiceById

Retrieves service's data by given ID.

Authorizations:

jwt

path Parameters

id

required

string

Represents the given ID for a template service.

header Parameters

user-id

required

string

Responses

Response samples

200
401
404
422
500

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfterMinutes": 0.1,
"active": true,
"order": 0.1,
"categoryId": "string",
"groupId": "string",
"type": "SERVICE",
"parentServiceId": "string",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
}
}

UpdateTemplateService

Updates a template service

Authorizations:

jwt

path Parameters

id

required

string

The ID of the template service to update

header Parameters

user-id

required

string

Request Body schema: application/json

The updated template service data

name required	string
description	string
cost required	number <double>
costMax	number <double>
smartPrice	boolean
smartPriceValue	number <double>
smartDuration	boolean
required	object (DurationRequest)
hasBreak required	boolean
canBookOnline required	boolean
doubleBooking required	boolean
bookScheduleBefore	boolean
bookScheduleBeforeMinutes	number <double>
bookScheduleAfter	boolean
bookScheduleAfterMinutes	number <double>
type required	string (ServiceType) Enum: "SERVICE" "ADD_ON"
	object (BackbarRequest)
categoryId required	string
parentServiceId	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"smartPrice": true,
"smartPriceValue": 0.1,
"smartDuration": true,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBefore": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfter": true,
"bookScheduleAfterMinutes": 0.1,
"type": "SERVICE",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
},
"categoryId": "string",
"parentServiceId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"cost": 0.1,
"costMax": 0.1,
"duration": {"start": 0.1,
"break": 0.1,
"finish": 0.1
},
"hasBreak": true,
"canBookOnline": true,
"doubleBooking": true,
"bookScheduleBeforeMinutes": 0.1,
"bookScheduleAfterMinutes": 0.1,
"active": true,
"order": 0.1,
"categoryId": "string",
"groupId": "string",
"type": "SERVICE",
"parentServiceId": "string",
"backbar": {"colorValue": 0.1,
"bleachValue": 0.1,
"tonerValue": 0.1,
"treatmentValue": 0.1
}
}

DeleteTemplateService

Deletes a template service

Authorizations:

jwt

path Parameters

id

required

string

The ID of the template service to delete

header Parameters

user-id

required

string

Responses

Response samples

Content type

application/json

"string"

DeactivateTemplateService

Deactivates a template service

Authorizations:

jwt

path Parameters

id

required

string

The ID of the template service to deactivate

header Parameters

user-id

required

string

Responses

Response samples

Content type

application/json

"string"

UpdateServiceOrder

Updates the order of a template service

Authorizations:

jwt

path Parameters

id

required

string

The ID of the template service to update

header Parameters

user-id

required

string

Request Body schema: application/json

The updated template service data

parentServiceId	string or null
categoryId	string or null
newOrderIndex required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"parentServiceId": "string",
"categoryId": "string",
"newOrderIndex": 0.1
}

Response samples

Content type

application/json

"string"