v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
Branch Service

Retrieve a branch service

Get a branch service for the specified business id, branch id and branch service id. There is an option to fetch online categories of branch services

get/api/business/{businessId}/branch/{branchId}/service/{serviceId}

Path parameters

businessIdstring required
branchIdstring required
serviceIdstring required

Query parameters

fetch_online_categoryboolean

include online categories of branch services

Response

Specified branch service retrieved

serviceIdstring
versioninteger
archivedboolean
categoryIdstring
durationinteger

in minutes

gapTimeinteger

in minutes

namestring
pricenumber
disqualifiedStaffstring[]
machinesstring[]
roomsstring[]
taxRatesstring[]
internetNamestring
categoryNamestring
internetEnabledboolean
internetDescriptionstring

Example response

{
  "serviceId": "ab123",
  "version": 1,
  "categoryId": "category1",
  "duration": 20,
  "gapTime": 15,
  "name": "Blow dry",
  "price": 25.5,
  "disqualifiedStaff": [
    "staff1",
    "staff2"
  ],
  "machines": [
    "machine1",
    "machine2"
  ],
  "rooms": [
    "room1",
    "room2"
  ],
  "taxRates": [
    "taxRateRef",
    "taxRateRef2"
  ],
  "internetName": "online name",
  "staffCategories": {
    "prices": [
      {
        "id": "priceCategory1",
        "price": 55.1
      }
    ]
  },
  "userDurations": [
    {
      "userRef": "userID1",
      "duration": 60
    }
  ],
  "userGapTimes": [
    {
      "userRef": "userID1",
      "gapTime": 10
    }
  ],
  "department": {
    "id": "ab123",
    "name": "Hair Department"
  },
  "categoryName": "category name",
  "internetDescription": "service description",
  "internetServiceCategories": [
    {
      "id": "ab123",
      "name": "Cut & Style"
    }
  ]
}