Categories

Summary

Categories can be used to mark listings as belonging to a specific group. A listing can belong to one to many categories. The categoryRef on the listing allows assigning categories to a listing. Categories can be used, for example, to define discounts for certain article groups.

Listings can be assigned to an article category by:

1. creating a category via API

2. referencing the ID of the category in the respective listing(s)

Categories can be created, edited and deleted via REST API. Categories that are assigned to one or more listings cannot be deleted.

More categories API information can be found here: REST API documentation – Categories

For a complete overview of the category endpoints, refer to the API documentation for Categories.

Create a category

To create a category, send a POST request to the following endpoint with the category data in the request body.

POST https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/categories

Example request body

{
  "nameLocalized": {
    "de_DE": "Lebensmittel",
    "en_US": "groceries"
  },
  "tenantCategoryId": "G-01"
}

A successful request returns a 201 CREATED response with a body that includes the id of the newly created category.

Example response body

{
    "lastModified": "2025-04-25T09:06:54.737Z",
    "version": 1,
    "nameLocalized": {
        "de_DE": "Lebensmittel",
        "en_US": "groceries"
    },
    "tenantCategoryId": "G-01",
    "id": "1f6fe169-893f-4e95-8ac0-38c9e6eca068",
    "created": "2025-04-25T09:06:54.737Z",
    "name": "groceries"
}