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
Step by step integration
To activate the integration, User Roles must previously be generated within the VTEX platform.
- Inside the VTEX ADMIN
- Access Account Settings
- Access User Roles
- Create a new ICOMMKT_Integration User Role with the following characteristics:
- Permissions:
a) Add product/OMS/Attribute View Orders (View Order) and (List Orders)
b) Add product/ Dynamic Storage/ Attribute Read-only access to data entities (Read Only Documents).
c) Add product/Catalog/Attributes:
- Field list
- Value field list
- Category
- Providers
- Groups
- Brands
- SKU
- a) Enter Account Settings on your Vtex platform
b) Select the Application Keys option
c) Select the Add External App Key button
d) Write the password and click on the Add roles button
e) Select the role Icommkt_Integration and confirm Add role
f) You will access the My passwords window where you must select the Generate new button
g) Write the name of the label and click on Generate
h) These steps will take you to a window where the token is displayed one time only.
i) Share the generated key with the Customer Success team to verify the integration.
- Configure the integration on the Icomm platform
- Go to Settings menu
- Enter the Integrations option
- Select the VTEX option
- 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.
- Press the Verify button to proceed to the next phase.
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:
Connection successful
If Icomm manages to connect with the VTEX platform, the following message will be displayed:
- Configure site and channel data
In case of a successful connection, you will be able to continue configuring the integration.
- 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.
- 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.
- Once the name is completed, click OK
• The system will generate the requested profile with the base field structure of VTEX MASTERDATA.
- To finish, press the Save button
The system will display a confirmation message.
Updated on: 07/24/2024
Thank you!