Facility Groups (Core)

Facility groups combine one or multiple facilities into logical groups.

List facility groups

get

Get all facility groups with pagination.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

tenantFacilityGroupIdstringOptional

Responses

200

The facility groups that were found based on the given filters.

application/json

FacilityGroups

totalnumberOptional

Total number of found entities for this query

Example: 42

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 endpoint

application/json

get/api/facilitygroups

HTTPcURLJavaScriptPython

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

{
  "facilityGroups": [
    {
      "nameLocalized": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "created": "2026-07-22T15:57:49.741Z",
      "customAttributes": {},
      "facilityCount": 1,
      "facilityRefs": [
        "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
      ],
      "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "lastModified": "2026-07-22T15:57:49.741Z",
      "name": "text",
      "tenantFacilityGroupId": "K12345",
      "version": 1
    }
  ],
  "total": 42
}

Create facility group

post

Creates a new facility group.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

FacilityGroupForCreation

customAttributesobject · nullableOptional

Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.

facilityRefsstring[]Required

Array of facility references belonging to this group. Cannot exceed your quota, default 1000.

Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]

tenantFacilityGroupIdstringRequired

The id of the facility group in the tenants own system

Example: K12345

Responses

201

The facility group was successfully created.

application/json

FacilityGroup

createdstring · date-timeRequired

Creation timestamp

customAttributesobject · nullableOptional

Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.

facilityCountnumberRequired

The number of facilities in this group

facilityRefsstring[]Required

Array of facility references belonging to this group. Cannot exceed your quota, default 1000.

Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]

idstringRequired

The facility group ID

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

lastModifiedstring · date-timeRequired

Last modified timestamp

namestringOptional

The name of the facility group

tenantFacilityGroupIdstringRequired

The id of the facility group in the tenants own system

Example: K12345

versionnumberRequired

Document version for optimistic locking

Example: 1

400

Invalid input. See response for details.

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 endpoint

application/json

post/api/facilitygroups

HTTPcURLJavaScriptPython

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

{
  "nameLocalized": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "customAttributes": {},
  "facilityRefs": [
    "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
  ],
  "tenantFacilityGroupId": "K12345"
}

{
  "nameLocalized": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "created": "2026-07-22T15:57:49.741Z",
  "customAttributes": {},
  "facilityCount": 1,
  "facilityRefs": [
    "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
  ],
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "lastModified": "2026-07-22T15:57:49.741Z",
  "name": "text",
  "tenantFacilityGroupId": "K12345",
  "version": 1
}

Get facility group

get

Get facility group by id.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityGroupIdstringRequired

Responses

200

Facility group was found. The result is in the body.

application/json

FacilityGroup

createdstring · date-timeRequired

Creation timestamp

customAttributesobject · nullableOptional

Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.

facilityCountnumberRequired

The number of facilities in this group

facilityRefsstring[]Required

Array of facility references belonging to this group. Cannot exceed your quota, default 1000.

Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]

idstringRequired

The facility group ID

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

lastModifiedstring · date-timeRequired

Last modified timestamp

namestringOptional

The name of the facility group

tenantFacilityGroupIdstringRequired

The id of the facility group in the tenants own system

Example: K12345

versionnumberRequired

Document version for optimistic locking

Example: 1

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 endpoint

application/json

404

The requested entity was not found

application/json

get/api/facilitygroups/{facilityGroupId}

HTTPcURLJavaScriptPython

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

{
  "nameLocalized": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "created": "2026-07-22T15:57:49.741Z",
  "customAttributes": {},
  "facilityCount": 1,
  "facilityRefs": [
    "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
  ],
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "lastModified": "2026-07-22T15:57:49.741Z",
  "name": "text",
  "tenantFacilityGroupId": "K12345",
  "version": 1
}

Delete facility group

delete

Delete facility group by id.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityGroupIdstringRequired

Responses

200

Facility group was found and deleted.

No content

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 endpoint

application/json

404

The requested entity was not found

application/json

delete/api/facilitygroups/{facilityGroupId}

HTTPcURLJavaScriptPython

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

No content

Update facility group

patch

Replace facility group by id. All updatable fields will be replaced with the values from the request. Fields that are not included in the request will be removed from the entity.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityGroupIdstringRequired

Body

application/json

FacilityGroupForUpdate

customAttributesobject · nullableOptional

Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.

facilityRefsstring[]Optional

Array of facility references belonging to this group. Cannot exceed your quota, default 1000.

Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]

tenantFacilityGroupIdstringOptional

The id of the facility group in the tenants own system

Example: K12345

versionnumberRequired

The version of the document to be used in optimistic locking mechanisms.

Example: 42

Responses

200

Facility group was replaced. The replaced facility group is in the body.

application/json

FacilityGroup

createdstring · date-timeRequired

Creation timestamp

customAttributesobject · nullableOptional

Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.

facilityCountnumberRequired

The number of facilities in this group

facilityRefsstring[]Required

Array of facility references belonging to this group. Cannot exceed your quota, default 1000.

Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]

idstringRequired

The facility group ID

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

lastModifiedstring · date-timeRequired

Last modified timestamp

namestringOptional

The name of the facility group

tenantFacilityGroupIdstringRequired

The id of the facility group in the tenants own system

Example: K12345

versionnumberRequired

Document version for optimistic locking

Example: 1

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 endpoint

application/json

404

The requested entity was not found

application/json

409

A version conflict occurred.

application/json

patch/api/facilitygroups/{facilityGroupId}

HTTPcURLJavaScriptPython

PATCH /api/facilitygroups/{facilityGroupId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 215

{
  "nameLocalized": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "customAttributes": {},
  "facilityRefs": [
    "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
  ],
  "tenantFacilityGroupId": "K12345",
  "version": 42
}

{
  "nameLocalized": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "created": "2026-07-22T15:57:49.741Z",
  "customAttributes": {},
  "facilityCount": 1,
  "facilityRefs": [
    "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
  ],
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "lastModified": "2026-07-22T15:57:49.741Z",
  "name": "text",
  "tenantFacilityGroupId": "K12345",
  "version": 1
}

Call facility group action

post

Perform action on a facility group. Supported actions are defined in the request body.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityGroupIdstringRequired

Body

application/json

or

or

or

Responses

200

Updated facility group in the body.

application/json

FacilityGroup

createdstring · date-timeRequired

Creation timestamp

customAttributesobject · nullableOptional

Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.

facilityCountnumberRequired

The number of facilities in this group

facilityRefsstring[]Required

Array of facility references belonging to this group. Cannot exceed your quota, default 1000.

Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]

idstringRequired

The facility group ID

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

lastModifiedstring · date-timeRequired

Last modified timestamp

namestringOptional

The name of the facility group

tenantFacilityGroupIdstringRequired

The id of the facility group in the tenants own system

Example: K12345

versionnumberRequired

Document version for optimistic locking

Example: 1

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 endpoint

application/json

post/api/facilitygroups/{facilityGroupId}/actions

HTTPcURLJavaScriptPython

POST /api/facilitygroups/{facilityGroupId}/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "facilitiesToAdd": [
    "text"
  ],
  "name": "ADD_FACILITIES_TO_GROUP",
  "version": 1
}

{
  "nameLocalized": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "created": "2026-07-22T15:57:49.741Z",
  "customAttributes": {},
  "facilityCount": 1,
  "facilityRefs": [
    "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
  ],
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "lastModified": "2026-07-22T15:57:49.741Z",
  "name": "text",
  "tenantFacilityGroupId": "K12345",
  "version": 1
}

List facility groups (search)

post

Search for FacilityGroup

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

FacilityGroupSearchPayload

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.

Example: 10

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

FacilityGroupPaginatedResult

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 endpoint

application/json

post/api/facilitygroups/search

HTTPcURLJavaScriptPython

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

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "facilityRefs": [
              "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
              "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
            ],
            "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "tenantFacilityGroupId": "MY_FACILITYGROUP_ID"
          }
        ],
        "facilityRefs": [
          "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
          "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
        ],
        "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "facilityRefs": [
              "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
              "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
            ],
            "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "tenantFacilityGroupId": "MY_FACILITYGROUP_ID"
          }
        ],
        "tenantFacilityGroupId": "MY_FACILITYGROUP_ID"
      }
    ],
    "facilityRefs": [
      "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
    ],
    "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "name": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "facilityRefs": [
          "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
          "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
        ],
        "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "tenantFacilityGroupId": "MY_FACILITYGROUP_ID"
      }
    ],
    "tenantFacilityGroupId": "MY_FACILITYGROUP_ID"
  },
  "size": 10,
  "sort": [
    {
      "facilityCount": "ASC",
      "name": "ASC",
      "tenantFacilityGroupId": "ASC"
    }
  ]
}

{
  "facilityGroups": [
    {
      "nameLocalized": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "created": "2026-07-22T15:57:49.741Z",
      "customAttributes": {},
      "facilityCount": 1,
      "facilityRefs": [
        "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
      ],
      "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "lastModified": "2026-07-22T15:57:49.741Z",
      "name": "text",
      "tenantFacilityGroupId": "K12345",
      "version": 1
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}