Menu
Feedback
Start here
Tutorials
Developer portal

Known Issues
Support Rules
Troubleshooting

Frequently Asked Questions
Announcements
Tutorials
Tutorials
Explore in-depth tutorials for operating your VTEX store.
Tutorials
Checkout
Checkout Settings
Configure template in SmartCheckout
Configure template in SmartCheckout
5 min read

The Portal is used to render Checkout (cart, personal data, address, payment method) and OrderPlaced (buying confirmation screen) screens. In this article it will be presented how to register and configure the resources of the Portal.

The Checkout module in the Admin, displays the sites that are registered for your account. Through it, it is also possible to create a new website, edit and configure information about existing websites.

Each registered site corresponds to a multidomain (if the account has contracted multidomains). For accounts that do not use multidomains, it is not necessary to register more than one site in this module. Learn more at Create a multistore/multidomain.

Creating a new website

  1. In the VTEX Admin, go to Store Settings > Storefront > Checkout, or type Checkout in the search bar at the top of the page.
  2. Click on the New Site button.
  3. Fill in the following fields:

  • Name: enter here the desired name for the site.
  • Store: fill in with the account name, which can be found at Account Settings > Account Management > Accounts > Account name.
  1. Click Save.

Creation of the new website:

{"base64":"  ","img":{"width":878,"height":1291,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":75169,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Checkout/Checkout%20Settings/configure-template-in-smartcheckout-update_1.png"}}

Account Name Access:

{"base64":"  ","img":{"width":1183,"height":1237,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":102588,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Checkout/Checkout%20Settings/configure-template-in-smartcheckout-update_2.png"}}

Editing and configuring website

  1. In the VTEX Admin, go to Store Settings > Storefront > Checkout, or type Checkout in the search bar at the top of the page.
  2. Click on the icon of the desired website.
  3. By accessing the blue options menu located at the top of the page, you can perform the following actions:
    • WebSites: return to the home screen of the registered websites.
    • Edit: edit the "Name" and "Store".
    • Checkout: perform basic settings, such as Shipping Calculation, Google Tag Manager, among others.
    • Orders: set up cancellation and order replacement reasons.
    • Code: display and create website related templates.
    • Pages: display existing pages for the website.

Example of existing sites in the same account:

{"base64":"  ","img":{"width":1281,"height":1281,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":146890,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Checkout/Checkout%20Settings/configure-template-in-smartcheckout-update_3.png"}}

Example of available pages for a website:

{"base64":"  ","img":{"width":1071,"height":402,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":28670,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Checkout/Checkout%20Settings/configure-template-in-smartcheckout-update_4.png"}}

If you want to delete a site, click on the delete button for the desired site, as in the example below:

{"base64":"  ","img":{"width":357,"height":148,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":4683,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Checkout/Checkout%20Settings/configure-template-in-smartcheckout-update_5.png"}}

We'll now have a more in-depth look at the following options menu settings: Code and Checkout, being responsible for configuring the pages checkout and order placed pages.

Configuring Checkout

  1. In the VTEX Admin, go to Store Settings > Storefront > Checkout, or type Checkout in the search bar at the top of the page.
  2. Click on the icon of the desired website.
  3. In the blue options menu at the top of the page, click Checkout and configure the fields below as needed:

  • Website Title: if informed, will be displayed in the title of the cart, checkout and confirmed order pages.
  • Google Tag Manager: enter the ID (in GTM-XXXX format) of your container Google Tag Manager, if you want to use it automatically.
  • Google Maps API Key: the key is used in two situations: when the Delivery function based on geographic coordinates is active or if the option to Pickup in store.
  • Calculation of Delivery Options (Beta and Stable): select whether the freight calculation will be done from the spreadsheet or by geolocation.

{"base64":"  ","img":{"width":971,"height":1263,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":63040,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Checkout/Checkout%20Settings/configure-template-in-smartcheckout-update_6.png"}}

Configure code

  1. In the VTEX Admin, go to Store Settings > Storefront > Checkout, or type Checkout in the search bar at the top of the page.
  2. Click on the icon of the desired website.
  3. In the blue options menu located at the top of the page, click on Code. A menu of Files and Templates will be displayed on the right with all the templates for your site, configured by the system.

Example:

{"base64":"  ","img":{"width":1076,"height":523,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":19944,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Checkout/Checkout%20Settings/configure-template-in-smartcheckout-update_7.png"}}

Configuring templates from the "Code" menu

You can customize the pages of your website, in addition to configuring other functionality through HTML, by accessing the Files and Templates menu.

The HTML code filled in the template corresponds to what will appear on the checkout and order placed pages of your site.

Of the available templates, the only ones that cannot be changed are vtex-checkout and vtex-orderPlaced. These correspond to the native functioning of the platform, rendering the main content of the checkout and order placed pages.

Javascripts included directly in any Portal templates will be ignored by the platform. The reason behind this is that only scripts that originated in Google Tag Manager are accepted by SmartCheckout. aTherefore, whenever you need to customize something (or even to insert specific tags) using javascript, do this through Google Tag Manager.

Examples of how to fill out templates

Below are examples of how the codes present in the checkout-header, checkout-footer, vtex-checkout and vtex-orderPlaced templates can be filled and their corresponding visualization in the website:

  • Template checkout-header and website page header:

{"base64":"  ","img":{"width":1066,"height":594,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":31227,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Checkout/Checkout%20Settings/configure-template-in-smartcheckout-update_8.png"}}

{"base64":"  ","img":{"width":1136,"height":930,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":44417,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Checkout/Checkout%20Settings/configure-template-in-smartcheckout-update_9.png"}}

  • Template checkout-footer and website page footer:

{"base64":"  ","img":{"width":1060,"height":586,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":27548,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Checkout/Checkout%20Settings/configure-template-in-smartcheckout-update_10.png"}}

{"base64":"  ","img":{"width":1144,"height":907,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":45592,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Checkout/Checkout%20Settings/configure-template-in-smartcheckout-update_11.png"}}

  • Template vtex-checkout and cart page at Checkout:

{"base64":"  ","img":{"width":1100,"height":641,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":31563,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Checkout/Checkout%20Settings/configure-template-in-smartcheckout-update_12.png"}}

{"base64":"  ","img":{"width":1017,"height":943,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":74477,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Checkout/Checkout%20Settings/configure-template-in-smartcheckout-update_13.png"}}

  • Template vtex-orderPlaced and confirmed order page:

{"base64":"  ","img":{"width":1187,"height":865,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":42725,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Checkout/Checkout%20Settings/configure-template-in-smartcheckout-update_14.png"}}

{"base64":"  ","img":{"width":1111,"height":1343,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":71688,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Checkout/Checkout%20Settings/configure-template-in-smartcheckout-update_15.png"}}

Multi-domain accounts

Multi-domain accounts can use just one site if no specifics configuration requirements are present. This is possible because, even tough just one site is used, the platform includes a class in the "body" tag, according to the accessed domain. Therefore, applying different layouts to the same site is made simple.

An example of a "body" tag that's inserted according to the accessed domain:

{"base64":"  ","img":{"width":1830,"height":1080,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":319336,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Checkout/Checkout%20Settings/configure-template-in-smartcheckout-update_16.jpg"}}

Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 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