Services

This API documentation outlines the functionalities for managing services within Whautomate. It follows the CRUD (Create, Read, Update, Delete) paradigm, enabling you to perform the following actions

This API offers functionalities to:

• Creating new services: Establish new service entries, defining their names, descriptions, pricing structures, and associating them with relevant categories.

• Accessing service information: Retrieve details of all available services or a specific service by its unique identifier.

• Updating service details: Modify existing services to keep information accurate and reflect any changes. This might involve updating names, descriptions, pricing, or category associations.

• Removing services: Permanently delete services that are no longer offered, ensuring a clean and up-to-date service catalogue.

GET<YOUR HOST>/v1/services

Query parameters

Header parameters

Response

200

200 response

Body

application/json

idstring

serviceType*enum

APPOINTMENTCLASSADD_ON

name*string

location*object

durationMinutesinteger

categoriesarray of object

staffsarray of object

numberOfParticipantsnumber

typeenum

LOCATION_VISITHOME_VISITVIRTUAL_SESSION

sellingPrice*number

costPricenumber

taxOverridesarray of object

isCustomCreditboolean

creditsinteger

activeboolean

allowOnlineBookingboolean

acceptPaymentOnlineboolean

advanceSettingsobject

addOnAppliesToenum

SELECTED_SERVICESALL_SERVICES

addOnServicesarray of object

sortOrderinteger

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/services', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "serviceType": "APPOINTMENT",
    "name": "text",
    "location": {
      "id": "text",
      "title": "text"
    },
    "categories": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "staffs": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "numberOfParticipants": 0,
    "type": "LOCATION_VISIT",
    "sellingPrice": 0,
    "costPrice": 0,
    "taxOverrides": [
      {
        "id": "text",
        "name": "text",
        "percentage": "text"
      }
    ],
    "isCustomCredit": false,
    "active": false,
    "allowOnlineBooking": false,
    "acceptPaymentOnline": false,
    "advanceSettings": {},
    "addOnAppliesTo": "SELECTED_SERVICES",
    "addOnServices": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
]

POST<YOUR HOST>/v1/services

Header parameters

Body

application/json

idstring

serviceType*enum

APPOINTMENTCLASSADD_ON

name*string

location*object

durationMinutesinteger

categoriesarray of object

staffsarray of object

numberOfParticipantsnumber

typeenum

LOCATION_VISITHOME_VISITVIRTUAL_SESSION

sellingPrice*number

costPricenumber

taxOverridesarray of object

isCustomCreditboolean

creditsinteger

activeboolean

allowOnlineBookingboolean

acceptPaymentOnlineboolean

advanceSettingsobject

addOnAppliesToenum

SELECTED_SERVICESALL_SERVICES

addOnServicesarray of object

sortOrderinteger

Response

200

200 response

Body

application/json

Empty Schema

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/services', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "location": {
        "id": "text"
      },
      "name": "text",
      "sellingPrice": 0,
      "serviceType": "APPOINTMENT"
    }),
});
const data = await response.json();

GET<YOUR HOST>/v1/services/{serviceId}

Path parameters

serviceId*string

Header parameters

Response

200

200 response

Body

application/json

idstring

serviceType*enum

APPOINTMENTCLASSADD_ON

name*string

location*object

durationMinutesinteger

categoriesarray of object

staffsarray of object

numberOfParticipantsnumber

typeenum

LOCATION_VISITHOME_VISITVIRTUAL_SESSION

sellingPrice*number

costPricenumber

taxOverridesarray of object

isCustomCreditboolean

creditsinteger

activeboolean

allowOnlineBookingboolean

acceptPaymentOnlineboolean

advanceSettingsobject

addOnAppliesToenum

SELECTED_SERVICESALL_SERVICES

addOnServicesarray of object

sortOrderinteger

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/services/{serviceId}', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": "text",
  "serviceType": "APPOINTMENT",
  "name": "text",
  "location": {
    "id": "text",
    "title": "text"
  },
  "categories": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "staffs": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "numberOfParticipants": 0,
  "type": "LOCATION_VISIT",
  "sellingPrice": 0,
  "costPrice": 0,
  "taxOverrides": [
    {
      "id": "text",
      "name": "text",
      "percentage": "text"
    }
  ],
  "isCustomCredit": false,
  "active": false,
  "allowOnlineBooking": false,
  "acceptPaymentOnline": false,
  "advanceSettings": {},
  "addOnAppliesTo": "SELECTED_SERVICES",
  "addOnServices": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}

PUT<YOUR HOST>/v1/services/{serviceId}

Path parameters

serviceId*string

Header parameters

Response

200

200 response

Body

application/json

idstring

serviceType*enum

APPOINTMENTCLASSADD_ON

name*string

location*object

durationMinutesinteger

categoriesarray of object

staffsarray of object

numberOfParticipantsnumber

typeenum

LOCATION_VISITHOME_VISITVIRTUAL_SESSION

sellingPrice*number

costPricenumber

taxOverridesarray of object

isCustomCreditboolean

creditsinteger

activeboolean

allowOnlineBookingboolean

acceptPaymentOnlineboolean

advanceSettingsobject

addOnAppliesToenum

SELECTED_SERVICESALL_SERVICES

addOnServicesarray of object

sortOrderinteger

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/services/{serviceId}', {
    method: 'PUT',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": "text",
  "serviceType": "APPOINTMENT",
  "name": "text",
  "location": {
    "id": "text",
    "title": "text"
  },
  "categories": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "staffs": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "numberOfParticipants": 0,
  "type": "LOCATION_VISIT",
  "sellingPrice": 0,
  "costPrice": 0,
  "taxOverrides": [
    {
      "id": "text",
      "name": "text",
      "percentage": "text"
    }
  ],
  "isCustomCredit": false,
  "active": false,
  "allowOnlineBooking": false,
  "acceptPaymentOnline": false,
  "advanceSettings": {},
  "addOnAppliesTo": "SELECTED_SERVICES",
  "addOnServices": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}