Backoffice permissions

This article provides information about the permissions required to access Backoffice pages, as well as the additional permissions needed to perform specific actions.

Additional information on configuring roles is available in the Custom roles section of the Users, roles, and permissions article.

Backoffice page access

For any custom role that needs Backoffice permission, there are 4 permissions that must be added for the role to work. All can be found in the Foundation section of the role creation screen.

Backoffice naming	Check which box?	Value in API
Configuration	Read	CONFIG_READ
Current user	Read	CURRENT_USER_READ
Facility	Read	FACILITY_READ
Remote configuration	Read	REMOTE_CONFIG_READ

When creating a role within Backoffice, you'll be warned if you try to create a role without these permissions.

If you use the Backoffice access chips, these 4 permissions will be added automatically.

View pages

In addition to the above permissions, you can specify which pages of Backoffice a role can access using the below permissions. Use the relevant Backoffice access chip to automatically add all relevant read permissions.

If the role should be able to do more than view these pages, the corresponding WRITE, MODIFY, CREATE, and/or DELETE permissions can be added as needed. You can use the checkboxes to do this.

Backoffice page	Backoffice naming	Check which box?	Value in API	Information
Analytics	Analytics dashboard	Read	ANALYTICS_DASHBOARD_READ
Facilities, Suppliers	Facility	Read	FACILITY_READ	Covered with must-have permissions.
Facility groups	Facility Facility group	Read	FACILITY_READ FACILITY_GROUP_READ
Inbound	Inbound process Listing Filter entity	Read	INBOUND_PROCESS_READ LISTING_READ FILTER_ENTITY_READ
Inventory	Stock Listing Stock availabilities Filter entity	Read	STOCK_READ LISTING_READ, STOCK_AVAILABILITIES_READ FILTER_ENTITY_READ
Orders	Filter entity Process Brand Carrier Routing Order Simulation order Records	Read	FILTER_ENTITY_READ PROCESS_READ BRAND_READ CARRIER_READ ROUTING_READ ORDER_READ SIMULATION_ORDER_READ ORDER_RECORD_READ
Returns	Return	Read	RETURN_READ
Roles	User Role	Read	USER_READ ROLE_READ
Routing	Routing Routing config DOMS toolkit Simulation order	Read	ROUTING_READ ROUTING_CONFIG_READ DOMS_TOOLKIT_READ SIMULATION_ORDER_READ
Routing	Routing config DOMS toolkit Simulation order	Write	ROUTING_CONFIG_WRITE DOMS_TOOLKIT_WRITE SIMULATION_ORDER_WRITE
Storage locations	Storage location Stock Zone Listing Filter entity	Read	STORAGE_LOCATION_READ STOCK_READ ZONE_READ LISTING_READ FILTER_ENTITY_READ
Users	Role Permission	Read	ROLE_READ PERMISSION_READ

View KPIs on Network view

KPI	Backoffice naming	Check which box?	Value in API
High performing facilities	Facility KPI	Read	FACILITY_READ KPI_READ
Low performing facilities	Facility KPI	Read	FACILITY_READ KPI_READ
Short‑pick reasons	Facility Pickjob KPI	Read	FACILITY_READ PICKJOB_READ KPI_READ
Processed pick jobs	Facility KPI	Read	FACILITY_READ KPI_READ
Top products	Facility Listing Stock KPI	Read	FACILITY_READ LISTING_READ STOCK_READ KPI_READ
Most returned products	Facility Listing Stock Return KPI	Read	FACILITY_READ LISTING_READ STOCK_READ RETURN_READ KPI_READ

Backoffice actions

If roles need to be able to perform certain actions on specific pages, additional permissions are available that can be configured accordingly.

Orders

Action required	Backoffice permission naming	Check which box?	Value in API
Assign order	Process	Write	PROCESS_WRITE
Reroute order	Process	Reroute	PROCESS_REROUTE
Unlock order	Order	Unlock	ORDER_UNLOCK
Cancel order	Order	Cancel	ORDER_CANCEL
Force cancel order	Order	Force cancel	ORDER_FORCE_CANCEL
Edit address	Order	Consumer write	ORDER_CONSUMER_WRITE
Edit line item	Order	Line item write	ORDER_LINE_ITEM_WRITE
Order line item quantity increase	Line item	Line item quantity increase	ORDER_LINEITEM_QUANTITY_INCREASE
Order line item quantity decrease	Line item	Line item quantity decrease	ORDER_LINEITEM_QUANTITY_DECREASE
Add new line item to order	Line item	Add	ORDER_LINEITEM_ADD
Delete line item from order	Line item	Delete	ORDER_LINEITEM_DELETE
Reset pick job	Pick job	Write	PICKJOB_WRITE
Restart pick job	Pick job	Write	PICKJOB_WRITE

Inventory

Inventory (network overview)

Action required	Backoffice permission naming	Check which box?	Value in API
Edit safety stock	Safety stock	Write	SAFETY_STOCK_WRITE

Inventory (facility view)

Action	Backoffice permission naming	Check which box?	Value in API
Edit stock	Stock	Write	STOCK_WRITE
Edit sales price	Listing	Write	LISTING_WRITE
Edit custom attributes	Listing	Write	LISTING_WRITE

Storage locations

Action	Backoffice permission naming	Check which box?	Value in API
Edit stock	Stock	Write	STOCK_WRITE
Edit storage location	Storage location	Write	STORAGE_LOCATION_WRITE

Inbound

Action	Backoffice permission naming	Check which box?	Value in API
Edit inbound process status	Inbound process	Write	INBOUND_PROCESS_WRITE

Settings

Action	Backoffice permission naming	Check which box?	Value in API
Connect apps	Tenant connector config	Read	TENANT_CONNECTOR_CONFIG_READ
Carrier credentials	Carrier	Read	CARRIER_READ
Substitution items	Substitute	Write	SUBSTITUTE_WRITE
Time frame for future capacity planning	Facility	Write	FACILITY_WRITE