[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 documentation docs guidelines 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-documentation-docs-guidelines/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/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-documentation-docs-guidelines/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-documentation-docs-guidelines/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-documentation-docs-guidelines/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-documentation-docs-guidelines/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-documentation-docs-guidelines/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/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/vtex-io-documentation-docs-guidelines/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/vtex-io-documentation-docs-guidelines/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/vtex-io-documentation-docs-guidelines/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/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/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/app-development-guides)

---

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

---

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

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/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/vtex-io-documentation-docs-guidelines/docs/guides/vtex-app-store)

[Becoming a registered VTEX App Store developer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer)

[Developing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-developing-an-app)

[Setting your app's billing model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-setting-your-apps-billing-model)

[Preparing your app for distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-preparing-your-app-distribution)

[Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)

[Using the Docs builder to publish app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/using-the-docs-builder-to-publish-app-documentation)

[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)

[App monetization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-business-guidelines-app-monetization)

[Marketing guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets)

[User Experience guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-design-guidelines)

[Engineering guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines)

[Documentation guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/managing-edition-apps)

---

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

---

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

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

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

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

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

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

---

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

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/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/vtex-io-documentation-docs-guidelines/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/vtex-io-documentation-docs-guidelines/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/vtex-io-documentation-docs-guidelines/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/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/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/app-development-guides)

---

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

---

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

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/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/vtex-io-documentation-docs-guidelines/docs/guides/vtex-app-store)

[Becoming a registered VTEX App Store developer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer)

[Developing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-developing-an-app)

[Setting your app's billing model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-setting-your-apps-billing-model)

[Preparing your app for distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-preparing-your-app-distribution)

[Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)

[Using the Docs builder to publish app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/using-the-docs-builder-to-publish-app-documentation)

[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)

[App monetization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-business-guidelines-app-monetization)

[Marketing guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets)

[User Experience guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-design-guidelines)

[Engineering guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines)

[Documentation guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/managing-edition-apps)

---

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

---

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

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-app-store)

[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)

[Documentation guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines)

Documentation guidelines

Developing and publishing apps on the VTEX App Store requires meticulous documentation to ensure seamless adoption by developers and business users. Follow these best practices to create clear, engaging, and effective documentation for your VTEX apps.

## Identifying your audience

When developing documentation, clearly distinguish between developers and business users. Developers will focus on installation, setup, and other configuration options, while business users need a streamlined understanding of app functionalities and operations.

## Defining the documentation objectives

Envision what users should achieve after reading your documentation. Clearly outline the learning objectives, ensuring that users leave with a comprehensive understanding of your app's capabilities.

## Structuring your documentation

### Title

The title must be concise and memorable. Ensure that it describes the experiences the app represents.

#### Do’s

* Use the app's name as the article title.
* Clearly state the learning objective of the article, preferably with only one verb.
* Capitalize the first letter of each word.

| ✅ Do                    | ❌ Don't                |
| ----------------------- | ---------------------- |
| Availability Subscriber | Availability Subscribe |
| Search Bar              | Search bar             |

#### Don’ts

* Do not use punctuation, such as periods, commas, exclamation points, question marks, semicolons, colons, and underscores.
* Do not use the word _App_.
* Do not include the app version number.

| ✅ Do               | ❌ Don't                    |
| ------------------ | -------------------------- |
| Google Tag Manager | Google Tag Manager v3.5.2. |
| Live Shopping      | Live Shopping app          |

### Introduction

The introduction should summarize your app’s purpose and what the user will learn with the documentation.

* Write a short description of the app.
* Emphasize the end-user benefits.
* Add an image that illustrates the app behavior.
* Use [Callout](#callout) for important notes.

| ✅ Do                                                                                | ❌ Don't                                                                                |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------- |
| The Availability Subscriber component shows the availability subscriber form displayed when a product is unavailable. This component can be imported and used by any VTEX App. | The Availability Subscriber is a First-Party solution and can be imported and used by any VTEX App. |

### (Optional) Before you begin

Before the app’s installation, the user may need to meet some prerequisites. For example, an account or permission in another platform, knowledge of specific web technology, or a development tool like the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).

* Create bullets or checklists to describe the prerequisites.
* Use [Callout](#callout) if applicable.

| ✅ Do                                                                                | ❌ Don't                                              |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------- |
| You need a Google account to use Google Tag Manager. You can use the same account if you already use Google products like Gmail. If you do not have an account for a Google product, create one at [Creating your Google account](https://read.calvincode.net/reader?url=https://support.google.com/accounts/answer/27441?hl=en). | You need a Google account to use Google Tag Manager. |

### Installation

Offer a step-by-step installation guide, utilizing code snippets to enhance user comprehension.

Refer to the _Installation_ section in the [Documentation template](#documentation-template) for an example.

### Configuration

After installation, guide users through configuring the app in their store's theme code or Admin settings. List all essential app settings with detailed step-by-step instructions.

Refer to the _Configuration_ section in the [Documentation template](#documentation-template) for an example.

### (Optional) Customization

If applicable, provide steps for customizing the app. For example, if your app uses CSS handles, provide the CSS handles related to the app and add a table with the available CSS handles. Make sure to add the documentation link for [the instructions to apply CSS customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization).

### (Optional) Contributors

Follow the [All-Contributors specification](https://read.calvincode.net/reader?url=https://github.com/all-contributors/all-contributors) and recognize the people who contributed to your app.

### Callout

If you need to highlight information, use one of the following callout types:

#### Information

Highlights an aspect the user should pay attention to, giving additional information about the subject. However, the lack of awareness of that information will not lead to problems.

`1

> ℹ Information goes here.

`

#### Warning

Applies when the user must pay attention to information to avoid issues or unexpected behaviors. It shows a medium criticality level that leads to problems.

`1

> ⚠ Warning message goes here.

`

#### Danger

Represents the highest criticality level. If the user ignores the information given, this might lead to critical issues, possibly breaking the feature.

`1

> ⛔ Danger message goes here.

`

## Documentation template

A basic documentation template structure with the previously described sections for you to start.

**Documentation template**

`` 1

# {Insert the app's name}

2

3

The `\{insert app's name\}` is responsible for `\{app's purpose\}` so you can `\{job to be done\}`.

4

5

![insert-an-image-preview](/)

6

7

## Before you begin

8

9

You need to have `\{insert what the user needs to have: an account in another platform, CLI, knowledge in another app, etc\}`.

10

11

If you do not have `\{insert what the user needs to have and how it can be done\}`.

12

13

## Installation

14

15

1. [Install](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-installing-an-app) the `\{insert app's name\}` app in the desired VTEX account by running `vtex install \{appVendor\}.\{appName\}` in your terminal.

16

2. Open your store’s Store Theme app directory in your code editor.

17

3. Open your app's `manifest.json file` and add the `\{insert app's name\}` app under the `peerDependencies` field.

18

19

20

 "peerDependencies": {

21

 "vtex.{appName}": "{appVersion}"

22

 }

23

24

25

4. Declare the `\{insert app's name\}` app in the desired template. For example:

26

27

 "store.home": {

28

 "blocks": [

29

 + "{app-name}",

30

 ]

31

 },

32

33

*![insert-an-image-preview](/)*

34

35

## Configuration

36

37

Once you have installed the app, you can `\{describe the app's configuration in the VTEX Admin, for example\}`.

38

39

1. `first step`.

40

2. `Second step`.

41

3. `Third step`.

42

43

## Customization

44

45

To apply CSS customizations to this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization).

46

47

| CSS Handles |

48

| ------------------ |

49

| csshandlesName |

50

| csshandlesName |

51

| csshandlesName |

52

53

## Contributors

54

55

Thanks go to these wonderful people:

56

57

- `\{insert the GitHub username\}`

58

59

This project follows the [all-contributors](https://read.calvincode.net/reader?url=https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome.

 ``

## Related articles

* [App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-homologation-requirements-for-vtex-app-store)
* [Preparing your app for distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-preparing-your-app-distribution)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/_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/Perks/vtex-io-documentation-homologation-requirements-for-vtex-app-store/vtex-io-documentation-docs-guidelines.md)

[Engineering guidelines« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines//docs/guides/vtex-io-documentation-engineering-guidelines)[Edition AppsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines//docs/guides/managing-edition-apps)

Contributors

1

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

ON THIS PAGE

[Identifying your audience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23identifying-your-audience)

[Defining the documentation objectives](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23defining-the-documentation-objectives)

[Structuring your documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23structuring-your-documentation)

[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23title)[Introduction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23introduction)[(Optional) Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23optional-before-you-begin)[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23installation)[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23configuration)[(Optional) Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23optional-customization)[(Optional) Contributors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23optional-contributors)[Callout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23callout)

[Documentation template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23documentation-template)

[Related articles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23related-articles)

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/Perks/vtex-io-documentation-homologation-requirements-for-vtex-app-store/vtex-io-documentation-docs-guidelines.md)

Copy page

On this page

ON THIS PAGE

[Identifying your audience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23identifying-your-audience)

[Defining the documentation objectives](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23defining-the-documentation-objectives)

[Structuring your documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23structuring-your-documentation)

[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23title)[Introduction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23introduction)[(Optional) Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23optional-before-you-begin)[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23installation)[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23configuration)[(Optional) Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23optional-customization)[(Optional) Contributors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23optional-contributors)[Callout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23callout)

[Documentation template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23documentation-template)

[Related articles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23related-articles)

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 gift card integration guide system architecture 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/gift-card-integration-guide-system-architecture/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/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/gift-card-integration-guide-system-architecture/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/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/gift-card-integration-guide-system-architecture/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/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/gift-card-integration-guide-system-architecture/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/getting-started)

---

Integration Guides

[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/erp-integration-guide)

[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/customer-credit-integration-guide)

[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/external-marketplace-integration-guide)

[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/external-seller-integration-guide)

[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide)

[Gift Card system architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture)

[Managing VTEX gift cards](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/managing-vtex-gift-cards)

[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/headless-commerce)

[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/login-integration-guide)

[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/punchout)

[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/sent-offers-integration-guide-connectors)

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/payments-integration-guide)

[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/search-integration-guide)

[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/session-manager)

[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/tax-service-integration-guide)

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/pricing-hub)

[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/recaptcha)

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/getting-started)

---

Integration Guides

[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/erp-integration-guide)

[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/customer-credit-integration-guide)

[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/external-marketplace-integration-guide)

[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/external-seller-integration-guide)

[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide)

[Gift Card system architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture)

[Managing VTEX gift cards](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/managing-vtex-gift-cards)

[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/headless-commerce)

[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/login-integration-guide)

[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/punchout)

[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/sent-offers-integration-guide-connectors)

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/payments-integration-guide)

[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/search-integration-guide)

[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/session-manager)

[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/tax-service-integration-guide)

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/pricing-hub)

[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/recaptcha)

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides)

Integration Guides

[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide)

[Gift Card system architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture)

Gift Card system architecture

Our Gift Card system provides stores with the flexibility to plug in multiple gift card providers and offer these different options to their customers. This is possible thanks to a layer of interaction between gift card providers and the store, which we call **Gift Card Hub**, and the communication standards defined in our **Gift Card Provider Protocol**.

![{"base64":"  ","img":{"width":1327,"height":456,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":24355,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/gift-card-integration-guide-system-architecture-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/gift-card-integration-guide-system-architecture-0.png)

This article presents an overview of this architecture, so you understand its building blocks and how they interact with each other. We will also explain the purpose of the [Gift Card API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23overview) and the [Gift Card Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-api%23overview) and how they should be used.

> If you do not need to integrate an external solution, remember you can [set up and manage gift cards](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/gift-card--tutorials%5F995) natively in your admin panel or using our [Gift Card API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23overview).

## Gift Card Hub

This is the system that provides a layer of interaction between gift card providers and VTEX stores. It is used to manage multiple gift card providers connected to a store, both native and external, using a single interface - the [Gift Card Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-api%23overview).

## Gift Card Provider Protocol

This is the protocol defining the communication standards gift card providers must follow in their integration with Gift Card Hub. The [Gift Card Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol%23overview) section of our API Reference provides details on the eleven endpoints that should be exposed by the middleware connecting the external gift card provider to VTEX.

## VTEX Gift Card Provider

Our native gift card provider is bundled into your VTEX store, and [Gift Card API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23overview) is the implementation of the Gift Card Provider Protocol for it. It can be used to manage VTEX gift cards directly - although Gift Card Hub API provides the same functionality in a more generic abstraction layer.

> The `VtexGiftCard` provider was built from a legacy system, created before our Gift Card system architecture evolved to the Gift Card Hub model. As such, it should not be considered a reference implementation of the Gift Card Provider Protocol.

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/_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/gift-card-integration-guide-system-architecture/_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/Integration-Guides/gift-card-integration-guide/gift-card-integration-guide-system-architecture.md)

[Gift Card« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture//docs/guides/gift-card-integration-guide)[Managing VTEX gift cardsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture//docs/guides/managing-vtex-gift-cards)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/_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/gift-card-integration-guide-system-architecture/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7108339%3Fv%3D4%26w=64%26q=75)](https://github.com/brunoamui)

ON THIS PAGE

[Gift Card Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture%23gift-card-hub)

[Gift Card Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture%23gift-card-provider-protocol)

[VTEX Gift Card Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture%23vtex-gift-card-provider)

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/Integration-Guides/gift-card-integration-guide/gift-card-integration-guide-system-architecture.md)

Copy page

On this page

ON THIS PAGE

[Gift Card Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture%23gift-card-hub)

[Gift Card Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture%23gift-card-provider-protocol)

[VTEX Gift Card Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture%23vtex-gift-card-provider)

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 documentation creating a new custom page 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-documentation-creating-a-new-custom-page/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/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-documentation-creating-a-new-custom-page/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-documentation-creating-a-new-custom-page/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-documentation-creating-a-new-custom-page/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-documentation-creating-a-new-custom-page/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-documentation-creating-a-new-custom-page/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework)

[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-store-theme)

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/getting-started-3)

Concepts

[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-building-pages)

[Building a Product Details Page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-building-a-product-details-page)

[Building a search results page with multiple layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts)

[Creating a Black Friday page from template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template)

[Creating a custom search results page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-custom-search-results-page)

[Creating a new custom page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page)

[Customizing the Header and Footer blocks by page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)

[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-using-components)

[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-using-advanced-layouts)

[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-working-with-site-editor)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-styling)

[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-dealing-with-events)

[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-configuring-analytics-google-tag-manager)

[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-setting-up-cross-border-stores)

[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-multi-language-stores)

[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-routing)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-managing-performance)

[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-semantic-html-migration)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-go-live)

[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-updating-live-stores)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework)

[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-store-theme)

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/getting-started-3)

Concepts

[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-building-pages)

[Building a Product Details Page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-building-a-product-details-page)

[Building a search results page with multiple layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts)

[Creating a Black Friday page from template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template)

[Creating a custom search results page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-custom-search-results-page)

[Creating a new custom page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page)

[Customizing the Header and Footer blocks by page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)

[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-using-components)

[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-using-advanced-layouts)

[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-working-with-site-editor)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-styling)

[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-dealing-with-events)

[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-configuring-analytics-google-tag-manager)

[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-setting-up-cross-border-stores)

[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-multi-language-stores)

[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-routing)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-managing-performance)

[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-semantic-html-migration)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-go-live)

[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-updating-live-stores)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/storefront-best-practices)

---

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/storefront-development)

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework)

[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-building-pages)

[Creating a new custom page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page)

Creating a new custom page

Stores are made up of several different pages, each one having a different layout and content. When creating a store from scratch in VTEX IO, some default pages with predefined URLs are already available to you, such as:

* `store.home` \- Home page
* `store.product`\- Product page
* `store.search` \- Search Results page
* `store.account` \- Client Account page
* `store.login` \- Login page
* `store.orderplaced` \- Order Placed page

> You can manage each page's title and template in the Pages section, within the admin's CMS.

However, you may want to create a new custom page to meet your store's specific needs. In this case, you must create a new URL and template to accompany it.

## Instructions

Follow the steps below and learn how to define a different layout and path for a new store page:

1. Create a new template in your Store Theme.
2. Create your new page's path.
3. Add content to your page.
4. Make your new theme content **publicly available**.

### Creating the new template

A template sets the page layout, so if you want to create a custom page for your store you also will need to create a new template for it.

In order to do so, you first must choose one of three template types to host your new page:

* **Product** \- For pages that must deal with the content of a single product, such as a product details page. Adding any new product automatically generates a new product page.
* **Product collections** \- For pages containing a group of products, such as the Search Result page.
* **Standard** \- For pages with no specific product content. For instance, the Home page.

> Even though `Standard` pages are not directly linked to any specific product, they may display shelves or lists of any chosen group of products. The main difference is that the group of products shown on such a page does not depend on the URL query but only on the setting of the shelf itself.

Let's suppose we are going to create a simple About Us page for a store. At first, the page is not directly connected to any specific product, we should create a custom `Standard` template for it with an image in its left column and a title and text content in its right column:

![{"base64":"  ","img":{"width":2088,"height":928,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":348895,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-creating-a-new-custom-page-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-creating-a-new-custom-page-0.png)

1. In your Store Theme's code, declare a new template within your `blocks` folder or `blocks.jsonc` file.

`1

{

2

 "store.custom#{templatename}": {

3

 "blocks": [

4

 ]

5

 }

6

}

`

1. Fill it out with the blocks that will set the desired layout. For example:

`1

{

2

 "store.custom#{templatename}": {

3

 "blocks": [

4

 "flex-layout.row#about-us"

5

 ]

6

 },

7

 "flex-layout.row#about-us": {

8

 "children": [

9

 "image#about-us",

10

 "flex-layout.col#text-about-us"

11

 ]

12

 },

13

 "flex-layout.col#text-about-us": {

14

 "children": [

15

 "rich-text#about-title",

16

 "rich-text#about-content"

17

 ],

18

 "props": {

19

 "preventVerticalStretch": true

20

 }

21

 },

22

"rich-text#about-title": {

23

 "props": {

24

 "text":

25

 "# About us Title"

26

 }

27

 },

28

 "rich-text#about-content": {

29

 "props": {

30

 "text":

31

 " About us content - Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum"

32

 }

33

 },

34

 "image#about-us": {

35

 "props": {

36

 "src": "https://storecomponents.vteximg.com.br/arquivos/mobile-phone.png",

37

 "maxHeight": "600px"

38

 }

39

 }

40

}

`

For more information, refer to the [Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout) documentation.

### Creating the new page's path

Now that your page layout has been defined in the Store Theme code, the next step is to define the page's path to make the page accessible. You can define it through direct code changes or by using the account's admin.

#### Through code changes

1. In your theme's source code, access the `routes.json` file. It can be found in the `store` folder.
2. There, add a path to the recently created template's JSON:

`1

"store.custom#{templatename}": {

2

 "path": "/{URL}"

3

}

`

1. Save your files.
2. [Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/) the theme to a Development workspace. You will be able to access and see your new page live through your workspace, using the following format: `{workspaceName}--{accountName}.myvtex.com/{pathName}`.

#### Using the account admin

If you prefer to set the new page path using account admin, you must first must [release](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-releasing-a-new-app-version) your changes regarding template creation and [install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) the new version of your Store Theme in a [production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace).

Once your changes are set up in a Production workspace, you will be able to use the admin's CMS to create the page's path:

1. Access the admin's **Pages** section.
2. Click on **Create New**.
3. Choose the desired URL and any created template. For instance, the About Us page template previously created:

![{"base64":"  ","img":{"width":2876,"height":1466,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":229185,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-creating-a-new-custom-page-1.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-creating-a-new-custom-page-1.png)

Notice that a template only sets the page layout. Hence, any new template can be set on any page that accepts templates of the same type as the page itself.

> When editing any content using the CMS section, it's always good to make your changes in a production workspace. Therefore, make sure you are not creating your new custom page in the store's master workspace.

### Adding the content

Your new page now has a custom layout, thanks to the newly created template, and can be accessed thanks to its route creation. The next step is editing its content.

You can define your page content by performing changes directly to your Store Theme app or using the admin's Site Editor. When using this last one, you can browse to your custom page or simply write its URL in the `Page URL` field. For example:

![{"base64":"  ","img":{"width":2876,"height":1524,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":594245,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-creating-a-new-custom-page-2.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-creating-a-new-custom-page-2.png)

### Making your theme content publicly available

If you are happy with the changes to your Store Theme, make your new theme content public. Up until this point, the changes were performed in your development workspace. Access our documentation on [**making your theme content publicly available**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/) and follow the steps detailed there.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/_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/concepts-1/vtex-io-documentation-creating-a-new-custom-page.md)

[Creating a custom search results page« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page//docs/guides/vtex-io-documentation-creating-a-custom-search-results-page)[Customizing the Header and Footer blocks by pageNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page//docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)

Contributors

1

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

ON THIS PAGE

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23instructions)

[Creating the new template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23creating-the-new-template)[Creating the new page's path](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23creating-the-new-pages-path)[Adding the content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23adding-the-content)[Making your theme content publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23making-your-theme-content-publicly-available)

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/concepts-1/vtex-io-documentation-creating-a-new-custom-page.md)

Copy page

On this page

ON THIS PAGE

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23instructions)

[Creating the new template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23creating-the-new-template)[Creating the new page's path](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23creating-the-new-pages-path)[Adding the content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23adding-the-content)[Making your theme content publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23making-your-theme-content-publicly-available)

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=)