Menu
Feedback
Start here
Tutorials
Developer portal

Known Issues
Support Rules
Troubleshooting

Frequently Asked Questions
Announcements
Tutorials
Tutorials
Explore in-depth tutorials for operating your VTEX store.
Tutorials
Account management
Access control
Predefined roles
Predefined roles
12 min read

Roles group License Manager resources, with each resource representing a permission in the VTEX platform.

In this document, are listed the roles that are predefined for new VTEX stores and their respective resources. To access them directly, use the list below.

Learn more about each resource listed in the roles below in License Manager Resources.

Admin - Start page only

This is the basic role that grants access to the home page of the administrative environment. It is the minimum required for a user not to be received with an error message when logging into the administrative environment.

Resource table:

Resource nameProductCategoryDescription
HomepageCatalogAdministrationHome page
Help pageCatalogAdministrationHelp home page

Checkout Admin

Resource table:

Resource nameProductCategoryDescription
Shopping Cart Full AccessCheckoutCheckoutResources
Orders Full AccessCheckoutCheckoutResourcesAccess all orders
Order CancelationCheckoutCheckoutResources

Call center operator

This is a role dedicated to telesales operators, as it grants access to VTEX's telesales features and allows you to view orders.

The Assisted Sales resource causes the user to be automatically redirected to the store's telesales page, which will leave the user logging into an account with this role without access to important features of the administrative menu.

We therefore recommend using two separate accounts (with different emails) for telesales users: one account for the Call center operator role (with the Assisted Sales and View order resources) and another account for carrying out operations in Admin, if necessary.

When creating a role, avoid including call center resources with other resources. Otherwise, the role might not work as expected.

Resource table:

Resource nameProductCategoryDescription
Assisted SalesCatalogTelesalesTelesales features. After the login, the user is redirected to the telesales site www.\{storename\}.com.br/a/telesales. This way, the operator can use telesales features such as navigating the store in the name of the customer.As this feature causes an automatic redirect to the store, the user who logs in an account with this resource in their role will not have access to important resources from Admin.
View orderOMSAcessoOMSAllows users to view orders in OMS.

Finance

Resource table:

Resource nameProductCategoryDescription
UI - Account listLicense ManagerWeb Access Control
View orderOMSAcessoOMSAllows users to view orders in OMS.
View store sales statsOMSAcessoOMSDisplays totalizers within the All Orders section in Orders Management. Displays total sales in addition to orders details.
Invoices ListBillingInvoiceCustomers, billing and finance managers have access. Allows users to view invoices.
Edit Company InformationBillingCompanyOnly billing and finance managers have access. Allows users to edit Company data.
Contracts ListBillingContractsCustomers, billing and finance managers have access. Allows users to view all contracts (active and inactive) for a company.
Display Company infoBillingCompanyCustomers, billing and finance managers have access. Allows users to view Company data.
Contacts ListBillingContactsCustomers, billing and finance managers have access. Allows users to view the list of Contacts that receive email notifications when charges are incurred.
Edit ContactsBillingContactsOnly billing and finance managers have access. Allows users to edit contacts that receive notifications when charges are incurred.
Generate new InvoiceBillingInvoiceOnly billing and finance managers have access. Finance managers can manually incur charges in the invoice through contracts.
Recalc InvoiceBillingInvoiceOnly billing and finance managers have access. Incur new charge with interest.

Finance - Full access

Resource table:

Resource nameProductCategoryDescription
Save accountLicense ManagerService Access ControlSave an account
Get account by identifierLicense ManagerService Access ControlQuery that returns account by identifier, which can be the account id or the account application host.
UI - Account listLicense ManagerWeb Access Control
UI - Edit accountLicense ManagerWeb Access Control
UI - Edit roleLicense ManagerWeb Access Control
View orderOMSAcessoOMSAllows users to view all orders in OMS.
View store sales statsOMSAcessoOMSDisplays totalizers within the All Orders section in Orders Management. Displays total sales in addition to orders details.
Invoices ListBillingInvoiceCustomers, billing and finance managers have access. Allows users to view invoices.
Edit Company InformationBillingCompanyOnly billing and finance managers have access. Allows users to edit Company data.
Contracts ListBillingContractsCustomers, billing and finance managers have access. Allows users to view all contracts (active and inactive) for a company.
Display Company infoBillingCompanyCustomers, billing and finance managers have access. Allows users to view Company data.
Contacts ListBillingContactsCustomers, billing and finance managers have access. Allows users to view the list of Contacts that receive email notifications when charges are incurred.
Edit ContactsBillingContactsOnly billing and finance managers have access. Allows users to edit contacts that receive notifications when charges are incurred.
Generate new InvoiceBillingInvoiceOnly billing and finance managers have access. Finance managers can manually incur charges in the invoice through contracts.
Edit Company's DocumentBillingCompanyOnly billing and finance managers have access. Allows users to edit the Company's document data (company registration number or individual taxpayer registration number), with which the invoice will be generated.
Add AccountBillingCompanyOnly billing and finance managers have access. Allows users to add an account to group other accounts linked to that customer into one billing.
Delete AccountBillingCompanyOnly billing and finance managers have access. Allows users to delete an account associated with a company. Company is the entity created to encompass several accounts from the same store.
Save contractsBillingContractsOnly billing, sales operations/growth and finance managers have access. Allows users to create new contracts.
Cancel Invoice DocumentBillingInvoiceOnly billing and finance managers have access. Cancel fiscal document in municipal administrations; gives the power to cancel a fiscal document even if the invoice has already been generated.
Issue Invoice DocumentBillingInvoiceOnly billing and finance managers have access. Used in specific cases of countries that do not generate fiscal documents automatically, depending on their financial system. In this case, they can be generated manually.
Conciliate InvoiceBillingInvoiceOnly billing and finance managers have access. The default is to automatically mark it as paid, but the customer can pay it outside the system, depending on the negotiation. In this case, the finance manager has the power to manually mark it as paid, conciliating the invoices.
Generate Invoice Overdue without InterestBillingInvoiceOnly billing and finance managers have access. Incur new charge with interest.
Cancel InvoiceBillingInvoiceOnly billing and finance managers have access. Cancel charges in billing; gives the power to cancel invoices even if they have already been generated.
Change payment statusBillingInvoiceOnly billing and finance managers have access. The finance manager has the power to change a company’s payment status, depending on his negotiation with the client.
Recalc InvoiceBillingInvoiceOnly billing and finance managers have access. Incur new charge with interest.
Get Unscrewed Dashboard ChargesBillingDashboardOnly billing and finance managers have access. Access to a dashboard external to Admin, which displays invoices issued at that time, and which accounts are provisioned.
Merge companiesBillingCompanyOnly billing and finance managers have access. Allows the merger between two companies, unifying their billing.
Split companiesBillingCompanyOnly billing and finance managers have access. Allows to split a company into different companies.
Unpaid invoicesBillingInvoiceOnly billing and finance managers have access. The finance manager can manually deselect the payment of a charge if it has not been made or if it has been made incorrectly.
Get AppLogLog AdminVTEX internal use.
Create TableLogLog AdminVTEX internal use.

Sales App - Sales Associate

Sales associates registered in Sales App cannot access the VTEX Admin, only Sales App.

Resource table:

Resource nameProductCategoryDescription
Assisted SalesCatalogTelevendasAfter logging in, the user is redirected to the store (accountname.myvtex.com)
View Payment DataPCI GatewayPayment-ViewPaymentDataRecovers a transaction.
View orderOMSAcessoOMSAllows users to view all orders in OMS.
Cancel orderOMSAcessoOMSAllows users to cancel orders in OMS.

IntegrationProfile - Fulfillment

Resource table:

Resource nameProductCategoryDescription
Place OrdersVTEX FulfilmentFulfilment Resources
Orders DetailVTEX FulfilmentFulfilment Resources

IntegrationProfile - Fulfillment Gateway

Resource table:

Resource nameProductCategoryDescription
Make PaymentsPCI GatewayPayment-MakePaymentsRepresents the payment gateway transactional operations.
View Payment DataPCI GatewayPayment-ViewPaymentDataRecovers a transaction.
Notify paymentOMSAcessoOMSAccess to the button that manually notifies payments to the gateway in the payment area within the order.
View orderOMSAcessoOMSAllows users to view all orders in OMS.
Place OrdersVTEX FulfilmentFulfilment Resources
Orders DetailVTEX FulfilmentFulfilment Resources
Cancel orderOMSAcessoOMSAllows users to cancel orders in OMS.

IntegrationProfile - Fulfillment Gateway GetOrder

Resource table:

Resource nameProductCategoryDescription
Make PaymentsPCI GatewayPayment-MakePaymentsRepresents the payment gateway transactional operations.
View Payment DataPCI GatewayPayment-ViewPaymentDataRecovers a transaction.
View orderOMSAcessoOMSAllows users to view all orders in OMS.
Place OrdersVTEX FulfilmentFulfilment Resources
Orders DetailVTEX FulfilmentFulfilment Resources

IntegrationProfile - Fulfillment Gateway Oms

Resource table:

Resource nameProductCategoryDescription
Make PaymentsPCI GatewayPayment-MakePaymentsRepresents the payment gateway transactional operations.
View Payment DataPCI GatewayPayment-ViewPaymentDataRecovers a transaction.
Change order workflow statusOMSAcessoOMSAllows users to access actions within the workflow to change orders status, through the Actions button in the Workflow
Notify paymentOMSAcessoOMSAccess to the button that manually notifies payments to the gateway in the payment area within the order.
Notify invoiceOMSAcessoOMSAllows users to manually inform invoices and data for tracking in OMS.
View orderOMSAcessoOMSAllows users to view all orders in OMS.
Place OrdersVTEX FulfilmentFulfilment Resources
Orders DetailVTEX FulfilmentFulfilment Resources
Notify refundOMSAcessoOMSAllows users to notify when an accounts receivable invoice is in processing, indicating a journal entry for something that was refunded. Allows the input of a return invoice.
Cancel orderOMSAcessoOMSAllows users to cancel orders in OMS.
Order feed subscriptionOMSAcessoOMSAllows users to subscribe to receive order status updates in the Order Feed.
Change orderOMSAcessoOMSAllows users to register changes in the order (discounts and/or exchanges)
View store sales statsOMSAcessoOMSDisplays totalizers within the All Orders section in Orders Management. Displays total sales in addition to orders details.

IntegrationProfile - Fulfillment Oms

Resource table:

Resource nameProductCategoryDescription
Change order workflow statusOMSAcessoOMSAllows access to actions within the workflow to change order status, through the Actions button in the Workflow
Notify paymentOMSAcessoOMSAccess to the button that manually notifies payments to the gateway in the payment area within the order.
Notify invoiceOMSAcessoOMSAllows users to manually inform invoices and data for tracking in OMS.
View orderOMSAcessoOMSAllows users to view all orders in OMS.
List OrdersOMSAcessoOMSAllows users to list all orders from the given account.
Place OrdersVTEX FulfilmentFulfilment Resources
Orders DetailVTEX FulfilmentFulfilment Resources
Notify refundOMSAcessoOMSAllows users to notify when an accounts receivable invoice is in processing, indicating a journal entry for something that was refunded. Allows the input of a return invoice.
Cancel orderOMSAcessoOMSAllows users to cancel orders in OMS.
Order feed subscriptionOMSAcessoOMSAllows users to subscribe to receive order status updates in the Order Feed.
Change orderOMSAcessoOMSAllows users to register changes in the order (discounts and/or exchanges)
View store sales statsOMSAcessoOMSDisplays totalizers within the All Orders section in Orders Management. Displays total sales in addition to orders details.

IntegrationProfile - OrderSimulation

Resource table:

Resource nameProductCategoryDescription
Orders DetailVTEX FulfilmentFulfilment Resources

Logistics - Full access

Resource table:

Resource nameProductCategoryDescription
Home-pageCatalogAdministrationHome page
Help-pageCatalogAdministrationHelp home page
Logistics full accessLogisticsAccess to LogisticsGives full access to all logistics resources (viewing, creating, editing and canceling settings)
Logistics viewerLogisticsAccess to LogisticsPermission to view the start page of the logistics module.
Logistics inventory full accessLogisticsAccess to LogisticsGives full access to the logistics inventory (viewing, creating, editing and canceling settings).
Logistics inventory read onlyLogisticsAccess to LogisticsAllows users to view the inventory module.
Logistics shipping full accessLogisticsAccess to LogisticsGives full access to all shipping functions of the logistics module (creation, editing and cancelation of settings).
Logistics shipping read onlyLogisticsAccess to Logistics

Logistics - Read only

Resource table:

Resource nameProductCategoryDescription
Logistics viewerLogisticsAccess to LogisticsPermission to view the start page of the logistics module.
Logistics inventory read onlyLogisticsAccess to LogisticsAllows users to view the inventory module.
Logistics shipping read onlyLogisticsAccess to Logisticstest

OMS - Full access

Resource table:

Resource nameProductCategoryDescription
Home-pageCatalogAdministrationHome page
Help-pageCatalogAdministrationHelp home page
Change order workflow statusOMSAccessOMSAllows users to access actions within the workflow to change orders status, through the Actions button in the Workflow
Notify paymentOMSAcessoOMSAccess to the button that manually notifies payments to the gateway in the payment area within the order.
Notify invoiceOMSAcessoOMSAllows users to manually inform invoices and data for tracking in OMS.
View orderOMSAcessoOMSAllows users to view all orders in OMS.
Logistics full accessLogisticsAccess to LogisticsGives full access to all logistics resources (viewing, creating, editing and canceling settings)
Notify refundOMSAcessoOMSAllows users to notify when an accounts receivable invoice is in processing, indicating a journal entry for something that was refunded. Allows the input of a return invoice.
Cancel orderOMSAcessoOMSAllows users to cancel orders in OMS.
Order feed subscriptionOMSAcessoOMSAllows users to subscribe to receive order status updates in the Order Feed.
Change orderOMSAcessoOMSAllows users to register changes in the order (discounts and/or exchanges)
View store sales statsOMSAcessoOMSDisplays totalizers within the All Orders section in Orders Management. Displays total sales in addition to orders details.
Logistics inventory full accessLogisticsAccess to LogisticsGives full access to the logistics inventory (viewing, creating, editing and canceling settings).
Logistics shipping full accessLogisticsAccess to LogisticsGives full access to all shipping functions of the logistics module (creation, editing and cancelation of settings).

OMS - Read only

Resource table:

Resource nameProductCategoryDescription
View orderOMSAcessoOMSAllows users to view all orders in OMS.
View store sales statsOMSAcessoOMSDisplays totalizers within the All Orders section in Orders Management. Displays total sales in addition to orders details.

Seller Manager

Resource table:

Resource nameProductCategoryDescription
View SellerSeller RegisterSeller AdministrationAllows users to view all sellers from an account
Save SellerSeller RegisterSeller AdministrationAllows users to create and edit all sellers from an account

User Administrator - RESTRICTED

Tabela de recursos:

Nome do recursoProdutoCategoriaDescrição
Save userLicense ManagerServices access controlCreate users, add or delete user roles, edit user data, create and edit application keys..

VTEX IO Admin

Resource table:

Resource nameProductCategoryDescription
Get resource by keyLicense ManagerService Access ControlChecks access permissions
Read Workspace AppsVTEX IOInfrastructureAllows reading the apps installed in the workspace and their direct and indirect dependencies.
Link AppVTEX IOInfrastructureAllows listing existing links and linking and unlinking apps.
Install AppVTEX IOInfrastructureAllows users to install and uninstall apps.
Vbase Read OnlyVTEX IOInfrastructureRead-only access to vbase.
Vbase Read WriteVTEX IOInfrastructureRead and write access to vbase.
Read Workspace ServicesVTEX IOInfrastructureAllows reading the infra apps in the workspace.
Install ServiceVTEX IOInfrastructureAllows users to install and uninstall apps
Log Access - Read-onlyVTEX IOInfrastructureAllows reading logs from all applications
Read Published ServiceVTEX IOInfrastructureAllows reading the services data from the infra registry
Debug AppVTEX IOInfrastructureAllows connecting a debugger to a linked app
Workspace CRUDVTEX IOInfrastructureAllows creating, deleting and modifying workspaces
Import RedirectsVTEX IOInfrastructureEnable users to manage redirects with VTEX IO's command line interface
Manage A/B TestVTEX IOA/B TestAllows users to start, finish or get status of an A/B Test
Read logsApplication Logs StreamLogsRead logs from VTEX IO apps owned from this account

VTEX Payment - Account Holder

This role gives full read and write access to VTEX Payment data and should be restricted to users who need to make settings.

VTEX Payment - Bookkeeper

This role allows users to read information about the VTEX Payment operation.

Webservice - Full access

Resource table:

Resource nameProductCategoryDescription
Webservice accessWebServicewebservicePermission to use any SOAP request
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page
Still got questions?
Ask the community
Find solutions and share ideas in the VTEX community.
Join our community
Request support from VTEX
For personalized assistance, contact our experts.
Open a support ticket
GithubDeveloper portalCommunityFeedback