This API helps you to retrieve all the services that are active in a center.
You must specify the appropriate details for the center_id
paramter in the API request.
You can also use the expand
parameter in the API request to specify details for the additional_info
, catalog_info
, category_id
, variants_info
, add_ons_info
, and image_paths
parameters. The category_id
parameter enables you to filter services according to their respective category or sub-category.
In addition, you can leverage the pagination feature by passing page
and size
query parameters if you have a large number of records. By default, page
is set as 1 and size
is set as 10. Size cannot be more than 100: which means that the maximum records per page cannot be more than 100.
Response Details
Name | Type | Description |
---|---|---|
id | guid | Unique 32-character identifier of the service. |
code | string | Code name of the service. |
name | string | Name of the service. |
description | string | Description of the service. |
duration | int | Ideal duration (in minutes) of the service. |
recovery_time | int | Recovery time (in minutes) required after the service has been completed. |
price_info | object | Object that contains price information-related elements of the service. For more information, refer to the price_info Object table. |
additional_info | object | Object that contains additional details about the service. For more information, refer to the additional_info Object table. |
catalog_info | object | Object that contains catalog information-related elements of the service. For more information, refer to the catalog_info Object table. |
variants_info | object | Object that contains variants information-related elements of the service. For more information, refer to the variants_info Object table. |
add_ons_info | object | Object that contains add-ons information-related elements of the service. For more information, refer to the add_ons_info Object table. |
image_paths | string? | Navigation path of the image used to illustrate the service. |
parallel_service_groups | object | Object that contains the id of the parallel service group. |
prerequisites_info | object | Object contains the prerequisite services that are available in the center. |
finishing_services_info | object | Object that contains information about the finishing services of the center. |
error | object | Object that contains error message and error code details. For more information, refer to the error Object table. |
price_info Object
Name | Type | Description |
---|---|---|
currency_id | int | Identifier of the currency used to pay for the service. |
sale_price | decimal | Sale price amount of the service. |
tax_id | guid | Unique 32-character identifier of the center's tax ID. |
ssg | decimal | Service charge amount paid for the service. |
include_tax | boolean | If true, it indicates that tax is to be included as part of the service's sale_price . |
demand_group_id | string | Demand price group ID applied to the service. |
additional_info Object
Name | Type | Description |
---|---|---|
html_description | string | HTML description about the service. |
category | object | Object that contains these elements of the category to which the service belongs: id and name . |
sub_category | object | Object that contains these elements of the sub-category to which the service belongs: id and name . |
business_unit | object | Object that contains these elements of the business unit to which the service belongs: id and name . |
catalog_info Object
Name | Type | Description |
---|---|---|
show_in_catalog | boolean | If true, it indicates that the service is to be displayed in the center catalog. |
can_book | boolean | If true, it indicates that guests can book the service. |
show_price | boolean | If true, it indicates that the price of the service is to be displayed. |
display_name | string | Name of the service that is displayed. |
display_price | decimal | Price of the service that is displayed. |
display_order | integer | Order in which the services are listed. |
video_url | string | Video URL of the service. |
variants_info Object
Name | Type | Description |
---|---|---|
is_variant | boolean | If true, it indicates that the service is a variant. |
has_variant | boolean | If true, it indicates that the service has a variant. |
add_ons_info Object
Name | Type | Description |
---|---|---|
is_add_on | boolean | If true, it indicates that the service is an add-on. |
has_add_ons | boolean | If true, it indicates that the service contains add-ons. |
add_ons_list | array | List of IDs of all add-ons associated with the service. |
error Object
code | message |
---|---|
401 | Authorization has been denied for this request. |
502 | Invalid center_id is passed. |