The Agents screen lists the agent accounts in your shop. Open Agents in the sidebar menu to reach the list. From the list, you search for agents, create new ones and delete existing ones. Agent accounts, like administrator accounts, are employee accounts that can sign in. Selecting an agent row opens that agent's record for editing.
List controls
Control | What it does |
Name | Search box with the placeholder Search. Filters the list to agents whose name matches the text you type. |
ADD AGENT | Opens the Create Agents form. |
Select all | Checkbox in the header row of the agents table, next to a checkbox on every agent row. |
Unselect | Button that sits beside a counter reading 0 items selected when no rows are ticked. |
Delete | Removes the agents whose row checkboxes you selected. |
Rows per page | Drop-down that sits beside the range indicator for the table. Controls how many rows appear at once. |
List columns
Column | What it shows |
Name | The agent's display name. |
The agent's email address. | |
Description | An optional free-text note about what the agent does. |
Sync key | The unique key that identifies the agent in sync operations. |
Agent form fields
The create form and an existing agent's record use the same fields.
Field | What it holds |
Name | Required text field. Holds the agent's display name. |
Required email field with the placeholder [email protected]. The field is disabled on an existing agent's record. Holds the agent's email address. | |
Password | Required on the create form and optional on an existing agent's record. Sets or updates the agent's password. When you edit an existing agent, you can leave the password blank and still save; the saved password stays unchanged. A password you type must be at least eight characters and include an uppercase letter, a lowercase letter and a digit. |
Description | Optional multi-line text field. Holds a note about what the agent does. |
Agent sync key | Required text field. Holds the unique key that identifies the agent in sync operations. |
Super agent | Optional switch. Marks the agent as a super agent. |
Resource access
The form includes a Resource access section that opens with the instruction Choose which sections this admin can see and manage. The section has Select all and Clear buttons.
Control | What it holds |
Read and write checkboxes | Most sections, such as Products and Orders, have a checkbox under both the read and write headings, while a few, such as Dashboard and Logs, have fewer. |
Selected resources counter | Reports how many of the listed resources are selected. |
Read access decides whether an agent sees a section in the sidebar. Write access decides whether the agent gets create, edit and delete actions in that section. After permissions are saved for an agent, any section that is not granted is denied. The form sends the complete permission set, so clearing a checkbox and saving revokes that access. Saving a change to an existing agent's permissions raises the Employee permissions changed event, which lists the sections granted and revoked.
Record form header and toolbar
Control | What it does |
Heading | On an existing agent's record, the heading shows a Back link followed by the agent's name. |
Save | Save starts unavailable on the create form and on an existing agent's record. After you change a field value, Save becomes available. |
Delete | Appears on an existing agent's record and not on the create form. Deleting an agent removes the account, and it can no longer sign in. |
Related