> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.icommkt.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# How to integrate with VTEX

# Introduction

Integration with VTEX E-Commerce allows customers' MASTERDATA data to be automatically sent to an ICOMMKT profile, as well as their enrichment based on processed information from the various purchases made by each of them.

* Among this data we can find:

• Last purchase date
• Days since last purchase
• Date of first purchase
• Days since first purchase
• Products purchased in the last 30, 60, 90, 180, 360, 360 + days
• Categories of Products purchased in the last 30, 60, 90, 180, 360, 360 + days
• Number of purchases made in the last 30, 60, 90, 180, 360, 360 + days
• Amount of purchases made in the last 30, 60, 90, 180, 360, 360 + days
• Average amount of purchases made in the last 30, 60, 90, 180, 360, 360 + days
• RFM for purchases made in the last 30, 60, 90, 180, 360, 360 + days
• Discount codes applied in the last 30, 60, 90, 180, 360, 360 + days.
• Latest Purchase Brands
• Last Purchase Categories
• Last Purchase Promo Codes
• RFM_Group 
• RFM_Segment

| Learn more about RFM fields: [What are the RFM_Group and RFM_Segment fields and what are they for?](/en-us/article/what-are-the-rfmgroup-and-rfmsegment-fields-and-what-are-they-for-1ikxu58/)

# Step by step integration

To activate the integration, **User Roles** must previously be generated within the VTEX platform.

1. Inside the VTEX ADMIN
* Access **Account Settings**
* Access **User Roles**

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/vtex-1translated_d6x0jq.jpg)

2. Create a new ICOMMKT_Integration User Role with the following characteristics:

- Permissions:

    a) Add product/OMS/Attribute View Orders (View Order) and (List Orders)

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/view-order-list-orders_eajchh.png)

  b) Add product/ Dynamic Storage/ Attribute Read-only access to data entities (Read Only Documents).

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/vtex-3translated_1u8wa4x.jpg)

c) Add product/Catalog/Attributes:

            * Field list
            * Value field list
            * Category
            * Providers
            * Groups
            * Brands
            * SKU

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/vtex-4translated_qltrbk.jpg)

3. a) Enter **Account Settings** on your Vtex platform

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/1translated_srm2zw.jpg)

b) Select the **Application Keys** option

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/2translated_k8jdn0.jpg)

c) Select the **Add External App Key** button

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/3translated_1wst4nj.jpg)

d) Write the password and click on the **Add roles** button

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/4translated_1nzee7x.jpg)

e) Select the role **Icommkt_Integration** and confirm **Add role**

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/6translated_1y450j8.jpg)

f) You will access the **My passwords** window where you must select the **Generate new** button

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/7translated_fzlvly.jpg)

g) Write the name of the label and click on **Generate**

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/8translated_dszg4x.jpg)

h) These steps will take you to a window where the token is displayed one time only.

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/9translated_1fg2dah.jpg)

i) Share the generated key with the Customer Success team to verify the integration.

| If you have any additional questions about this step, consult the VTEX documentation at the following URL: https://help.vtex.com/es/tutorial/application-keys--2iffYzlvvz4BDMr6WGUtet

4. Configure the integration on the **Icomm** platform

* Go to **Settings** menu
* Enter the **Integrations** option
* Select the **VTEX** option

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/10_cxffug.jpg)

5. Complete the basic data of the account to be synchronized (with your VTEX instance)

* Complete the required fields to sync the integration: **Account, Api Key and Api Token**.

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/image-25translated_131o4jc.jpg)

 * Press the **Verify** button to proceed to the next phase.

||| The "Verify" button will be disabled until all fields have data.

After pressing "Verify", the platform will report whether or not the connection with VTEX could be made.

**Could not connect**

If the platform failed to synchronize the connection, the following message will be displayed:

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/image-26translated_gms8xy.jpg)

**Connection successful**

If Icomm manages to connect with the VTEX platform, the following message will be displayed:

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/image-29translated_1rjipm4.jpg)

6. Configure site and channel data

In case of a successful connection, you will be able to continue configuring the integration.

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/image-30translated_87vxa7.jpg)

* **Sales Channel**: display the list and select the channels available in VTEX or choose the "Select All" option.
* **E-commerce URL**: Complete your website link.

7. Select the ICOMMKT profile in which the data will be stored

You can select an existing profile, or request the creation of a new one through the **NEW PROFILE** button (recommended option).

* When using the **NEW PROFILE** option, the system will request a name.

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/12_9eisci.jpg)

* Once the name is completed, click **OK**

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/13_1ngjtoa.jpg)

• The system will generate the requested profile with the base field structure of **VTEX MASTERDATA**.

![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/14_1v12pse.jpg)
![](https://storage.crisp.chat/users/helpdesk/website/e4b41ef8ae96c800/15_tzb3sa.jpg)

6. To finish, press the **Save** button

The system will display a confirmation message.

|| Note: The dashboard data update occurs every 4 hours, while the processed and enriched data profile is calculated and imported every 24 hours.

| Consult other articles about [Icomm Integrations](https://help.icommkt.com/en-us/category/integrations-1k8i7aa/).