[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] How do I use the VTEX product summary productsummarybrand app? Provide documentation and configuration details.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides/vtex-io-deprecated-apps)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/guides/vtex-io-deprecated-apps)

---

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/vtex-io-apps)

Product Summary Brand

[vtex.product-summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary)

Version: 2.91.0

Latest version: 2.91.0

![{"base64":"  ","img":{"width":73,"height":20,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","url":"https://img.shields.io/badge/-Deprecated-red"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/-Deprecated-red)

> The Product Summary Brand block has been deprecated in favor of the [Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-productbrand) app from the [Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/store-components) collection. Although support for this block is still granted, we strongly recommend updating your store theme with the Product Brand block.

Product Summary Brand is a block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-summary) responsible for rendering the brand of the product.

![{"base64":"  ","img":{"width":2854,"height":1578,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":661337,"url":"https://user-images.githubusercontent.com/52087100/70259346-bb081f80-176c-11ea-84db-5785c45829ce.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/52087100/70259346-bb081f80-176c-11ea-84db-5785c45829ce.png)

## Before you start

Ensure that you have registered [brands](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-brand--QU07yhHoaWcEYseEucOQW) in your store. To do so, follow the [How to register brands](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/registering-brands--tutorials%5F1414) guide.

## Configuration

1. Import the `vtex.product-summary` app to your theme's dependencies in the `manifest.json`:

`1

 "dependencies": {

2

 "vtex.product-summary": "2.x"

3

 }

`

1. Add the `product-summary-brand` block to your store theme as a child of the `product-summary.shelf` block. For example:

`1

 "product-summary.shelf": {

2

 "children": [

3

 "product-summary-image",

4

 "product-summary-name",

5

+ "product-summary-brand",

6

 "product-summary-attachment-list",

7

 "product-summary-space",

8

 "product-summary-column#1"

9

 ]

10

 },

`

See also

[Vtex.product SummaryVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/apps/vtex.product-summary)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

[Before you start](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/apps/vtex.product-summary/productsummarybrand%23before-you-start)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand/docs/apps/vtex.product-summary/productsummarybrand%23configuration)

Was this helpful?

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides configuring dynamic routes in vtex io services in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/app-development-guides)

[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-service)

[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/calling-commerce-apis-on-vtex-io)

[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-clients)

Handling events

[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/service-path-patterns)

[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/configuring-dynamic-routes-in-vtex-io-services)

[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-developing-service-configuration-apps)

[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/node-builder-7x-migration-guide)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/app-development-guides)

[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-service)

[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/calling-commerce-apis-on-vtex-io)

[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-clients)

Handling events

[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/service-path-patterns)

[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/configuring-dynamic-routes-in-vtex-io-services)

[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-developing-service-configuration-apps)

[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/node-builder-7x-migration-guide)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/app-development)

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/app-development-guides)

[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/configuring-dynamic-routes-in-vtex-io-services)

Configuring dynamic routes in VTEX IO services

Learn how to define variable-length paths in your VTEX IO service.

When developing a [VTEX IO service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service), you may need to define a route that supports variable-length paths to handle requests effectively. This necessity arises when your service needs to capture dynamic query parameters from URLs with a variable number of segments.

In this guide, you will learn how to use wildcard notation to configure your [service.json](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate%23nodeservicejson-file) file, addressing the complexities of dynamic URL structures.

> Check out our documentation to learn more about [Service path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns).

## Example use case

As an example, consider you are developing a service that interfaces with the [Get list of products for a query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23get-/product%5Fsearch/-facets-) endpoint.

The `facets` parameter of this API follows the format `/${facetKey1}/${facetValue1}/${facetKey2}/${facetValue2}/.../${facetKeyN}/${facetValueN}`, also allowing general filters such as `price`, `category-${n}`, `productClusterIds`, and `trade-policy`. The expected response lists the active products for a given query. To effectively interact with this API, your service needs to define a path that flexibly accommodates the variable structure of this API.

## Instructions

Follow the steps below to define these variable paths in your service:

### Step 1 - Defining the service routes

1. Open the `service.json` file in the app repository.
2. In `routes`, use `/*path` to define the desired service path.

See how the `service.json` file may be configured to consult the API route mentioned above:

`1

"productSearch": {

2

 "path": "/_v/api/intelligent-search/product_search/*path",

3

 "public": true

4

},

`

> Note that the `*` wildcard notation captures variable-length paths dynamically, allowing the endpoint to handle URLs with diverse structures and query parameters.This wildcard notation signals to the service that the endpoint's path can accommodate any number of segments beyond the specified prefix. For instance, in the configuration `"path"`: `"/_v/api/intelligent-search/product_search/*path"`, the `*/path` segment implies that the endpoint can handle URLs like `/_v/api/intelligent-search/product_search/segment1/segment2/.../segmentN`, where `segment1`, `segment2`, and so forth can vary in number and content.

### Step 2 - Accessing the path value in your route handler function

Open the file where your route handler is defined and use the following structure to access the `path` value:

`1

const {

2

 vtex: {

3

 route: {

4

 params: { path = '' },

5

 },

6

 },

7

} = ctx;

`

If necessary, break down the URL path into separate parts and filter out any empty segments as follows:

`1

const segments = path.split('/').filter(segment => segment !== '');

`

The `split()` method divides the URL path into an array of segments based on the delimiter, which in this case is the forward slash `('/')`. After splitting the URL, the `filter()` method removes empty strings from the array, ensuring that only meaningful URL segments are retained. By decomposing a URL path into manageable segments, these segments can be dynamically parsed and used according to the needs of your service.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/back-end-development-guides/configuring-dynamic-routes-in-vtex-io-services.md)

[Path patterns« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services//docs/guides/service-path-patterns)[Developing service configuration appsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services//docs/guides/vtex-io-documentation-developing-service-configuration-apps)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

ON THIS PAGE

[Example use case](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/configuring-dynamic-routes-in-vtex-io-services%23example-use-case)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/configuring-dynamic-routes-in-vtex-io-services%23instructions)

[Step 1 - Defining the service routes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/configuring-dynamic-routes-in-vtex-io-services%23step-1-defining-the-service-routes)[Step 2 - Accessing the path value in your route handler function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/configuring-dynamic-routes-in-vtex-io-services%23step-2-accessing-the-path-value-in-your-route-handler-function)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/back-end-development-guides/configuring-dynamic-routes-in-vtex-io-services.md)

Copy page

On this page

ON THIS PAGE

[Example use case](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/configuring-dynamic-routes-in-vtex-io-services%23example-use-case)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/configuring-dynamic-routes-in-vtex-io-services%23instructions)

[Step 1 - Defining the service routes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/configuring-dynamic-routes-in-vtex-io-services%23step-1-defining-the-service-routes)[Step 2 - Accessing the path value in your route handler function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuring-dynamic-routes-in-vtex-io-services/docs/guides/configuring-dynamic-routes-in-vtex-io-services%23step-2-accessing-the-path-value-in-your-route-handler-function)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides how to set up functions in the message center templates in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

[Setting up DKIM for transactional emails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/setting-up-dkim-for-transactional-emails)

[Setting up the SPF](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/setting-up-the-spf)

[How to set up functions in the Message Center templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/how-to-set-up-functions-in-the-message-center-templates)

[Including order variables in the transactional email template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/including-order-variables-in-the-transactional-email-template)

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

[Setting up DKIM for transactional emails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/setting-up-dkim-for-transactional-emails)

[Setting up the SPF](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/setting-up-the-spf)

[How to set up functions in the Message Center templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/how-to-set-up-functions-in-the-message-center-templates)

[Including order variables in the transactional email template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/including-order-variables-in-the-transactional-email-template)

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides)

Message Center

[How to set up functions in the Message Center templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/how-to-set-up-functions-in-the-message-center-templates)

How to set up functions in the Message Center templates

The purpose of this article is to present the most used commands and all the functions that can be used to boost your store’s email templates using Message Center.

To configure its templates, Message Center uses a language called Handlebars, with a few commands that make it easy to implement while expanding its customization.

When editing the email template on VTEX Admin, in **Store Settings** \> **Email Templates** \> **Templates**, it is possible to use a range of variables provided by the system. To use these variables in the email layout, you must follow this syntax using Handlebars: `{{class.attribute}}`. The `{{class.attribute}}` is obtained using the JSON Data field.

> Always configure transactional email templates relying on the information retrieved by the [Get Order API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders/-orderId-).

Check out the following example in which the template uses the `HostName` information from the JSON Data:

**HTML email template:**

`1

<strong>{{_accountInfo.HostName}}</strong>

`

**Example JSON Data:**

`1

"_accountInfo": {

2

 "HostName": "lojadosuporte"

3

}

`

**Result**: **lojadosuporte**

![{"base64":"  ","img":{"width":1209,"height":214,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":43685,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/how-to-set-up-functions-in-the-message-center-templates-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/how-to-set-up-functions-in-the-message-center-templates-0.png)

The above example can have different values when comparing Sellers and Marketplaces.

## Functions

The use of the functions follows the syntax `{{function class.attribute}}`.

Consider the following JSON Data example to understand the available functions, described in the table below.

**Example JSON Data:**

`1

"items": [

2

 {

3

 "name": "Product A",

4

 "sellingPrice": 20000,

5

 "priceValidUntil": "2050-05-30T21:00:00Z",

6

 "deliveryTime": "8bd"

7

 },

8

 {

9

 "name": "Product B",

10

 "sellingPrice": 3000,

11

 "priceValidUntil": "2050-09-23T11:00:00Z",

12

 "deliveryTime": "10d"

13

 }

14

]

`

| Function                      | Description                                                                                | Example syntax                                         | Example result      |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ | ------------------- |
| formatCurrency                | Formats a value as currency, separating decimal values with a comma ,.                                                                           | {{formatCurrency items.0.sellingPrice}}                | 200,00              |
| formatUSDCurrency             | Formats a value as currency, separating decimal values with a dot ..                                                                             | {{formatUSDCurrency items.0.sellingPrice}}             | 200.00              |
| formatCurrencyWithoutDecimals | Formats a value as currency without decimal values.                                                                                | {{formatCurrencyWithoutDecimals items.0.sellingPrice}} | 200                 |
| multiplyCurrency              | Formats a value as currency and multiplies it by a number. This function has the following syntax: {{formatCurrency class.attribute multiplier}} | {{formatCurrency items.0.sellingPrice 4}}              | 800,00              |
| formatDate                    | Formats a date as dd/mm/yyyy.                                                                                | {{formatDate items.0.priceValidUntil}}                 | 30/05/2050          |
| formatUSDate                  | Formats a date as mm/dd/yyyy.                                                                                | {{formatUSDate items.0.priceValidUntil}}               | 05/30/2050          |
| formatDateTime                | Formats a date as dd/mm/yyyy hh:mm:ss.                                                                                | {{formatDateTime items.0.priceValidUntil}}             | 30/05/2050 21:00:00 |
| formatDateUtc                 | Formats a date as dd/mm/yyyy mh:mm:ss and converts it to the local UTC                                                                           | {{formatDateUtc items.0.priceValidUntil}}              | 30/05/2050 18:00:00 |
| replace                       | Replaces a given value with another. This function has the following syntax: {{replace class.attribute "previous value" "new value"}}            | {{replace deliveryTime "bd" " business days"}}         | 8 business days     |

> If necessary, you should add currency symbols — such as `$` or `R$` — directly on the template, since they are not automatically retrieved by functions.

## Example

**Handlebars code:**

`1

{{#each items}}

2

{{name}}

3

Entrega{{#each ../shippingData.logisticsInfo}}

4

{{#eq itemId ../id}}

5

{{#each slas}}

6

{{#eq ../selectedSla id}}

7

{{#if deliveryWindow}}

8

agendada entre{{formatDateTime deliveryWindow.startDateUtc}} e {{formatDateTime deliveryWindow.endDateUtc}}

9

{{else}}

10

em até{{#hasSubStr shippingEstimate 'bd'}}

11

{{replace shippingEstimate 'bd' ' dias úteis.'}}

12

{{else}}

13

{{replace shippingEstimate 'd' ' dias.'}}

14

{{/hasSubStr}}

15

{{/if}}

16

{{/eq}}

17

{{/each}}

18

{{/eq}}

19

{{/each}}

20

{{quantity}}x R$ {{formatCurrency sellingPrice}}

21

{{/each}}

`

**Result:**

![{"base64":"  ","img":{"width":585,"height":177,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":25886,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/how-to-set-up-functions-in-the-message-center-templates-1.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/how-to-set-up-functions-in-the-message-center-templates-1.png)

Contributors

5

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F170467615%3Fv%3D4%26w=64%26q=75)](https://github.com/mariananantua)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77300325%3Fv%3D4%26w=64%26q=75)](https://github.com/Isabella-Veloso)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7108339%3Fv%3D4%26w=64%26q=75)](https://github.com/brunoamui)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Message-Center/templates/how-to-set-up-functions-in-the-message-center-templates.md)

[Setting up the SPF« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates//docs/guides/setting-up-the-spf)[Including order variables in the transactional email templateNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates//docs/guides/including-order-variables-in-the-transactional-email-template)

Contributors

5

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F170467615%3Fv%3D4%26w=64%26q=75)](https://github.com/mariananantua)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77300325%3Fv%3D4%26w=64%26q=75)](https://github.com/Isabella-Veloso)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7108339%3Fv%3D4%26w=64%26q=75)](https://github.com/brunoamui)

ON THIS PAGE

[Functions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/how-to-set-up-functions-in-the-message-center-templates%23functions)

[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/how-to-set-up-functions-in-the-message-center-templates%23example)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Message-Center/templates/how-to-set-up-functions-in-the-message-center-templates.md)

Copy page

On this page

ON THIS PAGE

[Functions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/how-to-set-up-functions-in-the-message-center-templates%23functions)

[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-set-up-functions-in-the-message-center-templates/docs/guides/how-to-set-up-functions-in-the-message-center-templates%23example)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides vtex io my authentication in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-my-authentication/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-my-authentication/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-my-authentication/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-my-authentication/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-my-authentication/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-my-authentication/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-my-authentication/updates/release-notes)

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-my-authentication/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-my-authentication/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-my-authentication/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-my-authentication/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-my-authentication/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-my-authentication/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-my-authentication/updates/release-notes)

Styling the My Authentication app

This guide shows the steps to change the appearance of the Authentication tab in My Account using CSS.

> This guide is for stores that use VTEX IO, making the customization through IO apps. If your store is not a VTEX IO store, check the [My Authentication Customization Guide using CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/ui-customization-my-authentication) article. General instructions for customization of IO apps using CSS handles can be found in the article [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization). Below are specific instructions to customize the My Authentication components in the Store Theme.

1. Open the code of the theme app of your store. As an example, the boilerplate code of the VTEX store-theme app can be found [here](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme).
2. Navigate to the `styles\css` folder.
3. Insert or create the css file for My Authentication customization. This file should have the name `vtex.my-authentication.css`.
4. In the css file, insert the code to customize the appearance of the components. The list of CSS handles is found below.
![{"base64":"  ","img":{"width":799,"height":372,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":42956,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-my-authentication-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-my-authentication-0.png)
5. In the root folder of the code of the app, open the `manifest.json` file.
6. Inside `"dependencies"`, insert the property `"vtex.my-authentication": "1.x"`.
![{"base64":"  ","img":{"width":791,"height":455,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":89754,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-my-authentication-1.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-my-authentication-1.png)
7. In a terminal, navigate to the root folder of the code of the app.
8. Run the command `vtex link`. After running this command, the theme app should be updated and the visual components should be as defined in the CSS file.

Below is the list of CSS handles for each UI component in My Authentication.

| CSS Handles                        |
| ---------------------------------- |
| box\_container                     |
| box\_header                        |
| box\_headerSeparator               |
| box\_content                       |
| box\_footer                        |
| errorAlert\_container              |
| warnAlert\_container               |
| authenticationScreen\_container    |
| authenticationScreen\_passBox      |
| newPassInput\_container            |
| passValidation\_container          |
| passValidation\_title              |
| passValidation\_content            |
| passValidation\_minLengthNumber    |
| passValidation\_minLength          |
| passValidation\_number             |
| passValidation\_lowerUpper         |
| passValidation\_lower              |
| passValidation\_upper              |
| passValidation\_iconSuccess        |
| passValidation\_iconFailure        |
| savePassButton\_container          |
| skeletonEditPassword\_content      |
| skeletonEditPassword\_button       |
| currPassInput\_container           |
| createPassword\_text               |
| codeInput\_container               |
| resendCodeButton\_container        |
| maskedPassword\_title              |
| maskedPassword\_content            |
| loginSessionsBox\_title            |
| loginSessionsBox\_content          |
| skeletonLoginSessions\_content     |
| skeletonLoginSessions\_button      |
| loginSessionsScreen\_container     |
| loginSessions\_skeleton            |
| loginSessions\_error               |
| loginSessions\_list                |
| loginSessions\_box                 |
| skeletonLoginSessionsScreen\_title |
| skeletonLoginSessionsScreen\_text1 |
| skeletonLoginSessionsScreen\_text2 |
| loginSession\_currSession          |
| loginSession\_currSessionIcon      |
| loginSession\_currSessionText      |
| loginSession\_device               |
| loginSession\_lastAccess           |
| loginSession\_originDetails        |
| loginSession\_fullAddress          |
| loginSession\_firstAccess          |

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-my-authentication/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/my-account/vtex-io-my-authentication.md)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-my-authentication/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/my-account/vtex-io-my-authentication.md)

Copy page

On this page

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides vtex search autocomplete in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/updates/release-notes)

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/updates/release-notes)

Autocomplete

`Autocomplete` is an alternative for the default VTEX autocomplete. It includes:

* Top Searches.
* Search History.
* Product Suggestions.
* Term Suggestions.

You can read a detailed explanation of Autocomplete and it's features [here](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4gXFsEWjF7QF7UtI2GAvhL).

## Usage

Add `autocomplete-result-list.v2` into the blocks of a `search-bar`. We also recommend to set `openAutocompleteOnFocus` as shown.

`1

{

2

 "autocomplete-result-list.v2": {

3

 "blocks": ["product-summary"]

4

 },

5

 "search-bar": {

6

 "blocks": ["autocomplete-result-list.v2"],

7

 "props": {

8

 "openAutocompleteOnFocus": true

9

 }

10

 }

11

}

`

### Props

| Prop name                     | Type                                            | Description                                                                                | Default value    |
| ----------------------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
| maxTopSearches                | Number                                          | Maximum number of terms in the top searches list                                                                                | 10               |
| maxHistory                    | Number                                          | Maximum number of terms in the search history list                                                                                | 5                |
| maxSuggestedProducts          | Number                                          | Maximum number of suggested products                                                                                | 3                |
| maxSuggestedTerms             | Number                                          | Maximum number of suggested terms                                                                                | 3                |
| autocompleteWidth             | Number                                          | Autocomplete width. Number between 0 and 100                                                                                | \-               |
| productLayout                 | [ProductLayoutEnum](#productlayoutenum)         | Defines the product layout in the suggested products list                                                                                | \-               |
| hideTitles                    | Boolean                                         | If true, all the titles will be hidden                                                                                | false            |
| historyFirst                  | Boolean                                         | If true, the history list will be prioritized                                                                                | false            |
| customBreakpoints             | [CustomBreakpointsProp](#custombreakpointsprop) | Defines a maximum number of suggested products by breakpoints                                                                                | \-               |
| \_\_unstableProductOriginVtex | Boolean                                         | You can use this property as true if any of your product-summary props come with a null value. This is because some product information does not come by default in the Search.                                                                                | false            |
| simulationBehavior            | "skip" or "default"                             | If you want faster searches and do not care about most up to date prices and promotions, use "skip" value.                                                                                | default          |
| customPage                    | string                                          | Defines a custom page to the autocomplete links. Example: store.search.custom                                                                                | store.search     |
| orderBy                       | enum                                            | Determines which order products must follow when displayed. The possible values are named after the sorting type: OrderByReleaseDateDESC, OrderByBestDiscountDESC, OrderByPriceDESC, OrderByPriceASC, OrderByNameASC, OrderByNameDESC, OrderByScoreDESC, or OrderByTopSaleDESC. ASC and DESC stand for ascending order and descending order, respectively. OrderByScoreDESC considers only [relevance settings](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/1qlObWIib6KqgrfX1FCOXS) and is not related to the [Score](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-does-the-score-field-work--1BUZC0mBYEEIUgeQYAKcae) Catalog field, incompatible with VTEX Intelligent Search. The last option (OrderByTopSaleDESC) considers the number of sold units of the product in the past 90 days, taking into account only ecommerce orders (no physical stores orders) from order-placed events (e.g. without checking if the payment was approved). If the store has an app, it is possible to consider the events from the app as long as they are implemented on the store's side, they aren't implemented by default. In case the shopper has an ad-blocking extension or a browser restriction that disables sending events, their navigation will not be counted. | OrderByScoreDESC |

#### ProductLayoutEnum

| Enum name  | Enum value |
| ---------- | ---------- |
| Horizontal | HORIZONTAL |
| Vertical   | VERTICAL   |

#### CustomBreakpointsProp

| Prop name | Type                              | Description                                | Default value |
| --------- | --------------------------------- | ------------------------------------------ | ------------- |
| md        | [BreakpointProp](#breakpointprop) | Defines the options for the md breakpoint  | \-            |
| lg        | [BreakpointProp](#breakpointprop) | Defines the options for the lg breakpoint  | \-            |
| xlg       | [BreakpointProp](#breakpointprop) | Defines the options for the xlg breakpoint | \-            |

#### BreakpointProp

| Prop name            | Type   | Description                                             | Default value |
| -------------------- | ------ | ------------------------------------------------------- | ------------- |
| width                | Number | Minimum width for the breakpoint                        | \-            |
| maxSuggestedProducts | Number | Maximum number of suggested products for the breakpoint | \-            |

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/basic-components/vtex-search-autocomplete.md)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

ON THIS PAGE

[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/docs/guides/vtex-search-autocomplete%23usage)

[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/docs/guides/vtex-search-autocomplete%23props)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/basic-components/vtex-search-autocomplete.md)

Copy page

On this page

ON THIS PAGE

[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/docs/guides/vtex-search-autocomplete%23usage)

[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete/docs/guides/vtex-search-autocomplete%23props)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)