Menu
Feedback
Start here
Tutorials


VTEX Sales App Offers
5 min read

The new offer area in VTEX Sales App features two main types of offers: specific products or search results. This flexibility allows merchants to adapt their marketing strategies based on their specific needs and goals, promoting individual products or groups of related products.

To customize a store's window display, merchants can add an Offers by store page by specifying the store ID in the Master Data to which the offer will be linked, allowing them to create personalized offers for each store.

In this document, we will provide detailed instructions on how to install, configure, and use the new offer area. Follow the steps below to set up this tool and boost your online sales.

Installing VTEX dependencies

Before installing the dependencies, you must have VTEX IO CLI installed. With VTEX IO CLI installed, execute the following commands in your computer's command prompt to install the necessary dependencies:


  1. vtex login {account}


  2. vtex install vtex.admin-cms@1.x vtex.admin-cms-graphql@0.x vtex.admin-cms-graphql-rc@1.x vtex.admin-releases@0.x vtex.cms-builder-sf-jamstack@1.x

Configuring the Headless CMS app

To create an offer page for VTEX Sales App, follow the steps below:

  1. In the VTEX Admin, go to Apps > App Management, or type App Management in the search bar at the top of the page.
  2. Click the CMS (alpha) item's Settings.
  3. Click Add More.
  4. In the Project ID field, type assisted-sales-app.
  5. In the Sections URL field, type https://instore--instore.vtex.app/assisted-sales/cms/sections.json.
  6. In the Content types URL field, type https://instore--instore.vtex.app/assisted-sales/cms/content-types.json.
  7. Click Save.

Creating an offer page

To create an offer page for VTEX Sales App, follow the steps below:

  1. Access the VTEX Admin URL: https://{main_account}.myvtex.com/admin/new-cms/assisted-sales-app
  2. Click Create New and select Ads.
  3. Click Untitled to edit and include the desired name. We recommend using the name Offers.
  4. In the Sections tab, click the + button to add a new section. Each section is a collection of products or search terms. Each section will be displayed as a carousel. You can reorder custom displays by clicking the Move down or Move up buttons.
  5. Select an offer type, either products or search results.
  • Product custom display: It will display each product and SKU (optional) that you specify. Add the following information: - Custom display title: Name of the custom display that will be displayed on the page. - Product ID: Identifier number of the product you want to display. Required field. - Product SKU ID: Iidentifier number of the product's SKU you want to display. Optional field.
    {"base64":"","img":{"width":590,"height":329,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":42292,"url":"//images.ctfassets.net/alneenqid6w5/6SREOFdog1AfNXqyhH0I5Z/055391c146dbfe153d0161eb1f9af701/image.png"}}
    After completing the fields, the product image will be displayed with the "starting at" price. If you include the SKU, the price and promotion of the indicated SKU will be displayed. You can add more products by clicking + NEW PRODUCT. You can add up to 10 products in each custom display. The result of the product custom display will be displayed as shown in the image below.
    {"base64":"","img":{"width":414,"height":389,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":69403,"url":"//images.ctfassets.net/alneenqid6w5/3SY8POqXIAK0Qi2lWax8qq/f288b81bbd6f3f9e788afdccead5286e/image.png"}}
  • Search results custom display: It will display products from a search result that you define. Add the following information: Custom display title: Name of the custom display that will be displayed on the page.
    • Search image: image that will represent the selection of products in the showcase.
    • Search name: Name of the search that will be displayed on the page.
    • Search term: Search term: Search term that will be used as a reference for the products.
      {"base64":"","img":{"width":629,"height":530,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":74153,"url":"//images.ctfassets.net/alneenqid6w5/2nOoe8dF1IaF1YPIr3N3dV/79a8cc3b08dd79d76d402456e47a62ac/image.png"}}
      When the seller clicks the search term, they will be directed to the search result determined in the Search term. You can also include up to 10 searches in each custom display. See the result in the image below:
      {"base64":"","img":{"width":453,"height":290,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":85198,"url":"//images.ctfassets.net/alneenqid6w5/s6MJ80nGy16Ex39NnPwnT/58073fd76945673090d787622ebcc09a/image.png"}}
  1. After creating the sections, click Save, then click Publish and Publish Now to finalize.

The publication of the custom display will enter the indexing queue and will be published within a few seconds.

  • Collection custom display: It will display products from a specified collection. Please add the following details:
    • Custom display title: Name of the custom display as it will appear on the page.
    • Collection ID: The collection identifier number that will be displayed on the page.

{"base64":"","img":{"width":1306,"height":337,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":14858,"url":"//images.ctfassets.net/alneenqid6w5/4hppMA8Zky77l93af8W6ks/c3f21920a6ac94d53a3097b8a7b3ad72/Vitrine_-_EN.png"}}

Activate the offer menu in VTEX Sales App

Access the technical settings of VTEX Sales App at: https://{main_account}.myvtex.com/admin/portal/#/sites

  1. Click the button.
  2. Select the Code tab.
  3. Select the checkout-instore-custom-js file in the side tab.
    {"base64":"","img":{"width":605,"height":360,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":142099,"url":"//images.ctfassets.net/alneenqid6w5/6JgOUD4YUDyArNzUkgzIVJ/8f4cdc9e643abd06f8b3ef4ecc906040/image.png"}}
  4. In the window.INSTORE_CONFIG object, add the flag enableExplore: true,.
    {"base64":"","img":{"width":376,"height":87,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":13119,"url":"//images.ctfassets.net/alneenqid6w5/6kpTp7g4zRuIsyYGdo5Bio/e2984ba814f55a81a0b4263ff9d1a694/image.png"}}
  5. Click Save.
  6. Optionally, you can set the offer page as the seller's homepage. To do this, add the flag initialPage: 'advertisements', to the window.INSTORE_CONFIG object.
    {"base64":"","img":{"width":327,"height":75,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":13098,"url":"//images.ctfassets.net/alneenqid6w5/1zS4dgPnw7Q0ZP2w0thQdt/57c885204ca51226610e97e88f2e85e4/image.png"}}

Accessing offers in VTEX Sales App

In VTEX Sales App, the seller will can access the offer page in two different ways:

  • Homepage: If the store administrator previously set the offer page as the seller's homepage, upon logging into the platform, the seller will be directed straight to the offer page. This configuration ensures that sellers are always up-to-date with relevant offers and promotions as soon as they access the system.

  • Explore Menu: If the offer page is not set as the seller's homepage, it can still be easily accessed through the Explore menu. To access the offer page, the seller should click the Explore menu. This will directly take the seller to the offer page, where they can view and interact with the available products and promotions.

{"base64":"","img":{"width":226,"height":730,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":94209,"url":"//images.ctfassets.net/alneenqid6w5/3YddBVVXNGJiVWfDK1xUrg/b1924f30b51e02d7c4fa4ca057b162bb/image.png"}}

Contributors
1
Photo of the contributor
+ 1 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Promotions on the Sales App search page
« Previous
VTEX Sales App: Sales Performance
Next »
Contributors
1
Photo of the contributor
+ 1 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