Facility groups
This article focuses on using Backoffice. For information on APIs and customizations, see the Facility groups article.
A facility group can be used to mark individual facilities as belonging to a specific group. A facility can be part of several facility groups.
Upon opening Facility groups in the sidebar, you'll see a table of all the facility groups that have been created in your network. To create a new facility group, click the Add facility group button at the bottom of the table, input the required information, and click Add.
You'll only see this view if you have the role and permission to select this view. See the Backoffice permissions article for more information.
The search bar can be used to find existing facility groups. You can search by facility group name only.
The facility group table consists of the following fields:
Name: Filters orders by order date.
Number of facilities: Filters orders by the facility where fulfillment occurs.
Group ID: Filters orders by the country where fulfillment occurs.
Custom attributes: Filters
To view details for an existing facility group, click the facility anywhere in the table row to open the details screen.
Facility group details view
The facility group details view contains the main information about a facility group. This includes the details of the facilities that are part of the facility group, the ID, and certain custom attributes. All of this can be edited using Backoffice. Once you've made any changes, ensure you click the Save button for them to take effect.
Facility group overview
The facility group overview table lists all facilities in the facility group.
The search bar can be used to find facilities within the facility group. You can search by facility name only. You can also filter the table by facility status and by country.
The facility group overview table consists of the following fields:
Status: The status of the facility in the facility group. Can be Online, Offline, or Suspended. See the facility status section for more information.
Name: The name of the facility in the facility group.
Street: The street address of the facility in the facility group.
City: The city address of the facility in the facility group.
Country: The country of the facility in the facility group.
Hovering over a facility reveals the more icon, which you can use to remove the facility from the facility group.
To add a facility to the facility group, click the Add facilities button at the bottom of the table, find and select the relevant facility, and click Add.
Facility group data
The facility group data includes the facility group name and ID. You can edit these at any time.
Custom attributes
The facility group custom attributes table lists all custom attributes associated with the facility group.
The facility group custom attributes table consists of the following fields:
Key: The key of each custom attribute
Value: The value of each custom attribute
To add a new custom attribute to the facility group, click the more icon in the table header, add the relevant custom attributes, and click Confirm.
Custom attributes must be added as JSON. For example:
Last updated
Was this helpful?