Skip to main content

RoleTypeEnum

All available role types.

enum RoleTypeEnum {
  ACCOUNT_MANAGER
  API_CLIENT_L1
  API_ORDERS
  BRAND_OPERATOR
  COMPANY_ADMIN
  COMPANY_OPERATOR
  FULFILLMENT_INTEGRATION
  GUEST_USER
  LOB_ADMIN
  ORDERS_RECEIVER
  ORDERS_SHIPPER
  PRODUCTS_EXPORTER
  PRODUCTS_IMPORTER
  SALES_INTEGRATION
  SUPPORT_ADMIN
  SYSTEM_ADMIN
  SYSTEM_COMPANY
  WMS_INTEGRATION
}

Values

`RoleTypeEnum.ACCOUNT_MANAGER`

An account manager

`RoleTypeEnum.API_CLIENT_L1`

A role for API clients with limited level 1

`RoleTypeEnum.API_ORDERS`

A role for API clients with access to the orders scope

`RoleTypeEnum.BRAND_OPERATOR`

A brand operator

`RoleTypeEnum.COMPANY_ADMIN`

A company administrator

`RoleTypeEnum.COMPANY_OPERATOR`

Read and write access to operational activities like editing products, processing orders and creating purchase orders. Read only access to company settings like integrations, sales channels, automations etc.

`RoleTypeEnum.FULFILLMENT_INTEGRATION`

A role for custom fulfillment integrations that allows API access to manage fulfillments and inventory.

`RoleTypeEnum.GUEST_USER`

Read only access to a specific company.

`RoleTypeEnum.LOB_ADMIN`

A line of business administrator

`RoleTypeEnum.ORDERS_RECEIVER`

An integration order receiver

`RoleTypeEnum.ORDERS_SHIPPER`

A role to handle orders shipping

`RoleTypeEnum.PRODUCTS_EXPORTER`

A role for integrations. Allow integrations to export products data to external systems

`RoleTypeEnum.PRODUCTS_IMPORTER`

The role to allow integrations to import products from external systems

`RoleTypeEnum.SALES_INTEGRATION`

A role for custom sales integrations that allows API access to creating orders and retreiving inventory

`RoleTypeEnum.SUPPORT_ADMIN`

Read and write access to all companies in the system. No access to system wide tools like creating API clients.

`RoleTypeEnum.SYSTEM_ADMIN`

A system administrator

`RoleTypeEnum.SYSTEM_COMPANY`

Allows the system to perform a controlled set of operations on its own behalf, such as automation operations

`RoleTypeEnum.WMS_INTEGRATION`

A role for an out of the box integration to an external WMS

Member Of

allowedRoles query ● AssignRoleInput input ● ConnectIntegrationInput input ● Role object ● RoleType object ● SetupIntegrationInput input ● UpdateApiClientInput input ● UserRoleInput input

Values
Member Of