Category endpoints

Get category

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

categoryIdstringRequired

Responses

200Success

application/json

Category

nameLocalizedobject · LocaleStringConstrainedRequired

LocaleStringConstrained

createdstring · date-timeRequired

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

idstringOptional

lastModifiedstring · date-timeRequired

tenantCategoryIdstring · min: 2 · max: 256Optional

unique identifier for categories used in the customer systems

Pattern: ^[A-Za-z0-9_-]+$

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

get

/api/categories/{categoryId}

HTTPcURLJavaScriptPython

GET /api/categories/{categoryId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "nameLocalized": {},
  "created": "2026-03-02T23:21:13.983Z",
  "customAttributes": {},
  "id": "text",
  "lastModified": "2026-03-02T23:21:13.983Z",
  "tenantCategoryId": "text",
  "version": 1
}

List categories

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sizenumber · min: 1 · max: 100OptionalDefault: 25

startAfterIdstringOptional

Responses

200Success

application/json

Category

nameLocalizedobject · LocaleStringConstrainedRequired

LocaleStringConstrained

createdstring · date-timeRequired

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

idstringOptional

lastModifiedstring · date-timeRequired

tenantCategoryIdstring · min: 2 · max: 256Optional

unique identifier for categories used in the customer systems

Pattern: ^[A-Za-z0-9_-]+$

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

get

/api/categories

HTTPcURLJavaScriptPython

GET /api/categories HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "nameLocalized": {},
    "created": "2026-03-02T23:21:13.983Z",
    "customAttributes": {},
    "id": "text",
    "lastModified": "2026-03-02T23:21:13.983Z",
    "tenantCategoryId": "text",
    "version": 1
  }
]

Create category

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CategoryForCreation

nameLocalizedobject · LocaleStringConstrainedRequired

LocaleStringConstrained

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

tenantCategoryIdstring · min: 2 · max: 256Optional

unique identifier for categories used in the customer systems

Pattern: ^[A-Za-z0-9_-]+$

Responses

201Success

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

post

/api/categories

HTTPcURLJavaScriptPython

POST /api/categories HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "nameLocalized": {},
  "customAttributes": {},
  "tenantCategoryId": "text"
}

{
  "nameLocalized": {},
  "created": "2026-03-02T23:21:13.983Z",
  "customAttributes": {},
  "id": "text",
  "lastModified": "2026-03-02T23:21:13.983Z",
  "tenantCategoryId": "text",
  "version": 1
}

Delete category

delete

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

categoryIdstringRequired

Query parameters

forceDeletionbooleanOptional

Responses

200Success

application/json

Category

nameLocalizedobject · LocaleStringConstrainedRequired

LocaleStringConstrained

createdstring · date-timeRequired

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

idstringOptional

lastModifiedstring · date-timeRequired

tenantCategoryIdstring · min: 2 · max: 256Optional

unique identifier for categories used in the customer systems

Pattern: ^[A-Za-z0-9_-]+$

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

delete

/api/categories/{categoryId}

HTTPcURLJavaScriptPython

DELETE /api/categories/{categoryId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "nameLocalized": {},
  "created": "2026-03-02T23:21:13.983Z",
  "customAttributes": {},
  "id": "text",
  "lastModified": "2026-03-02T23:21:13.983Z",
  "tenantCategoryId": "text",
  "version": 1
}

List categories (search)

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Search for Category

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CategorySearchPayload

afterstringOptional

The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.

beforestringOptional

The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).

lastnumber · min: 1 · max: 250Optional

Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.

sizenumber · min: 1 · max: 250Optional

Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.

startAfterIdstringOptionalDeprecated

The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.

Responses

200

Your search result

application/json

CategoryPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

post

/api/categories/search

HTTPcURLJavaScriptPython

POST /api/categories/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2528

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "nameLocalized": {
      "ANY_ADDITIONAL_PROPERTY": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      }
    },
    "and": [
      {
        "nameLocalized": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "and": [
          {
            "nameLocalized": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "and": "[Circular Reference]",
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "tenantCategoryId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "nameLocalized": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "and": "[Circular Reference]",
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "tenantCategoryId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "tenantCategoryId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "customAttributes": {
      "ANY_ADDITIONAL_PROPERTY": {
        "eq": true,
        "notEq": true
      }
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "name": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "nameLocalized": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "and": "[Circular Reference]",
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "tenantCategoryId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "tenantCategoryId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    }
  },
  "size": 1,
  "sort": [
    {
      "created": "ASC",
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "ASC",
      "lastModified": "ASC",
      "name": "ASC",
      "tenantCategoryId": "ASC"
    }
  ]
}

{
  "categories": [
    {
      "nameLocalized": {},
      "created": "2026-03-02T23:21:13.983Z",
      "customAttributes": {},
      "id": "text",
      "lastModified": "2026-03-02T23:21:13.983Z",
      "tenantCategoryId": "text",
      "version": 1
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}

Replace category

put

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

categoryIdstringRequired

Body

application/json

CategoryForUpdate

nameLocalizedobject · LocaleStringConstrainedRequired

LocaleStringConstrained

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

idstringOptional

tenantCategoryIdstring · min: 2 · max: 256Optional

unique identifier for categories used in the customer systems

Pattern: ^[A-Za-z0-9_-]+$

versionnumberRequired

Responses

200Success

application/json

Category

nameLocalizedobject · LocaleStringConstrainedRequired

LocaleStringConstrained

createdstring · date-timeRequired

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

idstringOptional

lastModifiedstring · date-timeRequired

tenantCategoryIdstring · min: 2 · max: 256Optional

unique identifier for categories used in the customer systems

Pattern: ^[A-Za-z0-9_-]+$

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

put

/api/categories/{categoryId}

HTTPcURLJavaScriptPython

PUT /api/categories/{categoryId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "nameLocalized": {},
  "customAttributes": {},
  "id": "text",
  "tenantCategoryId": "text",
  "version": 1
}

{
  "nameLocalized": {},
  "created": "2026-03-02T23:21:13.983Z",
  "customAttributes": {},
  "id": "text",
  "lastModified": "2026-03-02T23:21:13.983Z",
  "tenantCategoryId": "text",
  "version": 1
}