API Documentation

API

Let your clients book services without leaving your app!

Make your website or app more relevant, engaging and profitable by providing the action your clients wish to take upon discovering local businesses. Our API lets you easily include a 'Book Now' button directly in your web page, allowing your clients to schedule appointments in real-time, day or night.

Our API gives you access to all the booking data you need to build and deploy scheduling capabilities to your audience of clients.

Connecting a client with your business schedule, we are bridging an entirely new layer of commerce. We believe that direct appointment booking on your app or website allows us to provide you with client delivery, not just a client potential.

Why do thousands of clients choose the SimplyВook.me API?

Clear and simple interface. Building your own booking service is easy peasy

You can easily plug-in all the functionality you need

Real-time scheduling – your clients can book appointments wherever they want, whenever they want, 24/7

Our app gives you plenty of another useful features. Click here to learn more about our features.

Use our developer API to create your own booking interface. You can design any solution you want varying from simpliest widget to multifunctional application with functionality customized according to your business specific.

Simplybook Application Programming Interface uses JSON-RPC 2.0 protocol.

See an example of API-based booking interface, and also read the source code of this solution.

Authorization

Simplybook API methods require an authentication. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method getToken on http://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Plugins' link and select API plugin 'Settings'. Then you have to init remote access to Simplybook API. Your request should contain the following headers: 'X-Company-Login', 'X-Token'.

Getting the access-token can be implemented either from client side or from your server which is the more secure solution.

You may use javascript JSON-RPC-client library and php JSON-RPC-client library from our examples for your own solution development.


Client API (Company public service) authorization

Authorization from client side code

Getting the token-key.


    var loginClient = new JSONRpcClient({
        'url': 'https://user-api.simplybook.me' + '/login',
        'onerror': function (error) {},
    });
    var token = loginClient.getToken( YOUR_COMPANY_LOGIN, YOUR_API_KEY);
    

Initialization JSON-RPC-client


    this.client = new JSONRpcClient({
        'url': 'https://user-api.simplybook.me',
        'headers': {
            'X-Company-Login': YOUR_COMPANY_LOGIN,
            'X-Token': token
        },
        'onerror': function (error) {}
    });
    

Authorization from server side code

Getting the token-key.


    $loginClient = new JsonRpcClient('https://user-api.simplybook.me' . '/login/');
    $token = $loginClient->getToken(YOUR_COMPANY_LOGIN, YOUR_API_KEY);
    

Initialization JSON-RPC-client.


    $client = new JsonRpcClient( 'https://user-api.simplybook.me' . '/', array(
        'headers' => array(
            'X-Company-Login: ' .  YOUR_COMPANY_LOGIN,
            'X-Token: ' . $token
        )
    ));
    

User/Admin API (Company administration service) authorization

Authorization from client side code

Getting the token-key.


    var loginClient = new JSONRpcClient({
        'url': {$api_url} + '/login',
        'onerror': function (error) {},
    });
    var token = loginClient.getUserToken( YOUR_COMPANY_LOGIN,  YOUR_USER_LOGIN,  YOUR_USER_PASSWORD);
    

Initialization JSON-RPC-client.


    this.client = new JSONRpcClient({
        'url': 'https://user-api.simplybook.me' + '/admin/',
        'headers': {
            'X-Company-Login': YOUR_COMPANY_LOGIN,
            'X-User-Token': token
        },
        'onerror': function (error) {}
    });
    

Authorization from server side code

Getting the token-key.


    $loginClient = new JsonRpcClient('https://user-api.simplybook.me' . '/login/');
    $token = $loginClient->getUserToken({YOUR_COMPANY_LOGIN, YOUR_USER_LOGIN, YOUR_USER_PASSWORD);
    

Initialization JSON-RPC-client.


    $client = new JsonRpcClient('https://user-api.simplybook.me' . '/admin/', array(
        'headers' => array(
            'X-Company-Login: ' . YOUR_COMPANY_LOGIN,
            'X-User-Token: ' . $token
        )
    ));
    

Getting data from Simplybook server

A booking page usually is a page where clients choose service they need, an employee and a time of their meeting. Then a client enters some contact info and confirms the booking. The more complex solutions may include filling different additional fields, making some group or multy-times booking and so on. Lets describe the workflow of creation the simpliest booking page. Then if you need to add some extra functionality to your page, see here the full list of Simplybook API methods.

So the first thing you should display is the list of services and the list of employes. Get this data by getEventList and getUnitList methods. They both return a list with complete information about each item in it, so you have many possibilities how to display services and employees at your page. To make employee filtration use unit_map property of the service list, it contains the info about employees who can provide the selected service.

Code example of getting services list


    $services = $client->getEventList();
    // returns array(array(
    //     'id' => 1, - service id
    //     'name' => 'Service 1', - service's name
    //     'description' => 'Describe your service...', - service description
    //     'duration' => 60, - service duration
    //     'hide_duration' => 0, - Hide duration to clients flag,
    //     'picture' => null, - file name of picture or null
    //     'picture_path' => '/uploads/apidemo/event__picture/small/', - full path to picture,
    //     'position' => 1 - service position
    //     'is_active' => 1, - the service is activated
    //     'is_public' => 1, - the service is allowed to book by clients
    // ), ...)
    

Code example of getting service performers list


    $services = $client->getUnitList();
    // returns array(array(
    //    'id' => 1, - performer id
    //    'name' => 'Provider 1', - performer name
    //    'phone' => '111111111', - perfomer phone number
    //    'description' => 'Describe your performer...', - performer description
    //    'email' => 'test@gmail.com', - perfomer email,
    //    'is_active' => 1, - the performer is activated
    //    'is_visible' => 1, - the perfomer is visible for clients,
    //    'picture' => null, - file name of picture or null,
    //    'picure_path' => '/uploads/apidemo/unit_group__picture/small/', - full path to picture
    //    'position' => 1, - performer position
    //    'qty' => 1, performer quantity
    // ), ...)
    

The next step to a client is to pick a date and time of his service. We've used a Bootstrap date-picker in API-usage example, you can also use this or any other calendar. To set your calendar first date use getFirstWorkingDay method. It can take employee id as a parameter and returns the next date when the selected employee (or any employee in the company by default) is avaiable for booking.{""|t} To show time slots inside a selected date you need getWorkCalendar and getStartTimeMatrix methods. The first method give you an information about working day start and end time, and about day-offs. And the second one returns the list of time-slots which can be booked for a certain date.

Code example of getting work days info


    $year = 2020;
    $month = 3; // March
    $performerId = 1; // Can be null
    $workDaysInfo = $client->getWorkCalendar($year, $month, $performerId);
    // returns array(
    //     '2020-03-01' => array('from' => '09:00:00', 'to' => '18:00:00', 'is_day_off' => 0),
    //     '2020-03-02' => array('from' => '09:00:00', 'to' => '18:00:00', 'is_day_off' => 0),
    //     ...
    //);
    

Code example of getting start time matrix


    $dateFrom = '2020-03-03';
    $dateTo = '2020-03-04';
    $serviceId = 1;
    $performerId = 1;
    $qty = 1;
    $availableTime = $client->getStartTimeMatrix($dateFrom, $dateTo, $serviceId, $performerId, $qty);
    // returns array(
    //     '2015-03-03' => array('09:00:00', '09:30:00', '10:00:00', ....),
    //     '2015-03-04' => array('09:00:00', '09:30:00', '10:00:00', ....),
    //);
    

Another usefull method you may need is calculateEndTime. Each service can have its own duration, also your company's employees possible have different work schedule form day to day. So using this method you can show to a client an end date and time of the service he've booked in a correct way.

Code example of calculating booking end time


    $startDateTime = '2020-03-03 09:00:00';
    $serviceId = 1;
    $performerId = 1;
    $availableTime = $client->calculateEndTime($startDateTime, $serviceId, $performerId);
    // returns '2020-03-03 10:00:00'
    

When a client clicks confirm booking button you have to call book method. This is the main function which performs all necessary validations and registers a new booking in Simplybook system. It takes information about booking, client data like name and phone and some additional params. See all params descriptions of this method in API functions list. The book method responce contains an uniqe code and other details of the new booking or the list of errors if some problems occured, so you can use this information to show booking result to a client in convinient and intuitive way


Using of API secret key

In some cases the book method may require the confirmation, e.g. if your accept payments from clients you confirm booking only after the payment is already came. The Simplybook API confirmBookng method takes booking-id and secure signature as params (another method which requires secure signature is cancelBookng). For the secure signature generation your secret API-key should be used. See how it can be done in the example below. You can find the secret key at admin interface under 'Settings' link of API plugin in 'Plugins' list.

Code example of service booking and its confirmation using secret API key


    $additionalFields = array(
	'6740d3bce747107ddb9a789cbb78abf3' => 'value1',
	'b0657bafaec7a2c9800b923f959f8163' => 'value2'
    );

    $clientData = array(
        'name' => 'Client name',
        'email' => 'client@email.com',
        'phone' => '+13152108338'
    );

    $bookingsInfo = $client->book($eventId, $unitId, $date, $time, $clientData, $additionalFields);

    if ($bookingsInfo->require_confirm) {
       foreach ($bookingsInfo->bookings as $booking) {
           $sign = md5($booking->id . $booking->hash . YOUR_API_SECRET_KEY);
           $result = $client->confirmBooking($booking->id, $sign);
           echo '<br>Confirm result</b><br />';
           var_dump($result);
        }
    }
    

Code example of getting additional fields


    $fields = $client->getAdditionalFields($eventId);
    // returns - array(array(
    //		'name' => 'b0657bafaec7a2c9800b923f959f8163', - field name
    //		'title' => 'Test digits', - field title
    //		'type' => 'digits', - field type
    //		'values' => null, - available values for select field type
    //		'default' => null, - default value for field
    //		'is_null' => null, - is filed nullable
    //		'on_main_page' => 1,
    //		'pos' => 1, - field position
    //		'value' => null
    // )), ...)
    

Simplybook Plugins

If your company specific requires some additional functionality you can activate some of our additional plugins. The complete plugin list with detailed description is avaiable in your admin interface under the 'Plugins' link. After the necessary plugin is enabled the corresponding API methods will be activated so you can use them in your code.

Booking functionality codeflow

Authorize in Simplybook API using loginClient.getToken(companyLogin, apiKey); function.


Check if Service categories custom feature is activated by isPluginActivated('event_category') if yes then display list of categories getCategoriesList().


Get list of services (events) and performers (units) using getEventList() and getUnitList() functions. If 'unit_map' array is available for service it means this service can be provided by given performers only.


If Any Employee selector plugin is activated isPluginActivated('any_unit') and no special duration is set for service-performer pair in 'unit_map' array then user should be allowed to select Any provider option or choose provider manually. But manual selection of performers should not be possible if getCompanyParam('any_unit__hide_other_units') is enabled.


Use getStartTimeMatrix ($from as current date, $to as current date, $eventId, $unitId, $count as selected participants value ) to get available timeslots for given date. $unitId should be null if Any employee option is selected.


If Any Employee selector is active and Any employee was selected call getAvailableUnits($eventId, $dateTime, $count) to get available $unitId


If Additional fields plugin is activated isPluginActivated('event_field') call getAdditionalFields($eventId) function to get list of fields for client to fill.


Call book($eventId, $unitId, $date, $time, $clientData, $additional, $count, $batchId) to make a booking.


Get api token

Using Simplybook API methods require an authentification. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method getToken on http://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Plugins' link and select API plugin 'Settings'.'

var token = loginClient.getToken(companyLogin, apiKey);

var loginClient = new JSONRpcClient({
	'url': 'https://user-api.simplybook.me/login',
	'onerror': function (error) {
		alert(error);
	}
});
var token = loginClient.getToken('{companyLogin}', '{apiKey}');
Method result
Response body
HTTP Request

Get event list

You have just received auth token. Now you need to create JSON RPC Client, set http headers and then use this client to get data from Simplybook server. To get services list use getEventList() function as it is shown in code example below.

var events = client.getEventList();

var client = new JSONRpcClient({
	'url': 'https://user-api.simplybook.me',
	'headers': {
		'X-Company-Login': '{companyLogin}',
		'X-Token': '{token}'
	},
	'onerror': function (error) {
		alert(error);
	}
});
var services = client.getEventList();
Method result
Response body
HTTP Request

Get performer list

Also you need to get list of all service performers. For this purpose use getUnitList() function.

var units = client.getUnitList();

var performers = client.getUnitList();
Method result
Response body
HTTP Request

Filter performers by service

Now let users select service and then performer. Please note that services can be attached to certain performer or can be provided by any performer from list. That is why you should filter performers before users make selection, use unit_map param in service object for this. See code example below.

// fetch service and performers selects here
var serviceId;
var performerId;
jQuery('#select_event_id').empty();
jQuery('#select_unit_id').empty();
jQuery('#select_event_id').append('<option value=""></option>');
jQuery('#select_unit_id').append('<option value=""></option>');
for (var id in services) {
    jQuery('#select_event_id').append('<option value="' + id + '">' + services[id].name + '</option>');
}
for (var id in performers) {
    jQuery('#select_unit_id').append('<option value="' + id + '">' + performers[id].name + '</option>');
}
jQuery('#select_event_id').change(function () {
	// service id
	serviceId = jQuery(this).val();
	var selectedService = services[serviceId];
	// filter available performers
	if (selectedService) {
		if (typeof(selectedService.unit_map) != 'undefined' && selectedService.unit_map.length) {
			jQuery('#select_unit_id option').attr('disabled', true);
			jQuery('#select_unit_id option[value=""]').attr('disabled', false);
			for (var i = 0; i < selectedService.unit_map.length; i++) {
				jQuery('#select_unit_id option[value="' + selectedService.unit_map[i] + '"]').attr('disabled', false);
			}
		} else {
			jQuery('#select_unit_id option').attr('disabled', false);
		}
	}
	jQuery('#eventId').val(serviceId).change();
});
jQuery('#select_unit_id').change(function () {
	performerId = jQuery(this).val();
});

Get closest day with available time slots

After user has selected service and perfomer you should get first working day for the selected performer and set it as datepicker active date. Use getFirstWorkingDay() function for this purpose.

var firstWorkingDay = client.getFirstWorkingDay(performerId);

var firstWorkingDay = client.getFirstWorkingDay(performerId);
Method result
Response body
HTTP Request

Disable not working time in calendar

Becides setting active date in your datepicker you also can disable dayoffs in it using data of work calendar. See how the getWorkCalendar() function works in code example.

workCalendar = client.getWorkCalendar(year, month, performerId);

// Init datepicker.
var workCalendar = {};
jQuery('#datepicker').datepicker({
	'onChangeMonthYear': function (year, month, inst) {
		workCalendar = client.getWorkCalendar(year, month, performerId);
		jQuery('#datepicker').datepicker('refresh');
	},
	'beforeShowDay': function (date) {
		var year = date.getFullYear();
		var month = ("0" + (date.getMonth() + 1)).slice(-2);
		var day = ("0" + date.getDate()).slice(-2);
		var date = year + '-' + month + '-' + day;
		if (typeof(workCalendar[date]) != 'undefined') {
			if (parseInt(workCalendar[date].is_day_off) == 1) {
				return [false, "", ""];
			}
		}
		return [true, "", ""];
	}
});
var firstWorkingDateArr = firstWorkingDay.split('-');
workCalendar = client.getWorkCalendar(firstWorkingDateArr[0], firstWorkingDateArr[1], performerId);

jQuery('#datepicker').datepicker('refresh');
Method result
Response body
HTTP Request

Get available time slots

When user has selected a date you can load time intervals when service is available to be booked. Use the getStartTimeMatrix() function to get list of start time of time slots.

var startMatrix = client.getStartTimeMatrix(from, to, eventId, unitId, count)

// Handle date selection
var count = 1; // How many slots book
function formatDate(date) {
	var year = date.getFullYear();
	var month = ("0" + (date.getMonth() + 1)).slice(-2);
	var day = ("0" + date.getDate()).slice(-2);
	
	return year + '-' + month + '-' + day;
}

function drawMatrix(matrix) {
	jQuery('#starttime').empty();
	
	for (var i = 0; i < matrix.length; i++) {
		jQuery('#starttime').append('<span data-time="' + matrix[i] + '">' + matrix[i] + '</span>');
	}
	jQuery('#starttime span').click(function () {
		startTime = jQuery(this).data('time');
		
		jQuery('#starttime span').removeClass('selected');
		jQuery(this).addClass('selected');
	});
}

jQuery('#datepicker').datepicker('option', 'onSelect', function () {
	var startDate = formatDate(jQuery(this).datepicker('getDate'));
	jQuery('#dateFrom, #dateTo').val(startDate);
	
	var startMatrix = client.getStartTimeMatrix(startDate, startDate, serviceId, performerId, count);
	
	drawMatrix(startMatrix[startDate]);
});
var startMatrix = client.getStartTimeMatrix(firstWorkingDay, firstWorkingDay, serviceId, performerId, count);
drawMatrix(startMatrix[firstWorkingDay]);
Method result
Response body
HTTP Request

Check if additional fields plugin is activated

Now check if additional fields plugin is active to define what should be shown to client in the next step. See isPluginActivated() function usage example.

var additionalFieldsActivated = client.isPluginActivated('event_field');

var additionalFieldsActivated = client.isPluginActivated('event_field');
Method result
Response body
HTTP Request

Get additional fields

If addtional fields plugin is active, you should load additional field list using getAdditionalFields() function and add them to client details form.

// load additional fields
var additionalFields = [];

function clearAdditionalFields() {
	jQuery('#additional-fields').empty();
	additionalFields = [];
}

function addAdditionalField(field) {
	var container = jQuery('<div class="form-group"></div>');
	var title = jQuery('<div class="control-label">' + field.title + '</div>');
			
	container.append(title);
			
	var fieldContainer = jQuery('<div class="field"></div>');
			
	container.append(fieldContainer);
			
	var fieldNode = null;
	switch (field.type) {
		case 'checkbox':
			fieldNode = jQuery('<input type="checkbox" name="' + field.name + '" id="' + field.name + '" value="1" />');
			if (field['default']) {
				fieldNode.attr('checked', true);
			}
			break;
		case 'select':
			fieldNode = jQuery('<select class="select select2" name="' + field.name + '" id="' + field.name + '"></select>');
			var values = field.values.split(',');
			for (var k = 0; k < values.length; k++) {
				fieldNode.append(jQuery('<option value="' + values[k].trim() + '">' + values[k].trim() + '</option>'));
			}
			if (field['default']) {
				fieldNode.val(field['default']);
			}
			break;
		case 'textarea':
			fieldNode = jQuery('<textarea name="' + field.name + '" id="' + field.name + '"></textarea>');
			if (field['default']) {
				fieldNode.val(field['default']);
			}
			break;
		default:
			fieldNode = jQuery('<input type="text" name="' + field.name + '" id="' + field.name + '" />');
			if (field['default']) {
				fieldNode.val(field['default']);
			}
			break;
	}
	if (fieldNode) {
		if (field.type == 'checkbox') {
			fieldNode.addClass('checkbox');
		} else {
			fieldNode.addClass('form-control');
		}
		fieldContainer.append(fieldNode);
		jQuery('#additional-fields').append(container);
	}
}

if (additionalFieldsActivated) {
	clearAdditionalFields();
	additionalFields = client.getAdditionalFields(serviceId);
	for (var i = 0; i < additionalFields.length; i++) {
		addAdditionalField(additionalFields[i]);
	}
}
Method result
Response body
HTTP Request

Perform booking

After client has filled his information into additional fields you should start booking process by calling book() method.

// Collect client data
var clientData = {
	'name': jQuery('#clientName').val(),
	'email': jQuery('#clientEmail').val(),
	'phone': jQuery('#clientPhone').val()
};
// Collect additional fields
var additionalFieldValues = {};
jQuery('#additional-fields input, #additional-fields select, #additional-fields textarea').each(function () {
	var val = '';
	if (jQuery(this).attr('type') == 'checkbox') {
		if (jQuery(this).is(':checked')) {
			val = 1;
		} else {
			val = 0;
		}
	} else {
		val = jQuery(this).val();
	}
	additionalFieldValues[jQuery(this).attr('name')] = val;
});
var count = 1;

var result = client.book(serviceId, performerId, startDate, startTime, clientData, additionalFieldValues, count);
Method result
Response body
HTTP Request

Summary

It was simple example how you can use Simplybook API. Check out all available API methods here. Feel free to contact us and ask any questions.

Thank you for reading!

Service URL  https://user-api.simplybook.me/login

  • getServiceUrl ($companyLogin)

    Returns API url for given company login

    • @param String $companyLogin
    • @return String
  • getToken ($companyLogin, $apiKey)

    Returns an application's token string for a company. You should use this token to authenticate all calls of
    [[Company public service methods|Company public service API methods]] and [[Catalogue|Catalogue API methods]]. To

    get application API key you need to enable [[Plugins#API|API plugin]].

    • @param String $companyLogin
    • @param String $apiKey
    • @return String
  • getUserToken ($companyLogin, $userLogin, $userPassword)

    Returns an authentication token string for certain user registered for company. You should use this token to
    authenticate all calls of [[Company administration service methods|Company administration service API methods]] and

    [[Catalogue|Catalogue API methods]].

    • @param String $companyLogin a company identifier (login)
    • @param String $userLogin user's login associated with company
    • @param String $userPassword user's password
    • @return String
  • getApplicationToken ($applicationApiKey)

    Returns an application's token string for an application. You should use this token to authenticate all calls of
    [[Company public service methods|Company public service API methods]] and [[Catalogue|Catalogue API methods]]. To

    get application API key please contact SimplyBook.me support team.

    • @param String $applicationApiKey
    • @return String

Service URL  https://user-api.simplybook.me/

  • getUnitList ($isVisibleOnly, $asArray, $handleClasses, $searchString)

    {@inheritdoc}

    • @param bool $isVisibleOnly
    • @param bool $asArray
    • @param integer $handleClasses
    • @param string $searchString part of name (used for comboboxes)
    • @return Array
  • getEventList ($isVisibleOnly, $asArray, $handleClasses, $searchString)

    {@inheritdoc}

    • @param bool $isVisibleOnly
    • @param bool $asArray
    • @param integer $handleClasses (1 - classes only, -1 without classes, null - skip classes check)
    • @param string $searchString part of name (used for comboboxes)
    • @return Array
  • getCategoriesList ($isPublic)

    {@inheritdoc}

    • @param bool $isPublic
    • @return Array
  • getLocationsList ($isPublic)

    {@inheritdoc}

    • @param Boolean $isPublic
    • @return Array
  • getPaymentProcessorConfig ($paymentProcessor)

    Returns payment processor config

    • @param String $paymentProcessor
    • @return Array
  • validatePayment ($paymentInfo, $cartId)

    Validate application payment.

    • @param mixed $paymentInfo
    • @param Integer $cartId
    • @return Boolean
  • getBookingCart ($bookingIds)

    Returns cart information by bookings ids.
    cart_id and cart_hash is used to create secure signature to confirm cart payment.

    status - current cart status
    amount - is total amount to payment
    currency - cart currency
    cart - contains cart items. You can use them to provide information for payment system. Each item is object with following fields:
    id - booking id
    event_id - service id
    name - event name + start date time (use it to provide cart information for payment system)
    price - booking price
    qty - qty of bookings

    • @param Array $bookingIds
    • @return Object
  • getBookingCartInfo ($cartId, $sign)

    Returns current cart information
    cart_id and cart_hash is used to create secure signature to confirm cart payment.

    amount - is total amount to payment
    currency - cart currency
    cart - contains cart items. You can use them to provide information for payment system. Each item is object with following fields:
    id - booking id
    event_id - service id
    name - event name + start date time (use it to provide cart information for payment system)
    price - booking price
    qty - qty of bookings

    • @param Integer $cartId cart id
    • @param String $sign signature. (md5($cartId . $cartHash . $secretKey))
    • @return Object
  • getBookingCartStatus ($id)

    Returns current cart status
    Possible result values:

    cancel - user has canceled payment
    paid - user has paid
    error - error has been occurred on validation payment
    not_paid - cart is not paid yet or payment status is pending

    • @param Integer $id
    • @return String
  • confirmBookingCart ($cartId, $paymentProcessor, $sign)

    Confirm booking cart. Use it to confirm payment. Signature is required.

    • @param Integer $cartId cart id
    • @param String $paymentProcessor payment processor name
    • @param String $sign signature. (md5($cartId . $cartHash . $secretKey))
    • @return Boolean
  • confirmBooking ($id, $sign)

    Confirm booking. Signature is required.
    $sign = md5($bookingId . $bookingHash . $secretKey);

    Call this method from server side only

    • @param Integer $id
    • @param String $sign
    • @return Boolean
  • confirmBookingPayment ($id, $paymentProcessor, $sign)

    Confirm booking payment. Signature is required.
    $sign = md5($bookingId . $bookingHash . $secretKey);

    Call this method from server side only

    • @param Integer $id
    • @param String $paymentProcessor
    • @param String $sign
    • @return Boolean
  • confirmBookingBatch ($batchId, $batchType, $sign)

    Confirms booking batch. Signature is required.
    $sign = md5($batchId . $batchHash . $secret)

    Call this method from server side only

    • @param Integer $batchId
    • @param String $batchType
    • @param String $sign
    • @return Boolean
  • getBooking ($id, $sign)

    Returns an object with details information about booking. $sign parameter must be a string created
    with formula: md5($bookingId . $bookingHash . $secretKey). You can get $bookingHash

    value as result of [[#book|book]] API method call. Method return an error with code -32080
    (Appointment couldn't be found) if record with specified id not exists. Methods returns an error with code -32085
    (Signature error) if $sign parameter is wrong.

    • @param Integer $id
    • @param String $sign
    • @return Object
  • getBookingDetails ($id, $sign)

    Returns an object with details information about booking. $sign parameter must be a string created
    with formula: md5($bookingId . $bookingHash . $secretKey). You can get $bookingHash

    value as result of [[#book|book]] API method call. Method return an error with code -32080
    (Appointment couldn't be found) if record with specified id not exists. Methods returns an error with code -32085
    (Signature error) if $sign parameter is wrong.

    • @param Integer $id
    • @param String $sign
    • @return Object
  • isPaymentRequired ($eventId)

    Returns true if [[Plugins#Accept_payments|Accept payments]] plugin activated and event with specified id has
    configured price. If no paramentes specified then method returns true if payments plugin activated and at least

    one event has configured price. Otherwise returns false.

    • @param Integer $eventId
    • @return Boolean
  • book ($eventId, $unitId, $date, $time, $clientData, $additional, $count, $batchId, $recurringData)

    Creates new booking record. Returns an object with appointment information or throw exception if booking time not
    available or any of required parameters missed. If appointment requires confirmation, in result object will be

    require_confirm = true. $startDate and $startTime specifies a date of
    booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
    [[#getTimeframe|getTimeframe]] API method). $endDate and $endTime parameters
    should be calculated according to service duration. However you can specify different values to make appointment
    longer or shorter then service configuration. Note that $endDate and $endTime should be
    later in time than $startDate and $startTime. If your clients located in different time
    zone you should specify 'client_time_offset' value in $clientData object as difference
    between client's time zone and company's time zone in minutes. For example if company located in city with time
    zone GMT+2 and customer located in city with GMT+3 then $clientTimeOffset will be 60 minutes. You
    can get information about company's time zone using [[#getCompanyInfo|getCompanyInfo]] API method. To
    create batch booking you can specify either count more then 1 or valid batchId (only one
    parameter can be specified). You should specify an $additionalFields parameter if service requires
    some additional fields (see [[Plugins#Additional fields|Additional fields plugin]]). To create a booking with promo code you
    should pass it as additional field. For example: {"name": "promocode", "value": "some code", "type": "text"}

    See [[#book response|example]] of book API method response.

    • @see http://wiki.simplybook.me/index.php/Settings#Timeframe Timeframe information
    • @param Integer $eventId
    • @param Integer $unitId
    • @param String $date in Y-m-d format
    • @param String $time in H:i:s format
    • @param Object|array $clientData eg. {name: 'Name', email: 'test@gmail.com', phone: '+38099999999'}
    • @param array|Object $additional additional params and fields.
    • @param Integer $count bookings count, min. 1 (using for group bookings batch). (optional)
    • @param Integer $batchId add booking to multiple bookings batch. (optional)
    • @param Array $recurringData make booking recurrent. (optional)
    • @return Object
  • getRecurringDatetimes ($eventId, $unitId, $date, $time, $recurringData, $productIds)

    Get list of dates for recurring booking

    • @param Integer $eventId
    • @param Integer $unitId
    • @param String $date
    • @param String $time
    • @param array $recurringData
    • @param array $productIds
    • @return array
  • hasUpcommingPromotions ()

    Returns availability of active promotions

    • @return Boolean
  • validatePromoCode ($code, $startDateTime, $eventId, $count, $clientData)

    Validate promotion code.
    Returns true in case promocode is valid otherwise throws exception with error.

    • @param String $code
    • @param String $startDateTime
    • @param Integer $eventId
    • @param Integer $count
    • @param array|Object $clientData
    • @return Boolean
  • getPromocodeInfo ($code)

    Returns an object with detailed information about promotion by promotion code. Returns null if no promotions with
    specified code were not found.

    • @param String $code
    • @return Array
  • getPromotionRewardInfo ($commonPromotionId, $clientId, $hash)

    Returns promotion reward by common promotion id, client id and hash.

    • @param Integer $commonPromotionId
    • @param Integer $clientId
    • @param String $hash
    • @return Array
  • getUserLicenseText ()

    Returns user license text if user license plugin is turned on,
    otherwise throws exception

    • @return String
  • getClientInfo ($clientId, $sign)

    Returns client info by client id

    • @param Integer $clientId
    • @param String $sign signature = md5($clientId . $clientHash . $secretKey)
    • @return Object
  • getClientInfoByLoginPassword ($login, $password)

    Returns client information by clients login (email)/password

    • @param String $login
    • @param String $password
    • @return Object
  • remindClientPassword ($email)

    Sends remind email for client

    • @param String $email
    • @return Boolean
  • getClientByLoginHash ($hash)

    Get client information by client login hash

    • @param String $hash
    • @return Object
  • modifyClientInfo ($clientId, $data, $sign)

    Edit client information data

    • @param Integer $clientId
    • @param Array $data
    • @param String $sign signature = md5($clientId . $clientHash . $secretKey)
    • @return Object
  • getMembershipList ()

    Returns list of available memberships

    • @return Array
  • getClientMembershipList ($filter, $clientId, $sign)

    Returns purchased membership list

    • @param Array $filter
    • @param Integer $clientId
    • @param String $sign
    • @return Array
  • getClientBookings ($clientId, $sign, $filter)

    Returns client bookings, accepts $filter ($filter {upcoming_only: true/false, confirmed_only: true/false})

    • @param integer $clientId
    • @param string $sign
    • @param object|array $filter
    • @return array
  • membershipCheckClientAccess ($eventId, $clientId, $clientSign, $date, $count)

    Checks if client has access to book with $eventId at $startDateTime

    • @param Integer $eventId
    • @param Integer $clientId
    • @param String $clientSign signature = md5($clientId . $clientHash . $secretKey)
    • @param String $date
    • @param int $count
    • @return Boolean
  • getProductList ($filter)

    Returns product list with filter.
    At this time filter can accept only service_id parameter

    • @param object $filter
    • @return array
  • getClassesList ($filter)

    Returns company's classes list. Ordered by position

    • @param Array $filter
    • @return Array
  • rescheduleBook ($shedulerId, $sign, $startDate, $startTime, $endDate, $endTime, $additional, $clientTimeOffset, $clientTimezone)

    Edit existing booking record. See [[#book|book]] API method description for more details about date/time parameters,
    time zone handling and additional fields. Returns null if parameters not valid.

    • @param int $shedulerId an id of booking to edit. See <code>[[#book|book]]</code> or <code>[[#getBookings|getBookings]]</code> API methods.
    • @param string $sign
    • @param String $startDate in Y-m-d format
    • @param String $startTime in H:i:s format
    • @param String $endDate in Y-m-d format
    • @param String $endTime in H:i:s format
    • @param array $additional
    • @param int $clientTimeOffset
    • @param string $clientTimezone
    • @return Object
    • @throws Api_Service_Exception
    • @throws Exception
  • getCompanyParam ($key)

    Returns company config value for key. A different set of keys available for public API and for company
    administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not

    allowed. See [[#Company_params|list of available keys]].

    • @param String $key
    • @return mixed
  • getCompanyParams ($keys)

    Returns company's config values for specified keys as key-value map. For non-existent and not-allowed param keys
    it will return '''false''' as result. A different set of keys available for public API and for company

    administration API. See [[#Company_params|list of available keys]].

    • @param Array $keys
    • @return Array
  • getTimelineType ()

    Returns company timeline type

    • @return String
  • calculateEndTime ($startDateTime, $eventId, $unitId, $productIds)

    Returns end datetime if booking is available, else return false

    • @param String $startDateTime a date and time string in format 'Y-m-d H:i:s', eg. '2001-10-02 13:30:00'.
    • @param Integer $eventId
    • @param Integer $unitId
    • @param array $productIds
    • @return String
  • getWorkCalendar ($year, $month, $data)

    Returns company work schedule as array
    Eg.: {'2014-05-01': {'from': '09:00:00', 'to': '21:00:00', 'is_day_off': '0'}, '2014-05-02': ...}

    • @param Integer $year
    • @param Integer $month
    • @param Integer|array $data pass unit_group_id as integer for old version or structure for new version like {unit_group_id: int, event_id: int}
    • @return Object
  • getReservedTime ($from, $to, $eventId, $unitId, $count)

    Returns map of objects for each day in specified date range. The key of the result mps is a date string. The value
    is an array of two objects. Both objects contains list of time slots for type reserved_time and type

    not_worked_time. reserved_time type represents time slots working time but already booked
    by clients. Nobody knows what kind of data represented by not_worked_time type. Please don't use it.

    If [[Plugins#Google calendar sync plugin|Google calendar sync plugin]] enabled then object with
    reserved_time type will contain not empty list of time slots marked as busy in Google calendar. Call
    [[#isPluginActivated|isPluginActivated('google_calendar_export')]] API method to check if Google
    calendar sync plugin activated.


    Example:


    {
    "2016-02-05": [
    {
    "dd": [], // time slots from Google calendar
    "events": [ // reserved time slots
    { "from": "16:00", "to": "16:30" },
    { "from": "16:30", "to": "17:00" },
    ... ],
    "type": "reserved_time",
    },
    {
    "events": [
    { "from": "09:00", "to": "09:30" },
    { "from": "09:30", "to": "10:00" },
    ... ],
    "type": "not_worked_time"
    }],
    ...
    }

    • @param String $from
    • @param String $to
    • @param Integer $eventId
    • @param Integer $unitId
    • @param Integer $count
    • @return Object
  • getWorkDaysInfo ($from, $to, $unitId, $eventId, $count, $productIds)

    Returns an information about working hours and break times for specified service and performer for a period
    between two dates. If only service specified then information about performer (or performers) will be taken from

    service configuration. Method returns a list of objects for each date in specified period. Count of objects in
    list depends on break times. For example if performer works from 9:00 till 19:00 with one hour break at 13:00 method
    returns:


    {'2014-05-14' : [
    {'from': '09:00:00', 'to': '13:00:00'},
    {'from': '14:00:00', 'to': '19:00:00'}
    ] }


    Warning! Method can return a time string '24:00:00' as right edge of time range. This happens in case if time
    range finishes on midnight.

    • @param String $from
    • @param String $to
    • @param Integer $unitId (optional)
    • @param Integer $eventId (optional)
    • @param Integer $count (optional)
    • @param array $productIds (optional)
    • @return array
  • getFirstWorkingDay ($data)

    Returns first working date for unit

    • @param Integer|array $data pass unit_group_id as integer for old version or structure for new version like {unit_group_id: int, event_id: int}
    • @return String
  • getStartTimeMatrix ($from, $to, $eventId, $unitId, $count, $bookingId, $productIds)

    Returns available start time, taking into account breaktimes, start and end working time
    Eg.: {'2014-05-14': ['09:00:00', ...], ...}


    If locations plugin activated for company you should pass a list as $unitID parameter for filter results with
    units available only for selected location. See [[Plugins#Unit_location|Unit location]] plugin description for
    more details.

    • @param String $from
    • @param String $to
    • @param Integer $eventId
    • @param Mixed $unitId can be Integer or Array of Integers
    • @param Integer $count
    • @param int $bookingId
    • @param array $productIds
    • @return array
  • getAvailableTimeIntervals ($dateFrom, $dateTo, $eventId, $unitId, $count)

    Returns available time intervals for all service providers for given period, taking into account breaktimes, start and end working time
    Eg.: {['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}

    • @param String $dateFrom
    • @param String $dateTo
    • @param Integer $eventId
    • @param Mixed $unitId can be Integer or Array of Integers
    • @param Integer $count
    • @return Object
  • getServiceAvailableTimeIntervals ($dateFrom, $dateTo, $eventId, $unitId, $count)

    Returns available time intervals for all servics for given period, taking into account breaktimes, start and end working time
    Eg.: {['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}

    • @param String $dateFrom
    • @param String $dateTo
    • @param Mixed $eventId can be Integer or Array of Integers
    • @param Integer $unitId
    • @param Integer $count
    • @return Object
  • getReservedTimeIntervals ($dateFrom, $dateTo, $eventId, $unitId, $count, $bookingId)

    Returns not available time
    Eg.: {'2014-05-14': [{'reserved_time': [{'from': '14:00', 'to': '16:30'}], 'type': "reserved_time"}, ...], ...}

    • @param String $dateFrom
    • @param String $dateTo
    • @param Integer $eventId
    • @param Integer|Array $unitId
    • @param Integer $count
    • @param int $bookingId
    • @return array
  • getAvailableUnits ($eventId, $dateTime, $count, $unitId, $productIds)

    Returns list of available unit ids for specified date and service or empty array if all units are not allowed.
    Eg.: [1, 2, 3]

    • @param Integer $eventId
    • @param String $dateTime a date and time string in format 'Y-m-d H:i:s'
    • @param int $count
    • @param int $unitId
    • @param array $productIds
    • @return array
    • @throws Exception
  • getAnyUnitData ()

    Returns information about [[Plugins#Any_Employee_selector|Any Employee selector plugin]] configuration. Returns
    null if plugin not enabled.


    Example:
    {
    "description" : "Select this option, if you want to find an available time with any of the employees",
    "hide_other_units" : 1, // 1 or 0
    "image" : null,
    "name" : "Any employee",
    "picture_path" : null,
    "random_selection" : 0 // 1 or 0
    }

    • @return Object
  • getAdditionalFields ($eventId)

    Return additional fields for certain event if [[Plugins#Additional_fields|Additional fields plugin]] is
    activated. Returns empty array otherwise. Call [[#isPluginActivated|isPluginActivated('event_field')]]

    API method to check if 'event_field' plugin activated.

    • @param Integer $eventId
    • @return Array
  • getTimeframe ()

    Returns company's timeframe configuration (in minutes). Timeframe can be either 5, 10, 15, 20, 30 or 60 minutes.
    You can find more details about timeframe [[Settings#Timeframe|here]].

    • @return Integer
  • isPluginActivated ($pluginName)

    Return plugin status true if status active, else false. $pluginName parameter is a plugin identifier.
    See [[Plugins|plugins]] page for full plugins description. See [[#Plugin's identifiers|list of available plugin's names]].

    • @param String $pluginName
    • @return Boolean
  • getPluginStatuses ($pluginNames)

    Return plugin status true if status active, else false. See [[#Plugin's identifiers|list of available plugin's names]].

    • @param Array $pluginNames
    • @return Array
  • getCompanyInfo ()

    Returns an object with detailed information about company. See [[#getCompanyInfo response|example of response]].

    • @return Object
  • createBatch ()

    Creates new booking batch record. Returns newly created batch id. You can use this id in [[#book|book]]
    API method.

    • @return Integer
  • getCountryPhoneCodes ()

    Returns country phone code list

    • @return Array
  • getPluginPromoInfoByCode ()

    Returns an object with detailed information about promotion by promotion code. You can get promotion code
    using [[Catalogue#getPromotionList|getPromotionList]] API method. If promotion record with specified

    code not found then method returns an empty array (an empty object). If [[Plugins#Simply Smart Promotions|Simply Smart Promotions plugin]]
    not enabled then method returns an error with code -32001 (Plugin is not activated). Use
    [[#isPluginActivated|isPluginActivated('promo')]] API method call to check if plugin enabled.


    See [[#getPromotionList response|example]] of getPromotionList API method response. Please note that
    response contains a list of services for wich promotion discount can be applied (service_ids key).

    • @param String
    • @return Array
  • getCompanyTimezoneOffset ()

    Returns company timezone offset and company timezone

    • @return array

Service URL  https://user-api.simplybook.me/admin

  • getUserPhoneValidationInfo ($userId, $number)

    Get user db data (id, phone, is_validated)

    • @param int $userId
    • @param string $number
  • saveConfigKeys ($data, $module, $plugin)

    Save configuration keys

    • @param array $data
    • @param string $module optional
    • @param string $plugin optional
    • @return array
  • getNotificationConfigStructure ($plugin)

    Get structure of SMS and Email notification config params

    • @param string $plugin optional
    • @return mixed
  • getBookings ()

    Returns list of bookings filtered by given params. Filter params represented as object with following fields:


    * '''date_from''' a date of booking in string format 'Y-m-d'
    * '''time_from''' a time string in format 'H:i:s'
    * '''date_to''' a date string in format 'Y-m-d'
    * '''time_to''' a time string in format 'H:i:s'
    * '''created_date_from''' a date string in format 'Y-m-d'
    * '''created_date_to''' a date string in format 'Y-m-d'
    * '''unit_group_id''' an integer. Use it to get bookings assigned for certain service provider.
    * '''event_id''' an integer. Use it to get bookings only for certain service.
    * '''is_confirmed''' 1 or 0. If [[Plugins#Approve booking|Approve booking]] plugin enabled then method will return confirmed bookings with approve status 'new'.
    * '''client_id''' an integer. Use it to get bookings only for certain client.
    * '''order''' string either 'record_date', 'date_start' or 'date_start_asc'. By default used 'date_start' value.
    * '''booking_type''' a string. Value of this field depends on Approve booking plugin status.
    * '''code''' booking code
    *: If plugin not active:
    ** '''all''' for all bookings (default value)
    ** '''cancelled''' alias to 'is_confirmed' equal to 0
    ** '''non_cancelled''' alias to 'is_confirmed' equal to 1
    *: If plugin active:
    ** '''all''' for all bookings (default value)
    ** '''cancelled''' returns bookings with 'is_confirmed' field equals to 0 and approve booking status equals to 'cancelled' (or booking does not have any approve status)
    ** '''non_cancelled''' returns bookings with either 'is_confirmed' field equals to 1 or approve booking status equals to 'new'
    ** '''cancelled_by_client''' returns bookings approved by admin but cancelled by client
    ** '''cancelled_by_admin''' returns bookings cancelled by admin
    ** '''non_approved_yet''' returns bookings with approve status 'new'
    ** '''approved''' returns bookings with either 'is_confirmed' field equals to 1 and approve booking status equals to 'approved' (or booking does not have any approve status)

    Example:
    {
    "date_from":"2015-12-29",
    "date_to":"2015-12-29",
    "booking_type":"cancelled",
    "event_id":"5",
    "order":"start_date"
    }

    • @param Array
    • @return Array
  • pluginZapierSubscribe ($url, $notificationType)

    'create', 'cancel', 'new_client', 'change', 'create_invoice'

    • @param string $url
    • @param string $notificationType
    • @return bool
  • getBookingDetailsZapierMock ()

    • @return array
  • getClientInfo ($clientId)

    Returns client data

    • @param int|string $clientId
    • @return array
  • getClientInfoZapier ($clientId)

    Returns client data

    • @param int|string $clientId
    • @return array
    • @throws \Exception
  • getClientInfoZapierMock ()

    Returns client data

    • @return array
    • @throws \Exception
  • getBookingsZapier ()

    Returns list of bookings filtered by given params

    • @return Array
  • getInvoiceDetailsMock ()

    • @return array
  • getBookingDetails ($id)

    Returns detailed bookings object by booking id. See [[#getBookingDetails_response|response example]].

    • @param integer $id booking id
    • @return Array
  • getWorkDaysTimes ($startDateTime, $endDateTime, $type)

    Return busy time by unit id by GoogleCalendar plugin if enabled.
    Please note that this method may return not actual data because data synchronization between server and

    Google Calendar may take some time and synchronized data are cached for 15 minutes.

    • @param string $startDateTime
    • @param string $endDateTime
    • @param string $type either 'unit_group' or 'event'. Default value is 'unit_group'.
    • @return array
  • getGoogleCalendarBusyTime ($startDateTime, $endDateTime, $unitId)

    Returns a list of objects represented a time intervals marked as busy in Google Calendar. Each object of result
    contains from and to properties with datetime string as value. This method only actual if

    [Plugins#Google calendar sync plugin|Google calendar sync plugin] enabled. If plugin not enabled an empty list will
    be returned. You should call [[#isPluginActivated|isPluginActivated('google_calendar_export')]] to
    check status of the plugin. Each object of result contains from and to properties with
    datetime string as value. Please note that this method may return not actual data because data synchronization
    between server and Google Calendar may take some time and synchronized data are cached for 15 minutes.


    Example:

    [
    {"from" : "2016-02-16 13:30:00",
    "to" : "2016-02-16 16:00:00"},
    ...
    ]

    • @param string $startDateTime a date and time string in format 'Y-m-d H:i:s'
    • @param string $endDateTime a date and time string in format 'Y-m-d H:i:s'. You can date string avoiding time in this parameter. In this case method will use time value '23:59:59'.
    • @param int $unitId
    • @return Array
  • getGoogleCalendarBusyTimeAvailableUnits ()

    Returns configured unit ids, allowed to sync busy time

    • @return Array
  • getBookingLimitUnavailableTimeInterval ($startDateTime, $endDateTime, $eventId)

    Returns time intervals not available for bookings because of configuration of [[Plugins#Limit bookings|Limit bookings]]
    plugin for period of time. Returns empty array if plugin not available.

    • @param string $startDateTime a date and time string in format 'Y-m-d H:i:s'
    • @param string $endDateTime a date and time string in format 'Y-m-d H:i:s'
    • @param int $eventId
    • @return Array
  • getUnitWorkingDurations ($dateStart, $dateEnd, $unitGroupId)

    Return working durations

    • @param string $dateStart
    • @param string $dateEnd
    • @param int $unitGroupId
    • @return Array
  • getWorkload ($dateStart, $dateEnd, $unitGroupId)

    Return workload data for units in period of time. Workload for each unit represented as array with work hours
    at index 0, confirmed booking hours as load at index 1 and cancelled bookings hours at index 2.


    Example:
    ['2015-10-21' : {
    5 : [
    10, // working hours
    10, // load hours (confirmed bookings hours)
    0 // cancelled bookings hours
    ] }]

    • @param string $dateStart
    • @param string $dateEnd
    • @param int $unitGroupId
    • @return Array
  • getBookingRevenue ($dateStart, $dateEnd, $unitGroupId, $serviceId)

    Return bookings count and revenue value for each date in specified period. Data grouped by unit id and
    represented as array with bookings count at index 0 and revenue amount at index 1. You can filter data either

    by unit or by service. Set $dateStart and $dateEnd to null to get data for current week.

    Example:
    ['2015-11-12' : {
    3 : [
    11, // bookings count
    128.53 // revenue
    ]}

    • @param string $dateStart a date string in format 'Y-m-d'.
    • @param string $dateEnd a date string in format 'Y-m-d'
    • @param int $unitGroupId
    • @param int $serviceId
    • @return Array
  • getUnitWorkdayInfo ($dateStart, $dateEnd, $unitGroupId)

    Return workday info (date_start and date_end)

    • @param string $dateStart
    • @param string $dateEnd
    • @param int $unitGroupId
    • @return array
  • cancelBooking ($id)

    Cancels booking. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found) if
    no booking with specified id were found.

    • @param Integer $id
    • @return Boolean
  • cancelBatch ($id, $bookingIds)

    Cancel batch of bookings. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found)
    if no booking with specified id were found. A booking with first id in $bookingIds list is used for

    information in notifications.

    • @param Integer $id identifier of batch. See <code>[[#createBatch|createBatch]]</code> API method.
    • @param Array $bookingIds ids of bookings included to batch.
    • @return bool
  • book ($eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional, $count, $batchId, $recurringData)

    Creates new booking record. Returns an object with appointment information or throw exception if booking time not
    available or any of required parameters missed. If appointment requires confirmation, in result object will be

    require_confirm = true. $startDate and $startTime specifies a date of
    booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
    [[#getTimeframe|getTimeframe]] API method). $endDate and $endTime parameters
    should be calculated according to service duration. However you can specify different values to make appointment
    longer or shorter then service configuration. Note that $endDate and $endTime should be
    later in time than $startDate and $startTime. If your clients located in different time
    zone you should specify 'client_time_offset' value in $clientData object as difference
    between client's time zone and company's time zone in minutes. For example if company located in city with time
    zone GMT+2 and customer located in city with GMT+3 then $clientTimeOffset will be 60 minutes.
    You can get information about company's
    time zone using [[#getCompanyInfo|getCompanyInfo]] API method. To create batch booking you can
    specify either count more then 1 or valid batchId (only one parameter can be
    specified). You should specify an $additionalFields parameter if service requires some additional
    fields (see [[Plugins#Additional fields|Additional fields plugin]]).

    To create a booking with promo code you should pass it as additional field. For example: {"promocode": "some code"}

    If [[Plugins#Unit location|Unit location]] enabled you need to pass locations ID parameter as additional field
    location_id. For example: {"location_id": "1"}. Use [[#isPluginActivated|isPluginActivated('location')]]
    to check if plugin active and [[#getLocationsList|getLocationsList()]] method to get list of
    available locations.

    See [[#book response|example]] of book API method response.

    • @see http://wiki.simplybook.me/index.php/Settings#Timeframe Timeframe information
    • @param Integer $eventId
    • @param Integer $unitId
    • @param Integer $clientId
    • @param string $startDate a date string in format 'Y-m-d'
    • @param string $startTime a time string in format 'H:i:s'
    • @param string $endDate a date string in format 'Y-m-d'
    • @param string $endTime a time string in format 'H:i:s'
    • @param Integer $clientTimeOffset
    • @param array|Object $additional additional params and fields.
    • @param Integer $count bookings count used to make group bookings batch. This parameter can't be less than 1. (optional)
    • @param Integer $batchId add booking to group bookings batch. You can't use $count and $batchId in one call. Please specify only one parameter. (optional)
    • @param Array $recurringData make booking recurrent. (optional)
    • @return Object
  • editBook ($shedulerId, $eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional)

    Edit existing booking record. See [[#book|book]] API method description for more details about date/time parameters,
    time zone handling and additional fields. Returns null if parameters not valid.

    • @param Integer $shedulerId an id of booking to edit. See <code>[[#book|book]]</code> or <code>[[#getBookings|getBookings]]</code> API methods.
    • @param Integer $eventId
    • @param Integer $unitId
    • @param Integer $clientId
    • @param String $startDate in Y-m-d format
    • @param String $startTime in H:i:s format
    • @param String $endDate in Y-m-d format
    • @param String $endTime in H:i:s format
    • @param Integer $clientTimeOffset
    • @param array|Object $additional additional params and fields.
    • @return Object
  • addClient ($clientData, $sendEmail)

    Adds new client with specified data. You can specify name, email, phone, address1, address2, city, zip,
    country_id.

    email, phone number or both of them can be mandatory fields. You should call
    getCompanyParam('require_fields') method to check which fields are required.

    Method returns an error:

    * -32061 Client name value is wrong
    * -32062 Client email value is wrong
    * -32063 Client phone value is wrong


    Example:

    {
    name: "Frances T. Perez",
    phone: "+1502-810-4521",
    email: "FrancesTPerez@teleworm.us",
    address1: "3872 Earnhardt Drive",
    address2: "Louisville, KY 40219",
    city: Louisville,
    zip: 3872
    }

    • @param Object $clientData
    • @param Boolean $sendEmail
    • @return Integer
  • editClient ($clientId, $clientData)

    Edits client's record. See [[#addClient|addClient]] method description for list of available fields.
    Method returns an id of client's record.

    • @param Integer $clientId
    • @param Object $clientData
    • @return Integer
  • changeClientPassword ($clientId, $password, $sendEmail)

    Change client password and send password email changing

    • @param Integer $clientId
    • @param String $password
    • @param Boolean $sendEmail
  • resetClientsPassword ($clientIds)

    Resets client password and send them emails

    • @param Array $clientIds
  • remindClientsPassword ($email)

    Sends remind email for client

    • @param String $email
    • @return Boolean
  • getClientList ($searchString, $limit)

    Returns list of clients associated with company. You can use either phone number, email address or name as value
    for $searchString. Pass an empty string for $searchString and null for $limit

    parameters to get all records. See [[#addClient|addClient]] API method for list of available fields
    of client data object.

    • @param String $searchString
    • @param Integer $limit
    • @return Array
  • getStatuses ()

    Returns list of available statuses or an empty list if [[Plugins#Status|Status plugin]] not enabled.

    • @return Array
  • getBookingStatus ($bookingId)

    Returns status of given booking (if status plugin is enabled)
    default status will be returned if bookingId does not exists

    • @param Integer $bookingId
    • @return Array
  • setStatus ($bookingId, $statusId)

    Sets specified status for booking. Returns an error with code -32020 if logged in user don't have access to edit
    bookings. This method does nothing if [[Plugins#Status|Status plugin]] not enabled.

    • @param Integer $bookingId
    • @param Integer $statusId
    • @return Boolean
  • getRecurringSettings ($eventId)

    Returns an object with recurring settings for an event. Returns false if specified event does not configured as
    recurring.

    • @see http://blog.simplybook.me/recurring-and-periodic-bookings/ Recurring services desription
    • @param Integer $eventId
    • @return Array
  • getTopServices ($dateStart, $dateEnd)

    Returns a list with statistics for services for a period of time. This data contains number of bookings and
    revenues value for each service.

    • @param String $dateStart
    • @param String $dateEnd
    • @return Array
  • getTopPerformers ()

    Returns a list with statistics for performers. This data contains number of bookings and revenues value for each performer.

    • @return Array
  • getRecurringDatetimes ($eventId, $unitId, $date, $time, $recurringData, $endDateTime, $productIds)

    Get list of dates for recurring booking

    • @param Integer $eventId
    • @param Integer $unitId
    • @param String $date
    • @param String $time
    • @param array $recurringData
    • @param String $endDateTime (optional)
    • @param array $productIds
    • @return array
  • addDeviceToken ($token, $device)

    Subscribe a mobile device to push notifications service. Device will recieve notifications about new bookings or
    changes in already created bookings. Use either 'apple' or 'android' for device

    parameter.

    • @param String $token a device token string
    • @param String $device a device type ('android' or 'apple')
    • @return bool
  • deleteDeviceToken ($token)

    Unsubscribe from push notifications service.

    • @param String $token device token
    • @return bool
  • getCountryList ()

    Get list of all countries

    • @return Array
  • getFeedbacks ($approvedOnly, $reviewsOnly, $lastOnly, $limit)

    Get list of feedbacks

    • @param Boolean $approvedOnly
    • @param Boolean $reviewsOnly
    • @param Boolean $lastOnly
    • @param Integer $limit
    • @return Array
  • getRecentActions ($lastOnly, $limit)

    Returns latest actions

    • @param Boolean $lastOnly
    • @param Integer $limit
    • @return Array
  • getWarnings ($lastObly)

    Returns a list of objects represented system warnings. Each warning contains warning_type and warning_text
    properties. warning_text property contains localized message. warning_type can be one of the values:


    * '''sms_limit''' – warning indicates low amount of SMS credits
    * '''sheduler_limit''' – warning indicates low amount of available bookings

    • @param Boolean $lastObly Default value is '''false'''.
    • @return Array
  • updateNotification ($type)

    Mark notifications as readed

    • @param String $type
  • getLastNotificationUpdate ($type)

    Returns last update datetime

    • @param String $type
    • @return String
  • getBookingCancellationsInfo ($dateStart, $dateEnd)

    Returns statistics about created bookings and cancellations for a time period. Data presented as array of hashes for
    each type of operation (created or cancelled booking) groped by clients. "type" field can be either

    "create", "cancel" or "nopayment_cancel". If "user_id" not specified then bookings where created or
    cancelled by admin or employee. Data with type "nopayment_cancel" represents bookings cancelled
    automatically by system.

    Example:
    3 bookings where created by admin or employee and 2 bookings where automatically cancelled by system.
    [{
    "cnt" : 3,
    "firstname" : null,
    "lastname" : null,
    "login" : null,
    "type" : "create",
    "user_id"" : null
    }, {
    "cnt" : 2,
    "firstname" : null,
    "lastname" : null,
    "login" : null,
    "type" : "nopayment_cancel",
    "user_id"" : null
    }]

    • @param String $dateStart a date string in format 'Y-m-d'. Pass null to get data from first day of current week.
    • @param String $dateEnd a date string in format 'Y-m-d'. Pass null to get data filtered to last day of current week.
    • @return Array
  • pluginApproveBookingApprove ($id)

    Sets approve booking status to 'approved' if [[Plugins#Approve booking|Approve booking]] plugin enabled and returns
    list of approved booking IDs. Returns false if plugin not enabled. Use [[#isPluginActivated|isPluginActivated('approve_booking')]]

    API method call to check if plugin enabled.

    • @param Integer $id
    • @return Array
  • pluginApproveBookingCancel ($id)

    Sets approve booking status to 'canceled' if [[Plugins#Approve booking|Approve booking]] plugin enabled and returns
    true. Returns false if plugin not enabled. Use [[#isPluginActivated|isPluginActivated('approve_booking')]]

    API method call to check if plugin enabled.

    • @param Integer $id
    • @return Boolean
  • pluginApproveGetPendingBookingsCount ()

    Returns count of bookings pending approval if [[Plugins#Approve booking|Approve booking]] plugin enabled. Returns
    0 if plugin not enabled. Use [[#isPluginActivated|isPluginActivated('approve_booking')]] API method

    call to check if plugin enabled.

    • @return Integer
  • pluginApproveGetPendingBookings ()

    Returns list of objects with information about bookings pending approval if [[Plugins#Approve booking|Approve booking]]
    plugin enabled. Returns empty list if plugin not enabled. Use [[#isPluginActivated|isPluginActivated('approve_booking')]]

    API method call to check if plugin enabled.

    • @return array
  • getPluginList ()

    Returns a list of all plugins associated with company with status.

    • @return Array
  • getBookingComment ($id)

    Returns booking comment

    • @param Integer $id
    • @return String
  • setBookingComment ($id, $comment)

    Set booking comment

    • @param Integer $id
    • @param String $comment
    • @return Integer
  • getCurrentTariffInfo ()

    Returns all information about current tariff (subscription). For example:

    {
    "name" : "gold",
    "expire_date" : "2016-02-11 12:32:00",
    "rest" : 41, // number of days until subscription expiration
    "color" : "#fcb322"
    }

    • @return Array
  • getRegistrations ($groupBy)

    Returns number of clients registrations by 'day', 'week' or 'month'. A time period depends on selected
    grouping parameter:


    * for 'day' methods returns statistics for last 31 days
    * for 'week' methods returns data last 10 weeks period
    * for 'month' time period is last 12 months

    • @param String $groupBy either 'day', 'week' or 'month'
    • @return Array
  • getBookingStats ($groupBy)

    Returns statistic about bookings count grouped by 'day', 'week' or 'month'. A time period depends on selected
    grouping parameter:


    * for 'day' methods returns statistics for last 31 days
    * for 'week' methods returns data last 10 weeks period
    * for 'month' time period is last 12 months

    • @param String $groupBy either 'day', 'week' or 'month'
    • @return Array
  • getVisitorStats ($groupBy)

    Returns statistics about page visits if plugin [[Plugins#Visitor Counter|Visitor Counter plugin]] enabled. Returns
    an empty list if plugin not enabled. Use [[#isPluginActivated|isPluginActivated('counter')]] API method

    call to check if plugin enabled. Results can be grouped by 'day', 'week' or 'month'. A time period depends on
    selected grouping parameter:

    * for 'day' methods returns statistics for last 31 days
    * for 'week' methods returns data last 10 weeks period
    * for 'month' time period is last 12 months

    • @param String $groupBy
    • @return Array
  • getSocialCounterStats ($provider)

    Returns social counters value for your domain

    • @param String $provider
    • @return Integer
  • getCompanyCurrency ()

    Returns company's currency as three chars code (ISO 4217).

    • @return String
  • getClientComments ($clientId, $shedulerId)

    Returns list of all comments for given client

    • @param Integer $clientId
    • @param Integer $shedulerId
    • @return Array
  • getClientSoapData ($clientId)

    Returns current SOAP information by client id

    • @param integer $clientId
    • @return array
  • getClientSoapHistory ($clientId)

    Returns SOAP history by client id

    • @param integer $clientId
    • @return array
  • updateClientSoapData ($clientId, $data)

    Updates SOAP information if it was changed

    • @param integer $clientId
    • @param array $data
  • getClientSoapCryptData ($clientId)

    Returns current SOAP (crypt) information by client id

    • @param integer $clientId
    • @return array
  • getClientSoapCryptHistory ($clientId)

    Returns SOAP (crypt) history by client id

    • @param integer $clientId
    • @return array
  • updateClientSoapCryptData ($clientId, $data)

    Updates SOAP (crypt) information if it was changed

    • @param integer $clientId
    • @param array $data
  • getCurrentUserDetails ()

    Returns an object with information about logged in user. Note: you are responsible for implementation of some
    access rights based on group property value. Most of API methods returns an error if user has low access

    rights but not all. There are 4 roles:

    * '''Administrator''' - have full access to the system
    * '''Senior Employee''' - have access to calendar, services and providers, and can modify bookings related with user
    * '''Junior Employee''' - can access caledar (but only to own bookings), services associated with user
    * '''Viewer''' - have only access to calendar and services in read only mode

    group property can be one of the values:

    * shop_user - "Senior Employee" access role
    * station_user - "Junior Employee" access role
    * admin - "Administrator" access role
    * viewer - "Viewer" access role
    * reseller_company_admin - reserved

    Example:

    {
    "id": 1,
    "login": admin,
    "email": "admin@mycoolcompany.com";
    "firstname": "Michail",
    "lastname": " ",
    "phone": "",
    "group": "admin",
    "is_blocked": 0,
    "last_access_time": "2016-06-06 17:55:51",
    "unit_group_id": null
    }

    • @return Array
  • deleteCategories ($categories)

    Delete given set of categories if it is possible
    Returns an error with code -32001 if plugin is not activated. Use [[#isPluginActivated|isPluginActivated('event_category')]]

    API method to check if plugin activated.
    Returns an error with code -32101 if trying to delete default category and
    an error with code -32102 if trying to delete all categories
    Return an error with code -32002 if no $categories provided

    • @param array $categories
    • @return bool
  • deleteLocations ($locations)

    Delete given set of locations if it is possible
    Returns an error with code -32001 if plugin is not activated.

    Use [[#isPluginActivated|isPluginActivated('location')]] API method to check if plugin activated.
    Returns an error with code -32074 if trying to delete default location and
    an error with code -32075 if trying to delete all locations
    Returns an error with code -32002 if no $locations provided

    • @param array $locations
    • @return bool
  • addServiceProvider ($data)

    Adds new service provider


    Example:

    {
    "name" : "newtagg1 - 4",
    "description" : "Description - 1",
    "phone" : "1234567890",
    "email" : "test@test.com",
    "qty" : "2",
    "is_visible" : 1,
    "is_active" : 1,
    "position" : 2,
    "position_in_location" : null,
    "locations" : [ 3 ],
    "services" : [ 1, 2 ]
    }

    • @param array $data
    • @return Array
  • editServiceProvider ($id, $data)

    Edit service provider
    there is no way to delete provider via API, in this case set is_active = 0



    Example:

    {
    "name" : "newtagg1 - 4",
    "description" : "Description - 1",
    "phone" : "1234567890",
    "email" : "test@test.com",
    "qty" : "2",
    "is_visible" : 1,
    "is_active" : 1,
    "position" : 2,
    "position_in_location" : null,
    "locations" : [ 3 ],
    "services" : [ 1, 2 ]
    }

    • @param integer $id
    • @param array $data
    • @return Array
  • addService ($data)

    Adds new service


    Example:


    {
    "name":"Service name",
    "duration":"60",
    "hide_duration":"0",
    "description":"Service description",
    "is_public":"1",
    "is_active":"1",
    "position":"1",
    "file_id":null,
    "seo_url":null,
    "is_recurring":"0",
    "picture":null,
    "picture_sub_path":null,
    "picture_path":null,
    "recurring_settings":{
    "days":7,
    "repeat_count":1,
    "type":"fixed",
    "mode":"skip",
    "is_default_settings":true,
    "days_names":[
    "Friday",
    "Saturday",
    "Sunday"
    ]
    },
    "units":[
    2, 3
    ],
    "price":10,
    "currency":"USD",
    }

    • @param array $data
    • @return Array
  • editService ($id, $data)

    Edit service
    there is no way to delete service via API, in this case set is_active = 0



    Example:

    {
    "name":"Service name",
    "duration":"60",
    "hide_duration":"0",
    "description":"Service description",
    "is_public":"1",
    "is_active":"1",
    "position":"1",
    "file_id":null,
    "seo_url":null,
    "is_recurring":"0",
    "picture":null,
    "picture_sub_path":null,
    "picture_path":null,
    "recurring_settings":{
    "days":7,
    "repeat_count":1,
    "type":"fixed",
    "mode":"skip",
    "is_default_settings":true,

    "days_names":[
    "Friday",
    "Saturday",
    "Sunday"
    ]
    },
    "units":[
    2, 3
    ],
    "categories":[
    2
    ]
    "price":10,
    "currency":"USD",
    }

    • @param integer $id
    • @param array $data
    • @return Array
  • editServiceCategory ($id, $data)

    Edit service category


    Example:


    {
    "name":"Category name",
    "description":"Category description",
    "is_default":1,
    "position":0,

    • @param integer $id
    • @param array $data
    • @return Array
  • deleteServiceCategory ($id)

    Delete service category

    • @param integer $id
    • @return Array
  • getCategoriesList ($isPublic)

    Returns company categories list if [[Plugins#Service categories|Service categories plugin]] is activated. Returns
    an error with code -32001 if plugin is not activated. Use [[#isPluginActivated|isPluginActivated('event_category')]]

    API method to check if plugin activated.

    • @param Boolean $isPublic
    • @return Array
  • getLocationsList ($isPublic, $asArray)

    Returns available locations for company if plugin [[Plugins#Unit location|Unit location plugin]] is activated. Return
    an error with code -32001 if plugin is not activated. Use [[#isPluginActivated|isPluginActivated('location')]]

    API method to check if plugin activated.

    This method accepts two boolean flags as parameters. If '''isPublic''' flag is '''true''' then method returns only
    public locations. If '''asArray''' flag is '''true''' method returns list of objects. Otherwise method returns
    map of objects with object id as key. You can omit both parameters.

    • @param Boolean $isPublic Optional. Default value is '''false'''.
    • @param bool $asArray Optional. Default value is '''false'''.
    • @return Array
  • deleteServiceProviderLocation ($id)

    Delete service provider location

    • @param integer $id
    • @return Array
  • addServiceCategory ($data)

    Edit service category


    Example:


    {
    "name":"Category name",
    "description":"Category description",
    "is_default":1,
    "position":0,

    • @param array $data
    • @return Array
  • editServiceProviderLocation ($id, $data)

    Edit service provider location


    Example:


    {
    "title":"Location mame",
    "description":"Locartion description",
    "address1":"Address 1",
    "address2":"Address 2",
    "city":"City",
    "zip":"12345",
    "country_id":"US",
    "lat":"0.00000000000000000000",
    "lng":"0.00000000000000000000",
    "phone":"11234567",
    "position":"1",
    "is_default":"1"
    }

    • @param integer $id
    • @param array $data
    • @return Array
  • addServiceProviderLocation ($data)

    Add service provider location


    Example:


    {
    "title":"Location mame",
    "description":"Locartion description",
    "address1":"Address 1",
    "address2":"Address 2",
    "city":"City",
    "zip":"12345",
    "country_id":"US",
    "lat":"0.00000000000000000000",
    "lng":"0.00000000000000000000",
    "phone":"11234567",
    "position":"1",
    "is_default":"1"
    }

    • @param array $data
    • @return Array
  • getMembership ($membershipId)

    Returns membership's data object.

    • @param int $membershipId
    • @return Array
  • getClientMembershipList ($clientId)

    Returns purchased membership list

    • @param Integer $clientId
    • @return Array
  • setWorkDayInfo ($info)

    Set work day schedule for company|service|provider for week_day|date


    Example:

    {
    "start_time":"10:00",
    "end_time":"18:00",
    "is_day_off":0,
    "breaktime":[{"start_time":"14:00","end_time":"15:00"}],
    "index":"1",
    "name":"Monday",
    "date":"",
    "unit_group_id":"",
    "event_id":""
    }


    index is 1-7 for Monday - Sunday (used for weekly settings)
    date is used to set worktime for special date
    unit_group_id is provider id
    event_id is service id
    if unit_group_id and event_id not passed then it set data for company

    • @param array $info
    • @return boolean true on success
  • deleteSpecialDay ($date, $params)

    Delete special date if set


    Example:

    {
    "unit_group_id":"",
    "event_id":""
    }

    • @param string $date 'Y-m-d'
    • @param array $params = null
    • @return boolean true on success
  • getCompanyWorkCalendarForYear ($year)

    Returns company special days and vacations

    • @param Integer $year
    • @return Object
  • getServiceWorkCalendarForYear ($year, $eventId)

    Returns special days and vacations, defined for given service (event)

    • @param Integer $year
    • @param Integer $eventId
    • @return Object
  • getCompanyVacations ()

    Get list of company vacations in format array(vacation_id => array())

    • @return array
  • getServiceVacations ($serviceId)

    Get list of service vacations

    • @param Integer $serviceId
    • @return array
  • getPerformerVacations ($performerId)

    Get list of performer vacations

    • @param Integer $performerId
    • @return array
  • getCompanyVacation ($vacationId)

    Get company vacation by id

    • @param Integer $vacationId
    • @return array vacation table row data
  • getServiceVacation ($vacationId, $serviceId)

    Get service vacation by id

    • @param Integer $vacationId
    • @param Integer $serviceId
    • @return array vacation table row data
  • getPerformerVacation ($vacationId, $performerId)

    Get service vacation by id

    • @param Integer $vacationId
    • @param Integer $performerId
    • @return array vacation table row data
  • saveCompanyVacation ($data)

    Save company vacation data
    (create or update table depending on 'id' param existing in $data)

    • @param array $data
    • @return Integer id of saved vacation
  • saveServiceVacation ($data, $serviceId)

    Save company vacation data
    (create or update table depending on 'id' param existing in $data)

    • @param array $data
    • @param Integer $serviceId
    • @return Integer id of saved vacation
  • savePerformerVacation ($data, $performerId)

    Save company vacation data
    (create or update table depending on 'id' param existing in $data)

    • @param array $data
    • @param Integer $performerId
    • @return Integer id of saved vacation
  • deleteCompanyVacation ($vacationId)

    Delete company vacation with all it's bindings
    (including created special days in work_day_special table)

    • @param Integer $vacationId
  • deleteServiceVacation ($vacationId, $serviceId)

    Delete service vacation with all it's bindings
    (including created special days in work_day_special table)

    • @param Integer $vacationId
    • @param Integer $serviceId
  • deletePerformerVacation ($vacationId, $unigGroupId)

    Delete performer vacation with all it's bindings
    (including created special days in work_day_special table)

    • @param Integer $vacationId
    • @param Integer $unigGroupId
  • getClassesList ($isVisibleOnly, $asArray)

    Returns company's classes list. If $asArray is false then method returns a map with event id as key
    and details object as value. If parameter set to true then method returns a list sorted by 'position' property of

    class's details object.

    • @param Boolean $isVisibleOnly
    • @param Boolean $asArray
    • @return Array
  • getProductList ($filter)

    Returns product list with filter.
    At this time filter can accept only service_id parameter

    • @param object $filter
    • @return array
  • deleteProduct ($id)

    Delete given product or products if it is possible, otherwise set it as inactive
    The $id param can be int or array of int

    • @param integer|array $id
    • @return bool
  • getBookingReport ()

    Get paginated data for Booking report

    The following filters can be provided in request param:
    Date date_from, date_to, created_date_from, created_date_to
    Integer unit_group_id, client_id
    String code, promo_code
    String booking_type = 'approved' | 'not_approved_yet' | 'cancelled_by_admin' | 'cancelled_by_client' | 'non_cancelled' | 'cancelled' | 'all'

    Order can be one of the following values: record_date, date_start, date_start_asc

    Return data in the following format:
    array(
    'data' => $data,
    'metadata' => array(
    'items_count'
    'pages_count'
    'page'
    'on_page'
    )
    or Api_Service_Exception in error case

    • @todo : implement order by end_date, record_date
    • @param Api
    • @return array
  • getClientReport ()

    Get paginated data for Client report

    The following filters can be provided in request param:
    Date date_from, date_to
    Integer event_id, unit_group_id, client_id
    String client_search (search string, can contains client name, address, phone)
    String service_using_type = 'used_in_period' | 'not_used_in_period' | 'not_used_in_period_but_used_before'

    No custom ordering implemented yet

    Group data = 'client' | 'client_email_phone' | 'client_email' | 'client_phone'


    Return data in the following format:
    array(
    'data' => $data,
    'metadata' => array(
    'items_count'
    'pages_count'
    'page'
    'on_page'
    )
    or Api_Service_Exception in error case

    • @todo : implement order by send_date, sms_count
    • @param Api
    • @return array
  • getSmsReport ()

    Get paginated data for SMS report

    The following filters can be provided in request param:
    Date date_from, date_to
    Integer unit_group_id, client_id
    String phone, message

    No custom ordering implemented yet (always ordered by client name)

    Return data in the following format:
    array(
    'data' => $data,
    'metadata' => array(
    'items_count'
    'pages_count'
    'page'
    'on_page'
    )
    or Api_Service_Exception in error case

    • @todo : implement order by date
    • @param Api
    • @return array
  • getPosReport ()

    Get paginated data for Pos report



    Return data in the following format:
    array(
    'data' => $data,
    'metadata' => array(
    'items_count'
    'pages_count'
    'page'
    'on_page'
    )
    or Api_Service_Exception in error case

    • @param Api
    • @return array
  • getFeedbackReport ()

    Get paginated data for Feedback report

    The following filters can be provided in request param:
    Date date_from, date_to
    Integer from 1 to 5 rate_from, rate_to
    String name, subject, message

    Report can be ordered by one of the following fields:
    date, rate, name, message, subject, answer

    Return data in the following format:
    array(
    'data' => $data,
    'metadata' => array(
    'items_count'
    'pages_count'
    'page'
    'on_page'
    )
    or Api_Service_Exception in error case

    • @param Api
    • @return array
  • getPromotionList ($isVisibleOnly, $asArray, $promotionType)

    Get detailed list of promotions (new)

    • @param bool $isVisibleOnly
    • @param bool $asArray
    • @param string $promotionType = 'discount' / 'gift_card' / null
    • @return array
  • getPromotionInstanceList ($promotionType, $asArray)

    Get all list of promotion instances

    • @param string $promotionType = 'gift_card' | 'discount'
    • @param bool $asArray
    • @return array
  • getPromotionDetails ($id)

    Return promotion detailed info

    • @param integer $id
    • @return array
  • getStaticPageList ()

    Get static page list

    • @return array
  • confirmInvoice ($id, $paymentSystem)

    Confirms invoice by id

    • @param integer $id
    • @param string $paymentSystem
    • @return array
    • @throws Api_Entity_Exception
  • applyPromoCode ($id, $code)

    Applies promo code to order (Coupons & Gift Cards custom feature)

    • @param integer $id
    • @param string $code
    • @return array
    • @throws Api_Entity_Exception
  • getCountByShedulerChannels ($startDate, $endDate)

    • @param string $startDate
    • @param string $endDate
    • @return array
  • getCompanyParam ($key)

    Returns company config value for key. A different set of keys available for public API and for company
    administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not

    allowed. See [[#Company_params|list of available keys]].

    • @param String $key
    • @return mixed
  • getCompanyParams ($keys)

    Returns company's config values for specified keys as key-value map. For non-existent and not-allowed param keys
    it will return '''false''' as result. A different set of keys available for public API and for company

    administration API. See [[#Company_params|list of available keys]].

    • @param Array $keys
    • @return Array
  • getTimelineType ()

    Returns company timeline type

    • @return String
  • getEventList ($isVisibleOnly, $asArray, $handleClasses, $searchString)

    Returns company's events list. If $asArray is false then method returns a map with event id as key
    and details object as value. If parameter set to true then method returns a list sorted by 'position' property of

    event's details object.

    • @param Boolean $isVisibleOnly
    • @param Boolean $asArray
    • @param integer $handleClasses 1 - classes only, -1 without classes, null - skip classes check
    • @param string $searchString part of name (used for comboboxes)
    • @return Array
  • getUnitList ($isVisibleOnly, $asArray, $handleClasses, $searchString)

    Returns list of service performers. If $asArray is false then method returns a map with event id as
    key and details object as value. If parameter set to true then method returns a list sorted by 'position' property

    of event's details object.

    • @param Boolean $isVisibleOnly
    • @param Boolean $asArray
    • @param integer $handleClasses 1 - classes only, -1 without classes, null - skip classes check
    • @param string $searchString part of name (used for comboboxes)
    • @return Array
  • calculateEndTime ($startDateTime, $eventId, $unitId, $productIds)

    Returns end datetime if booking is available, else return false

    • @param String $startDateTime a date and time string in format 'Y-m-d H:i:s', eg. '2001-10-02 13:30:00'.
    • @param Integer $eventId
    • @param Integer $unitId
    • @param array $productIds
    • @return String
  • getWorkCalendar ($year, $month, $data)

    Returns company work schedule as array
    Eg.: {'2014-05-01': {'from': '09:00:00', 'to': '21:00:00', 'is_day_off': '0'}, '2014-05-02': ...}

    • @param Integer $year
    • @param Integer $month
    • @param Integer|array $data pass unit_group_id as integer for old version or structure for new version like {unit_group_id: int, event_id: int}
    • @return Object
  • getReservedTime ($from, $to, $eventId, $unitId, $count)

    Returns map of objects for each day in specified date range. The key of the result mps is a date string. The value
    is an array of two objects. Both objects contains list of time slots for type reserved_time and type

    not_worked_time. reserved_time type represents time slots working time but already booked
    by clients. Nobody knows what kind of data represented by not_worked_time type. Please don't use it.

    If [[Plugins#Google calendar sync plugin|Google calendar sync plugin]] enabled then object with
    reserved_time type will contain not empty list of time slots marked as busy in Google calendar. Call
    [[#isPluginActivated|isPluginActivated('google_calendar_export')]] API method to check if Google
    calendar sync plugin activated.


    Example:


    {
    "2016-02-05": [
    {
    "dd": [], // time slots from Google calendar
    "events": [ // reserved time slots
    { "from": "16:00", "to": "16:30" },
    { "from": "16:30", "to": "17:00" },
    ... ],
    "type": "reserved_time",
    },
    {
    "events": [
    { "from": "09:00", "to": "09:30" },
    { "from": "09:30", "to": "10:00" },
    ... ],
    "type": "not_worked_time"
    }],
    ...
    }

    • @param String $from
    • @param String $to
    • @param Integer $eventId
    • @param Integer $unitId
    • @param Integer $count
    • @return Object
  • getWorkDaysInfo ($from, $to, $unitId, $eventId, $count, $productIds)

    Returns an information about working hours and break times for specified service and performer for a period
    between two dates. If only service specified then information about performer (or performers) will be taken from

    service configuration. Method returns a list of objects for each date in specified period. Count of objects in
    list depends on break times. For example if performer works from 9:00 till 19:00 with one hour break at 13:00 method
    returns:


    {'2014-05-14' : [
    {'from': '09:00:00', 'to': '13:00:00'},
    {'from': '14:00:00', 'to': '19:00:00'}
    ] }


    Warning! Method can return a time string '24:00:00' as right edge of time range. This happens in case if time
    range finishes on midnight.

    • @param String $from
    • @param String $to
    • @param Integer $unitId (optional)
    • @param Integer $eventId (optional)
    • @param Integer $count (optional)
    • @param array $productIds (optional)
    • @return array
  • getFirstWorkingDay ($data)

    Returns first working date for unit

    • @param Integer|array $data pass unit_group_id as integer for old version or structure for new version like {unit_group_id: int, event_id: int}
    • @return String
  • getStartTimeMatrix ($from, $to, $eventId, $unitId, $count, $bookingId, $productIds)

    Returns available start time, taking into account breaktimes, start and end working time
    Eg.: {'2014-05-14': ['09:00:00', ...], ...}


    If locations plugin activated for company you should pass a list as $unitID parameter for filter results with
    units available only for selected location. See [[Plugins#Unit_location|Unit location]] plugin description for
    more details.

    • @param String $from
    • @param String $to
    • @param Integer $eventId
    • @param Mixed $unitId can be Integer or Array of Integers
    • @param Integer $count
    • @param int $bookingId
    • @param array $productIds
    • @return array
  • getAvailableTimeIntervals ($dateFrom, $dateTo, $eventId, $unitId, $count)

    Returns available time intervals for all service providers for given period, taking into account breaktimes, start and end working time
    Eg.: {['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}

    • @param String $dateFrom
    • @param String $dateTo
    • @param Integer $eventId
    • @param Mixed $unitId can be Integer or Array of Integers
    • @param Integer $count
    • @return Object
  • getServiceAvailableTimeIntervals ($dateFrom, $dateTo, $eventId, $unitId, $count)

    Returns available time intervals for all servics for given period, taking into account breaktimes, start and end working time
    Eg.: {['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}

    • @param String $dateFrom
    • @param String $dateTo
    • @param Mixed $eventId can be Integer or Array of Integers
    • @param Integer $unitId
    • @param Integer $count
    • @return Object
  • getReservedTimeIntervals ($dateFrom, $dateTo, $eventId, $unitId, $count, $bookingId)

    Returns not available time
    Eg.: {'2014-05-14': [{'reserved_time': [{'from': '14:00', 'to': '16:30'}], 'type': "reserved_time"}, ...], ...}

    • @param String $dateFrom
    • @param String $dateTo
    • @param Integer $eventId
    • @param Integer|Array $unitId
    • @param Integer $count
    • @param int $bookingId
    • @return array
  • getAvailableUnits ($eventId, $dateTime, $count, $unitId, $productIds)

    Returns list of available unit ids for specified date and service or empty array if all units are not allowed.
    Eg.: [1, 2, 3]

    • @param Integer $eventId
    • @param String $dateTime a date and time string in format 'Y-m-d H:i:s'
    • @param int $count
    • @param int $unitId
    • @param array $productIds
    • @return array
    • @throws Exception
  • getAnyUnitData ()

    Returns information about [[Plugins#Any_Employee_selector|Any Employee selector plugin]] configuration. Returns
    null if plugin not enabled.


    Example:
    {
    "description" : "Select this option, if you want to find an available time with any of the employees",
    "hide_other_units" : 1, // 1 or 0
    "image" : null,
    "name" : "Any employee",
    "picture_path" : null,
    "random_selection" : 0 // 1 or 0
    }

    • @return Object
  • getAdditionalFields ($eventId)

    Return additional fields for certain event if [[Plugins#Additional_fields|Additional fields plugin]] is
    activated. Returns empty array otherwise. Call [[#isPluginActivated|isPluginActivated('event_field')]]

    API method to check if 'event_field' plugin activated.

    • @param Integer $eventId
    • @return Array
  • getTimeframe ()

    Returns company's timeframe configuration (in minutes). Timeframe can be either 5, 10, 15, 20, 30 or 60 minutes.
    You can find more details about timeframe [[Settings#Timeframe|here]].

    • @return Integer
  • isPluginActivated ($pluginName)

    Return plugin status true if status active, else false. $pluginName parameter is a plugin identifier.
    See [[Plugins|plugins]] page for full plugins description. See [[#Plugin's identifiers|list of available plugin's names]].

    • @param String $pluginName
    • @return Boolean
  • getPluginStatuses ($pluginNames)

    Return plugin status true if status active, else false. See [[#Plugin's identifiers|list of available plugin's names]].

    • @param Array $pluginNames
    • @return Array
  • getCompanyInfo ()

    Returns an object with detailed information about company. See [[#getCompanyInfo response|example of response]].

    • @return Object
  • createBatch ()

    Creates new booking batch record. Returns newly created batch id. You can use this id in [[#book|book]]
    API method.

    • @return Integer
  • getCountryPhoneCodes ()

    Returns country phone code list

    • @return Array
  • getPluginPromoInfoByCode ()

    Returns an object with detailed information about promotion by promotion code. You can get promotion code
    using [[Catalogue#getPromotionList|getPromotionList]] API method. If promotion record with specified

    code not found then method returns an empty array (an empty object). If [[Plugins#Simply Smart Promotions|Simply Smart Promotions plugin]]
    not enabled then method returns an error with code -32001 (Plugin is not activated). Use
    [[#isPluginActivated|isPluginActivated('promo')]] API method call to check if plugin enabled.


    See [[#getPromotionList response|example]] of getPromotionList API method response. Please note that
    response contains a list of services for wich promotion discount can be applied (service_ids key).

    • @param String
    • @return Array
  • getCompanyTimezoneOffset ()

    Returns company timezone offset and company timezone

    • @return array

Service URL  https://user-api.simplybook.me/catalog

  • getCompanyList ($filter, $from, $limit)

    Returns companies list

    $filter filter params. Object that contains following params


    'search_string': String,
    'service_name': String,
    'company_name': String,
    'company_address': String,
    'category_id': Integer,
    'tag_ids': [Integer, Integer, ...],
    'tags': String,
    'country_id': String,
    'city_id': String,
    'nearby': {
    'radius': Integer,
    'center': {
    'lat': Number,
    'lng': NUmber
    }
    }

    Use tag_ids OR tags

    • @param Object $filter filter object
    • @param Integer $from from position
    • @param Integer $limit rows limit
    • @return array
  • getPromotionList ($filter, $from, $limit)

    Returns active promotion list

    $filter filter params. Object that contains following params


    'search_string': String,
    'service_name': String,
    'company_name': String,
    'company_address': String,
    'tag_ids': [Integer, Integer, ...],
    'tags': String,
    'country_id': String,
    'city_id': String,
    'nearby': {
    'radius': Integer,
    'center': {
    'lat': Number,
    'lng': NUmber
    }
    }

    Use tag_ids OR tags

    • @param Object $filter filter object
    • @param Integer $from from position
    • @param Integer $limit rows limit
    • @return array
  • getPromotionListByIds ()

    Returns active promotion list

    • @param array
    • @return array
  • getCompanyCount ($filter)

    Returns total companies count with specified filter

    $filter filter params. Object that contains following params


    'search_string': String,
    'service_name': String,
    'company_name': String,
    'company_address': String,
    'tag_ids': [Integer, Integer, ...],
    'tags': String,
    'country_id': String,
    'city_id': String,
    'nearby': {
    'radius': Integer,
    'center': {
    'lat': Number,
    'lng': NUmber
    }
    }

    Use tag_ids OR tags

    • @param Object $filter filter object
    • @return array
  • getPromotionCount ($filter)

    Returns total active promotions count with specified filter

    $filter filter params. Object that contains following params


    'search_string': String,
    'service_name': String,
    'company_name': String,
    'company_address': String,
    'tag_ids': [Integer, Integer, ...],
    'tags': String,
    'country_id': String,
    'city_id': String,
    'nearby': {
    'radius': Integer,
    'center': {
    'lat': Number,
    'lng': NUmber
    }
    }

    Use tag_ids OR tags

    • @param Object $filter filter object
    • @return array
  • getTopCountries ()

    Returns country list as Array order by company count in country

    • @return Array [{'id': ..., 'country': ...., 'count': ....}, ...]
  • getTopCities ()

    Returns city list as Array order by company count in city

    • @return Array [{'id': ..., 'city': ...., 'country_id': ...., 'count': .....}, ....]
  • getCountries ()

    Returns a list of objects with just two properties each: id and country. An id
    is a two character string with ISO 3166-1 country code.

    • @return Array [{'id': ..., 'country': ...., 'count': ....}, ...]
  • getCities ($country, $withActiveCompany)

    Returns a list of objects. If $country parametr specified then method returns only cities of this
    country. Each object in list has 4 properties:


    * id - number. A unique identificator of city. You should use it as filter options in methods getCompanyList.
    * city - string. A city name.
    * count_id - string. Two chars ISO 3166-1 country code.
    * count - number.

    Example:


    [{
    "cnt" : 7,
    "country_id"" : "GB",
    "id" : 4607,
    "name" : "Uxbridge"
    },
    ...]

    • @param String $country Optional. A two character ISO 3166-1 country code.
    • @param bool $withActiveCompany
    • @return Array [{'id': ..., 'city': ...., 'country_id': ...., 'count': .....}, ....]
  • getTags ($filter)

    Returns tags list

    $filter filter params. Object that contains following params


    'tag_ids': [Integer, Integer, ...],
    'tags': String,
    'country_id': String,
    'city_id': String

    Use tag_ids OR tags

    • @param Object $filter filter object
    • @return Array [{'id': ..., 'tag': ...}, ....]
  • getCompanyInfo ($login)

    Returns company information by company login

    • @param String $login
    • @return Object
  • getPromotionInfo ($id, $feedbackFrom, $feedbackCount)

    Returns promotion information by id

    • @param Integer $id
    • @param Integer $feedbackFrom = 0
    • @param Integer $feedbackCount = 100
    • @return Object
  • getRelatedPromotions ($id, $count)

    Returns related promotions by given promotion id

    • @param Integer $id
    • @param Integer $count = 10
    • @return Array
  • getCompanyReviews ($login, $count, $offset)

    Returns a list of company's review objects.


    [{
    "company_id" : 86409,
    "domain" : "simplybook.me",
    "feedback_datetime" : "2015-10-27 13:06:57",
    "feedback_id" : 4623,
    "feedback_link" : "",
    "id" : 17384,
    "image" : "http://graph.facebook.com/1020443689023222/picture",
    "link" : "https://www.facebook.com/app_scoped_user_id/1020443689023222/",
    "message" : "Brilliant!",
    "name" : "Simply Booker",
    "provider" : "",
    "provider_data" : "...", // String. An object encoded with PHP's serialize method.
    "rate" : 5, // 0 to 5 rate
    "status" : "approved", // 'new' or 'approved'
    "subject" : "Good",
    "with_comment" : 1
    },
    ...]

    • @see http://php.net/serialize
    • @param String $login
    • @param Integer $count
    • @param Integer $offset
    • @return Object
  • getCompanyReviewsCount ($login)

    Returns company's reviews count

    • @param String $login
    • @return Integer
  • getCompanyReview ($login, $reviewId)

    Returns a company's review objects.

    • @param String $login
    • @param Integer $reviewId
    • @return Object
  • getClientReviewsLikes ($clientId, $clientProvider)

    Returns a list of company's review likes.

    • @param String $clientId
    • @param String $clientProvider
    • @return Object
  • addCompanyReview ($login, $subject, $message, $rate, $provider, $accessToken)

    Adds company review

    • @param String $login
    • @param String $subject
    • @param String $message
    • @param Integer $rate
    • @param String $provider
    • @param String $accessToken
    • @return Boolean
  • addPromotionReview ($promotionId, $subject, $message, $rate, $provider, $accessToken)

    Add promotion review

    • @param Integer $promotionId
    • @param String $subject
    • @param String $message
    • @param Integer $rate
    • @param String $provider
    • @param String $accessToken
    • @return Boolean
  • getPromotionReviews ($promotionId)

    Returns promotion reviews list

    • @param Integer $promotionId
    • @return Object
  • getRecentPromotions ($count)

    Returns list of promotions ordered by date DESC

    • @param Integer $count
    • @return Array
  • getRecentFeedbacks ($count)

    Returns list of feedbacs ordered by date DESC

    • @param Integer $count
    • @return Array
  • getRecentCompanies ($count)

    Returns list of companies ordered by date DESC

    • @param Integer $count
    • @return Array
  • getCategories ()

    Returns all categories as list of objects. Each category can have a subcategories. Each subcategory contains parent
    category id in company_category_id field. For top level categories this field is null and

    is_header field is true.


    Example:


    [{
    "company_category_id": null,
    "id": "1",
    "image": "/common/images/category_icons/car.png",
    "is_active": "1",
    "is_header": "1",
    "name": "Cars",
    },
    {
    "company_category_id": "1",
    "id" = 11;
    "image": null,
    "is_active": "1",
    "is_header": "0",
    "name": "Car wash",
    },
    ...]

    • @return Array
  • getFeedbackList ()

    Get list of ALL simplybook feedbacks

    • @return Array
  • getCompanyPromotionList ($promotionCompanyLogin, $count)

    Returns a list of promotions objects associated with specified company. If company doesn't have any promotions or
    [[Plugins#Simply_Smart_Promotions|Simply Smart Promotions plugin]] not active for this company method returns an

    empty list.

    • @param String $promotionCompanyLogin
    • @param Integer $count Optional. Maximum amount of objects in response. Default value is 100.
    • @return Array
  • getUserLocation ($ip)

    Returns user location info

    • @param String $ip optional
    • @return Object
  • getAutocompleete ($filter, )

    Returns suggestions for autocompeter

    $filter filter params. Object that contains following params


    'search_string': String,
    'service_name': String,
    'company_name': String,
    'company_address': String,
    'category_id': Integer,
    'tag_ids': [Integer, Integer, ...],
    'tags': String,
    'country_id': String,
    'city_id': String,
    'nearby': {
    'radius': Integer,
    'center': {
    'lat': Number,
    'lng': NUmber
    }
    }

    Use tag_ids OR tags

    • @param Object $filter filter object
    • @param Boolean
    • @return array
  • deleteClientFeedbacks ($gdprDataSerialized)

    Anonymize client feedbacks and feedback likes
    according to GDPR client's right to be forgotten

    • @param array $gdprDataSerialized
  • deleteClientPromotionFeedbacks ($gdprDataSerialized)

    Delete promotion_feedbak and promotion_feedback_response data
    according to GDPR client's right to be forgotten

    • @param array $gdprDataSerialized
    • @return mixed
    • @throws Gdpr_Exception

Methods

    Authentication

  • Authentication

    Authentication process. Return auth token info (TokenEntity)
    Accepts AdminLoginEntity data as body of request.
    Throws BadRequest error in case invalid data was provided with detailed errors per field.
    Endpoint:
    /admin/auth
    Method:
    POST
    Request parameters:
    AdminLoginEntity body - authentication data
    Return:
    Throws:
    AccessDenied
    BadRequest
    HTTP Request example:
    POST https://user-api-v2.simplybook.me/admin/auth
    Content-Type: application/json
    
    {
      "company": "<insert your company login>",
      "login": "<insert your user login>",
      "password": "<insert your user password>"
    }
  • Second factory authentication

    Second factory authentication process. Return auth token info (TokenEntity). Required in case 2FA authentication is enabled.
    Pass session from authentication step. In case you use SMS as 2fa provider you need to call /admin/auth/sms to receive SMS with code.
    Accepts AdminLogin2FAEntity data as body of request.
    Throws BadRequest error in case invalid data was provided with detailed errors per field.
    Throws AccessDenied error in case user does not have access to perform this action.
    Endpoint:
    /admin/auth/2fa
    Method:
    POST
    Request parameters:
    AdminLogin2FAEntity body - second factory authentication data
    Return:
    Throws:
    AccessDenied
    BadRequest
    HTTP Request example:
    POST https://user-api-v2.simplybook.me/admin/auth/2fa
    Content-Type: application/json
    
    {
      "company": "<insert your company login>",
      "session_id": "<insert session_id value from auth request>",
      "code": "<insert 2FA code>",
      "type": "<insert 2FA type (ga/sms)>"
    }
  • Get SMS code

    Send SMS to user phone number. Returns empty response.
    Throws BadRequest error in case invalid data was provided.
    Throws AccessDenied error in case user does not have access to perform this action.
    Endpoint:
    /admin/auth/sms
    Method:
    GET
    Request parameters:
    string company - company login
    string session_id - company login
    Throws:
    AccessDenied
    BadRequest
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/auth/sms?company=<insert your company login>&session_id=<insert session_id value from auth request>
    Content-Type: application/json
  • Renew token with refresh token

    Renew token with refresh token with refresh token, that was received on authentication step. Return TokenEntity.
    Accepts RefreshTokenEntity data as body of request.
    Throws BadRequest error in case invalid data was provided.
    Throws AccessDenied error in case user does not have access to perform this action.
    Endpoint:
    /admin/auth/refresh-token
    Method:
    POST
    Request parameters:
    RefreshTokenEntity body - refresh token data
    Throws:
    AccessDenied
    BadRequest
    HTTP Request example:
    POST https://user-api-v2.simplybook.me/admin/auth/refresh-token
    Content-Type: application/json
    
    {
      "company": "<insert your company login>",
      "refresh_token": "<insert refresh_token from auth step>"
    }
  • Logout and revoke token

    Revoke token that was received on authentication.
    Accepts AdminLogoutEntity data as body of request.
    Throws BadRequest error in case invalid data was provided.
    Throws AccessDenied error in case user does not have access to perform this action.
    Endpoint:
    /admin/auth/logout
    Method:
    POST
    Request parameters:
    AdminLogoutEntity body - logout data
    Throws:
    AccessDenied
    BadRequest
    HTTP Request example:
    POST https://user-api-v2.simplybook.me/admin/auth/logout
    Content-Type: application/json
    
    {
      "auth_token": "<insert your token from auth step>"
    }
  • Bookings

  • Make new booking

    Make new booking and return booking result (BookingResultEntity).
    Accepts AdminBookingBuildEntity data as body of request.
    Throws AccessDenied error in case user does not have access to booking.
    Throws BadRequest error in case invalid data was provided with detailed errors per field.
    Endpoint:
    /admin/bookings
    Method:
    POST
    Request parameters:
    AdminBookingBuildEntity body - booking data
    Throws:
    AccessDenied
    BadRequest
    HTTP Request example:
    POST https://user-api-v2.simplybook.me/admin/bookings
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
    
    {
      "count": 1,
      "start_datetime": "2020-12-02 09:30:00",
      "location_id": 2,
      "category_id": 2,
      "provider_id": 4,
      "service_id": 3,
      "client_id": 10,
      "additional_fields": [
        {
          "field": "e5a1d0e5312b9515874406a89c986765",
          "value": "test"
        },
        {
          "field": "3adae019f9183fcfb7b02fcef54b094d",
          "value": "Option 1"
        },
        {
          "field": "9c3ce1fc22bd50cbb21bdfcfd2f850bf",
          "value": "988"
        },
        {
          "field": "1a2e4bdc78b9fd4593d8924b25f38244",
          "value": "Select 2"
        }
      ]
    }
  • Edit booking

    Modify booking and return booking result (BookingResultEntity).
    Accepts AdminBookingBuildEntity data as body of request.
    Throws AccessDenied error in case user does not have access to booking.
    Throws BadRequest error in case invalid data was provided with detailed errors per field.
    Throws NotFound error in case booking is not found.
    Endpoint:
    /admin/bookings/{id}
    Method:
    PUT
    Request parameters:
    int id - booking id
    AdminBookingBuildEntity body - booking data
    Throws:
    AccessDenied
    BadRequest
    NotFound
    HTTP Request example:
    PUT https://user-api-v2.simplybook.me/admin/bookings/1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
    
    {
      "count": 1,
      "start_datetime": "2020-12-02 09:30:00",
      "location_id": 2,
      "category_id": 2,
      "provider_id": 4,
      "service_id": 3,
      "client_id": 10,
      "additional_fields": [
        {
          "field": "e5a1d0e5312b9515874406a89c986765",
          "value": "test"
        },
        {
          "field": "3adae019f9183fcfb7b02fcef54b094d",
          "value": "Option 1"
        },
        {
          "field": "9c3ce1fc22bd50cbb21bdfcfd2f850bf",
          "value": "988"
        },
        {
          "field": "1a2e4bdc78b9fd4593d8924b25f38244",
          "value": "Select 2"
        },
        {
          "field": "b90b2d238ffc2a7a782c6a81a8e60bb1",
          "value": "test"
        }
      ]
    }
  • Get booking details

    Return booking item entity by booking id. (AdminBookingDetailsEntity)
    Throws AccessDenied error in case user does not have access to booking.
    Throws NotFound error in case booking is not found.
    Endpoint:
    /admin/bookings/{id}
    Method:
    GET
    Request parameters:
    int id - booking id
    Throws:
    AccessDenied
    NotFound
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/bookings/1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Cancel booking

    Cancel booking by booking id and return booking that was canceled (AdminBookingDetailsEntity).
    Throws AccessDenied error in case user does not have access to booking.
    Throws NotFound error in case booking is not found.
    Endpoint:
    /admin/bookings/{id}
    Method:
    DELETE
    Request parameters:
    int id - booking id
    Throws:
    AccessDenied
    BadRequest
    HTTP Request example:
    DELETE https://user-api-v2.simplybook.me/admin/bookings/1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Approve booking with approve booking custom feature

    Approve booking by booking id and return booking details (AdminBookingDetailsEntity).
    Throws AccessDenied error in case user does not have access to booking.
    Throws BadRequest error in case booking can not be approved.
    Throws NotFound error in case booking is not found.
    Endpoint:
    /admin/bookings/{id}/approve
    Method:
    PUT
    Request parameters:
    int id - booking id
    Throws:
    AccessDenied
    BadRequest
    HTTP Request example:
    PUT https://user-api-v2.simplybook.me/admin/bookings/1/approve
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Apply status with status custom feature

    Apply booking status booking by booking id and return booking details (AdminBookingDetailsEntity).
    Throws AccessDenied error in case user does not have access to booking.
    Throws NotFound error in case booking is not found.
    Endpoint:
    /admin/bookings/{id}/status
    Method:
    PUT
    Request parameters:
    int id - booking id
    Throws:
    AccessDenied
    NotFound
    HTTP Request example:
    PUT https://user-api-v2.simplybook.me/admin/bookings/1/status
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
    
    {
      "status_id": 1
    }
  • Set comment for booking

    Set booking comment by booking id and return booking details (AdminBookingDetailsEntity).
    Throws AccessDenied error in case user does not have access to booking.
    Throws NotFound error in case booking is not found.
    Endpoint:
    /admin/bookings/{id}/comment
    Method:
    PUT
    Request parameters:
    int id - booking id
    Throws:
    AccessDenied
    NotFound
    HTTP Request example:
    PUT https://user-api-v2.simplybook.me/admin/bookings/1/comment
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
    
    {
      "comment": "This is booking comment."
    }
  • Get schedule

    Return array of day schedule info objects for selected service, provider and dates
    Endpoint:
    /admin/schedule
    Method:
    GET
    Request parameters:
    int service_id - selected service id
    int provider_id - selected provider id
    string date_from - date from
    string date_to - date to
    Return:
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/schedule?date_from=2020-08-25&date_to=2020-08-27&provider_id=2&service_id=1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get slots

    Return array of available slots to book as admin.
    It just returns schedule of day divided by slots.
    Endpoint:
    /admin/schedule/slots
    Method:
    GET
    Request parameters:
    int service_id - selected service id
    int provider_id - selected provider id
    string date - selected date
    Return:
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/schedule/slots?date=2020-08-28&provider_id=1&service_id=5
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get available slots

    Return array of available slots to book.
    Endpoint:
    /admin/schedule/available-slots
    Method:
    GET
    Request parameters:
    int service_id - selected service id
    int provider_id - selected provider id
    string date - selected date
    int count - group booking count
    array|int[] products - array of selected addons
    Return:
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/schedule/available-slots?date=2020-08-27&provider_id=1&service_id=5
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get first available slot

    Return first available slot for selected service/provider/date
    It can return slot for different date in case all slots are busy for selected date.
    Endpoint:
    /admin/schedule/first-available-slot
    Method:
    GET
    Request parameters:
    int service_id - selected service id
    int provider_id - selected provider id
    string date - selected date
    int count - group booking count
    Return:
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/schedule/first-available-slot?date=2020-08-30&provider_id=1&service_id=5
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get slots timeline

    Return data for slots timeline per date.
    Endpoint:
    /admin/timeline/slots
    Method:
    GET
    Request parameters:
    int service_id - selected service id
    int provider_id - selected provider id
    string date_from - date from
    int count - bookings count
    bool with_available_slots - to calculate available slots count (Display Remaining Spaces custom feature required)
    int booking_id - timeline for edit booking
    int[]|array product_ids - array of selected service addons ids
    bool skip_min_max_restriction - to skip min and max restriction
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/timeline/slots?date_from=2020-09-25&date_to=2020-09-25&provider_id=1&service_id=1&with_available_slots=1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get bookings list

    Return bookings list.
    Please note that result is wrapped into paginated result.
    Throws AccessDenied error in case user does not have access to bookings report.
    In GET parameters you can pass page, on_page and filter with following parameters:
    upcoming_only - return upcomming bookings only
    status - booking status (can be confirmed/confirmed_pending/pending/canceled)
    services - array of service ids to filter by services
    providers - array of provider ids to filter by providers
    client_id - client id. to filter by client id
    date - filter by date
    search - search string (by code, client data)
    Endpoint:
    /admin/bookings
    Method:
    GET
    Request parameters:
    int page - page in list
    int on_page - items per page
    object filter - filter object
    Return:
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/bookings?filter[upcomming_only]=1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get calendar data

    Return calendar data with bookings, notes and break times.
    Throws AccessDenied error in case user does not have access to bookings report.
    In GET parameters you can pass mode (day, week, provider or service) and filter with following parameters:
    upcoming_only - return upcomming bookings only
    status - booking status (can be confirmed/confirmed_pending/pending/canceled)
    services - array of service ids to filter by services
    providers - array of provider ids to filter by providers
    client_id - client id. to filter by client id
    date_from - filter by date from
    date_to - filter by date to
    search - search string (by code, client data)
    Endpoint:
    /admin/calendar
    Method:
    GET
    Request parameters:
    int page - page in list
    int on_page - items per page
    object filter - filter object
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/calendar?mode=provider&filter[status]=confirmed_pending&filter[date_from]=2020-08-26&filter[date_to]=2020-08-26
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Clients

  • Get clients list

    Return clients list.
    Please note that result is wrapped into paginated result.
    In GET parameters you can pass page, on_page and filter with following parameters:
    search - search string
    Endpoint:
    /admin/clients
    Method:
    GET
    Request parameters:
    int page - page in list
    int on_page - items per page
    object filter - filter object
    Return:
    array|ClientEntity[]
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/clients?page=1&on_page=10&filter[search]=al
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get client

    Return client item item by id.
    Throws AccessDenied error in case user does not have access to perform this action.
    Throws NotFound error in case client is not found.
    Endpoint:
    /admin/clients/{id}
    Method:
    GET
    Request parameters:
    int id - client id
    Return:
    Throws:
    AccessDenied
    NotFound
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/clients/1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Create client

    Create new client and return it.
    Throws AccessDenied error in case user does not have access to perform this action.
    Throws BadRequest error in case invalid data was provided with detailed errors per field.
    Throws NotFound error in case client is not found.
    Endpoint:
    /admin/clients
    Method:
    POST
    Request parameters:
    ClientEntity body - client data
    Return:
    Throws:
    AccessDenied
    BadRequest
    NotFound
    HTTP Request example:
    POST https://user-api-v2.simplybook.me/admin/clients
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
    
    {
      "name": "Mike",
      "email": "mikeemail@gmail.com",
      "phone": "+123456789987"
    }
  • Edit client

    Modify client by id and return it.
    Throws AccessDenied error in case user does not have access to perform this action.
    Throws BadRequest error in case invalid data was provided with detailed errors per field.
    Throws NotFound error in case client is not found.
    Endpoint:
    /admin/clients/{id}
    Method:
    PUT
    Request parameters:
    ClientEntity body - client data
    int id - client id
    Return:
    Throws:
    AccessDenied
    BadRequest
    NotFound
    HTTP Request example:
    PUT https://user-api-v2.simplybook.me/admin/clients/1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
    
    {
      "name": "Mike",
      "email": "mikeemail@gmail.com",
      "phone": "+123456789987"
    }
  • Delete client

    Delete client by id. Return empty response
    Throws AccessDenied error in case user does not have access to perform this action.
    Throws NotFound error in case booking is not found.
    Endpoint:
    /admin/clients/{id}
    Method:
    DELETE
    Request parameters:
    int id - client id
    Throws:
    AccessDenied
    NotFound
    HTTP Request example:
    DELETE https://user-api-v2.simplybook.me/admin/clients/1000
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get client memberships list

    Return client membership list.
    Please note that result is wrapped into paginated result.
    In GET parameters you can pass page, on_page and filter with following parameters:
    client_id - client id
    service_id - service id
    service_start_date - booking start date (to filter actual memberships only)
    count - group bookings count
    active_only - active memberships only
    search - search string
    Endpoint:
    /admin/clients/memberships
    Method:
    GET
    Request parameters:
    int page - page in list
    int on_page - items per page
    object filter - filter object
    Return:
    array|AdminClientMembershipPaymentEntity[]
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/clients/memberships?page=1&on_page=10&filter[client_id]=78&filter[service_id]=8&filter[service_start_date]=2020-08-20
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get client fields list

    Returns client fields list, including name, email, phone and address fields.
    Endpoint:
    /admin/clients/fields
    Method:
    GET
    Return:
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/clients/fields
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get client fields values

    Returns client fields values list, including name, email, phone and address fields.
    Throws AccessDenied error in case user does not have access to perform this action.
    Throws NotFound error in case client is not found.
    Endpoint:
    /admin/clients/field-values/{id}
    Method:
    GET
    Request parameters:
    int id - client id
    Throws:
    AccessDenied
    NotFound
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/clients/fields
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Edit client with fields

    Modify client data from fields list.
    Returns client fields list, including name, email and phone field.
    Throws AccessDenied error in case user does not have access to perform this action.
    Throws NotFound error in case client is not found.
    Throws BadRequest error in case invalid data was provided with detailed errors per field.
    Endpoint:
    /admin/clients/field-values/{id}
    Method:
    PUT
    Request parameters:
    int id - client id
    Client_DetailsEntity body - client data
    Throws:
    AccessDenied
    BadRequest
    NotFound
    HTTP Request example:
    PUT https://user-api-v2.simplybook.me/admin/clients/field-values/7
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
    
    {
      "id": 7,
      "fields":
      [
        {
          "id": "name",
          "value": "test"
        },
        {
          "id": "email",
          "value": "test@gmail.com"
        },
        {
          "id": "phone",
          "value": "38099999999999"
        },
        {
          "id": "de3b235b9e42131c9a86b5449acca9dd",
          "value": 12
        }
      ]
    }
  • Make client with fields

    Makes new client from fields list.
    Returns client fields list, including name, email and phone field.
    Throws AccessDenied error in case user does not have access to perform this action.
    Throws BadRequest error in case invalid data was provided with detailed errors per field.
    Endpoint:
    /admin/clients/field-values
    Method:
    POST
    Request parameters:
    Client_DetailsEntity body - client data
    Throws:
    BadRequest
    AccessDenied
    HTTP Request example:
    POST https://user-api-v2.simplybook.me/admin/clients/field-values
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
    
    {
      "id": null,
      "fields":
      [
        {
          "id": "name",
          "value": "test"
        },
        {
          "id": "email",
          "value": "test@gmail.com"
        },
        {
          "id": "phone",
          "value": "38099999999999"
        },
        {
          "id": "de3b235b9e42131c9a86b5449acca9dd",
          "value": 12
        }
      ]
    }
  • Services

  • Get services list

    Return services list.
    Please note that result is wrapped into paginated result.
    In GET parameters you can pass filter (see http example) with following parameters:
    search - search string
    Endpoint:
    /admin/services
    Method:
    GET
    Request parameters:
    object filter - filter object
    Return:
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/services?filter[search]=massage
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get service

    Return service item by id.
    Throws AccessDenied error in case user does not have access to service.
    Throws NotFound error in case service is not found.
    Endpoint:
    /admin/services/{id}
    Method:
    GET
    Request parameters:
    int id - service id
    Return:
    Throws:
    AccessDenied
    NotFound
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/services/1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get products for service

    Return list of products with default qty for selected service
    In GET parameters you can pass filter (see http example) with following parameters:
    service_id - service id
    type - type. can be 'product'/'attribute'
    Endpoint:
    /admin/services/products
    Method:
    GET
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/services/products?filter[service_id]=1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get service categories list

    Return list of categories. (categories custom feature)
    Please note that result is wrapped into paginated result.
    Endpoint:
    /admin/categories
    Method:
    GET
    Return:
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/categories
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Providers

  • Get providers list

    Return providers list.
    Please note that result is wrapped into paginated result.
    In GET parameters you can pass filter (see http example) with following parameters:
    search - search string
    service_id - filter providers by service (only providers that can provide this service)
    Endpoint:
    /admin/providers
    Method:
    GET
    Request parameters:
    object filter - filter object
    Return:
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/providers?filter[search]=mike&filter[service_id]=1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get provider

    Return provider item by id.
    Throws AccessDenied error in case user does not have access to provider.
    Throws NotFound error in case provider is not found.
    Endpoint:
    /admin/providers/{id}
    Method:
    GET
    Request parameters:
    int id - provider id
    Return:
    Throws:
    AccessDenied
    NotFound
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/providers/1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get provider locations list

    Return list of locations. (locations custom feature)
    Please note that result is wrapped into paginated result.
    Endpoint:
    /admin/locations
    Method:
    GET
    Return:
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/locations
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Intake forms

  • Get additional fields list

    Return intake forms fields. (intake forms custom feature)
    Please note that result is wrapped into paginated result.
    In GET parameters you can pass filter (see http example) with following parameters:
    service_id - return fields for this service
    Endpoint:
    /admin/additional-fields
    Method:
    GET
    Request parameters:
    object filter - filter object
    Return:
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/additional-fields?filter[service_id]=1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Products/Service addons

  • Get products/attributes list

    Return products/attributes list. (products/service addons custom features)
    Please note that result is wrapped into paginated result.
    In GET parameters you can pass filter (see http example) with following parameters:
    service_id - return products/attributes for selected service
    search - search string
    type - product type. can be 'product' or 'attribute'
    visible_only - visible products only
    Endpoint:
    /admin/products
    Method:
    GET
    Request parameters:
    object filter - filter object
    Return:
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/products?filter[search]=cofee&filter[service_id]=1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get product/attribute item

    Return product/attribute item by id.
    Endpoint:
    /admin/products/{id}
    Method:
    GET
    Return:
    Throws:
    AccessDenied
    NotFound
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/products/1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Status

  • Get statuses list

    Return user statuses list (status custom feature)
    Endpoint:
    /admin/statuses
    Method:
    GET
    Return:
    array|StatusEntity[]
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/statuses
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Notes and block time

  • Get notes list

    Return notes list.
    Please note that result is wrapped into paginated result.
    In GET parameters you can pass page, on_page and filter with following parameters:
    providers - filter by providers. array of providers ids
    services - filter by services. array of services ids
    types - filter by note types. array of types ids
    search - search string
    date_from - date from
    date_to - date to
    Endpoint:
    /admin/calendar-notes
    Method:
    GET
    Request parameters:
    int page - page in list
    int on_page - items per page
    object filter - filter object
    Return:
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/calendar-notes?page=1&filter[services][]=1&filter[services][]=2&filter[date_from]=2020-08-01&filter[date_to]=2020-08-10
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get note details

    Return note details by id
    Throws AccessDenied error in case user does not have access to the calendar note.
    Throws NotFound error in case the calendar note is not found.
    Endpoint:
    /admin/calendar-notes/{id}
    Method:
    GET
    Request parameters:
    int id - calendar note id
    Throws:
    AccessDenied
    NotFound
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/calendar-notes/1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Create new note

    Create new note and return it.
    Throws AccessDenied error in case user does not have access to the calendar note.
    Throws NotFound error in case the calendar note is not found.
    Throws BadRequest error in case invalid data was provided with detailed errors per field.
    Endpoint:
    /admin/calendar-notes
    Method:
    POST
    Request parameters:
    CalendarNoteEntity body - calendar note
    Throws:
    AccessDenied
    NotFound
    BadRequest
    HTTP Request example:
    POST https://user-api-v2.simplybook.me/admin/calendar-notes
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
    
    {
      "provider_id": 1,
      "service_id": null,
      "start_date_time": "2020-09-06 15:00:00",
      "end_date_time": "2020-09-06 15:30:00",
      "note_type_id": "1",
      "note": "note body",
      "mode": "provider",
      "time_blocked": true
    }
    
  • Modify note

    Edit note and return it.
    Throws AccessDenied error in case user does not have access to the calendar note.
    Throws NotFound error in case the calendar note is not found.
    Throws BadRequest error in case invalid data was provided with detailed errors per field.
    Endpoint:
    /admin/calendar-notes/{id}
    Method:
    POST
    Request parameters:
    int id - calendar note id
    CalendarNoteEntity body - calendar note
    Throws:
    AccessDenied
    NotFound
    BadRequest
    HTTP Request example:
    PUT https://user-api-v2.simplybook.me/admin/calendar-notes/1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
    
    {
      "provider_id": 2,
      "service_id": null,
      "start_date_time": "2020-09-06 15:00:00",
      "end_date_time": "2020-09-06 15:30:00",
      "note_type_id": "1",
      "note": "note body",
      "mode": "provider",
      "time_blocked": true
    }
    
  • Delete calendar note

    Delete calendar note by id. Return empty response
    Throws AccessDenied error in case user does not have access to booking.
    Throws NotFound error in case booking is not found.
    Endpoint:
    /admin/calendar-notes/{id}
    Method:
    DELETE
    Request parameters:
    int id - calendar note id
    Throws:
    AccessDenied
    NotFound
    HTTP Request example:
    DELETE https://user-api-v2.simplybook.me/admin/calendar-notes/1
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get note types list

    Return array of not types
    Endpoint:
    /admin/calendar-notes/types
    Method:
    GET
    Return:
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/calendar-notes/types
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get default note type

    Return default note type object
    Endpoint:
    /admin/calendar-notes/types/default
    Method:
    GET
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/calendar-notes/types/default
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Payments

  • Get orders/invoices list

    Return orders and invoices list.
    Note that not all data can be presented in list result. To get full info you need to get separate item.
    Please note that result is wrapped into paginated result.
    In GET parameters you can pass page, on_page and filter with following parameters:
    client_id - client id
    datetime_from - order/invoice date and time from
    datetime_to - order/invoice date and time to
    status - order/invoice status
    booking_code - filter by booking code
    Endpoint:
    /admin/invoices
    Method:
    GET
    Request parameters:
    int page - page in list
    int on_page - items per page
    object filter - filter object
    Return:
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/invoices?filter[booking_code]=0z2ohjmy
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Get order/invoice item

    Return order/invoice item by id
    Endpoint:
    /admin/invoices/{id}
    Method:
    GET
    Request parameters:
    int id - invoice/order id
    Throws:
    AccessDenied
    NotFound
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/invoices/34
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Accept payment

    Manual accept payment. The order will be marked as payed with provided payment processor.
    You can pass payment_processor as GET parameter and in body of request.
    Throws AccessDenied error in case user does not have access to order.
    Throws BadRequest error in case invalid data was provided with detailed errors.
    Throws NotFound error in case order/invoice is not found.
    Endpoint:
    /admin/invoices/{id}/accept-payment
    Method:
    PUT
    Request parameters:
    int id - order id
    string payment_processor - payment processor
    Throws:
    AccessDenied
    BadRequest
    NotFound
    HTTP Request example:
    PUT https://user-api-v2.simplybook.me/admin/invoices/1/accept-payment
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
    
    {
      "payment_processor": "manual"
    }
  • Apply promo code

    Apply promo code. Coupons & Gift Cards custom feature.
    You can apply promo code only to pending and new orders.
    You can pass code as GET parameter and in body of request.
    Throws AccessDenied error in case user does not have access to order.
    Throws BadRequest error in case invalid data was provided with detailed errors.
    Throws NotFound error in case order/invoice is not found.
    Endpoint:
    /admin/invoices/{id}/apply-promo-code
    Method:
    PUT
    Request parameters:
    int id - order id
    string code - promo code
    Throws:
    AccessDenied
    BadRequest
    NotFound
    HTTP Request example:
    PUT https://user-api-v2.simplybook.me/admin/invoices/1/apply-promo-code
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
    
    {
      "code": "mycode123"
    }
  • Tickets

  • Get ticket info by code

    Return ticket info by code.
    Throws AccessDenied error in case user does not have access to ticket.
    Throws NotFound error in case ticket is not found.
    Endpoint:
    /admin/tickets/{code}
    Method:
    GET
    Request parameters:
    string code - ticket code
    Throws:
    AccessDenied
    NotFound
    HTTP Request example:
    GET https://user-api-v2.simplybook.me/admin/tickets/0z2ph7e716b88
    Content-Type: application/json
    X-Company-Login: <insert your company login>
    X-Token: <insert your token from auth step>
  • Check in ticket

    Check in ticket by code and return the ticket info.
    Please note that the reason of unavailable check in will be in ticket object.
    Throws AccessDenied error in case user does not have access to ticket.
    Throws NotFound error in case ticket is not found.
    Endpoint:
    /admin/tickets/{code}/check-in
    Method:
    PUT
    Request parameters:
    string code - ticket code
    Throws:
    AccessDenied
    NotFound

    Types

  • AdminLoginEntity

    Entity that contains admin login information (input only)
    Name Type Description
    company string Company name
    login string User login
    password string User password
  • AdminLogin2FAEntity

    Entity that contains admin login information for 2 FA (input only)
    Name Type Description
    company string Company name
  • AdminLogoutEntity

    Entity that contains logout info
    Name Type Description
    auth_token string Auth token
  • TokenEntity

    Entity that contains token information
    Name Type Description
    token string Auth token
    company string Company login
    login string User login
    refresh_token string|null Refresh token (use it to get new access token when old expired)
    domain string|null Company domain
    require2fa bool Required two factor authorisation (token and refresh will be empty)
    allowed2fa_providers array|string[] Allowed providers (sms/ga)
    auth_session_id string Authentication session id (pass it with 2FA request)
  • RefreshTokenEntity

    Entity that contains refresh token information
    Name Type Description
    company string Company login
    refresh_token string Refresh token
    device_token string|null Device token
  • AdminBookingBuildEntity

    Entity that contains information to make booking from admin side
    Name Type Description
    start_datetime string Booking start datetime
    end_datetime string Booking end datetime
    location_id int Location id
    category_id int Category id
    service_id int Service id
    provider_id int Provider id
    client_id int Client id
    count int Group booking count. You can use either count or recurringSettings
    recurring_settings Booking_RecurringSettingsEntity Recurring settings. You can use either count or recurringSettings
    additional_fields array|Booking_AdditionalFieldValueEntity[] Array of additional fields values. Booking_AdditionalFieldValueEntity[]
    products array|ProductQtyEntity[] Array of products (addons). ProductQtyEntity[]
    client_membership_id int Client membership instance id.
    skip_membership bool Do not use membership for this booking
    user_status_id int Users status id
    accept_payment bool Set true to make payment order for booking
    payment_processor string|null Payment accepted by payment processor
  • BookingResultEntity

    Entity that contains booking result information.
    Readonly entity
    Name Type Description
    bookings array|BookingEntity[] Array of bookings, that were booked.
    batch BookingBatchEntity|null Booking batch
  • BookingEntity

    Entity that contains booking information
    Name Type Description
    id int Booking id. Auto-generated value.
    code string Booking code. Auto-generated value.
    is_confirmed bool Booking is confirmed
    start_datetime string Booking start datetime
    end_datetime string Booking end datetime
    location_id int Location id
    category_id int Category id
    service_id int Service id
    provider_id int Provider id
    client_id int Client id
    duration int Duration in minutes
  • BookingBatchEntity

    Entity that contains booking batch information
    Name Type Description
    id int Batch id. Auto-generated value.
    type string Batch type. Can be 'recurring', 'multiple', 'group'.
    is_closed bool Flag that indicates that user has finished booking.
  • Booking_RecurringSettingsEntity

    Entity that contains booking recurring information.
    Name Type Description
    days int Repeat days. Use each $days day for 'fixed' type and mask of week days for 'weekly' type.
    repeat_count int Repeat count
    type string Type of repeat. Can be 'fixed', 'weekly'
    'weekly' means repeat every week day, that set in $days mask.
    'fixed' means repeat every $days day.
    mode string Mode when it is impossible to book appointment on some date. Can be: 'skip', 'book_available', 'book_and_move'.
    'skip' - Skip all bookings
    'book_available' - book only on available dates
    'book_and_move' - move to next date in case some date is not available
  • Booking_AdditionalFieldValueEntity

    Entity that contains additional field value
    Name Type Description
    id int Additional field id
    field string Additional field name.
    value mixed Additional field value
  • ProductQtyEntity

    Entity that contains product qty information
    Name Type Description
    product_id int Product id
    qty int Product qty
  • AdminBookingDetailsEntity

    Detailed booking info. allowed only for admin API.
    Name Type Description
    id int Booking id. Auto-generated value.
    code string Booking code. Auto-generated value.
    is_confirmed bool Booking is confirmed
    start_datetime string Booking start datetime
    end_datetime string Booking end datetime
    location_id int|null Provider location id
    category_id int|null Service category id
    service_id int Service id
    provider_id int Provider id
    client_id int Client id
    duration int Duration in minutes
    provider ProviderEntity Booking provider details entity
    service ServiceEntity Booking service details entity
    client ClientEntity Client details entity
    status string Booking status - confirmed/pending/canceled (depending on approve booking status and accept payment)
    membership_id int|null Client membership id
    invoice_id int|null Invoice id
    invoice_status string|null Booking payment status ('deleted', 'new', 'pending', 'cancelled', 'cancelled_by_timeout', 'error', 'paid')
    invoice_payment_received bool|null Payment was received
    invoice_number string|null Invoice number
    invoice_datetime string|null Invoice datetime
    invoice_payment_processor string|null Payment processor key
    ticket_code string|null Booking ticket code
    ticket_validation_datetime string|null Booking ticket validation date and time
    ticket_is_used bool|null Ticket was already validated
    user_status_id int|null Status custom feature id
    category CategoryEntity|null Service category entity
    location LocationEntity|null Provider location entity
    can_be_edited bool Can this booking be edited by user
    can_be_canceled bool Can this booking be canceled by user
    log array|Booking_LogEntity[] Booking edit log
    additional_fields array|Booking_AdditionalFieldValueEntity[] Booking intake form details
    products array|Booking_DetailedProductQtyEntity[] Booking detailed products list
    attributes array|Booking_DetailedProductQtyEntity[] Booking detailed attributes list
    invoice AdminInvoiceEntity|null Invoice entity
    membership ClientMembershipPaymentEntity|null Client membership object
    user_status StatusEntity|null User status entity
    comment string Booking comment
    resources array|ResourceEntity[] Booking resources list
  • AdminReportBookingEntity

    Admin booking list info entity
    Class AdminReportBookingEntity
    Name Type Description
    id int Booking id. Auto-generated value.
    code string Booking code. Auto-generated value.
    is_confirmed bool Booking is confirmed
    start_datetime string Booking start datetime
    end_datetime string Booking end datetime
    location_id int|null Provider location id
    category_id int|null Service category id
    service_id int Service id
    provider_id int Provider id
    client_id int Client id
    duration int Duration in minutes
    provider ProviderEntity Booking provider details entity
    service ServiceEntity Booking service details entity
    client ClientEntity Client details entity
    status string Booking status - confirmed/pending/canceled (depending on approve booking status and accept payment)
    membership_id int|null Client membership id
    invoice_id int|null Invoice id
    invoice_status string|null Booking payment status ('deleted', 'new', 'pending', 'cancelled', 'cancelled_by_timeout', 'error', 'paid')
    invoice_payment_received bool|null Payment was received
    invoice_number string|null Invoice number
    invoice_datetime string|null Invoice datetime
    invoice_payment_processor string|null Payment processor key
    ticket_code string|null Booking ticket code
    ticket_validation_datetime string|null Booking ticket validation date and time
    ticket_is_used bool|null Ticket was already validated
    user_status_id int|null Status custom feature id
    category CategoryEntity|null Service category entity
    location LocationEntity|null Provider location entity
    can_be_edited bool Can this booking be edited by user
    can_be_canceled bool Can this booking be canceled by user
  • Booking_DetailedProductQtyEntity

    Booking product details info. Read only object
    Name Type Description
    product_id int Product id
    qty int Product qty
    product ProductEntity Product entity
  • Booking_LogEntity

    Entity that contains booking log information. Readonly object
    Name Type Description
  • WorkDayEntity

    Entity that contains work day information
    Name Type Description
    date string Work day date
    time_from string Work day time from
    time_to string Work day time to
    is_day_off bool Is day off
  • TimeSlotEntity

    Entity that contains time slot information
    Name Type Description
    date string Time slot date
    time string Time slot time
  • Timeline_SlotsDateEntity

    Entity for daily timeline
    Name Type Description
    date string Date
    slots Timeline_SlotEntity[] Slots
  • Timeline_SlotEntity

    Entity for daily timeline slot
    Name Type Description
    time string Time
    available_count int Available slots count
    total_count int Total slots count
  • LocationEntity

    Entity that contains location information
    Name Type Description
    id int Location id. Auto-generated value.
    name string Location name
    providers array|int[] Location providers (list of ids)
    address1 string|null Location address 1
    address2 string|null Location address 2
    city string|null Location city
    zip string|null Location zip code
    country_id string|null Location country id
  • CategoryEntity

    Entity that contains event category information
    Name Type Description
    id int Category id. Auto-generated value.
    name string Category name
    services array|int[] Category services (list of ids)
  • ProviderEntity

    Entity that contains provider information
    Name Type Description
    id int Provider id. Auto-generated value.
    name string Provider name
    qty int Provider capacity
    email string Provider email
    phone string Provider phone
    picture string Picture file name
    picture_preview string Path to preview picture
    color string Provider color
    is_active bool If provider is active
  • ServiceEntity

    Entity that contains service information
    Name Type Description
    id int Service id. Auto-generated value.
    name string Service name
    description string Promotion description
    price float Service price
    currency string Service price currency
    tax_id int Tax id
    tax TaxEntity Tax information
    duration int Duration in minutes
    buffer_time_after int Buffer time after in minutes
    recurring_settings Booking_RecurringSettingsEntity|null Service recurring settings (in case it is recurring service)
    memberships array|int[] Array of ids of memberships where this service presents.
    picture string Picture file name
    picture_preview string Path to preview picture
    is_active bool If service is active
  • Service_ProductEntity

    Product information for service (with default qty info)
    Name Type Description
    product ProductEntity Product
    qty int Qty
  • StatusEntity

    User status entity
    Name Type Description
    id int Status id. Auto-generated value.
    name string Status name.
    description string Status description.
    color string Status color
    is_default bool Is status default
  • ResourceEntity

    Resource info
    Name Type Description
    id int Resource id
    name string Resource name
  • ClientEntity

    Entity that contains client information
    Name Type Description
    id int Client id. Auto-generated value.
    name string Client name
    email string Client email
    phone string Client phone
  • Client_FieldDetailsEntity

    Client field details info
    Name Type Description
    id string Field id
    title string Field title
    default_value mixed Default field value
    values array|Client_FieldSelectOptionEntity[] Array of available values for select field
    is_visible bool Field is visible on public site
    is_optional bool Field is optional
    type string Field type
  • Client_DetailsEntity

    Client data each field value is in separate [[Client_FieldValueEntity]] object.
    Name Type Description
    id int Id of client
    fields array|Client_FieldValueEntity[] Array of fields with values
  • Client_FieldSelectOptionEntity

    Option data for select client field
    Name Type Description
    value string Option value
    is_default bool Is default value
    position int Position
  • Client_FieldValueEntity

    Client field value object
    Name Type Description
    id string Field id
    field Client_FieldDetailsEntity Field object. Read only (you do not need to pass it on save)
    value mixed Field value
  • UserEntity

    Entity that contains user information.
    This entity will be returned only by admin API
    Name Type Description
    id int User id. Auto-generated value.
    login string User login
    firstname string User first name
    lastname string User last name
    email string User email
    phone string User phone
    company CompanyEntity User company
  • CompanyEntity

    Entity that contains company information.
    This entity will be returned only by admin API
    Name Type Description
    login string Company login
    name string Company name
    dashboard_url string Dashboard company url
    public_url string Public company url
  • AdditionalFieldEntity

    Intake forms field information
    Name Type Description
    id int Field id
    name string Unique field name
    field_name string Field label
    field_type string Field type
    field_options array Field options
    default_value mixed Default field value
    optional bool Is optional field
    is_visible bool Is visible on public site
    show_for_all_services bool Show field for all services
  • ProductEntity

    Entity that contains product information
    Name Type Description
    id int Product id. Auto-generated value.
    name string Product name
    barcode string Product barcode
    description string Product description