inStore setup

A setup guide to inStore, VTEX's solution that brings the power of e-commerce to your physical store.

Setting up inStore's page and template

In the Portal module you can set up the inStore's template, the customization file and the page path.

To do this, you need to enter the Portal module in VTEX Admin, select the website and click on the gear button, which will redirect you to the settings.

inStore template configuration

  • After clicking the gear button, click the Code tab.
  • On this tab, click the New button, and then click Template.
  • Type instore in the template name and click Create.
  • In the created template, copy and paste the code below:

---

vtex_io:

app_name: checkout-instore

file_path: index.html

---

  • Click Save.

Setting up the checkout-instore-custom.js file

After creating the template, you need to create the checkout-instore-custom.js file.

  • Still in the Code tab, click the New button.
  • Click File.
  • Type checkout-instore-custom.js in the file name and click Create.

This file must be saved empty. Once it's been saved, add the code below to the file and click Save.

window.INSTORE_CONFIG = {

topbarTitle: 'Instore QA'

}

inStore page setup

In order to allow access to inStore, a page needs to be created.

  • Enter the Pages tab.
  • Click New Page.
  • In the Path field, fill in with checkout/instore.
  • In the Template field, fill in with instore.
  • Check the option Require HTTPS.
  • Click Save.
Bullet list icon