For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Developer
Developer
Search docs
/
Ask AI
Dev Portal
Docs
API Reference
Learn
Community
Changelog
GraphQL
B2B
Types
Objects
CompanyRoleType
OBJECT
Copy page
Fields
id
String
Required
ID of the role
name
String
Optional
Role name
roleType
Integer
Optional
Role type. 1 is predefined, 2 is custom
roleLevel
Integer
Optional
Role level. 1 is store level
permissions
list of optional
CompanyRolePermissionsType
Optional
Permissions of the role
Show 5 fields
Referenced by
Queries
companyRole