[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 messages messages graphql api 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.messages/messages-graphql-api/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/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.messages/messages-graphql-api/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/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.messages/messages-graphql-api/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/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.messages/messages-graphql-api/updates/release-notes)

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtexarg.abtester)

[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.abandoned-cart-service)

[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.badges)

[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.broadcaster)

[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.catalog-images)

[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.checkout-ui-custom)

[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.checkout-ui-settings)

[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages)

[Messages GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api)

[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.product-context)

[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtexbr.pickup-selector)

[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.rewriter)

[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.responsive-values)

[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.search-graphql)

[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.session-client)

[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.store-icons)

[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.store-sitemap)

[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.telemarketing)

[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/assembly-options-app)

[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/affiliates-program-app)

---

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

---

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

---

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

---

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

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides)

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

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

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

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

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/troubleshooting)

---

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtexarg.abtester)

[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.abandoned-cart-service)

[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.badges)

[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.broadcaster)

[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.catalog-images)

[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.checkout-ui-custom)

[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.checkout-ui-settings)

[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages)

[Messages GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api)

[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.product-context)

[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtexbr.pickup-selector)

[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.rewriter)

[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.responsive-values)

[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.search-graphql)

[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.session-client)

[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.store-icons)

[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.store-sitemap)

[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.telemarketing)

[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/assembly-options-app)

[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/affiliates-program-app)

---

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

---

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

---

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

---

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

---

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

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

[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages)

Messages GraphQL API

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

Version: 1.71.0

Latest version: 1.71.0

This article serves as a comprehensive reference for the GraphQL API provided by the [Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages). This API enables the internationalization of messages in various store contexts, such as Catalog, Intelligent Search, and VTEX IO apps. For more details about how this API is used, see the [Overwriting the Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app) article.

## Schema overview

### Query

languages

translations

userTranslations

listV2

Languages

supported \[String!\]!

default String!

Translation

lang String!

translation String!

MessageListV2

srcLang String!

groupContext String

context String

translations \[Translation!\]!

Query

languages Languages!

authorize Boolean!

translate(args TranslateArgs!) : \[String\]!

translateWithDependencies(args TranslateWithDependenciesArgs!) : \[String\]!

userTranslations(args IndexedMessages!) : \[MessageListV2\]!

listV2(args ListArgsV2!) : \[MessageListV2!\]!

| Field                         | (argument)                                                       | Type                                                                                | Description |
| ----------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **languages**                 | [Languages](#languages)!                                         | Returns the store's default locale and the list of supported languages. These values are defined in the **Default Language** and **Supported Languages** settings in the [Messages app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages%23settings).                          |             |
| **translate**                 | \[String\]!                                                      | Endpoint that retrieves a list of translated messages from a specific locale in Catalog.                                                                                |             |
| args                          | [TranslateArgs](#translateargs)!                                 | Input for translation requests.                                                                                |             |
| **translateWithDependencies** | \[String\]!                                                      | Retrieves a list of translated messages from a specific locale in a VTEX IO app. The response is a list of MessageListV2, where each element contains a list of messages.                                                                                |             |
| args                          | [TranslateWithDependenciesArgs](#translatewithdependenciesargs)! | Input for translation requests. Similar to TranslateArgs but requires dependency information.                                                                                |             |
| **userTranslations**          | \[[MessageListV2](#messagelistv2)\]!                             | Retrieves user translations. The response is a list of MessageListV2, where each element contains a list of messages from a specific source (CMS, an app, etc.).                                                                                |             |
| args                          | [IndexedMessages](#indexedmessages)!                             | Group of messages by their source language.                                                                                |             |
| **listV2**                    | \[[MessageListV2](#messagelistv2)!\]!                            | Retrieves a subset of all messages stored in VBase. The range argument defines the beginning and the end of the retrieved list. The response is a list of MessageListV2, where each element has a list of messages from a specific source (CMS, an app, etc.).                           |             |
| args                          | [ListArgsV2](#listargsv2)!                                       | Argument used for message pagination.                                                                                |             |
| **authorize**                 | Boolean!                                                         | Handles authorization for requests outside IO using a two-factor [authentication token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens). It works with the **Two Factor URL** [app setting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages%23settings). |             |

### Mutation

Mutation

saveV2(args SaveArgsV2!) : Boolean!

| Field      | (argument)                 | Type                                                                                | Description |
| ---------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **saveV2** | Boolean!                   | Creates or updates custom messages for the specified locale. This applies to translations for Catalog, Intelligent Search, and installed apps. |             |
| args       | [SaveArgsV2](#saveargsv2)! | Input of messages to be saved.                                                                                |             |

## Schema description

> Arguments must be provided by the user. Required fields are marked with an exclamation mark (`!`).

### Languages

| Field         | Type         | Description                                                                                |
| ------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **supported** | \[String!\]! | A list of languages the store supports. Each language is defined by its locale code in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US. If the request to the Messages app has a target language that isn't supported, it will translate to the default language, which is defined by **Supported Languages** in the [app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages%23settings). |
| **default**   | String!      | The default fallback language for the store, defined by its locale code in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US. If the value is \*, all languages will be supported. This is defined by **Default Language** in the [app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages%23settings).                                                                                |

[Query](#query) 🔼

### MessageListV2

| Field            | Type                              | Description                                                                                |
| ---------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **srcLang**      | String!                           | Locale code of the message list source content in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US.                                                                                |
| **groupContext** | String                            | Groups related translations based on their context.Apps: automaticV2.CMS: CMS.Undefined: null.                                                                                |
| **context**      | String                            | Defines the context for the translation. For example:Catalog: ID of the product/brand/category you want to translate, found in the Admin under **Product** \> **Catalog**.Apps: The name of the app in which the message is being overwritten.Intelligent Search: intelligentSearchFacets, which defines the context of VTEX Intelligent Search. |
| **translations** | \[[Translation](#translation)!\]! | List of messages in the context.                                                                                |

[Query](#query) 🔼

[IndexedMessages](#indexedmessages) 🔽

### Translation

| Field           | Type    | Description                                                                                |
| --------------- | ------- | ---------------------------------------------------------------------------------------------------------------------- |
| **lang**        | String! | Message locale code in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US. |
| **translation** | String! | The translated message string.                                                                                |

[MessageListV2](#messagelistv2) 🔼

### IndexedMessages

| Field        | Type                                    | Description                                                                                |
| ------------ | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| **from**     | String!                                 | Source message locale code in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US. |
| **messages** | \[[MessageInputV2](#messageinputv2)!\]! | List of messages to check translations. Each item in the list is a message in MessageInputV2 format.                          |

[Query](#query) 🔼

[TranslateArgs](#translateargs) 🔽

[TranslateWithDependenciesArgs](#translatewithdependenciesargs) 🔽

### ListArgsV2

| Field     | Type                             | Description                                               |
| --------- | -------------------------------- | --------------------------------------------------------- |
| **range** | [MessagesRange](#messagesrange)! | Range indicating the first and last messages in the list. |

[Query](#query) 🔼

### MessageInputV2

| Field        | Type                  | Description                                                                                |
| ------------ | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **content**  | String!               | Source message string.                                                                                |
| **context**  | String                | Provides context for the message. For example:Catalog: ID of the product/brand/category you want to check the translation, found in the Admin under Product > Catalog.Apps: The name of the app in which the message has been overwritten. |
| **behavior** | [Behavior](#behavior) | Defines the translation source. The available options are USER\_ONLY, USER\_AND\_APP, and FULL.                                                                                |

[IndexedMessages](#indexedmessages) 🔼

### MessageSaveInputV2

| Field             | Type    | Description                                                                                |
| ----------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **srcLang**       | String! | Store's locale default code in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US. In the VTEX Intelligent Search context, this variable must be the store's binding default.                                                                                |
| **srcMessage**    | String! | The source message based on its context:Catalog: Source message string.Apps: The ID of your message string declared in the app's messages folder.Intelligent Search: Source message string. Check the list below for the possible values of this variable and their definitions.Category 1: Department.Category 2: Category.Category 3: Subcategory.Price: Price.Promotion: Promotion.New Release: New release.Location: Location.Brand: Brand. |
| **targetMessage** | String! | Catalog: Translated message string.Apps: Translated message string.Intelligent Search: Translated message string.                                                                                |
| **groupContext**  | String  | Groups related translations based on their context.Apps: automaticV2.CMS: CMS.Undefined: null.                                                                                |
| **context**       | String  | Catalog: ID of the product/brand/category you want to translate, found in the Admin under **Product** \> **Catalog**.Apps: The name of the app in which the message is being overwritten.Intelligent Search: intelligentSearchFacets, which defines the context of VTEX Intelligent Search.                                                                                |

[SaveArgsV2](#saveargsv2) 🔽

### MessagesRange

| Field    | Type | Description                         |
| -------- | ---- | ----------------------------------- |
| **from** | Int! | Position of the first list element. |
| **to**   | Int! | Position of the last list element.  |

[ListArgsV2](#listargsv2) 🔼

### SaveArgsV2

| Field         | Type                                            | Description                                                                                |
| ------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| **to**        | String!                                         | Target locale code ([ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php), for example: en-US) for the translation. |
| **messages**  | \[[MessageSaveInputV2](#messagesaveinputv2)!\]! | List of messages to be translated.                                                                                |
| **fireEvent** | Boolean                                         | If true, the request triggers an event. Default: false.                                                                                |

[Mutation](#mutation) 🔼

### TranslateArgs

| Field             | Type                                      | Description                                                                                |
| ----------------- | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| **indexedByFrom** | \[[IndexedMessages](#indexedmessages)!\]! | List of IndexedMessages. Each item in the list has a locale and a corresponding list of messages.                                                    |
| **to**            | String!                                   | Target locale code ([ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php), for example: en-US) for the translation.         |
| **depTree**       | String                                    | The dependency tree in the format "\[{"id": "{context}"}\]". Example: "\[{"id": "[vtex.store-components@3.x](mailto:vtex.store-components@3.x)"}\]". |
| **encoding**      | [Encoding](#encoding)                     | The encoding format for messages sent to the automatic translation service. The available formats are ICU and HANDLEBARS.                            |

[Query](#query) 🔼

### TranslateWithDependenciesArgs

| Field             | Type                                      | Description                                                                                |
| ----------------- | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| **indexedByFrom** | \[[IndexedMessages](#indexedmessages)!\]! | List of IndexedMessages. Each item in the list has a locale and a corresponding list of messages.                                                    |
| **to**            | String!                                   | Target locale code ([ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php), for example: en-US) for the translation.         |
| **depTree**       | String!                                   | The dependency tree in the format "\[{"id": "{context}"}\]". Example: "\[{"id": "[vtex.store-components@3.x](mailto:vtex.store-components@3.x)"}\]". |
| **encoding**      | [Encoding](#encoding)                     | The encoding format for messages sent to the automatic translation service. The available formats are ICU and HANDLEBARS.                            |

[Query](#query) 🔼

### Behavior

| Value              | Description                                                                              |
| ------------------ | ---------------------------------------------------------------------------------------- |
| **USER\_ONLY**     | Only uses translations defined by users, ignoring app and automatic translations.        |
| **USER\_AND\_APP** | Uses both user-defined and app-defined translations, but ignores automatic translations. |
| **FULL**           | Uses all available translation sources.                                                  |

[MessageInputV2](#messageinputv2) 🔼

### Encoding

| Value          | Description                                                                                |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **ICU**        | Use for messages to be encoded in [ICU (International Components for Unicode) format](https://read.calvincode.net/reader?url=https://unicode-org.github.io/icu/userguide/format%5Fparse/messages) through the [ICU MessageFormat Parser](https://read.calvincode.net/reader?url=https://formatjs.github.io/docs/icu-messageformat-parser). |
| **HANDLEBARS** | Use for messages to be encoded in [Handlebars format](https://read.calvincode.net/reader?url=https://handlebarsjs.com/guide/%23installation).                                                                                |

[TranslateArgs](#translateargs) 🔼

[TranslateWithDependenciesArgs](#translatewithdependenciesargs) 🔼

[Messages« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages)[Product ContextNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.product-context)

See also

[Vtex.messagesVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

[Schema overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23schema-overview)

[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23query)[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23mutation)

[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23schema-description)

[Languages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23languages)[MessageListV2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23messagelistv2)[Translation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23translation)[IndexedMessages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23indexedmessages)[ListArgsV2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23listargsv2)[MessageInputV2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23messageinputv2)[MessageSaveInputV2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23messagesaveinputv2)[MessagesRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23messagesrange)[SaveArgsV2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23saveargsv2)[TranslateArgs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23translateargs)[TranslateWithDependenciesArgs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23translatewithdependenciesargs)[Behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23behavior)[Encoding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23encoding)

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 google tag manager 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/google-tag-manager/docs/guides)

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

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

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

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework)

[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-store-theme)

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/getting-started-3)

Concepts

[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-building-pages)

[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-using-components)

[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-using-advanced-layouts)

[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-working-with-site-editor)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-styling)

[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-dealing-with-events)

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

[Installing Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager)

[Setting up Google Tag Manager events and triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager)

[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-setting-up-cross-border-stores)

[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-multi-language-stores)

[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-routing)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/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/google-tag-manager/docs/guides/vtex-io-documentation-semantic-html-migration)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-go-live)

[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/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/google-tag-manager/docs/guides/storefront-best-practices)

---

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

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

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

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

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

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

---

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

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework)

[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-store-theme)

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/getting-started-3)

Concepts

[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-building-pages)

[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-using-components)

[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-using-advanced-layouts)

[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-working-with-site-editor)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-styling)

[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-dealing-with-events)

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

[Installing Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager)

[Setting up Google Tag Manager events and triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager)

[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-setting-up-cross-border-stores)

[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-multi-language-stores)

[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-routing)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/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/google-tag-manager/docs/guides/vtex-io-documentation-semantic-html-migration)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-go-live)

[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/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/google-tag-manager/docs/guides/storefront-best-practices)

---

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

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework)

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

Configuring Analytics (Google Tag Manager)

Discover how to manage Analytics on Store Framework using the Google Tag Manager app.

To manage Analytics on [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework), you need to install the [Google Tag Manager (GTM) app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager), which is a first-party solution that integrates your VTEX account with [Google Tag Manager](https://read.calvincode.net/reader?url=https://tagmanager.google.com), a JavaScript and HTML tag management system provided by Google for tracking user browsing.

The app allows you to manage website tags without accessing the store source code, allowing you to add, edit, or remove tags easily, and provides user browsing tracking for Google Analytics.

> This app is only available for stores built with [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework). For stores built with Legacy CMS Portal, see [Configuring Google Tag Manager](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-setup-google-analytics-in-vtex-store--G2P0rmSrEiqCcmUMyUUwG%23configuring-google-tag-manager).

![{"base64":"  ","img":{"width":1920,"height":1368,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":188718,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/google-tag-manager-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/google-tag-manager-0.png)

[Installing Google Tag ManagerLearn how to install the Google Tag Manager app in your VTEX store.Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager)[Setting up Google Tag ManagerSet up the Google Tag Manager app with variables, triggers, and tags.Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/_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/Storefront-Guides/store-framework-configuring-analytics-google-tag-manager.md)

[Using events to trigger side effects on store components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager//docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components)[Installing Google Tag ManagerNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager//docs/guides/vtex-io-documentation-installing-google-tag-manager)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/_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?

 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/store-framework-configuring-analytics-google-tag-manager.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 io documentation setting up google analytics search tracking 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-setting-up-google-analytics-search-tracking/docs/guides)

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

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/troubleshooting)

---

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

Setting up Google Analytics search tracking

## Introduction

The charts and graphs generated by Google Analytics’ search tracking help retailers analyze user queries, measuring the store’s main searched terms.

To add this tracking tool, you’ll need to ensure that your Analytics is properly configured to translate search URLs into relevant data on user behavior.

Follow the steps below and configure your store’s tracking.

## Instructions

1. Accessing Google Analytics in the desired account, click on **Admin** (gear button) in the lower left corner of your screen.
2. Access **View Settings**.
3. Enable **Site search Tracking** and fill out the **Query parameter** field with `_q,rest`.
4. Enable **Site search categories** and fill out the **Category parameter** field with `_c`.

![{"base64":"  ","img":{"width":784,"height":690,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":72148,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-setting-up-google-analytics-search-tracking-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-setting-up-google-analytics-search-tracking-0.png)

1. Click on **Save**.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/_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/managing-seo/vtex-io-documentation-setting-up-google-analytics-search-tracking.md)

Contributors

1

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

ON THIS PAGE

[Introduction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking%23introduction)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking%23instructions)

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/managing-seo/vtex-io-documentation-setting-up-google-analytics-search-tracking.md)

Copy page

On this page

ON THIS PAGE

[Introduction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking%23introduction)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking%23instructions)

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 receive order notifications on vtex io 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-receive-order-notifications-on-vtex-io/docs/guides)

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

App Development

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

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-getting-started)

---

Project structure

---

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

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/app-development-guides)

[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-service)

[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/calling-commerce-apis-on-vtex-io)

[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-clients)

Handling events

[Receiving Catalog Changes on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-catalog-changes-on-vtex-io)

[Receiving Order Notifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-order-notifications-on-vtex-io)

[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/service-path-patterns)

[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/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/how-to-receive-order-notifications-on-vtex-io/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/how-to-receive-order-notifications-on-vtex-io/docs/guides/node-builder-7x-migration-guide)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/ab-tests)

---

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

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/updates/release-notes)

App Development

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

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-getting-started)

---

Project structure

---

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

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/app-development-guides)

[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-service)

[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/calling-commerce-apis-on-vtex-io)

[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-clients)

Handling events

[Receiving Catalog Changes on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-catalog-changes-on-vtex-io)

[Receiving Order Notifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-order-notifications-on-vtex-io)

[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/service-path-patterns)

[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/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/how-to-receive-order-notifications-on-vtex-io/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/how-to-receive-order-notifications-on-vtex-io/docs/guides/node-builder-7x-migration-guide)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/ab-tests)

---

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

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/app-development)

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/app-development-guides)

Handling events

[Receiving Order Notifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-order-notifications-on-vtex-io)

Receiving Order Notifications

Learn how to receive real-time order status notifications

This guide explains how to receive real-time order status notifications from VTEX using the `vtex.orders-broadcast` app and a sample listener application. By following these steps, you’ll be able to set up a workspace, configure the broadcast app, and start receiving notifications when orders are placed in your store.

## Before you begin

* A VTEX IO account with [workspace permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace).
* [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install) installed.
* Basic familiarity with linking apps on VTEX IO.

## Instructions

1. Choose a workspace on your account that you'll work on. Let's suppose we're using the workspace `oms`.
2. Clone the [Orders Feed Example](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/orders-feed-example) repository to your local environment:
`1
git clone https://github.com/vtex-apps/orders-feed-example
`
3. In your browser, open the Orders Broadcast configuration page: `https://{accountName}.myvtex.com/admin/apps/vtex.orders-broadcast/setup`
4. Change the `Target Workspace` variable to the name of the workspace you have created previously.
5. Now you can link the `vtex.orders-feed-example` app in your desired workspace and receive order status updates.
6. Now, if you finish an order on the account's Store, you'll see the notifications pop up on the console. You can start your development by extracting the listener code from the cloned app and adding it to your application.

> For more information about customizing the listener, check the [example app's README](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/orders-feed-example/blob/master/docs/README.md)

Example running on account `cliqueretire` and workspace `lucis`:

![{"base64":"  ","img":{"width":2880,"height":1658,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":460244,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/how-to-receive-order-notifications-on-vtex-io-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/how-to-receive-order-notifications-on-vtex-io-0.png)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/_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/Getting-Started/back-end-development-guides/how-to-receive-order-notifications-on-vtex-io.md)

[Receiving Catalog Changes on VTEX IO« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io//docs/guides/how-to-receive-catalog-changes-on-vtex-io)[Path patternsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io//docs/guides/service-path-patterns)

Contributors

1

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

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-order-notifications-on-vtex-io%23before-you-begin)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-order-notifications-on-vtex-io%23instructions)

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/how-to-receive-order-notifications-on-vtex-io.md)

Copy page

On this page

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-order-notifications-on-vtex-io%23before-you-begin)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-order-notifications-on-vtex-io%23instructions)

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