Online Booking

Get Services Available for Booking

The object of services available for booking has the following fields:

Field	Type	Description
categories	array of objects	Array of service categories (you can't book a category)
services	array of objects	Services available for booking by category

An object from the categories array, has the following fields:

Field	Type	Description
id	number	Category ID
title	string	Category name
gender	number	Category belonging to gender (1 - male, 2 - female, 0 - not specified)
weight	number	Category weight. Categories are sorted by weight, heavier ones first
api_id	string	External Category ID

An object from the services array, has the following fields:

Field	Type	Description
id	number	Service ID
title	string	Service name
category_id	number	Identifier of the category to which the service belongs
weight	number	Category weight. Services are sorted by weight, heavier ones first
price_min	number	The minimum cost of the service
price_max	number	Maximum cost of the service
discount	number	Service discount
comment	string	Comment on the service
active	number	Is the service active
prepaid	string	Online payment status
gender	number	Gender for which the service is provided
session_length	number	Service duration in seconds (only if filter by team member is set)
image	string	Image services

If you need to get the services provided by a specific team member, then you need to use the filter by team member. The following filters are available:

staff_id: team member ID. If you need services that only the selected team member provides
datetime: date (in iso8601 format). Specifies the desired appointment date. Use this parameter to retrieve services that can be booked with the selected team member on that specific date.
service_ids: An array of service IDs. If a team member is already selected and the time and service(s) are part of an existing appointment, this parameter should be used to select an additional service.

get/book_services/{location_id}

Path parameters

location_idnumber required

location ID

Query parameters

staff_idnumber

team member ID. Filter by team member ID Default: 0

datetimestring

date (in iso8601 format). Filter by service booking date (for example '2005-09-09T18:30') Default: ''

service_ids[]number[]

Service ID. Filter by the list of identifiers of already selected (within one appointment) services. It makes sense if a filter by team member and date is set.

Headers

Acceptstring required

e.g. application/vnd.api.v2+json

Content-Typestring required

application/json

Authorizationstring required

Bearer partner_token

Response

successboolean

Success status (true)

metaobject[]

Metadata (empty array)

Example response

{
  "success": true,
  "data": {
    "events": [],
    "services": [
      {
        "id": 1896208,
        "title": "hair wash",
        "category_id": 1895571,
        "price_min": 0,
        "price_max": 0,
        "discount": 0,
        "comment": "",
        "weight": 0,
        "active": 0,
        "gender": 0,
        "image": "",
        "prepaid": "forbidden",
        "seance_length": 3600
      },
      {
        "id": 1896303,
        "title": "Coloring",
        "category_id": 1895574,
        "price_min": 0,
        "price_max": 0,
        "discount": 0,
        "comment": "",
        "weight": 0,
        "active": 0,
        "gender": 0,
        "image": "",
        "prepaid": "forbidden",
        "seance_length": 3600
      }
    ],
    "category": [
      {
        "id": 1895571,
        "title": "Hair care",
        "gender": 0,
        "api_id": "0",
        "weight": 60
      },
      {
        "id": 1895574,
        "title": "Hair coloring",
        "gender": 0,
        "api_id": "0",
        "weight": 7
      }
    ]
  },
  "meta": []
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.