Facility groups

For a complete endpoint definition, see the Facility groups section in the REST API reference.

Create a facility group

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

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

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

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

{
    "version": 1,
    "nameLocalized": {
        "de_DE": "Deutschland Westen",
        "en_US": "Germany West"
    },
    "tenantFacilityGroupId": "DE_W",
    "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": "Germany West"
}