Use Cases
      Back to home
      1. Knowledge Base
      2. Webhooks & APIs
      3. Use Cases

      How to Use the SERVICE CATEGORY API

      The following article provides an overview of the Service Category API and explains how to use each of its endpoints.

      The following article provides an overview of the Service Category API and explains how to use each of its endpoints.

      Please take note that this API requires a Partner API Key. If you haven’t been provided with such a key, please contact your Booxi representative.

      Be reminded that the URL at which you access the API depends on your hosting region. This article may present examples from a North American hosting only.


      North America

      Europe

      api.booxi.com

      api.booxi.eu

      CRUD Endpoints

      GET serviceCategory/{serviceCategoryId}

      Retrieves the details of a specific service category.


      Permissions & Security 

      • A Partner API key is required. 
      • The Partner API key provided must be valid.

      Requirements & Specifications

      • The serviceCategoryId provided must belong to an active merchant that is associated with the Partner API key provided.

      Parameters

      Parameter

      Format

      Description

      serviceCategoryId

      integer

      The id of the service category

      Request URL for North America

      https://api.booxi.com/booking/v1/serviceCategory/YOUR_SERVICE_CATEGORY_ID

      Request URL for Europe

      https://api.booxi.eu/booking/v1/serviceCategory/YOUR_SERVICE_CATEGORY_ID

      cURL 

      curl -X 'GET' \
        'https://api.booxi.com/booking/v1/serviceCategory/YOUR_SERVICE_CATEGORY_ID' \
        -H 'accept: application/json' \
        -H 'Booxi-PartnerKey: YOUR_PARTNER_API_KEY'

      Successful Response

      Here’s an example of a successful response.

      {
        "id": YOUR_SERVICE_CATEGORY_ID,
        "name": "Nail Treatments",
        "description": "",
        "profileImageUrl": "",
        "merchantId": 11359,
        "isTemplate": false,
        "serviceCategoryTemplateId": YOUR_SERVICE_CATEGORY_TEMPLATE_ID
      }

      You can test this endpoint at the following links.

      For North America

      For Europe

      getServiceCategory

      getServiceCategory

      Error Codes


      Code

      Conditions

      400

      Request data is wrong (ex: characters provided are not integers)

      401

      Partner API Key is not found.

      Partner API Key is invalid.

      403

      Forbidden

      404

      Provided serviceCategoryId is associated with a disabled merchant (status = -1)

      No service category record found for provided serviceCategoryId.

      Service category is already deleted.

      Unexpected error

      Limitations & Notes

      • This API shall not be used to generate reports or export data.
      • Modules must be configured and activated by Booxi before usage.

      References

      For more information about the Booxi APIs and their usage, please refer to the following links:


      Americas: https://api.booxi.com/doc/booking.html

      Europe: https://api.booxi.eu/doc/booking.html


      Where to find API keys:

      • Your Merchant API key can be found in the Back Office, section My Business > Business Details.
      • Your Partner API key is provided by your Booxi Account Manager. The Partner API key must only be used in server-side (backend) code to keep it a secret.