Skip to main content

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.
API regionapi.whautomate.com

GET /v1/services​

GET /v1/services
Headers
x-api-keystringrequired
Your Whautomate API key.
Query parameters
locationIdstring
limitstring
pagestring
serviceTypestring
searchTextstring
Response 200
idstring
serviceTypestring (enum)required
One of: APPOINTMENT, CLASS, ADD_ON.
namestringrequired
locationobjectrequired
durationMinutesinteger
categoriesobject[]
staffsobject[]
numberOfParticipantsnumber
typestring (enum)
One of: LOCATION_VISIT, HOME_VISIT, VIRTUAL_SESSION.
sellingPricenumberrequired
costPricenumber
taxOverridesobject[]
isCustomCreditboolean
creditsinteger
activeboolean
allowOnlineBookingboolean
acceptPaymentOnlineboolean
advanceSettingsobject
addOnAppliesTostring (enum)
One of: SELECTED_SERVICES, ALL_SERVICES.
addOnServicesobject[]
sortOrderinteger
Request
curl -X GET "https://api.whautomate.com/v1/services" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
[
  {
    "id": "string",
    "serviceType": "APPOINTMENT",
    "name": "string",
    "location": {
      "id": "string",
      "title": "string"
    },
    "durationMinutes": 0,
    "categories": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "staffs": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "numberOfParticipants": 0,
    "type": "LOCATION_VISIT",
    "sellingPrice": 0,
    "costPrice": 0,
    "taxOverrides": [
      {
        "id": "string",
        "name": "string",
        "percentage": "string"
      }
    ],
    "isCustomCredit": true,
    "credits": 0,
    "active": true,
    "allowOnlineBooking": true,
    "acceptPaymentOnline": true,
    "advanceSettings": {
      "advanceBookingLimitDays": 0,
      "blockTimeAfterAppointment": 0
    },
    "addOnAppliesTo": "SELECTED_SERVICES",
    "addOnServices": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "sortOrder": 0
  }
]

POST /v1/services​

POST /v1/services
Headers
x-api-keystringrequired
Your Whautomate API key.
Body
idstring
serviceTypestring (enum)required
One of: APPOINTMENT, CLASS, ADD_ON.
namestringrequired
locationobjectrequired
durationMinutesinteger
categoriesobject[]
staffsobject[]
numberOfParticipantsnumber
typestring (enum)
One of: LOCATION_VISIT, HOME_VISIT, VIRTUAL_SESSION.
sellingPricenumberrequired
costPricenumber
taxOverridesobject[]
isCustomCreditboolean
creditsinteger
activeboolean
allowOnlineBookingboolean
acceptPaymentOnlineboolean
advanceSettingsobject
addOnAppliesTostring (enum)
One of: SELECTED_SERVICES, ALL_SERVICES.
addOnServicesobject[]
sortOrderinteger
Request
curl -X POST "https://api.whautomate.com/v1/services" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "serviceType": "APPOINTMENT",
    "name": "string",
    "location": {
      "id": "string",
      "title": "string"
    },
    "durationMinutes": 0,
    "categories": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "staffs": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "numberOfParticipants": 0,
    "type": "LOCATION_VISIT",
    "sellingPrice": 0,
    "costPrice": 0,
    "taxOverrides": [
      {
        "id": "string",
        "name": "string",
        "percentage": "string"
      }
    ],
    "isCustomCredit": true,
    "credits": 0,
    "active": true,
    "allowOnlineBooking": true,
    "acceptPaymentOnline": true,
    "advanceSettings": {
      "advanceBookingLimitDays": 0,
      "blockTimeAfterAppointment": 0
    },
    "addOnAppliesTo": "SELECTED_SERVICES",
    "addOnServices": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "sortOrder": 0
  }'
Response 200
{}

GET /v1/services/{serviceId}​

GET /v1/services/{serviceId}
Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
serviceIdstringrequired
Response 200
idstring
serviceTypestring (enum)required
One of: APPOINTMENT, CLASS, ADD_ON.
namestringrequired
locationobjectrequired
durationMinutesinteger
categoriesobject[]
staffsobject[]
numberOfParticipantsnumber
typestring (enum)
One of: LOCATION_VISIT, HOME_VISIT, VIRTUAL_SESSION.
sellingPricenumberrequired
costPricenumber
taxOverridesobject[]
isCustomCreditboolean
creditsinteger
activeboolean
allowOnlineBookingboolean
acceptPaymentOnlineboolean
advanceSettingsobject
addOnAppliesTostring (enum)
One of: SELECTED_SERVICES, ALL_SERVICES.
addOnServicesobject[]
sortOrderinteger
Request
curl -X GET "https://api.whautomate.com/v1/services/{serviceId}" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "id": "string",
  "serviceType": "APPOINTMENT",
  "name": "string",
  "location": {
    "id": "string",
    "title": "string"
  },
  "durationMinutes": 0,
  "categories": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "staffs": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "numberOfParticipants": 0,
  "type": "LOCATION_VISIT",
  "sellingPrice": 0,
  "costPrice": 0,
  "taxOverrides": [
    {
      "id": "string",
      "name": "string",
      "percentage": "string"
    }
  ],
  "isCustomCredit": true,
  "credits": 0,
  "active": true,
  "allowOnlineBooking": true,
  "acceptPaymentOnline": true,
  "advanceSettings": {
    "advanceBookingLimitDays": 0,
    "blockTimeAfterAppointment": 0
  },
  "addOnAppliesTo": "SELECTED_SERVICES",
  "addOnServices": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "sortOrder": 0
}

PUT /v1/services/{serviceId}​

PUT /v1/services/{serviceId}
Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
serviceIdstringrequired
Response 200
idstring
serviceTypestring (enum)required
One of: APPOINTMENT, CLASS, ADD_ON.
namestringrequired
locationobjectrequired
durationMinutesinteger
categoriesobject[]
staffsobject[]
numberOfParticipantsnumber
typestring (enum)
One of: LOCATION_VISIT, HOME_VISIT, VIRTUAL_SESSION.
sellingPricenumberrequired
costPricenumber
taxOverridesobject[]
isCustomCreditboolean
creditsinteger
activeboolean
allowOnlineBookingboolean
acceptPaymentOnlineboolean
advanceSettingsobject
addOnAppliesTostring (enum)
One of: SELECTED_SERVICES, ALL_SERVICES.
addOnServicesobject[]
sortOrderinteger
Request
curl -X PUT "https://api.whautomate.com/v1/services/{serviceId}" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "id": "string",
  "serviceType": "APPOINTMENT",
  "name": "string",
  "location": {
    "id": "string",
    "title": "string"
  },
  "durationMinutes": 0,
  "categories": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "staffs": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "numberOfParticipants": 0,
  "type": "LOCATION_VISIT",
  "sellingPrice": 0,
  "costPrice": 0,
  "taxOverrides": [
    {
      "id": "string",
      "name": "string",
      "percentage": "string"
    }
  ],
  "isCustomCredit": true,
  "credits": 0,
  "active": true,
  "allowOnlineBooking": true,
  "acceptPaymentOnline": true,
  "advanceSettings": {
    "advanceBookingLimitDays": 0,
    "blockTimeAfterAppointment": 0
  },
  "addOnAppliesTo": "SELECTED_SERVICES",
  "addOnServices": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "sortOrder": 0
}
Last updated on