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

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

---

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

---

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

---

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

---

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

---

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

---

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

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

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

Rewriter GraphQL API

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

Version: 1.68.0

Latest version: 1.68.0

This article serves as a comprehensive guide to the GraphQL API provided by the [Rewriter app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter). This API allows managing internal URLs and URL redirects.

Routes stored in the Rewriter commonly have complex paths, since they communicate with other systems and databases. To improve client-side usage and SEO rankings, the Rewriter app has, in the definition of the routes, the standard paths along with canonical (shorter) paths. For instance, the standard path to a product is `/_v/segment/routing/vtex.store@2.x/product/:id/:slug/p`, while the canonical path to a product is `/:slug/p`.

The Rewriter app is responsible for three main types of routes: **product**, **search**, and **navigation** routes.

The first two are first-class entities in Rewriter, meaning Rewriter identifies these routes and directly forwards them to the rendering pipeline.

Navigation routes, in turn, are client-side defined routes related to custom paths and VTEX IO pre-defined templates, such as department, brand, and category routes. These routes can have a canonical path and a search query string.

In Rewriter, navigation routes are identified by the internal type, and routes used to redirect a route from one path to another are identified by the redirect type.

The table below summarizes the classification of routes used in the API.

| Type of route | Description                                                                                |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Internal      | Identifies navigation routes. Its standard path can have segments specifying the communication with other systems such as databases or apps, possibly making them long. It can be associated with a canonical path, omitting some segments, for improved client-side usage and SEO ranking. |
| Redirect      | Navigation route that redirects one path to another. There are various reasons to use a redirect including URL changes, content removal, SEO and navigation improvements, and others.                                                                                |

Rewriter includes functionalities to:

* Create an internal route.
* Create a canonical path related to an internal route.
* Create a redirect route.
* Delete an internal route.
* Delete a canonical path related to an internal route.
* Delete a redirect route.
* Create translated URLs for cross-border stores.

In the following sections are the definitions of endpoints and parameter descriptions of the Rewriter GraphQL API.

## Schema overview

### Query

 Query  version: String [ redirect: ](#redirect) [ QueryRedirect!](#queryredirect) [internal:](#internal) [QueryInternal!](#queryinternal)  QueryRedirect  get(path:String!, locator:[RouteLocator](#routelocator)): [Redirect](#redirect)  listRedirects(limit:Int, next:String): [ListRedirectsResponse!](#listredirectsresponse)  Query: redirect  QueryInternal  get(path:String!, locator:[RouteLocator](#routelocator)): [Internal](#internal)  listInternals(limit:Int, next:String): [ListInternalsResponse!](#listinternalsresponse)  routes(locator:[EntityLocator](#entitylocator)): [\[RoutesByBinding!\]](#routesbybinding)  Query: internal  Redirect  from: String!  to: String!  endDate: String  type: [RedirectTypes!](#redirecttypes)  binding: String!  origin: String  QueryRedirect: get  ListRedirectsResponse  routes: [\[Redirect!\]](#redirect)  next: String  QueryRedirect: listRedirects  Internal  from: String!  declarer: String!  type: String!  id: String!  query: JSON  binding: String!  endDate: String  imagePath: String  imageTitle: String  routesVersion: Float  resolveAs: String  origin: String  disableSitemapEntry: Boolean  QueryInternal: get  ListInternalsResponse  routes: [\[Internal!\]](#internal)  next: String  QueryInternal: listInternals  RoutesByBinding  binding: String!  route: String!  QueryInternal: routes  ListRedirectsResponse: routes  ListInternalsResponse: routes

| Field        | Type                             | Description                                                                                |
| ------------ | -------------------------------- | ------------------------------------------------------------------------------------------------------ |
| **redirect** | [QueryRedirect](#queryredirect)! | Provides _redirect_ routes data.Redirect routes are used to redirect a route from one path to another. |
| **internal** | [QueryInternal](#queryinternal)! | Provides _internal_ routes data.Internal routes are navigation routes.                                 |

### Mutation

Mutation  Mutation [redirect](#redirect) [ MutateRedirect!](#mutateredirect) [internal:](#internal) [ MutateInternal!](#mutateinternal) MutateRedirect  MutateRedirect  save(route: [RedirectInput](#redirectinput)!): [Redirect](#redirect)  saveMany(routes: \[[RedirectInput](#redirectinput)!\]!): Boolean!  delete(path: String! locator: [RouteLocator](#routelocator)): [Redirect](#redirect) deleteMany(paths: \[String!\]! locators: \[[RouteLocator](#routelocator)!\]): Boolean! Mutation:redirectport->MutateRedirect Mutation: redirect MutateInternal  MutateInternal save(route: [InternalInput](#internalinput)!): [Internal](#internal) saveMany(routes: \[[InternalInput](#internalinput)!\]!): Boolean! delete(path: String! locator: [RouteLocator](#routelocator)): [Internal](#internal) deleteMany(paths: \[String!\]! locators: \[[RouteLocator](#routelocator)!\]): Boolean! Mutation:internalport->MutateInternal Mutation: internal  Redirect  from: String!  to: String!  endDate: String  type: [RedirectTypes!](#redirecttypes)  binding: String!  origin: String MutateRedirect:deleteport-Redirect MutateRedirect: delete  Internal  from: String!  declarer: String!  type: String!  id: String!  query: JSON  binding: String!  endDate: String  imagePath: String  imageTitle: String  routesVersion: Float  resolveAs: String  origin: String  disableSitemapEntry: Boolean MutateInternal:saveport-Internal MutateInternal: save MutateInternal:deleteport-Internal MutateInternal: delete MutateRedirect:saveport-Redirect MutateRedirect: save

| Field        | Type                               | Description                                                                                |
| ------------ | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| **redirect** | [MutateRedirect](#mutateredirect)! | Updates or deletes _redirect_ routes data according to the provided arguments.Redirect routes are used to redirect a route from one path to another. |
| **internal** | [MutateInternal](#mutateinternal)! | Updates or deletes _internal_ routes data according to the provided arguments.Internal routes are navigation routes.                                 |

## Schema description

> Arguments must be provided by the user. The exclamation mark `!` indicates that a type cannot be nullable.

### QueryRedirect

| Field             | (argument)                                       | Type                                                                                | Description |
| ----------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
| **get**           | [Redirect](#redirect)                            | Returns information regarding a specific redirect route, given its related _path_ and _locator_.                                                                                |             |
| path              | **String!**                                      | The path of the desired route to fetch data.                                                                                |             |
| locator           | [RouteLocator](#routelocator)                    | The _RouteLocator_ object, containing information about the store locale and route origin.                                                                                |             |
| **listRedirects** | [ListRedirectsResponse](#listredirectsresponse)! | Lists all redirect routes.                                                                                |             |
| limit             | Int                                              | The number of _ListRedirectsResponse_ objects to be displayed at once.                                                                                |             |
| next              | String                                           | The argument used to fetch more internal routes from _ListRedirectsResponse_.It must be empty in the first query and, in the following, filled in with the string previously obtained from the _ListRedirectsResponse_ object. |             |

[Query](#query) 🔼

### QueryInternal

| Field             | (argument)                                       | Type                                                                                | Description |
| ----------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
| **get**           | [Internal](#internal)                            | Returns information regarding a specific internal route, given its related _path_ and _locator_                                                                                |             |
| path              | String!                                          | The path of the desired route to fetch data.                                                                                |             |
| locator           | [RouteLocator](#routelocator)                    | The _RouteLocator_ object, containing information about the store locale and route origin.                                                                                |             |
| **listInternals** | [ListInternalsResponse](#listinternalsresponse)! | Lists all internal routes.                                                                                |             |
| limit             | Int                                              | The number of _ListInternalsResponse_ objects to be displayed at once.                                                                                |             |
| next              | String                                           | The argument used to fetch more internal routes from _ListInternalsResponse_.It must be empty in the first query and, in the following, filled in with the string previously obtained from the _ListInternalsResponse_ object. |             |
| **routes**        | \[[RoutesByBinding](#routesbybinding)!\]         | Lists all internal routes of a specific type (e.g. deparment routes, category routes, etc.) and its related _binding_, which is an identifier for each store locale.                                                           |             |
| locator           | [EntityLocator](#entitylocator)                  | The _EntityLocator_ object, containing information about the entity type of the routes to be listed.                                                                                |             |

[Query](#query) 🔼

### MutateRedirect

| Field          | (argument)                            | Type                                                                                | Description |
| -------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------ | ----------- |
| **save**       | [Redirect](#redirect)                 | Creates or updates a redirect route according to the provided arguments.                               |             |
| route          | [RedirectInput](#redirectinput)!      | The data regarding the redirect route to be created or updated.                                        |             |
| **saveMany**   | Boolean!                              | Creates or updates many redirect routes according to the provided arguments.                           |             |
| routes         | \[[RedirectInput](#redirectinput)!\]! | The data regarding the redirect routes to be created or updated.                                       |             |
| **delete**     | [Redirect](#redirect)                 | Deletes a redirect route according to the provided arguments.                                          |             |
| path           | String!                               | The path of the route to be deleted.                                                                   |             |
| locator        | [RouteLocator](#routelocator)         | The _EntityLocator_ object, containing information about the entity type of the route to be deleted.   |             |
| **deleteMany** | Boolean!                              | Deletes many redirect route according to the provided arguments.                                       |             |
| paths          | \[String!\]!                          | The paths of the routes to be deleted.                                                                 |             |
| locators       | \[[RouteLocator](#routelocator)!\]    | The _EntityLocator_ objects, containing information about the entity type of the routes to be deleted. |             |

[Mutation](#mutation) 🔼

### MutateInternal

| Field          | (argument)                            | Type                                                                                | Description |
| -------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------ | ----------- |
| **save**       | [Internal](#internal)                 | Creates or updates an internal route according to the provided arguments.                              |             |
| route          | [InternalInput](#internalinput)!      | The data regarding the internal route to be created or updated.                                        |             |
| **saveMany**   | Boolean!                              | Creates or updates many internal routes according to the provided arguments.                           |             |
| routes         | \[[InternalInput](#internalinput)!\]! | The data regarding the internal routes to be created or updated.                                       |             |
| **delete**     | [Internal](#internal)                 | Deletes an internal route according to the provided arguments.                                         |             |
| path           | String!                               | The path of the route to be deleted.                                                                   |             |
| locator        | [RouteLocator](#routelocator)         | The _EntityLocator_ object, containing information about the entity type of the route to be deleted.   |             |
| **deleteMany** | Boolean!                              | Deletes many internal routes according to the provided arguments.                                      |             |
| paths          | \[String!\]!                          | The paths of the routes to be deleted.                                                                 |             |
| locators       | \[[RouteLocator](#routelocator)!\]    | The _EntityLocator_ objects, containing information about the entity type of the routes to be deleted. |             |

[Mutation](#mutation) 🔼

### Internal

| Field                   | Type    | Description                                                                                |
| ----------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **from**                | String! | The route path.                                                                                |
| **declarer**            | String! | The app that originally defined the route in a routes.json file. For VTEX IO pre-defined routes, the declarer value is [vtex.store@2.x](mailto:vtex.store@2.x).                                                                                |
| **type**                | String! | The route entity type defined in the declarer app, which can be: department, category, subcategory, brand, etc.                                                                                |
| **id**                  | String! | The entity type id. For example, a deparment id.                                                                                |
| **query**               | JSON    | The query string parameters of a route.                                                                                |
| **binding**             | String! | The id of the _binding_ which the route is available._Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |
| **endDate**             | String  | The date a route stops being valid._Keep in mind: The endDate value for permanent routes is null._                                                                                |
| **imagePath**           | String  |                                                                                |
| **imageTitle**          | String  |                                                                                |
| **routesVersion**       | Float   | The current routes version._Keep in mind: If the routesVersion value is null or different from the current version, the route is not currently available in the store._                                                                                |
| **resolveAs**           | String  | Alias paths of a route, meaning that the route will resolve the paths defined in the resolveAs field _Keep in mind: The resolveAs parameter must always be defined in the catalog's default language._                                                         |
| **origin**              | String  | A string that defines the origin of the route, for example: user-canonical                                                                                |
| **disableSitemapEntry** | Boolean | The boolean value that indicates if a route is included (False) or not (True) in the store's sitemap.                                                                                |

[QueryInternal](#queryinternal) 🔼

[MutateInternal](#mutateinternal) 🔼

[ListInternalsResponse](#listinternalsresponse) 🔼

### ListInternalsResponse

| Field      | Type                       | Description                                                                                |
| ---------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **routes** | \[[Internal](#internal)!\] | Returns the demanded information from the _Internal_ object for each route.                                                                                |
| **next**   | String                     | Returns a string to be used as the _next_ argument of the succeeding _listInternals_ query to fetch more data.When _next_ returns _null_, all data have already been fetched. |

[QueryInternal](#queryinternal) 🔼

### RoutesByBinding

| Field       | Type    | Description                                                                                |
| ----------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **binding** | String! | The id of the _binding_ which the route is available. _Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |
| **route**   | String! | Returns the route path.                                                                                |

[QueryInternal](#queryinternal) 🔼

### Redirect

| Field       | Type                             | Description                                                                                |
| ----------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **from**    | String!                          | The original route path.                                                                                |
| **to**      | String!                          | The route redirect path.                                                                                |
| **endDate** | String                           | The date a redirect route stops being valid. _Keep in mind: The endDate value for permanent routes is null._                                                                                |
| **type**    | [RedirectTypes](#redirecttypes)! | The route type: temporary or permanent.                                                                                |
| **binding** | String!                          | The id of the _binding_ which the route is available. _Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |
| **origin**  | String                           | A string that defines the origin of the route, for example: user-canonical                                                                                |

[QueryRedirect](#queryredirect) 🔼

[MutateRedirect](#mutateredirect) 🔼

### ListRedirectsResponse

| Field      | Type                       | Description                                                                                |
| ---------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **routes** | \[[Redirect](#redirect)!\] | Returns the demanded information from the _Redirect_ object for each route.                                                                                |
| **next**   | String                     | Returns a string to be used as the _next_ argument of the succeeding _listInternals_ query to fetch more data.When _next_ returns _null_, all data have already been fetched. |

[QueryRedirect](#queryredirect) 🔼

### EntityLocator

| Field    | Type    | Description                                                                         |
| -------- | ------- | ----------------------------------------------------------------------------------- |
| **id**   | String! | The entity type id. For example, a deparment id.                                    |
| **type** | String! | The route entity type, which can be: department, category, subcategory, brand , etc |

[QueryInternal](#queryinternal) 🔼

### InternalInput

| Field                   | Type    | Description                                                                                |
| ----------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **from**                | String! | The route path.                                                                                |
| **declarer**            | String! | The app that originally defined the route in a routes.json file. For VTEX IO pre-defined routes, the declarer value is [vtex.store@2.x](mailto:vtex.store@2.x).                                                                                |
| **type**                | String! | The route entity type, which can be: department, category, subcategory, brand , etc                                                                                |
| **id**                  | String! | The entity type id. For example, a deparment id.                                                                                |
| **query**               | JSON    | The query string parameters of a route.                                                                                |
| **binding**             | String  | The id of the _binding_ which the route is available._Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |
| **endDate**             | String  | The date a route stops being valid._Keep in mind: The endDate value for permanent routes is null._                                                                                |
| **imagePath**           | String  |                                                                                |
| **imageTitle**          | String  |                                                                                |
| **resolveAs**           | String  | Alias paths of a route, meaning that the route will resolve the paths defined in the resolveAs field. _Keep in mind: The resolveAs parameter must always be defined in the catalog's default language._                                                        |
| **origin**              | String  | A string that defines the origin of the route, for example: user-canonical                                                                                |
| **disableSitemapEntry** | Boolean | The boolean value that indicates if a route is included (False) or not (True) in the store's sitemap.                                                                                |

[MutateInternal](#mutateinternal) 🔼

### RedirectInput

| Field       | Type                             | Description                                                                                |
| ----------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **from**    | String!                          | The original route path.                                                                                |
| **to**      | String!                          | The route redirect path.                                                                                |
| **endDate** | String                           | The date a route stops being valid._Keep in mind: The endDate value for permanent routes is null._                                                                                |
| **type**    | [RedirectTypes](#redirecttypes)! | The route type: temporary or permanent.                                                                                |
| **binding** | String                           | The id of the _binding_ which the route is available._Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |
| **origin**  | String                           | A string that defines the origin of the route, for example: user-canonical                                                                                |

[MutateRedirect](#mutateredirect) 🔼

### RouteLocator

| Field       | Type    | Description                                                                                |
| ----------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **from**    | String! | The original route path.                                                                                |
| **binding** | String! | The id of the _binding_ which the route is available._Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |

[QueryRedirect](#queryredirect) 🔼

[QueryInternal](#queryinternal) 🔼

[MutateRedirect](#mutateredirect) 🔼

[MutateInternal](#mutateinternal) 🔼

### RedirectTypes

| Value         | |  **PERMANENT** |
| ------------- | ---------------- |
| **TEMPORARY** |                  |

[Redirect](#redirect) 🔼

[RedirectInput](#redirectinput) 🔼

[Rewriter« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter)[Responsive ValuesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.responsive-values)

See also

[Vtex.rewriterVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter)[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.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23schema-overview)

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

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

[QueryRedirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23queryredirect)[QueryInternal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23queryinternal)[MutateRedirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23mutateredirect)[MutateInternal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23mutateinternal)[Internal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23internal)[ListInternalsResponse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23listinternalsresponse)[RoutesByBinding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23routesbybinding)[Redirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23redirect)[ListRedirectsResponse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23listredirectsresponse)[EntityLocator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23entitylocator)[InternalInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23internalinput)[RedirectInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23redirectinput)[RouteLocator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23routelocator)[RedirectTypes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23redirecttypes)

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 faststore organisms payment methods 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/faststore/organisms-payment-methods/docs/guides)

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

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

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

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/components-index)

[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/atoms-overview)

[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/molecules-overview)

[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-overview)

[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-banner-text)

[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-cart-sidebar)

[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-empty-state)

[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-filter-slider)

[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-filter)

[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-hero)

[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-image-gallery)

[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-navbar-slider)

[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-navbar)

[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-newsletter)

[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-out-of-stock)

[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods)

[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-price-range)

[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-product-grid)

[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-product-shelf)

[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-region-modal)

[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-search-input)

[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-shipping-simulation)

[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-slide-over)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides)

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

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

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

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

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/troubleshooting)

---

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

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/components-index)

[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/atoms-overview)

[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/molecules-overview)

[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-overview)

[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-banner-text)

[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-cart-sidebar)

[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-empty-state)

[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-filter-slider)

[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-filter)

[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-hero)

[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-image-gallery)

[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-navbar-slider)

[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-navbar)

[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-newsletter)

[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-out-of-stock)

[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods)

[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-price-range)

[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-product-grid)

[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-product-shelf)

[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-region-modal)

[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-search-input)

[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-shipping-simulation)

[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-slide-over)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/storefront-best-practices)

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/storefront-development)

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/components-index)

[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-overview)

PaymentMethods

Displays the logos of the available payment options in a store.

[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/organisms/PaymentMethods)

The `PaymentMethods` component displays the logos of the available payment options in a store.

Example

Code

### Payment Methods

* Amex
* Visa
* Diners Club
* Mastercard
* Elo Card
* PayPal
* Pix
* Stripe
* GooglePay
* ApplePay

## Usage

### Import the component

`1

import { PaymentMethods } from "@faststore/ui";

`

### Import styles

To apply styles, include the following in your stylesheet:

`1

@import "@faststore/ui/src/components/organisms/PaymentMethods/styles.scss";

`

For details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).

---

## Design tokens

### Title

| Local token                             | Default value/Global token linked |
| --------------------------------------- | --------------------------------- |
| \--fs-payment-methods-title-size        | var(--fs-text-size-body)          |
| \--fs-payment-methods-title-weight      | var(--fs-text-weight-bold)        |
| \--fs-payment-methods-title-line-height | 1.25                              |

### Flags

| Local token                            | Default value/Global token linked |
| -------------------------------------- | --------------------------------- |
| \--fs-payment-methods-flags-row-gap    | var(--fs-spacing-1)               |
| \--fs-payment-methods-flags-margin-top | var(--fs-spacing-3)               |

### Flag

| Local token                              | Default value/Global token linked |
| ---------------------------------------- | --------------------------------- |
| \--fs-payment-methods-flag-width         | var(--fs-spacing-5)               |
| \--fs-payment-methods-flag-height        | var(--fs-spacing-4)               |
| \--fs-payment-methods-flag-bkg-color     | var(--fs-color-neutral-0)         |
| \--fs-payment-methods-flag-border-width  | var(--fs-border-width)            |
| \--fs-payment-methods-flag-border-color  | var(--fs-color-neutral-3)         |
| \--fs-payment-methods-flag-border-radius | var(--fs-border-radius-small)     |

---

## Data attributes

You can target and override `PaymentMethods` styles using the following data attributes:`data-fs-payment-methods`

`data-fs-payment-methods-title`

`data-fs-payment-methods-flags`

`data-fs-payment-methods-flag`

---

## Props

| Name           | Type             | Description                                                                                | Default            |    |                          |                             |                     |             |                                                                                |
| -------------- | ---------------- | -------------------------------------------------------------------------------------------- | ------------------ | -- | ------------------------ | --------------------------- | ------------------- | ----------- | --------------------------------------------------------------------------------- |
| **testId**     | string           | ID to find this component in testing tools (e.g.: cypress, testing-library, and jest).       | fs-payment-methods |    |                          |                             |                     |             |                                                                                |
| **title**      | string \| number | false                                                                                | true               | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Title of the payment methods section (e.g.: "Payment methods", "Accepted Cards"). |
| **aria-label** | string           | Defines a string value that labels the current element when title is not used.               |                    |    |                          |                             |                     |             |                                                                                |
| **flagList\*** | Flag\[\]         | List of flags to be displayed in the payment methods section (e.g.:, visa, mastercard, etc). |                    |    |                          |                             |                     |             |                                                                                |

## Flag

| Name     | Type             | Description                                                               | Default |
| -------- | ---------------- | ------------------------------------------------------------------------- | ------- |
| **icon** | { icon: string } | An object with the icon name to display the flag image.                   |         |
| **alt**  | string           | Description of the flag image to be also used for accessibility purposes. |         |

Contributors

3

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

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/_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/faststore/organisms-payment-methods/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F62757720%3Fv%3D4%26w=64%26q=75)](https://github.com/aliceoq)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/organisms/payment-methods.mdx)

[OutOfStock« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-out-of-stock)[PriceRangeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-price-range)

Contributors

3

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

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/_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/faststore/organisms-payment-methods/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F62757720%3Fv%3D4%26w=64%26q=75)](https://github.com/aliceoq)

ON THIS PAGE

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

[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23import-styles)

[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23design-tokens)

[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23title)[Flags](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23flags)[Flag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23flag)

[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23data-attributes)

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

[Flag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23flag)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/organisms/payment-methods.mdx)

Copy page

On this page

ON THIS PAGE

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

[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23import-styles)

[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23design-tokens)

[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23title)[Flags](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23flags)[Flag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23flag)

[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23data-attributes)

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

[Flag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23flag)

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 what is 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/vtex-io-documentation-what-is-vtex-io/docs/guides)

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

App Development

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

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-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/vtex-io-documentation-what-is-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/vtex-io-documentation-what-is-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/vtex-io-documentation-what-is-vtex-io/docs/guides/app-development-guides)

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

---

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

App Development

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

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-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/vtex-io-documentation-what-is-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/vtex-io-documentation-what-is-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/vtex-io-documentation-what-is-vtex-io/docs/guides/app-development-guides)

---

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

---

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

---

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

---

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

---

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

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/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-what-is-vtex-io/docs/app-development)

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

What is VTEX IO

VTEX IO is a low-code development platform designed to handle performance, scalability, and security requirements in enterprise applications. By managing infrastructure complexities, VTEX IO enables developers to concentrate on application logic and business-specific needs.

The platform supports a wide range of use cases, such as web storefronts, custom admin applications, and backend integrations.

## Cloud-native infrastructure

VTEX IO provides a cloud-native environment optimized for scalability and high availability, minimizing manual infrastructure management.

* **Automatic scaling:** Resources are dynamically adjusted based on traffic demands, maintaining uptime and performance even during peak usage without requiring pre-scaling.
* **VTEX IO Command-line interface (CLI):** The VTEX IO CLI enables fast setup and configuration, allowing developers to synchronize code with the cloud environment quickly and efficiently.
* **Continuous deployment:** Code changes in the local environment are automatically synced and deployed to the cloud, ensuring a consistent development and production environment.

## Workspaces

The [workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace) functionality on VTEX IO provides isolated environments, allowing teams to develop, test, and deploy code safely without impacting the live environment.

* **Version control:** Multiple workspaces allow developers to maintain and test separate code versions. Each workspace can be deployed independently to evaluate changes.
* **Testing and monitoring:** Workspaces support A/B testing and enable real-time performance tracking, allowing teams to measure the impact of updates and optimize them accordingly.

## Supported frameworks and technologies

VTEX IO incorporates an opinionated set of frameworks supported by [VTEX IO Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders) to facilitate development with familiar tools.

Supported frameworks include [TypeScript](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/), [React](https://read.calvincode.net/reader?url=https://react.dev/), [GraphQL](https://read.calvincode.net/reader?url=https://graphql.org/), [.NET](https://read.calvincode.net/reader?url=https://dotnet.microsoft.com/en-us/), and [Node](https://read.calvincode.net/reader?url=https://nodejs.org/en).

### VTEX IO Store Framework

For teams specifically focused on building and maintaining storefronts, VTEX IO offers the [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework). This framework provides foundational tools and components, making it easy to create dynamic and customized ecommerce experiences.

* **React-based store blocks:** The Store Framework offers pre-built, customizable React [blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps), which simplify the process of developing and updating storefront layouts and features.
* **Consistent architecture:** Designed to integrate seamlessly with other VTEX services, the Store Framework ensures stable, scalable storefronts that align with VTEX’s core capabilities, supporting efficient and robust ecommerce solutions.

For further technical information, see the [VTEX IO Frequently Asked Questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions) to explore detailed use cases and platform-specific guidance.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-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/vtex-io-documentation-what-is-vtex-io.md)

[What is a VTEX AppNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io//docs/guides/vtex-io-documentation-what-is-a-vtex-app)

Contributors

1

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

[Cloud-native infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io%23cloud-native-infrastructure)

[Workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io%23workspaces)

[Supported frameworks and technologies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io%23supported-frameworks-and-technologies)

[VTEX IO Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io%23vtex-io-store-framework)

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/vtex-io-documentation-what-is-vtex-io.md)

Copy page

On this page

ON THIS PAGE

[Cloud-native infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io%23cloud-native-infrastructure)

[Workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io%23workspaces)

[Supported frameworks and technologies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io%23supported-frameworks-and-technologies)

[VTEX IO Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io%23vtex-io-store-framework)

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