Menu
Feedback
Start here
Tutorials & Solutions
Developers Portal

Known Issues
Support Rules

Frequently Asked Questions
Announcements
Start here
Omnichannel
VTEX Sales App - Getting started and setting upVTEX Sales App - Basic settings
VTEX Sales App - Basic settings
4 min read

VTEX Sales App is one of VTEX's main products for unified commerce operations. It is an app that allows your store to provide a true omnichannel experience, integrating your online and physical channels and placing your customers at the core of the business.

Before you start using VTEX Sales App, make sure your store meets all the prerequisites.

To use VTEX Sales App, you must follow the steps below in your main account.

It is not necessary to install or configure VTEX Sales App on franchise accounts that represent physical stores. The procedure described in this article must be performed only on the main brand account.

Installing VTEX Sales App

The first step is to install the free VTEX Sales App Setup app, available in the VTEX App Store, on the main brand account.

  1. Go to the VTEX Sales App Setup page in the VTEX App Store.
  2. Click on Get app.
  3. Enter your VTEX main account name and click on Confirm.
  4. Click on Close order.
  5. Click on Go to the installation page. You will be redirected to the VTEX Sales App Setup app page in your Admin.
  6. Click on Install.

When installing VTEX Sales App, the checkout/instore page and its respective files (checkout-instore-custom.js and checkout-instore-custom.css) are automatically created on the default site within Checkout. By default, VTEX Sales App should always be used in the default site of the master account to make the ecommerce operation easier and avoid errors.

To check the default site, go to Store Settings > Checkout and click . Check if the URL contains the word default, as in the example: https://{{accountName}}.myvtex.com/admin/portal/#/sites/default/. Another option is to check under Store Settings > CMS > Layout > CMS > Sites and channels.

Configuring VTEX Sales App

After installing, you will configure the basic settings of the VTEX Sales App app in the VTEX Admin of your main account, as follows.

  1. In the VTEX Admin, go to Apps > My Apps, or type My Apps in the search bar at the top of the page.
  2. Find VTEX Sales App and click on Settings.
  3. Click Advanced.
  4. Add the store address.
  5. Add the sales associate's email and name.
  6. Configure the payment methods.

Add the store address

{"base64":"  ","img":{"width":511,"height":615,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":31469,"url":"https://images.ctfassets.net/alneenqid6w5/51ICHIzuWsMAwPCVwQuQoB/071ec5240f968e662badf4e828954072/cadastrar-loja-pt.png"}}

On this screen, enter the name of the first physical store where VTEX Sales App will be used and the full address of the store. After filling out all the fields, click on Confirm.

You can add other stores later, if you wish.

If you choose to Skip this step, a fictitious store will be created for testing purposes.

Adding a sales associate's email and name

{"base64":"  ","img":{"width":277,"height":380,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":32771,"url":"https://images.ctfassets.net/alneenqid6w5/5PvZutdPYWkm7rj4HCrlPC/0316ea7fd74dae942a64e5fdb22f3807/registrar-vendedor-pt.png"}}

You must define an email and a name to be used as a sales associate’s login credentials. When you are ready, click on Confirm.

The email added in this screen cannot be in use on the VTEX platform Admin. Use sales associate emails that do not have Admin access.

In this step, you’ll only add one of your sales associates. After configuring the basic settings, you can add other sales associates.

If you choose to Skip this step, a fictitious sales associate will be created with the email address instorevendedor@gmail.com and the name VTEX Sales App Seller. These credentials are valid for logging in to the VTEX Sales App app and can be used for testing.

Configuring payment methods

The next step is to set up the payment methods you will accept on VTEX Sales App. Enable the desired options using the button, as shown below.

{"base64":"  ","img":{"width":715,"height":498,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":133487,"url":"https://images.ctfassets.net/alneenqid6w5/3kjTg7Y2tUI5UErQBsGc02/5174724afd2987a4b8f578c1d74b87b9/configurar-meios-de-pagamento-pt.gif"}}

There are two options:

  • Cash: enable this option if you want to accept cash payments.
  • Card: if you already have an agreement with an acquirer to receive credit or debit card payments, you can activate it on the acquirer drop-down menu. Otherwise, disable this option for now.

After selecting the desired options, click on Confirm. You will see the following confirmation message:

{"base64":"  ","img":{"width":522,"height":300,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":19036,"url":"https://images.ctfassets.net/alneenqid6w5/nVSjiQuE0EXIYecELJJFQ/79a0d24adb51e7ad68f371afe5ca0491/sucesso-instore-pt.png"}}

Configuring payment conditions

After configuring the basic settings described, you must set up the VTEX Sales App payment terms in the Payments module. To do this, please refer to the guide Setting up payment methods for VTEX Sales App.

Setting up logistics

To start using VTEX Sales App, you also need to configure the Logistics settings according to the strategies you want to implement. For more information, read the guides about Unified commerce and Logistics.

Contributors
1
Photo of the contributor
+ 1 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
Creating franchise accounts
« Previous
Managing physical stores in VTEX Sales App
Next »
Contributors
1
Photo of the contributor
+ 1 contributors
On this page
Still got questions?
Request support from VTEX
For personalized assistance, contact our experts.
Open a support ticket
Ask the community
Find solutions and share ideas in the VTEX community.
Join our community
GithubDevelopers PortalCommunityFeedbackSite Map