Facility groups

Facility groups can be used to mark individual facilities as belonging to a specific group. A facility can be part of several facility groups.

Facilities can be assigned to a group by:

1. Creating a facility group via API

2. Referencing the ID of the facilities in the respective facility group

3. Creating a facility group in Backoffice

Facility groups can be used, for example, to define sales prices for certain facility groups.

Create a facility group

To create a facility group, send a POST request to the following endpoint with a JSON body.

POST https://ocff-{PROJECT_ID}.api.fulfillmenttools.com/api/facilitygroups

The tenantFacilityGroupId is the internal ID that you can use to reference the facility group. This follows the URN pattern.

The facilityRefs are the id of each facility you want to include in the facility group.

The nameLocalized will be displayed in the clients.

{
  "tenantFacilityGroupId": "US_WC",
  "facilityRefs": [
    "871c1620-3757-4242-9a8d-5d20b81cadde_96358521",
    "bc6fd1f7-cbbf-41da-938d-01a68d90a926_0001a6c5",
    "bc6fd1f7-cbbf-41da-938d-01a68d90a926_003fcc05"
  ],
  "nameLocalized": {
    "de_DE": "US Westen",
    "en_US": "US West Coast"
  }
}

A successful request returns a 201 Created response with the created facility group object in the body:

{
    "version": 1,
    "nameLocalized": {
        "de_DE": "US Westen",
        "en_US": "US West Coast"
    },
    "tenantFacilityGroupId": "US_WC",
    "facilityRefs": [
        "871c1620-3757-4242-9a8d-5d20b81cadde_96358521",
        "bc6fd1f7-cbbf-41da-938d-01a68d90a926_0001a6c5",
        "bc6fd1f7-cbbf-41da-938d-01a68d90a926_003fcc05"
    ],
    "lastModified": "2025-04-29T12:26:15.844Z",
    "id": "26c594fc-d26a-4bad-a930-dda610c85678",
    "created": "2025-04-29T12:26:15.844Z",
    "name": "US West Coast"
}