Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Sales | Service Categories

Retrieve a list of Service Categories

get
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Query parameters
rootIdinteger · int32Optional

Id of the root category to start tree from. Null returns the full tree

namesstring[]Optional

Filter categories by certain names. Note: the response will not be a full tree hierarchy anymore.

languagestring · enumOptional

Language options for a customer or user interaction

Possible values:
Responses
200

OK: Service category tree.

application/json
totalinteger · int32Required
get/v1/sales/service-categories
GET /v1/sales/service-categories HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "childCategories": [
        {
          "childCategories": [
            "[Circular Reference]"
          ],
          "imageLink": "https://my.cdn.org/categories/notebooks/image.png",
          "id": 4,
          "name": "notebooks",
          "displayValue": "text",
          "self": {
            "href": "text",
            "method": "text"
          }
        }
      ],
      "imageLink": "https://my.cdn.org/categories/notebooks/image.png",
      "id": 4,
      "name": "notebooks",
      "displayValue": "text",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Create a new service category

post
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Body
parentCategoryIdinteger · int32 · nullableOptional

The identifier of the categories parent. Set to null if the category is a root category.

Example: 2
namestring · max: 50Required

The technical name of the category to identify category regardless localization. Must be unique and can not be updated afterwards.

Example: notebooks
displayValuestring · max: 50Required
descriptionstring · max: 500 · nullableOptional

A further description of the category

Example: Category for all types of notebooks and laptops
rankinteger · int32 · nullableOptional

The display rank order of the category

Example: 4
imageLinkstring · max: 2000 · nullableOptional

Url to an image to be shown in the marketplace.

Example: https://my.cdn.org/categories/notebooks/image.pngPattern: ^https://.*
Responses
201

Created: The created service category.

application/json
imageLinkstring · nullableOptional

Url to an image to be shown in the marketplace.

Example: https://my.cdn.org/categories/notebooks/image.png
idinteger · int32Optional

The identifier of the category.

Example: 4
namestring · nullableOptional

The technical name of the category to identify category regardless localization.

Example: notebooks
displayValuestring · nullableOptional
post/v1/sales/service-categories
POST /v1/sales/service-categories HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 200

{
  "parentCategoryId": 2,
  "name": "notebooks",
  "displayValue": "text",
  "description": "Category for all types of notebooks and laptops",
  "rank": 4,
  "imageLink": "https://my.cdn.org/categories/notebooks/image.png"
}
{
  "childCategories": [
    {
      "childCategories": [
        {
          "childCategories": [
            "[Circular Reference]"
          ],
          "imageLink": "https://my.cdn.org/categories/notebooks/image.png",
          "id": 4,
          "name": "notebooks",
          "displayValue": "text",
          "self": {
            "href": "text",
            "method": "text"
          }
        }
      ],
      "imageLink": "https://my.cdn.org/categories/notebooks/image.png",
      "id": 4,
      "name": "notebooks",
      "displayValue": "text",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "imageLink": "https://my.cdn.org/categories/notebooks/image.png",
  "id": 4,
  "name": "notebooks",
  "displayValue": "text",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a single service category by its ID

get
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
categoryIdinteger · int32Required

The identifier of the service category.

Query parameters
languagestring · enumOptional

Language options for a customer or user interaction

Possible values:
Responses
200

OK: The requested service category.

application/json
createdstring · date-timeOptional

The date and time when the service was created. (ISO 8601 format)

descriptionstring · nullableOptional

A further description of the category

Example: Category for all types of notebooks and laptops
rankinteger · int32 · nullableOptional

The display rank order of the category

Example: 4
imageLinkstring · nullableOptional

Url to an image to be shown in the marketplace.

Example: https://my.cdn.org/categories/notebooks/image.png
idinteger · int32Optional

The identifier of the category.

Example: 4
namestring · nullableOptional

The technical name of the category to identify category regardless localization.

Example: notebooks
displayValuestring · nullableOptional
get/v1/sales/service-categories/{categoryId}
GET /v1/sales/service-categories/{categoryId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "parentCategory": {
    "rank": 4,
    "parentCategory": {
      "rank": 4,
      "parentCategory": {
        "rank": 4,
        "parentCategory": {
          "rank": 4,
          "parentCategory": {
            "rank": 4,
            "parentCategory": "[Circular Reference]",
            "attributeDefinitions": [
              {
                "definition": {
                  "id": 4,
                  "name": "RAM",
                  "self": {
                    "href": "text",
                    "method": "text"
                  }
                },
                "rank": 1
              }
            ],
            "id": 4,
            "name": "notebooks",
            "displayValue": "text",
            "self": {
              "href": "text",
              "method": "text"
            }
          },
          "attributeDefinitions": [
            {
              "definition": {
                "id": 4,
                "name": "RAM",
                "self": {
                  "href": "text",
                  "method": "text"
                }
              },
              "rank": 1
            }
          ],
          "id": 4,
          "name": "notebooks",
          "displayValue": "text",
          "self": {
            "href": "text",
            "method": "text"
          }
        },
        "attributeDefinitions": [
          {
            "definition": {
              "id": 4,
              "name": "RAM",
              "self": {
                "href": "text",
                "method": "text"
              }
            },
            "rank": 1
          }
        ],
        "id": 4,
        "name": "notebooks",
        "displayValue": "text",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "attributeDefinitions": [
        {
          "definition": {
            "id": 4,
            "name": "RAM",
            "self": {
              "href": "text",
              "method": "text"
            }
          },
          "rank": 1
        }
      ],
      "id": 4,
      "name": "notebooks",
      "displayValue": "text",
      "self": {
        "href": "text",
        "method": "text"
      }
    },
    "attributeDefinitions": [
      {
        "definition": {
          "id": 4,
          "name": "RAM",
          "self": {
            "href": "text",
            "method": "text"
          }
        },
        "rank": 1
      }
    ],
    "id": 4,
    "name": "notebooks",
    "displayValue": "text",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "attributeDefinitions": [
    {
      "definition": {
        "id": 4,
        "name": "RAM",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "rank": 1
    }
  ],
  "created": "2026-01-01T00:00:00.000Z",
  "description": "Category for all types of notebooks and laptops",
  "rank": 4,
  "imageLink": "https://my.cdn.org/categories/notebooks/image.png",
  "id": 4,
  "name": "notebooks",
  "displayValue": "text",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Delete an existing service category

delete
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
categoryIdinteger · int32Required

The identifier of the service category to be deleted.

Responses
204

NoContent: Delete successful.

No content
delete/v1/sales/service-categories/{categoryId}
DELETE /v1/sales/service-categories/{categoryId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

Partially update an existing service category

patch
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
categoryIdinteger · int32Required

The identifier of the service category.

Bodyobject · Operation[]
valueany · nullableOptional
pathstring · nullableOptional
opstring · nullableOptional
fromstring · nullableOptional
Responses
204

NoContent: Update successful.

No content
patch/v1/sales/service-categories/{categoryId}
PATCH /v1/sales/service-categories/{categoryId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 385

[
  {
    "op": "add",
    "path": "/parentCategoryId",
    "value": "2"
  },
  {
    "op": "add",
    "path": "/name",
    "value": "notebooks"
  },
  {
    "op": "add",
    "path": "/displayValue",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/description",
    "value": "Category for all types of notebooks and laptops"
  },
  {
    "op": "add",
    "path": "/rank",
    "value": "4"
  },
  {
    "op": "add",
    "path": "/imageLink",
    "value": "https://my.cdn.org/categories/notebooks/image.png"
  }
]
No content

Retrieve a list of attribute definitions for a specific category

get

This endpoint returns all attribute definitions of a category, including attributes of the parent categories.

You can use this to retrieve all recommended attributes when creating a new service

Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
categoryIdinteger · int32Required

The identifier of the service category.

Responses
200

OK: Attribute definition list.

application/json
totalinteger · int32Required
get/v1/sales/service-categories/{categoryId}/attribute-definitions
GET /v1/sales/service-categories/{categoryId}/attribute-definitions HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "description": "Temporary memory for fast data access.",
      "knownValues": [
        {
          "id": 4,
          "displayValue": "8 GB",
          "self": {
            "href": "text",
            "method": "text"
          }
        }
      ],
      "id": 4,
      "name": "RAM",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a list of all translated fields for a specific category

get
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
categoryIdinteger · int32Required

Id of the category to get translations for

Responses
200

OK: List of translation objects.

application/json
totalinteger · int32Required
get/v1/sales/service-categories/{categoryId}/translations
GET /v1/sales/service-categories/{categoryId}/translations HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "childCategories": [
        {
          "childCategories": [
            "[Circular Reference]"
          ],
          "imageLink": "https://my.cdn.org/categories/notebooks/image.png",
          "id": 4,
          "name": "notebooks",
          "displayValue": "text",
          "self": {
            "href": "text",
            "method": "text"
          }
        }
      ],
      "imageLink": "https://my.cdn.org/categories/notebooks/image.png",
      "id": 4,
      "name": "notebooks",
      "displayValue": "text",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Update the translation of the category for a specific language

patch
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
categoryIdinteger · int32Required

The identifier of the service category.

languagestring · enumRequired

Language options for a customer or user interaction

Possible values:
Bodyobject · Operation[]
valueany · nullableOptional
pathstring · nullableOptional
opstring · nullableOptional
fromstring · nullableOptional
Responses
204

NoContent: Update successful.

No content
patch/v1/sales/service-categories/{categoryId}/translations/{language}
PATCH /v1/sales/service-categories/{categoryId}/translations/{language} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 152

[
  {
    "op": "add",
    "path": "/displayValue",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/description",
    "value": "Category for all types of notebooks and laptops"
  }
]
No content

Last updated

Was this helpful?