VTEX Sales App is one of VTEX's main products for unified commerce operations. It enables your store to provide a true omnichannel experience, integrating your online and physical channels and placing customers at the core of your business.
Before you start using VTEX Sales App, make sure your store meets all the prerequisites.
To use VTEX Sales App, follow the steps below in your main account.
There is no need to install or configure VTEX Sales App on franchise accounts representing physical stores. You should only configure these settings on the main brand account.
Installing VTEX Sales App
The first step is to install VTEX Sales App, available in the VTEX App Store, on the main brand account. To do so, follow these steps:
- Go to the VTEX Sales App page in the VTEX App Store.
- Click on
Get app
. - Enter your VTEX main account name and click
Confirm
. - Click
Place order
. - Click
Go to install page
. You'll be redirected to the VTEX Sales App page in the VTEX Admin. - Click
Install
.
When you install the the VTEX Sales App, the checkout/instore
page and its corresponding 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 on the main account's Default site to simplify ecommerce operations and prevent errors.
To check the default
site, go to Store settings > Storefront > Checkout and click the icon. Make sure the URL contains the word Default, as in this example: https://{{accountName}}.myvtex.com/admin/portal/#/sites/default/
. Alternatively, go to Storefront > Layout > CMS > Sites and channels.
Configuring VTEX Sales App
After installation, configure the basic settings for the VTEX Sales App, as described below.
- In the VTEX Admin, go to Apps > Extensions Hub > App Management, or type App Management in the search bar at the top of the page.
- In the Installed tab, find VTEX Sales App and click Settings
- Click
Advanced
. - Add the store address.
- Add the sales associate.
- Configure the payment methods.
Adding the store address
On the screen for adding a new store, enter the name and full address of the first physical store where the VTEX Sales App will be used. After completing all the fields, click Continue
.
You can add other stores later, if you wish.
Adding a sales associate
In this section, you need to define an email and a name to be used as the sales associate's login credentials. If you want, you can include an identification code for the sales associate. Once defined, click Continue
.
The email entered on this screen can't already be in use in the VTEX Admin. Use sales associate emails without Admin access.
In this step, you'll add only one of your sales associates. After configuring the basic settings, you can add other sales associates.
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 using the toggle switch.
There are two options available:
- Cash: enable this option if you want to accept cash payments.
- Social selling: Enable this option to make all payment methods configured in your ecommerce Checkout available in VTEX Sales App when using the shared cart (Social Selling).
After selecting the desired options, click Continue
.
Configuring payment conditions
After completing the basic settings, configure VTEX Sales App payment conditions in the Payments module. To do this, see the guide Setting up payment methods for VTEX Sales App.
Linking the store product catalog to the storefront
For the physical store catalog to be reflected in VTEX Sales App, you need to configure the binding in the CMS (Layout - Legacy CMS). This configuration links the trade policy to the storefront, ensuring that products will be displayed correctly.
To configure the binding and ensure the store catalog is displayed in VTEX Sales App, follow the steps below:
- In the VTEX Admin, go to Storefront > Layout, or type Layout in the search bar at the top of the page.
- Click CMS and select Sites and channels.
- Select the desired website from the list.
- In the Links section, click the corresponding binding row and then click
Update
. - In the Available Sales Channels section, select the trade policy you want to link to the binding.
- Click
Save Binding
.
Make sure the trade policy is correctly configured in your VTEX Admin before linking it to the binding. This configuration is essential to ensure the store catalog displays correctly in VTEX Sales App.
Configuring logistics
To start using VTEX Sales App, you also need to configure the Logistics settings based on the strategies you want to implement. For more information, see the guides Unified commerce and Logistics.