PHphorest
Branch Service

List branch services

Changed on

Get a list of branch services for the specified business id and branch id. List can be filtered by service category id, service type, possibility to include archived branch services in the list and option to fetch online categories of branch services. Use <code>service_type</code> to control which services are returned: <code>services_only</code> (default — excludes add-on-only services); <code>addons_only</code> returns services flagged as add-ons; <code>services_and_addons</code> returns all services regardless of add-on flag.

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

Request

Path parameters

businessIdstring required
branchIdstring required

Query parameters

category_idstring

service category id to filter by

includeArchivedboolean

include archived branch services in the list

fetch_online_categoryboolean

include online categories of branch services

fetch_addon_servicesboolean

include add-on service IDs for each service

service_typestring

filter services by type. Allowed values: <code>services_only</code> (default — excludes add-on-only services), <code>addons_only</code> (only add-on services), <code>services_and_addons</code> (all services)

number of branch service records to return, max is 200

page number, default is 0 and is optional

Response

Branch services listed

Example response

{
  "_embedded": {
    "services": [
      {
        "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"
          }
        ],
        "userPrices": [
          {
            "userRef": "cO8vpfkhkHYOhfvZuIcwng",
            "price": 116
          }
        ]
      }
    ]
  }
}

Changes

  • beea6ef29634Revision changes
    • info

      added the new optional query request parameter fetch_addon_services

    • info

      added the new optional query request parameter service_type

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status