id
stringlengths 12
53
| messages
listlengths 3
3
|
|---|---|
code_admin-vbase-example_9c736208
|
[
{
"role": "system",
"content": "You are an expert VTEX IO developer. You specialize in building VTEX Store Framework apps, React components, GraphQL APIs, and Node.js services for e-commerce platforms."
},
{
"role": "user",
"content": "Show me the implementation of admin-vbase-example/node/service.json from the admin-vbase-example VTEX app."
},
{
"role": "assistant",
"content": "Here's the implementation:\n\n```json\n{\n \"memory\": 256,\n \"ttl\": 10,\n \"timeout\": 2,\n \"minReplicas\": 2,\n \"maxReplicas\": 4,\n \"workers\": 1\n}\n\n```"
}
] |
code_admin-vbase-example_9c48f0ef
|
[
{
"role": "system",
"content": "You are an expert VTEX IO developer. You specialize in building VTEX Store Framework apps, React components, GraphQL APIs, and Node.js services for e-commerce platforms."
},
{
"role": "user",
"content": "Show me the implementation of admin-vbase-example/node/package.json from the admin-vbase-example VTEX app."
},
{
"role": "assistant",
"content": "Here's the implementation:\n\n```json\n{\n \"dependencies\": {\n \"co-body\": \"^6.0.0\",\n \"ramda\": \"^0.25.0\"\n },\n \"devDependencies\": {\n \"@types/co-body\": \"^0.0.3\",\n \"@types/jest\": \"^24.0.18\",\n \"@types/node\": \"^12.0.0\",\n \"@types/ramda\": \"types/npm-ramda#dist\",\n \"@vtex/api\": \"6.36.3\",\n \"@vtex/test-tools\": \"^1.0.0\",\n \"tslint\": \"^5.14.0\",\n \"tslint-config-vtex\": \"^2.1.0\",\n \"typescript\": \"3.9.7\"\n },\n \"scripts\": {\n \"lint\": \"tsc --noEmit --pretty && tslint -c tslint.json --fix './**/*.ts'\"\n },\n \"version\": \"0.0.2\"\n}\n\n```"
}
] |
code_admin-vbase-example_8d10605c
|
[
{
"role": "system",
"content": "You are an expert VTEX IO developer. You specialize in building VTEX Store Framework apps, React components, GraphQL APIs, and Node.js services for e-commerce platforms."
},
{
"role": "user",
"content": "Show me the implementation of admin-vbase-example/node/index.ts from the admin-vbase-example VTEX app."
},
{
"role": "assistant",
"content": "Here's the implementation:\n\n```typescript\nimport {\n ClientsConfig,\n LRUCache,\n Service,\n ServiceContext,\n ParamsContext,\n RecorderState,\n} from '@vtex/api'\n\nimport { Clients } from './clients'\nimport { queries, mutations } from './resolvers'\n\nconst TIMEOUT_MS = 800\n\n// Create a LRU memory cache for the Status client.\n// The @vtex/api HttpClient respects Cache-Control headers and uses the provided cache.\nconst memoryCache = new LRUCache<string, any>({ max: 5000 })\nmetrics.trackCache('status', memoryCache)\n\n// This is the configuration for clients available in `ctx.clients`.\nconst clients: ClientsConfig<Clients> = {\n // We pass our custom implementation of the clients bag, containing the Status client.\n implementation: Clients,\n options: {\n // All IO Clients will be initialized with these options, unless otherwise specified.\n default: {\n retries: 2,\n timeout: TIMEOUT_MS,\n },\n // This key will be merged with the default options and add this cache to our Status client.\n orders: {\n timeout: 3000,\n },\n status: {\n memoryCache,\n },\n },\n}\n\ndeclare global {\n // We declare a global Context type just to avoid re-writing ServiceContext<Clients, State> in every handler and resolver\n type Context = ServiceContext<Clients, State>\n\n // The shape of our State object found in `ctx.state`. This is used as state bag to communicate between middlewares.\n interface State extends RecorderState {\n code: number\n }\n}\n\n// Export a service that defines route handlers and client options.\nexport default new Service<Clients, State, ParamsContext>({\n clients,\n graphql: {\n resolvers: {\n Query: {\n ...queries,\n },\n Mutation: {\n ...mutations,\n },\n },\n },\n})\n\n```"
}
] |
code_admin-vbase-example_8696cf67
|
[
{
"role": "system",
"content": "You are an expert VTEX IO developer. You specialize in building VTEX Store Framework apps, React components, GraphQL APIs, and Node.js services for e-commerce platforms."
},
{
"role": "user",
"content": "Show me the implementation of admin-vbase-example/react/adminExample.tsx from the admin-vbase-example VTEX app."
},
{
"role": "assistant",
"content": "Here's the implementation:\n\n```tsx\nimport React, { FC, useState } from 'react'\nimport { useMutation, useQuery } from 'react-apollo'\nimport { Layout, PageBlock, Button, Input } from 'vtex.styleguide'\nimport saveTokenGQL from './graphql/saveToken.gql'\nimport tokenGQL from './graphql/token.gql'\n\nconst AdminExample: FC = () => {\n const [token, setToken] = useState('')\n useQuery(tokenGQL, { onCompleted: ({ token }) => setToken(token) })\n const [saveToken] = useMutation(saveTokenGQL)\n return (\n <Layout>\n <PageBlock\n title=\"Configuração de Token\"\n subtitle=\"Explicação aqui dos tokens\"\n variation=\"full\"\n >\n <Input\n placeholder=\"API Token\"\n value={token}\n onChange={(e: any) => setToken(e.target.value)}\n />\n <Button\n onClick={() => {\n saveToken({ variables: { token } })\n }}\n >\n Salvar\n </Button>\n </PageBlock>\n </Layout>\n )\n}\nexport default AdminExample\n\n```"
}
] |
code_admin-vbase-example_23f3aeda
|
[
{
"role": "system",
"content": "You are an expert VTEX IO developer. You specialize in building VTEX Store Framework apps, React components, GraphQL APIs, and Node.js services for e-commerce platforms."
},
{
"role": "user",
"content": "Show me the implementation of admin-vbase-example/react/package.json from the admin-vbase-example VTEX app."
},
{
"role": "assistant",
"content": "Here's the implementation:\n\n```json\n{\n \"name\": \"CHANGE_ME\",\n \"version\": \"0.0.2\",\n \"scripts\": {\n \"test\": \"vtex-test-tools test\"\n },\n \"dependencies\": {\n \"apollo-client\": \"^2.6.8\",\n \"react\": \"^16.12.0\",\n \"react-apollo\": \"^3.1.3\",\n \"react-dom\": \"^16.12.0\",\n \"react-intl\": \"^3.12.0\"\n },\n \"devDependencies\": {\n \"@apollo/react-testing\": \"^3.1.3\",\n \"@types/jest\": \"^25.1.4\",\n \"@types/node\": \"^13.9.8\",\n \"@types/react\": \"^16.9.31\",\n \"@vtex/test-tools\": \"^3.3.2\",\n \"@vtex/tsconfig\": \"^0.4.4\",\n \"apollo-cache-inmemory\": \"^1.6.5\",\n \"graphql\": \"^14.6.0\",\n \"typescript\": \"3.9.7\"\n }\n}\n\n```"
}
] |
code_admin-vbase-example_ed4e3fb2
|
[
{
"role": "system",
"content": "You are an expert VTEX IO developer. You specialize in building VTEX Store Framework apps, React components, GraphQL APIs, and Node.js services for e-commerce platforms."
},
{
"role": "user",
"content": "Show me the implementation of admin-vbase-example/react/adminOtherExample.tsx from the admin-vbase-example VTEX app."
},
{
"role": "assistant",
"content": "Here's the implementation:\n\n```tsx\nimport React, { FC } from 'react'\nimport { Layout, PageBlock } from 'vtex.styleguide'\nimport { useQuery } from 'react-apollo'\n\nimport tokenGQL from './graphql/token.gql'\n\nconst AdminOtherExample: FC = () => {\n const { data: retrievedToken } = useQuery(tokenGQL)\n\n return (\n <Layout>\n <PageBlock\n title=\"Gerenciamento\"\n subtitle=\"Tokens e Dados de Configuração\"\n variation=\"full\"\n >\n <p>Current token: {retrievedToken?.token}</p>\n </PageBlock>\n </Layout>\n )\n}\n\nexport default AdminOtherExample\n\n```"
}
] |
code_admin-vbase-example_eb11b3e2
|
[
{
"role": "system",
"content": "You are an expert VTEX IO developer. You specialize in building VTEX Store Framework apps, React components, GraphQL APIs, and Node.js services for e-commerce platforms."
},
{
"role": "user",
"content": "Show me the implementation of admin-vbase-example/node/clients/index.ts from the admin-vbase-example VTEX app."
},
{
"role": "assistant",
"content": "Here's the implementation:\n\n```typescript\nimport { IOClients } from '@vtex/api'\n\nexport class Clients extends IOClients {}\n\n```"
}
] |
code_admin-vbase-example_797dbe71
|
[
{
"role": "system",
"content": "You are an expert VTEX IO developer. You specialize in building VTEX Store Framework apps, React components, GraphQL APIs, and Node.js services for e-commerce platforms."
},
{
"role": "user",
"content": "Show me the implementation of admin-vbase-example/node/resolvers/index.ts from the admin-vbase-example VTEX app."
},
{
"role": "assistant",
"content": "Here's the implementation:\n\n```typescript\nimport token from './token'\nimport saveToken from './saveToken'\n\nexport const mutations = {\n saveToken,\n}\n\nexport const queries = {\n token,\n}\n\n```"
}
] |
code_admin-vbase-example_a3dcbc58
|
[
{
"role": "system",
"content": "You are an expert VTEX IO developer. You specialize in building VTEX Store Framework apps, React components, GraphQL APIs, and Node.js services for e-commerce platforms."
},
{
"role": "user",
"content": "Show me the implementation of admin-vbase-example/node/resolvers/saveToken.ts from the admin-vbase-example VTEX app."
},
{
"role": "assistant",
"content": "Here's the implementation:\n\n```typescript\nexport default function saveToken(\n _: any,\n { token }: { token: string },\n ctx: Context\n) {\n return ctx.clients.vbase\n .saveJSON('account.example', 'configs', { token })\n .then((_) => 'success')\n}\n\n```"
}
] |
code_admin-vbase-example_d7930f86
|
[
{
"role": "system",
"content": "You are an expert VTEX IO developer. You specialize in building VTEX Store Framework apps, React components, GraphQL APIs, and Node.js services for e-commerce platforms."
},
{
"role": "user",
"content": "Show me the implementation of admin-vbase-example/node/resolvers/token.ts from the admin-vbase-example VTEX app."
},
{
"role": "assistant",
"content": "Here's the implementation:\n\n```typescript\nexport default function token(_: any, __: any, ctx: Context) {\n return ctx.clients.vbase\n .getJSON<{ token: string }>('account.example', 'configs')\n .then(({ token }) => token)\n}\n\n```"
}
] |
code_admin-vbase-example_8b876a99
|
[
{
"role": "system",
"content": "You are an expert VTEX IO developer. You specialize in building VTEX Store Framework apps, React components, GraphQL APIs, and Node.js services for e-commerce platforms."
},
{
"role": "user",
"content": "Show me the implementation of admin-vbase-example/react/__tests__/index.test.tsx from the admin-vbase-example VTEX app."
},
{
"role": "assistant",
"content": "Here's the implementation:\n\n```tsx\ndescribe('Orders List Scenarios', () => {\n it('should work', () => {\n expect(1).toBe(1)\n })\n})\n\n```"
}
] |
code_admin-vbase-example_9730e8e2
|
[
{
"role": "system",
"content": "You are an expert VTEX IO developer. You specialize in building VTEX Store Framework apps, React components, GraphQL APIs, and Node.js services for e-commerce platforms."
},
{
"role": "user",
"content": "Show me the implementation of admin-vbase-example/react/graphql/saveToken.gql from the admin-vbase-example VTEX app."
},
{
"role": "assistant",
"content": "Here's the implementation:\n\n```graphql\nmutation saveToken($token: String) {\n saveToken(token: $token)\n}\n\n```"
}
] |
doc_bcf841cd
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation business guidelines self service level in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-business-guidelines-self-service-level/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-self-service-level/docs/api-reference)\n\n[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-business-guidelines-self-service-level/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-self-service-level/docs/storefront-development)\n\n[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-business-guidelines-self-service-level/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-self-service-level/docs/troubleshooting)\n\n[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-business-guidelines-self-service-level/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-self-service-level/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-self-service-level/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-self-service-level/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-self-service-level/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-self-service-level/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-self-service-level/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-self-service-level/updates/release-notes)\n\nSelf-service level\n\nVTEX App Store's mission is to provide scalable, reliable and high-level self-service solutions to our retailers anywhere in the world. For your app to be approved in our homologation process, it must:\n\n* Be plug and play.\n* Offer a direct support channel.\n* Have technical documentation.\n\n## Plug&Play\n\nThose interested in your application should be able to install and configure it on their own, using only the VTEX admin panel to enable its features.\n\nExternal assistance to support the app implementation process should not be considered an option. For homologation approval, it is required that your application is plug and play.\n\n## Support channel\n\nEvery application in the VTEX App Store must provide a direct support channel for retailers who install it, such as email, phone, ticketing tool, or a combination of these options.\n\nIn addition, the first response time must be a maximum of eight business hours in the developer's time zone. This requirement aims to ensure that store operations will not be affected by errors in third-party applications.\n\n## Technical documentation\n\nProvide official documentation to support future users in implementing and understanding the application.\n\nThis documentation should include all the technical and commercial requirements for the application's operation, installation and configuration, the frequently asked questions (FAQ) among users who have installed it, etc.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Perks/vtex-io-documentation-homologation-requirements-for-vtex-app-store/vtex-io-documentation-business-guidelines-self-service-level.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Plug&Play](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-self-service-level/docs/guides/vtex-io-documentation-business-guidelines-self-service-level%23plugplay)\n\n[Support channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-self-service-level/docs/guides/vtex-io-documentation-business-guidelines-self-service-level%23support-channel)\n\n[Technical documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-self-service-level/docs/guides/vtex-io-documentation-business-guidelines-self-service-level%23technical-documentation)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Perks/vtex-io-documentation-homologation-requirements-for-vtex-app-store/vtex-io-documentation-business-guidelines-self-service-level.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Plug&Play](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-self-service-level/docs/guides/vtex-io-documentation-business-guidelines-self-service-level%23plugplay)\n\n[Support channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-self-service-level/docs/guides/vtex-io-documentation-business-guidelines-self-service-level%23support-channel)\n\n[Technical documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-self-service-level/docs/guides/vtex-io-documentation-business-guidelines-self-service-level%23technical-documentation)\n\nOn this page\n\n[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=)"
}
] |
doc_8dce66ee
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore go live 1 configuring external dns in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/troubleshooting)\n\n[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/go-live-1-configuring-external-dns/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-overview)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-before-you-begin)\n\n[1\\. Configuring external DNS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns)\n\n[2\\. Integrating the VTEX Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-2-integrating-the-vtex-login)\n\n[3\\. Integrating the VTEX Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout)\n\n[4\\. Integrating the VTEX Order Placed and My Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-4-integrating-the-vtex-order-placed-and-my-account)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-overview)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-before-you-begin)\n\n[1\\. Configuring external DNS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns)\n\n[2\\. Integrating the VTEX Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-2-integrating-the-vtex-login)\n\n[3\\. Integrating the VTEX Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout)\n\n[4\\. Integrating the VTEX Order Placed and My Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-4-integrating-the-vtex-order-placed-and-my-account)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-overview)\n\nConfiguring external DNS\n\nLearn how to point your custom domain to FastStore and get your store ready for production.\n\nIn this guide, you will configure your custom domain so it correctly points to your FastStore website hosted on [FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-dashboard) (`https://{accountName}.vtex.app/`). Once the configuration is complete, customers will access your store using your final domain (e.g., `www.mystore.com`) instead of the default WebOps URL.\n\nThis process includes:\n\n* Creating DNS records that point your domain to VTEX’s CDN infrastructure\n* Registering your domains in VTEX Account Settings\n* Associating your domain with your FastStore WebOps project\n* Migrating your store to the final HTTPS domain\n\nAs soon as you complete this guide, your FastStore website will be accessible via a custom domain, and **VTEX Checkout** will also be operational. You will then be ready to continue configuring other VTEX solutions, such as **Order Placed**, **Login**, and **My Account**.\n\n> **Plan ahead:** Because several steps in this guide depend on DNS changes becoming fully available worldwide, we strongly recommend planning your go-live schedule accordingly. Avoid making last-minute updates that may delay your deployment or cause temporary domain resolution issues.\n\n## Before you begin\n\n* Develop your FastStore project by following the [Getting Started track](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview).\n* Deploy your FastStore project.\n* Purchase the domain you want to use.\n* [Configure a root-domain redirect to the www subdomain.](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configuring-access-without-www--tutorials%5F4278%23root-domain-redirect-without-www)\n\n## Instructions\n\n> If you still need to configure other VTEX solutions, **use a fictitious domain name** while following the steps. Once you have set up all the desired integrations, repeat the instructions using your final domain to make your website publicly available to end users.\n\n### Step 1 - Creating DNS records\n\nVTEX uses a CDN to serve FastStore websites. To make your domain reachable, you must create DNS CNAME records pointing your domain to VTEX’s CDN endpoints. Without this step, VTEX cannot validate or route traffic for your domain.\n\n1. Access your domain provider's website.\n2. Create a **CNAME** DNS record for your `www` domain (e.g., `www.mystore.com`) pointing to `www.{rootDomain}.cdn.vtex.com` (example: `www.mystore.com.cdn.vtex.com`). Check your domain provider's documentation for more information. The configured addresses may not be immediately available to everyone due to DNS propagation, which can take 24-48 hours to complete. For example:\n\n| Hostname | Type | Points to |\n| ----------------------------------------- | ----- | ------------------------------------------------------------------- |\n| [www.mystore.com](https://read.calvincode.net/reader?url=http://www.mystore.com) | CNAME | [www.mystore.com.cdn.vtex.com](https://read.calvincode.net/reader?url=http://www.mystore.com.cdn.vtex.com) |\n\n> If your strategy requires additional subdomains (e.g., `b2b.mystore.com`), add them as separate CNAMEs and ensure they are [listed under Hosts](#step-3-configuring-domains-in-vtex-account-settings).\n\n### Step 2 - Putting your account into production\n\nBefore VTEX can serve your website on a custom domain, your account must be configured as a production-ready environment. See [Putting your account into production](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/go-live-your-store--4Ns5FxIiksmjsdX2yOTduM/7wFsbWgN4rnZsbjhv8IItX%23putting-your-account-into-production) for more information.\n\n### Step 3 - Configuring domains in VTEX Account Settings\n\nVTEX must know which domains belong to your store so it can recognize incoming requests and serve the appropriate environment. Adding your domains here ensures My Account, Checkout, Login, and other VTEX services can operate correctly.\n\n> For more information about store domain configuration, see the [Configuring the store domain](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configuring-the-store-domain--tutorials%5F2450) guide.\n\n1. In the VTEX Admin, click your profile avatar, identified by the first letter of your email address.\n2. Access **Account Settings > Account**.\n3. Go to the **Stores** tab and in the **Hosts** table, click the menu (**⋮**) and choose **Edit**.\n4. In the **Hosts** field, enter your main store domain (e.g., `www.mystore.com`) into the list.\n5. Click `Add`.\n6. Add the root domain as well (e.g., `mystore.com`).\n7. Click the **Save** button.\n\n> Checkout and secure flows will not work if any used domain or subdomain is missing. If your store uses multiple subdomains or custom prefixes, see [For stores with custom domain prefixes](#for-stores-with-custom-domain-prefixes) section.\n\n#### For stores with custom domain prefixes\n\nTo ensure your store operates efficiently, it's important to correctly configure custom domain prefixes for checkout and secure product viewing. Custom domain prefixes must be configured in the following scenarios:\n\n* Stores with multiple subdomains: Add all the subdomains to the host list.\n* Stores with prefixed domains: Add `subDomainPrefix` for prefixed domains.\n**Adding subdomains to the host list**\n\nTo ensure a seamless checkout experience, all subdomains used by your store must be added to the host list. If the store operates without the `www.` domain, you must include both the `www.` and non-`www.` domains in the host list.\n\nStores with custom prefixes, like `shop.mystore.com`, need both the prefix and main domain (`shop.mystore.com` and `mystore.com`) added. This guarantees that the checkout process works seamlessly when customers access the store with or without `www.` or any other custom prefix.\n\n**Adding `subDomainPrefix` for prefixed domains**\n\nTo ensure customers can view products in the secured environment on your store's final domain, add the `subDomainPrefix` property to the [discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23files) file. The `subDomainPrefix` property maintains compatibility between cookies set in the storefront and the secure environment.\n\nTo add the `subDomainPrefix` property, follow these steps:\n\n1. Open your FastStore project in a code editor of your preference.\n2. Open the `discovery.config.js` file.\n3. Navigate to the `api` object and add the following: \n`1 \n// Platform specific configs for API \n2 \napi: { \n3 \n ... \n4 \n subDomainPrefix: ['xxx'] \n5 \n}, \n` \n> Replace `'xxx'` in the `subDomainPrefix` property with the actual subdomain prefix (example: `['b2b']`). If you have multiple prefixes, add them as an array of strings (example: `['b2b', 'dev']`).\n4. Save your changes.\n\n> You will commit and deploy these changes later in [Step 4](#step-4-associating-your-custom-domain-with-your-faststore-project).\n\n### Step 4 - Associating your custom domain with your FastStore project\n\nUp to this stage, your FastStore build continues to reference the default WebOps URL. Complete the steps below to update your storefront configuration and environment variables to point to your final production domain.\n\n1. Open your FastStore project in any code editor of your preference.\n2. Open the [discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options) file.\n3. In the `discovery.config.js` file, update the `Production URLs` field with the new URLs, and replace the `rootDomain` value with your store root domain name. See the example below: \n`1 \n... \n2 \n \n3 \n// Production URLs \n4 \nstoreUrl: \"https://www.mystore.com\", \n5 \ncheckoutUrl: \"https://www.mystore.com/checkout\", \n6 \nloginUrl: \"https://www.mystore.com/api/io/login\", \n7 \naccountUrl: \"https://www.mystore.com/api/io/account\", \n8 \n \n9 \n... \n` \n> Remove any references to `secureSubdomain` and `secure` host.\n4. Save your changes.\n5. Open the `vtex.env` file.\n6. Add the `SITE_HOST` key with the main store domain as the value specified in [Step 3](#step-3-configuring-domains-in-vtex-account-settings), for example, `SITE_HOST=www.yourstore.com`\n7. Save your changes.\n8. Open a Pull Request, commit your changes, and deploy them to `main`.\n\n### Step 5 - Configuring the CDN workflow (Only for new go-lives)\n\nIf your FastStore website is going live for the first time, VTEX must activate the CDN workflow for your account. [Open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support) and specify that you need to configure the CDN workflow for your store's secure and main domains.\n\nInclude the following information in your ticket:\n\n* Your VTEX **account name**.\n* The store's main domain (e.g., `www.mystore.com`).\n\nThe VTEX team will evaluate your request and take the necessary actions to configure your account's CDN workflow.\n\n### Step 6 - Adding your store domain to FastStore WebOps\n\nTo finish the domain configuration, add your store domain to [FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-dashboard).\n\n> FastStore WebOps domain configuration always takes priority over any settings in `discovery.config.js`.\n\n1. Access your [FastStore WebOps dashboard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-dashboard).\n2. Navigate to the **Settings** tab.\n3. In the **Host** field, choose your store's domain (example: `www.mystore.com`) from the dropdown list.\n4. Click `Add`. \n\n\n### Step 7 - Monitoring the new deployment\n\nAfter you add your domain to FastStore WebOps, an automatic deployment is triggered to update the CDN and routing configuration. This deployment must finish successfully before your store becomes accessible under your custom domain.\n\n1. Access your FastStore WebOps dashboard.\n2. Navigate to the Settings tab.\n3. Confirm your domain appears in the **Current Domains** list. \n\n\n### Step 8 - Migrating the domain\n\nThis final step asks VTEX to fully migrate your WebOps project so the custom domain becomes the primary URL instead of the default `{accountName}.vtex.app`. This is required for HTTPS, secure flows, and production routing.\n\n1. Open a ticket with [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support) requesting a **domain migration** for your FastStore WebOps implementation. Include the following information: \n * VTEX account name \n * Store's main domain (example: `www.mystore.com`) \n * Store's root domain (example: `mystore.com`) \n * Confirmation that you’ve completed all previous steps in this guide.\n2. Wait for the VTEX team to process your request and complete the domain migration.\n3. Once the migration is complete, test your store to ensure everything is working properly.\n\n## Related Resources\n\n* [Configuring the store domain](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configuring-the-store-domain--tutorials%5F2450)\n* [Setting up DNS pointing to VTEX](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/go-live-your-store--4Ns5FxIiksmjsdX2yOTduM/12bQlMbJ68Ot0LIaO6Btkj%23setting-up-dns-pointing)\n* [Insert a reverse proxy in front of VTEX services](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/insert-reverse-proxy-in-front-of-vtex-services--4PFWsfRAKviNVPf1bYdiir)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/go-live/1-configuring-external-dns.mdx)\n\n[Before you begin« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-before-you-begin)[2\\. Integrating the VTEX LoginNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-2-integrating-the-vtex-login)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23instructions)\n\n[Step 1 - Creating DNS records](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23step-1-creating-dns-records)[Step 2 - Putting your account into production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23step-2-putting-your-account-into-production)[Step 3 - Configuring domains in VTEX Account Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23step-3-configuring-domains-in-vtex-account-settings)[Step 4 - Associating your custom domain with your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23step-4-associating-your-custom-domain-with-your-faststore-project)[Step 5 - Configuring the CDN workflow (Only for new go-lives)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23step-5-configuring-the-cdn-workflow-only-for-new-go-lives)[Step 6 - Adding your store domain to FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23step-6-adding-your-store-domain-to-faststore-webops)[Step 7 - Monitoring the new deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23step-7-monitoring-the-new-deployment)[Step 8 - Migrating the domain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23step-8-migrating-the-domain)\n\n[Related Resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23related-resources)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/go-live/1-configuring-external-dns.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23instructions)\n\n[Step 1 - Creating DNS records](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23step-1-creating-dns-records)[Step 2 - Putting your account into production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23step-2-putting-your-account-into-production)[Step 3 - Configuring domains in VTEX Account Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23step-3-configuring-domains-in-vtex-account-settings)[Step 4 - Associating your custom domain with your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23step-4-associating-your-custom-domain-with-your-faststore-project)[Step 5 - Configuring the CDN workflow (Only for new go-lives)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23step-5-configuring-the-cdn-workflow-only-for-new-go-lives)[Step 6 - Adding your store domain to FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23step-6-adding-your-store-domain-to-faststore-webops)[Step 7 - Monitoring the new deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23step-7-monitoring-the-new-deployment)[Step 8 - Migrating the domain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23step-8-migrating-the-domain)\n\n[Related Resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns/docs/guides/faststore/go-live-1-configuring-external-dns%23related-resources)\n\nOn this page\n\n[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=)"
}
] |
doc_d9046c78
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides graphql authorization in io apps in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/graphql-in-vtex-io)\n\n[List of GraphQL APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-graphql-api-list)\n\n[Developing a GraphQL API in service apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/developing-a-graphql-api-in-service-apps)\n\n[GraphQL authorization in IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/graphql-authorization-in-io-apps)\n\n[Integrating an app with a GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/integrating-an-app-with-a-graphql-api)\n\n[Implementing cache in GraphQL APIs for IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/implementing-cache-in-graphql-apis-for-io-apps)\n\n[Admin GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/graphql-ide)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/graphql-in-vtex-io)\n\n[List of GraphQL APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-graphql-api-list)\n\n[Developing a GraphQL API in service apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/developing-a-graphql-api-in-service-apps)\n\n[GraphQL authorization in IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/graphql-authorization-in-io-apps)\n\n[Integrating an app with a GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/integrating-an-app-with-a-graphql-api)\n\n[Implementing cache in GraphQL APIs for IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/implementing-cache-in-graphql-apis-for-io-apps)\n\n[Admin GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/graphql-ide)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/app-development)\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/graphql-in-vtex-io)\n\n[GraphQL authorization in IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/graphql-authorization-in-io-apps)\n\nGraphQL authorization in IO apps\n\nLearn to implement and use protected GraphQL operations with IO apps.\n\nAuthenticated GraphQL requests are crucial for securing access to your VTEX IO app's data and functions. Authentication ensures that only authorized users or applications can interact with your GraphQL endpoints, protecting sensitive information and preventing unauthorized actions. In addition to authentication, app developers can implement authorization to control who can access specific resources and what operations they can perform.\n\nGraphQL authorization in VTEX IO apps works with auth tokens and [directives](https://read.calvincode.net/reader?url=https://graphql.org/learn/schema/%23directives) within your GraphQL schema, enabling fine-grained access control based on [License Manager resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). The app identifies the requester by the [auth token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens) in [apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app) or the [user token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens) in API calls. These tokens have [roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) or [policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies) associated with VTEX resources.\n\nIn this guide, you will learn how to:\n\n1. Implement protected GraphQL API operations in apps using authorization.\n2. Make authorized requests from apps.\n3. Make external requests with appropriate authorization.\n\n> Only VTEX apps, Admin users, and [application keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) can be authorized to make GraphQL requests, as they must be associated with a role or policy that grants access to a License Manager resource. Store users don't have this type of access.\n\n## Implementing GraphQL API authorization in apps\n\nThe `@auth` directive has different implementation methods depending on the builder version.\n\nFor the builder version `1.x`, the directive is optional. If a query or mutation doesn't have the directive, it's considered public by default. For the builder version `2.x`, the directive is mandatory.\n\nTo enable authorization, you must add the `@auth` directive to the specific fields or operations in your GraphQL schema that need protection. This directive ensures that only requesters with access to the corresponding [License Manager resource](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) are allowed to execute the operation.\n\nThe `@auth` directive uses the following arguments:\n\n| Argument | Description | [Builder version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-graphql-builder%23versioning) details |\n| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |\n| scope | The authorization scope of the query or mutation. It has two possible values:PUBLIC: The query is public, so it doesn't require any authorization. This scope is mostly used for shoppers browsing a store.PRIVATE: The query is private, which requires authorization for a specific License Manager resource and product. This scope should be used for scenarios other than store browsing by a shopper, such as in the Admin. | Works only on version 2.x, and is mandatory. |\n| productCode | The numeric code that identifies the product in License Manager (for example, \"66\" for **VTEX IO**). See the product codes in the **Product ID** column of the table in [License Manager resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). | Works on versions 1.x and 2.x. For 2.x, this argument is mandatory if scope is set to PRIVATE. |\n| resourceCode | The License Manager resource identifier (for example, \"workspace-read-write\" for **Workspace CRUD**). See the resource codes in the **Key** column of the table in [License Manager resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). | Works on versions 1.x and 2.x. For 2.x, this argument is mandatory if scope is set to PRIVATE. |\n\nExamples:\n\nWith version `1.x`:\n\n`1\n\ntype Mutation { \n\n2\n\n createWorkspace(account: String, workspace: String): GenericResponse \n\n3\n\n @auth(productCode: \"66\", resourceCode: \"workspace-read-write\") \n\n4\n\n} \n\n`\n\nPublic with version `2.x`:\n\n`1\n\ntype Query { \n\n2\n\n source(id: ID!): String \n\n3\n\n @auth(scope: PUBLIC) \n\n4\n\n} \n\n`\n\nIn this example, there is no verification of whether the requester has access to a specific License Manager resource.\n\nPrivate with version `2.x`:\n\n`1\n\ntype Mutation { \n\n2\n\n createWorkspace(account: String, workspace: String): GenericResponse \n\n3\n\n @auth(scope: PRIVATE, productCode: \"66\", resourceCode: \"workspace-read-write\") \n\n4\n\n} \n\n`\n\nIn this example, when the user requests the `createWorkspace` mutation, VTEX checks if the user has access to the `workspace-read-write` resource from License Manager. If the user has this access, the endpoint will be processed as intended. Otherwise, the request will be denied.\n\nYou can see the available products and resources in [License Manager resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n\n### Error scenarios\n\nIf a developer tries to build an app with the GraphQL builder `2.x`, the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) will show an error message in the following cases:\n\n* Any query or mutation lacks the `@auth` directive.\n* The `scope` argument is missing in the directive.\n* When `scope` is `PRIVATE` in the directive and the `productCode` or `resourceCode` arguments are missing.\n\n> An error occurred while loading the image ../../images/graphql-auth-directive-error.png\n\n## Making requests to protected GraphQL APIs from a VTEX IO app\n\nWhen making requests to a protected GraphQL API from another VTEX IO app, you must export a [custom Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-how-to-create-and-use-clients) that extends the `AppGraphQLClient` type and set the `VtexIdclientAutCookie` header with the auth token in the [Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients). The requester must have the role or policy that includes the `resourceCode` and `productCode` defined in the target operation's `@auth` directive.\n\nDeclare the token based on the requester's context:\n\n* **App**: `ctx.authToken`.\n* **Admin user**: `ctx.adminUserAuthToken`.\n\nExample\n\nnode/clients/catalogGraphQL/index.ts\n\n`1\n\nimport { AppGraphQLClient, InstanceOptions, IOContext } from '@vtex/api' \n\n2\n\nexport class CatalogGQL extends AppGraphQLClient { \n\n3\n\n constructor(ctx: IOContext, options?: InstanceOptions) { \n\n4\n\n super('vtex.catalog-graphql@1.x', ctx, { \n\n5\n\n ...options, \n\n6\n\n headers: { \n\n7\n\n ...options?.headers, \n\n8\n\n VtexIdclientAutCookie: ctx.adminUserAuthToken, \n\n9\n\n }, \n\n10\n\n }) \n\n11\n\n } \n\n12\n\n } \n\n`\n\nFor details about token types, see [App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens).\n\n> Use the user token (Admin) whenever possible to properly identify the requester. The app token (`ctx.authToken`) should only be used when the user can't access the requested service.\n\n## Making requests to protected GraphQL APIs of apps\n\nWhen making external requests to a GraphQL API of an app, include the [user token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens) in the `VtexIdclientAutCookie` HTTP header. The requester must have a role that includes the resource and product defined in the endpoint's `@auth` directive.\n\nExample (cURL):\n\nterminal\n\n`1\n\ncurl -X POST \\ \n\n2\n\n 'https://https://app.io.vtex.com/vtex.rewriter/v1/{account}/_v/graphql' \\ \n\n3\n\n -H 'Content-Type: application/json' \\ \n\n4\n\n -H 'VtexIdclientAutCookie: {your_user_token}' \\ \n\n5\n\n -d '{ \n\n6\n\n \"query\": \" \n\n7\n\n mutation SaveInternal($route: InternalInput!) { \n\n8\n\n internal { \n\n9\n\n save(route: $route) { \n\n10\n\n from \n\n11\n\n id \n\n12\n\n type \n\n13\n\n binding \n\n14\n\n resolveAs \n\n15\n\n origin \n\n16\n\n } \n\n17\n\n } \n\n18\n\n } \n\n19\n\n \", \n\n20\n\n \"variables\": { \n\n21\n\n \"route\": { \n\n22\n\n \"from\": \"/old-path\", \n\n23\n\n \"declarer\": \"vtex.store@2.x\", \n\n24\n\n \"type\": \"redirect\", \n\n25\n\n \"id\": \"custom-redirect-old-path\", \n\n26\n\n \"binding\": \"your-binding-id\", \n\n27\n\n \"resolveAs\": \"/new-path\", \n\n28\n\n \"origin\": \"internal\", \n\n29\n\n \"disableSitemapEntry\": false \n\n30\n\n } \n\n31\n\n } \n\n32\n\n }' \n\n`\n\n> You can make GraphQL requests with GraphQL IDEs that support custom HTTP headers, such as the [one in the VTEX Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide). Not all GraphQL IDEs allow setting authentication headers, which may prevent requests to protected operations from being executed successfully.\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/GraphQL/graphql-authorization-in-io-apps.mdx)\n\n[Developing a GraphQL API in service apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps//docs/guides/developing-a-graphql-api-in-service-apps)[Integrating an app with a GraphQL APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps//docs/guides/integrating-an-app-with-a-graphql-api)\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Implementing GraphQL API authorization in apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/graphql-authorization-in-io-apps%23implementing-graphql-api-authorization-in-apps)\n\n[Error scenarios](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/graphql-authorization-in-io-apps%23error-scenarios)\n\n[Making requests to protected GraphQL APIs from a VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/graphql-authorization-in-io-apps%23making-requests-to-protected-graphql-apis-from-a-vtex-io-app)\n\n[Making requests to protected GraphQL APIs of apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/graphql-authorization-in-io-apps%23making-requests-to-protected-graphql-apis-of-apps)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/GraphQL/graphql-authorization-in-io-apps.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Implementing GraphQL API authorization in apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/graphql-authorization-in-io-apps%23implementing-graphql-api-authorization-in-apps)\n\n[Error scenarios](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/graphql-authorization-in-io-apps%23error-scenarios)\n\n[Making requests to protected GraphQL APIs from a VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/graphql-authorization-in-io-apps%23making-requests-to-protected-graphql-apis-from-a-vtex-io-app)\n\n[Making requests to protected GraphQL APIs of apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps/docs/guides/graphql-authorization-in-io-apps%23making-requests-to-protected-graphql-apis-of-apps)\n\nOn this page\n\n[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=)"
}
] |
doc_2b04b2a6
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides tax protocol graphql api in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-service-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-services-overview)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-services-specification)\n\n[Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-services-recipe)\n\n[Tax Protocol GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api)\n\n[Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-services-reference-implementation)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-service-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-services-overview)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-services-specification)\n\n[Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-services-recipe)\n\n[Tax Protocol GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api)\n\n[Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-services-reference-implementation)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides)\n\nIntegration Guides\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-service-integration-guide)\n\n[Tax Protocol GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api)\n\nTax Protocol GraphQL API\n\nGraphQL API reference for the Tax Protocol.\n\nThis API allows setting and retrieving the Tax Configuration, which is part of the [OrderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration) for the Tax Service.\n\n## Schema overview\n\n### Query\n\ngetTaxConfiguration\n\nTaxConfiguration\n\nallowExecutionAfterErrors Boolean\n\nauthorizationHeader String\n\nintegratedAuthentication Boolean\n\nurl String\n\nQuery\n\ngetTaxConfiguration TaxConfiguration\n\n| Field | Argument | Type | Description |\n| ----------------------- | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **getTaxConfiguration** | [TaxConfiguration](#taxconfiguration) | Retrieves the tax configuration of an account from the orderForm using the Checkout API ([Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pvt/configuration/orderForm)). | |\n\n### Mutation\n\npaymentConfiguration\n\ntaxConfiguration\n\napps\n\nsetTaxConfiguration\n\nPaymentConfiguration\n\nrequiresAuthenticationForPreAuthorizedPaymentOption Boolean\n\nallowInstallmentsMerge Boolean\n\nblockPaymentSession Boolean\n\npaymentSystemToCheckFirstInstallment Boolean\n\nTaxConfiguration\n\nallowExecutionAfterErrors Boolean\n\nauthorizationHeader String\n\nintegratedAuthentication Boolean\n\nurl String\n\nApp\n\nfields \\[String\\]\n\nid \\[String\\]\n\nmajor Int\n\nOrderFormConfiguration\n\npaymentConfiguration PaymentConfiguration\n\ntaxConfiguration TaxConfiguration\n\nminimumQuantityAccumulatedForItems Int\n\ndecimalDigitsPrecision Int\n\nminimumValueAccumulated Int\n\napps \\[App\\]\n\nallowMultipleDeliveries Boolean\n\nallowManualPrice Boolean\n\nmaxIntOfWhiteLabelSellers Int\n\nmaskFirstPurchaseData Boolean\n\nrecaptchaValidation Boolean\n\nMutation\n\nsetTaxConfiguration(operation String) : OrderFormConfiguration\n\n| Field | Argument | Type | Description |\n| ----------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **setTaxConfiguration** | [OrderFormConfiguration](#orderformconfiguration) | Activates or deactivates the tax service in the [orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration) using the ([Update orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pvt/configuration/orderForm)) endpoint. | |\n| operation | String | Argument to define whether the tax service will be activated or deactivated. Possible values: \"activate\", \"deactivate\". | |\n\n## Schema description\n\n> Arguments must be provided by the user. Required fields are marked with an exclamation mark (`!`).\n\n### OrderFormConfiguration\n\n| Field | Argument | Type | Description |\n| -------------------------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |\n| **paymentConfiguration** | [PaymentConfiguration](#paymentconfiguration) | Payment configuration information. | |\n| **taxConfiguration** | [TaxConfiguration](#taxconfiguration) | External tax service configuration information. | |\n| **minimumQuantityAccumulatedForItems** | Int | Minimum SKU quantity per cart. This field is mandatory and must be sent in all requests. | |\n| **decimalDigitsPrecision** | Int | Number of decimal price digits. | |\n| **minimumValueAccumulated** | Int | Minimum cart total. | |\n| **apps** | \\[[App](#app)\\] | List of App objects, where each object has a piece of app configuration information. You can see an example with the apps list in the [Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration) response body. | |\n| **allowMultipleDeliveries** | Boolean | Enables multiple delivery options in a single purchase. | |\n| **allowManualPrice** | Boolean | Allows editing SKU prices directly in the cart. | |\n| **maxIntOfWhiteLabelSellers** | Int | Maximum number of white label sellers allowed in the cart. | |\n| **maskFirstPurchaseData** | Boolean | Masks customer data for first-time purchases. This can be useful when using a shared cart and the customer doesn't want to share their data. | |\n| **recaptchaValidation** | Boolean | Configures reCAPTCHA validation status for the account. | |\n\n[Mutation](#mutation) 🔼\n\n### App\n\n| Field | Argument | Type | Description |\n| ---------- | ---------- | ------------------------------------ | ----------- |\n| **fields** | \\[String\\] | List of fields available to the app. | |\n| **id** | String | App ID. | |\n| **major** | Int | App major version. | |\n\n[OrderFormConfiguration](#orderformconfiguration) 🔼\n\n### PaymentConfiguration\n\n| Field | Argument | Type | Description |\n| ------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **requiresAuthenticationForPreAuthorizedPaymentOption** | Boolean | Determines whether pre-authorized payments require authentication. This field is mandatory and must be sent in all requests. | |\n| **allowInstallmentsMerge** | Boolean | The default when this is false and a multi-seller purchase is in progress is to simply show the installment options that are common to all sellers. When true, this option allows a more complex but flexible installment option configuration taking into account the installment maximum of every seller, even if they don't match. Installment values don't need to be equal in this case. | |\n| **blockPaymentSession** | Boolean | Indicates whether shoppers can add credit cards in the store's [My Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account) section. | |\n| **paymentSystemToCheckFirstInstallment** | Boolean | If you want to apply a first-installment discount to a particular payment system, set this field to the ID of the payment system. Learn more in [Configuring a discount for orders paid in full](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configuring-a-discount-for-orders-prepaid-in-full--7Lfcj9Wb5dpYfA2gKkACIt). | |\n\n[OrderFormConfiguration](#orderformconfiguration) 🔼\n\n### TaxConfiguration\n\n| Field | Type | Description |\n| ----------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **allowExecutionAfterErrors** | Boolean | Allows proceeding with the purchase even when there's a tax system problem. |\n| **authorizationHeader** | String | String that Checkout will use in the Authorization header of calls to the external tax calculation API. This field can be used to define the access credentials for this API. Example: \"99b9935b048dfd86893d0bf9gas628849\". |\n| **integratedAuthentication** | Boolean | When true, the tax system will use [VTEX auth](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication). When false, it will use the authorizationHeader instead. |\n| **url** | String | External API endpoint URL of the tax provider that Checkout will query to receive the calculated taxes. Example: \"<https://sandbox-rest.avatax.com/api/v2/transactions/create>\". |\n\n[Query](#query) 🔼\n\n[OrderFormConfiguration](#orderformconfiguration) 🔼\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/tax-service-integration-guide/tax-protocol-graphql-api.md)\n\n[Recipe« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api//docs/guides/tax-services-recipe)[Reference ImplementationsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api//docs/guides/tax-services-reference-implementation)\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[Schema overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api%23schema-overview)\n\n[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api%23query)[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api%23mutation)\n\n[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api%23schema-description)\n\n[OrderFormConfiguration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api%23orderformconfiguration)[App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api%23app)[PaymentConfiguration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api%23paymentconfiguration)[TaxConfiguration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api%23taxconfiguration)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/tax-service-integration-guide/tax-protocol-graphql-api.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Schema overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api%23schema-overview)\n\n[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api%23query)[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api%23mutation)\n\n[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api%23schema-description)\n\n[OrderFormConfiguration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api%23orderformconfiguration)[App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api%23app)[PaymentConfiguration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api%23paymentconfiguration)[TaxConfiguration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-protocol-graphql-api/docs/guides/tax-protocol-graphql-api%23taxconfiguration)\n\nOn this page\n\n[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=)"
}
] |
doc_7388f53c
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation docs guidelines in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-app-store)\n\n[Becoming a registered VTEX App Store developer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer)\n\n[Developing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-developing-an-app)\n\n[Setting your app's billing model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-setting-your-apps-billing-model)\n\n[Preparing your app for distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-preparing-your-app-distribution)\n\n[Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)\n\n[Using the Docs builder to publish app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/using-the-docs-builder-to-publish-app-documentation)\n\n[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n[App monetization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-business-guidelines-app-monetization)\n\n[Marketing guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets)\n\n[User Experience guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-design-guidelines)\n\n[Engineering guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines)\n\n[Documentation guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-app-store)\n\n[Becoming a registered VTEX App Store developer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer)\n\n[Developing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-developing-an-app)\n\n[Setting your app's billing model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-setting-your-apps-billing-model)\n\n[Preparing your app for distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-preparing-your-app-distribution)\n\n[Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)\n\n[Using the Docs builder to publish app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/using-the-docs-builder-to-publish-app-documentation)\n\n[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n[App monetization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-business-guidelines-app-monetization)\n\n[Marketing guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets)\n\n[User Experience guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-design-guidelines)\n\n[Engineering guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines)\n\n[Documentation guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/app-development)\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-app-store)\n\n[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n[Documentation guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines)\n\nDocumentation guidelines\n\nDeveloping and publishing apps on the VTEX App Store requires meticulous documentation to ensure seamless adoption by developers and business users. Follow these best practices to create clear, engaging, and effective documentation for your VTEX apps.\n\n## Identifying your audience\n\nWhen developing documentation, clearly distinguish between developers and business users. Developers will focus on installation, setup, and other configuration options, while business users need a streamlined understanding of app functionalities and operations.\n\n## Defining the documentation objectives\n\nEnvision what users should achieve after reading your documentation. Clearly outline the learning objectives, ensuring that users leave with a comprehensive understanding of your app's capabilities.\n\n## Structuring your documentation\n\n### Title\n\nThe title must be concise and memorable. Ensure that it describes the experiences the app represents.\n\n#### Do’s\n\n* Use the app's name as the article title.\n* Clearly state the learning objective of the article, preferably with only one verb.\n* Capitalize the first letter of each word.\n\n| ✅ Do | ❌ Don't |\n| ----------------------- | ---------------------- |\n| Availability Subscriber | Availability Subscribe |\n| Search Bar | Search bar |\n\n#### Don’ts\n\n* Do not use punctuation, such as periods, commas, exclamation points, question marks, semicolons, colons, and underscores.\n* Do not use the word _App_.\n* Do not include the app version number.\n\n| ✅ Do | ❌ Don't |\n| ------------------ | -------------------------- |\n| Google Tag Manager | Google Tag Manager v3.5.2. |\n| Live Shopping | Live Shopping app |\n\n### Introduction\n\nThe introduction should summarize your app’s purpose and what the user will learn with the documentation.\n\n* Write a short description of the app.\n* Emphasize the end-user benefits.\n* Add an image that illustrates the app behavior.\n* Use [Callout](#callout) for important notes.\n\n| ✅ Do | ❌ Don't |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------- |\n| The Availability Subscriber component shows the availability subscriber form displayed when a product is unavailable. This component can be imported and used by any VTEX App. | The Availability Subscriber is a First-Party solution and can be imported and used by any VTEX App. |\n\n### (Optional) Before you begin\n\nBefore the app’s installation, the user may need to meet some prerequisites. For example, an account or permission in another platform, knowledge of specific web technology, or a development tool like the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).\n\n* Create bullets or checklists to describe the prerequisites.\n* Use [Callout](#callout) if applicable.\n\n| ✅ Do | ❌ Don't |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------- |\n| You need a Google account to use Google Tag Manager. You can use the same account if you already use Google products like Gmail. If you do not have an account for a Google product, create one at [Creating your Google account](https://read.calvincode.net/reader?url=https://support.google.com/accounts/answer/27441?hl=en). | You need a Google account to use Google Tag Manager. |\n\n### Installation\n\nOffer a step-by-step installation guide, utilizing code snippets to enhance user comprehension.\n\nRefer to the _Installation_ section in the [Documentation template](#documentation-template) for an example.\n\n### Configuration\n\nAfter installation, guide users through configuring the app in their store's theme code or Admin settings. List all essential app settings with detailed step-by-step instructions.\n\nRefer to the _Configuration_ section in the [Documentation template](#documentation-template) for an example.\n\n### (Optional) Customization\n\nIf applicable, provide steps for customizing the app. For example, if your app uses CSS handles, provide the CSS handles related to the app and add a table with the available CSS handles. Make sure to add the documentation link for [the instructions to apply CSS customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization).\n\n### (Optional) Contributors\n\nFollow the [All-Contributors specification](https://read.calvincode.net/reader?url=https://github.com/all-contributors/all-contributors) and recognize the people who contributed to your app.\n\n### Callout\n\nIf you need to highlight information, use one of the following callout types:\n\n#### Information\n\nHighlights an aspect the user should pay attention to, giving additional information about the subject. However, the lack of awareness of that information will not lead to problems.\n\n`1\n\n> ℹ️ Information goes here. \n\n`\n\n#### Warning\n\nApplies when the user must pay attention to information to avoid issues or unexpected behaviors. It shows a medium criticality level that leads to problems.\n\n`1\n\n> ⚠️ Warning message goes here. \n\n`\n\n#### Danger\n\nRepresents the highest criticality level. If the user ignores the information given, this might lead to critical issues, possibly breaking the feature.\n\n`1\n\n> ⛔ Danger message goes here. \n\n`\n\n## Documentation template\n\nA basic documentation template structure with the previously described sections for you to start.\n\n**Documentation template**\n\n`` 1\n\n# {Insert the app's name} \n\n2\n\n \n3\n\nThe `\\{insert app's name\\}` is responsible for `\\{app's purpose\\}` so you can `\\{job to be done\\}`. \n\n4\n\n \n5\n\n \n\n6\n\n \n7\n\n## Before you begin \n\n8\n\n \n9\n\nYou need to have `\\{insert what the user needs to have: an account in another platform, CLI, knowledge in another app, etc\\}`. \n\n10\n\n \n11\n\nIf you do not have `\\{insert what the user needs to have and how it can be done\\}`. \n\n12\n\n \n13\n\n## Installation \n\n14\n\n \n15\n\n1. [Install](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-installing-an-app) the `\\{insert app's name\\}` app in the desired VTEX account by running `vtex install \\{appVendor\\}.\\{appName\\}` in your terminal. \n\n16\n\n2. Open your store’s Store Theme app directory in your code editor. \n\n17\n\n3. Open your app's `manifest.json file` and add the `\\{insert app's name\\}` app under the `peerDependencies` field. \n\n18\n\n \n19\n\n \n20\n\n \"peerDependencies\": { \n\n21\n\n \"vtex.{appName}\": \"{appVersion}\" \n\n22\n\n } \n\n23\n\n \n24\n\n \n25\n\n4. Declare the `\\{insert app's name\\}` app in the desired template. For example: \n\n26\n\n \n27\n\n \"store.home\": { \n\n28\n\n \"blocks\": [ \n\n29\n\n + \"{app-name}\", \n\n30\n\n ] \n\n31\n\n }, \n\n32\n\n \n33\n\n** \n\n34\n\n \n35\n\n## Configuration \n\n36\n\n \n37\n\nOnce you have installed the app, you can `\\{describe the app's configuration in the VTEX Admin, for example\\}`. \n\n38\n\n \n39\n\n1. `first step`. \n\n40\n\n2. `Second step`. \n\n41\n\n3. `Third step`. \n\n42\n\n \n43\n\n## Customization \n\n44\n\n \n45\n\nTo apply CSS customizations to this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization). \n\n46\n\n \n47\n\n| CSS Handles | \n\n48\n\n| ------------------ | \n\n49\n\n| csshandlesName | \n\n50\n\n| csshandlesName | \n\n51\n\n| csshandlesName | \n\n52\n\n \n53\n\n## Contributors \n\n54\n\n \n55\n\nThanks go to these wonderful people: \n\n56\n\n \n57\n\n- `\\{insert the GitHub username\\}` \n\n58\n\n \n59\n\nThis project follows the [all-contributors](https://read.calvincode.net/reader?url=https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome. \n\n ``\n\n## Related articles\n\n* [App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n* [Preparing your app for distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-preparing-your-app-distribution)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Perks/vtex-io-documentation-homologation-requirements-for-vtex-app-store/vtex-io-documentation-docs-guidelines.md)\n\n[Engineering guidelines« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines//docs/guides/vtex-io-documentation-engineering-guidelines)[Edition AppsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines//docs/guides/managing-edition-apps)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Identifying your audience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23identifying-your-audience)\n\n[Defining the documentation objectives](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23defining-the-documentation-objectives)\n\n[Structuring your documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23structuring-your-documentation)\n\n[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23title)[Introduction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23introduction)[(Optional) Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23optional-before-you-begin)[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23installation)[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23configuration)[(Optional) Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23optional-customization)[(Optional) Contributors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23optional-contributors)[Callout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23callout)\n\n[Documentation template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23documentation-template)\n\n[Related articles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23related-articles)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Perks/vtex-io-documentation-homologation-requirements-for-vtex-app-store/vtex-io-documentation-docs-guidelines.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Identifying your audience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23identifying-your-audience)\n\n[Defining the documentation objectives](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23defining-the-documentation-objectives)\n\n[Structuring your documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23structuring-your-documentation)\n\n[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23title)[Introduction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23introduction)[(Optional) Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23optional-before-you-begin)[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23installation)[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23configuration)[(Optional) Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23optional-customization)[(Optional) Contributors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23optional-contributors)[Callout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23callout)\n\n[Documentation template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23documentation-template)\n\n[Related articles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines/docs/guides/vtex-io-documentation-docs-guidelines%23related-articles)\n\nOn this page\n\n[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=)"
}
] |
doc_448440cf
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides gift card integration guide system architecture in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide)\n\n[Gift Card system architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture)\n\n[Managing VTEX gift cards](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/managing-vtex-gift-cards)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide)\n\n[Gift Card system architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture)\n\n[Managing VTEX gift cards](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/managing-vtex-gift-cards)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides)\n\nIntegration Guides\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide)\n\n[Gift Card system architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture)\n\nGift Card system architecture\n\nOur Gift Card system provides stores with the flexibility to plug in multiple gift card providers and offer these different options to their customers. This is possible thanks to a layer of interaction between gift card providers and the store, which we call **Gift Card Hub**, and the communication standards defined in our **Gift Card Provider Protocol**.\n\n\n\nThis article presents an overview of this architecture, so you understand its building blocks and how they interact with each other. We will also explain the purpose of the [Gift Card API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23overview) and the [Gift Card Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-api%23overview) and how they should be used.\n\n> If you do not need to integrate an external solution, remember you can [set up and manage gift cards](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/gift-card--tutorials%5F995) natively in your admin panel or using our [Gift Card API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23overview).\n\n## Gift Card Hub\n\nThis is the system that provides a layer of interaction between gift card providers and VTEX stores. It is used to manage multiple gift card providers connected to a store, both native and external, using a single interface - the [Gift Card Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-api%23overview).\n\n## Gift Card Provider Protocol\n\nThis is the protocol defining the communication standards gift card providers must follow in their integration with Gift Card Hub. The [Gift Card Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol%23overview) section of our API Reference provides details on the eleven endpoints that should be exposed by the middleware connecting the external gift card provider to VTEX.\n\n## VTEX Gift Card Provider\n\nOur native gift card provider is bundled into your VTEX store, and [Gift Card API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api%23overview) is the implementation of the Gift Card Provider Protocol for it. It can be used to manage VTEX gift cards directly - although Gift Card Hub API provides the same functionality in a more generic abstraction layer.\n\n> The `VtexGiftCard` provider was built from a legacy system, created before our Gift Card system architecture evolved to the Gift Card Hub model. As such, it should not be considered a reference implementation of the Gift Card Provider Protocol.\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/gift-card-integration-guide/gift-card-integration-guide-system-architecture.md)\n\n[Gift Card« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture//docs/guides/gift-card-integration-guide)[Managing VTEX gift cardsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture//docs/guides/managing-vtex-gift-cards)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Gift Card Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture%23gift-card-hub)\n\n[Gift Card Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture%23gift-card-provider-protocol)\n\n[VTEX Gift Card Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture%23vtex-gift-card-provider)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/gift-card-integration-guide/gift-card-integration-guide-system-architecture.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Gift Card Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture%23gift-card-hub)\n\n[Gift Card Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture%23gift-card-provider-protocol)\n\n[VTEX Gift Card Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide-system-architecture/docs/guides/gift-card-integration-guide-system-architecture%23vtex-gift-card-provider)\n\nOn this page\n\n[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=)"
}
] |
doc_8dedc55a
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation creating a new custom page in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-building-pages)\n\n[Building a Product Details Page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-building-a-product-details-page)\n\n[Building a search results page with multiple layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts)\n\n[Creating a Black Friday page from template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template)\n\n[Creating a custom search results page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-custom-search-results-page)\n\n[Creating a new custom page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page)\n\n[Customizing the Header and Footer blocks by page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-building-pages)\n\n[Building a Product Details Page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-building-a-product-details-page)\n\n[Building a search results page with multiple layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts)\n\n[Creating a Black Friday page from template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template)\n\n[Creating a custom search results page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-custom-search-results-page)\n\n[Creating a new custom page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page)\n\n[Customizing the Header and Footer blocks by page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework)\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/store-framework-building-pages)\n\n[Creating a new custom page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page)\n\nCreating a new custom page\n\nStores are made up of several different pages, each one having a different layout and content. When creating a store from scratch in VTEX IO, some default pages with predefined URLs are already available to you, such as:\n\n* `store.home` \\- Home page\n* `store.product`\\- Product page\n* `store.search` \\- Search Results page\n* `store.account` \\- Client Account page\n* `store.login` \\- Login page\n* `store.orderplaced` \\- Order Placed page\n\n> You can manage each page's title and template in the Pages section, within the admin's CMS.\n\nHowever, you may want to create a new custom page to meet your store's specific needs. In this case, you must create a new URL and template to accompany it.\n\n## Instructions\n\nFollow the steps below and learn how to define a different layout and path for a new store page:\n\n1. Create a new template in your Store Theme.\n2. Create your new page's path.\n3. Add content to your page.\n4. Make your new theme content **publicly available**.\n\n### Creating the new template\n\nA template sets the page layout, so if you want to create a custom page for your store you also will need to create a new template for it.\n\nIn order to do so, you first must choose one of three template types to host your new page:\n\n* **Product** \\- For pages that must deal with the content of a single product, such as a product details page. Adding any new product automatically generates a new product page.\n* **Product collections** \\- For pages containing a group of products, such as the Search Result page.\n* **Standard** \\- For pages with no specific product content. For instance, the Home page.\n\n> Even though `Standard` pages are not directly linked to any specific product, they may display shelves or lists of any chosen group of products. The main difference is that the group of products shown on such a page does not depend on the URL query but only on the setting of the shelf itself.\n\nLet's suppose we are going to create a simple About Us page for a store. At first, the page is not directly connected to any specific product, we should create a custom `Standard` template for it with an image in its left column and a title and text content in its right column:\n\n\n\n1. In your Store Theme's code, declare a new template within your `blocks` folder or `blocks.jsonc` file.\n\n`1\n\n{ \n\n2\n\n \"store.custom#{templatename}\": { \n\n3\n\n \"blocks\": [ \n\n4\n\n ] \n\n5\n\n } \n\n6\n\n} \n\n`\n\n1. Fill it out with the blocks that will set the desired layout. For example:\n\n`1\n\n{ \n\n2\n\n \"store.custom#{templatename}\": { \n\n3\n\n \"blocks\": [ \n\n4\n\n \"flex-layout.row#about-us\" \n\n5\n\n ] \n\n6\n\n }, \n\n7\n\n \"flex-layout.row#about-us\": { \n\n8\n\n \"children\": [ \n\n9\n\n \"image#about-us\", \n\n10\n\n \"flex-layout.col#text-about-us\" \n\n11\n\n ] \n\n12\n\n }, \n\n13\n\n \"flex-layout.col#text-about-us\": { \n\n14\n\n \"children\": [ \n\n15\n\n \"rich-text#about-title\", \n\n16\n\n \"rich-text#about-content\" \n\n17\n\n ], \n\n18\n\n \"props\": { \n\n19\n\n \"preventVerticalStretch\": true \n\n20\n\n } \n\n21\n\n }, \n\n22\n\n\"rich-text#about-title\": { \n\n23\n\n \"props\": { \n\n24\n\n \"text\": \n\n25\n\n \"# About us Title\" \n\n26\n\n } \n\n27\n\n }, \n\n28\n\n \"rich-text#about-content\": { \n\n29\n\n \"props\": { \n\n30\n\n \"text\": \n\n31\n\n \" About us content - Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum\" \n\n32\n\n } \n\n33\n\n }, \n\n34\n\n \"image#about-us\": { \n\n35\n\n \"props\": { \n\n36\n\n \"src\": \"https://storecomponents.vteximg.com.br/arquivos/mobile-phone.png\", \n\n37\n\n \"maxHeight\": \"600px\" \n\n38\n\n } \n\n39\n\n } \n\n40\n\n} \n\n`\n\nFor more information, refer to the [Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout) documentation.\n\n### Creating the new page's path\n\nNow that your page layout has been defined in the Store Theme code, the next step is to define the page's path to make the page accessible. You can define it through direct code changes or by using the account's admin.\n\n#### Through code changes\n\n1. In your theme's source code, access the `routes.json` file. It can be found in the `store` folder.\n2. There, add a path to the recently created template's JSON:\n\n`1\n\n\"store.custom#{templatename}\": { \n\n2\n\n \"path\": \"/{URL}\" \n\n3\n\n} \n\n`\n\n1. Save your files.\n2. [Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/) the theme to a Development workspace. You will be able to access and see your new page live through your workspace, using the following format: `{workspaceName}--{accountName}.myvtex.com/{pathName}`.\n\n#### Using the account admin\n\nIf you prefer to set the new page path using account admin, you must first must [release](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-releasing-a-new-app-version) your changes regarding template creation and [install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) the new version of your Store Theme in a [production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace).\n\nOnce your changes are set up in a Production workspace, you will be able to use the admin's CMS to create the page's path:\n\n1. Access the admin's **Pages** section.\n2. Click on **Create New**.\n3. Choose the desired URL and any created template. For instance, the About Us page template previously created:\n\n\n\nNotice that a template only sets the page layout. Hence, any new template can be set on any page that accepts templates of the same type as the page itself.\n\n> When editing any content using the CMS section, it's always good to make your changes in a production workspace. Therefore, make sure you are not creating your new custom page in the store's master workspace.\n\n### Adding the content\n\nYour new page now has a custom layout, thanks to the newly created template, and can be accessed thanks to its route creation. The next step is editing its content.\n\nYou can define your page content by performing changes directly to your Store Theme app or using the admin's Site Editor. When using this last one, you can browse to your custom page or simply write its URL in the `Page URL` field. For example:\n\n\n\n### Making your theme content publicly available\n\nIf you are happy with the changes to your Store Theme, make your new theme content public. Up until this point, the changes were performed in your development workspace. Access our documentation on [**making your theme content publicly available**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/) and follow the steps detailed there.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-creating-a-new-custom-page.md)\n\n[Creating a custom search results page« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page//docs/guides/vtex-io-documentation-creating-a-custom-search-results-page)[Customizing the Header and Footer blocks by pageNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page//docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23instructions)\n\n[Creating the new template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23creating-the-new-template)[Creating the new page's path](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23creating-the-new-pages-path)[Adding the content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23adding-the-content)[Making your theme content publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23making-your-theme-content-publicly-available)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-creating-a-new-custom-page.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23instructions)\n\n[Creating the new template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23creating-the-new-template)[Creating the new page's path](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23creating-the-new-pages-path)[Adding the content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23adding-the-content)[Making your theme content publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page%23making-your-theme-content-publicly-available)\n\nOn this page\n\n[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=)"
}
] |
doc_27363960
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore headless cms overview in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/troubleshooting)\n\n[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/headless-cms-overview/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-overview)\n\n[Managing content with 'scopes' and 'requiredScopes'](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)\n\n[Multiple page templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-multiple-page-template)\n\n[Previewing Headless CMS in development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)\n\n[Widgets for Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-widgets)\n\n[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/dynamic-content-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-overview)\n\n[Managing content with 'scopes' and 'requiredScopes'](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)\n\n[Multiple page templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-multiple-page-template)\n\n[Previewing Headless CMS in development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)\n\n[Widgets for Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-widgets)\n\n[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/dynamic-content-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore)\n\nIntroducing the Headless CMS\n\nIn this guide, you will be presented with **Headless CMS**, the solution for content management in FastStore projects. By using the Headless CMS, you can empower editors to create, edit, and publish web content independently through the VTEX Admin.\n\nAs a developer, you are responsible not only for creating custom frontend solutions for your client's store but also for defining which content of the storefront will be editable via a Content Management System (CMS). A CMS allows others to edit the frontend content of your store without having to touch your code at all.\n\n---\n\n## Before you begin\n\nBefore you proceed, please ensure the following:\n\n### Access to a VTEX account\n\nEnsure you have a VTEX account to set up the Headless CMS with a FastStore project.\n\n### Set up your FastStore project\n\nIf you do not have a FastStore project, refer to the [Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project) guide.\n\n### Set up CMS resources with your VTEX user role\n\nYou must have the following [resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) associated with your VTEX Admin [user role](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) to be able to manage the Headless CMS:\n\n| **Product** | **Category** | **Resource** |\n| ----------- | -------------- | --------------------------- |\n| CMS | cms | See CMS menu on the top-bar |\n| CMS | cms | Settings |\n| CMS | GraphQL | CMS GraphQL API |\n| VTEX IO | Infrastructure | Vbase Read Write |\n\nTo associate a role with the resources mentioned above, you can [create a custom role](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc%23creating-a-role), add the resources to it, or add them to an existing role by editing it.\n\n---\n\n## Headless CMS\n\nHeadless CMS is a headless content management system that allows users to store content in a decoupled data layer and deliver it as structured data to their FastStore project via an API.\n\nAfter onboarding through [FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project), users can manage their FastStore project on VTEX Admin by navigating to **Storefront > Headless CMS** under the [Projects](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/managing-projects--42IpDFqTVTESH8DCypJMPM) feature.\n\nEach project lists all web pages created within it, starting empty and filling as editors add new pages. Each page corresponds to a unique URL and is identified by the following properties:\n\n| Property name | Description |\n| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Name** | Identifies a given page. This name is not available elsewhere and is used only internally in the Headless CMS for identification purposes. |\n| **Type** _(a.k.a., Content Type)_ | Determines the nature of a page. For example, the **Type** can be a Landing Page, a Product Listing Page (PLP), a Product Details Page (PDP), etc. You, as a developer, are the one responsible for defining which content types will be available for the editors of your store. |\n| **Last modified** | Indicates the last time a given page was edited. |\n| **Status** | Identifies the state of a page: Published: Pages that are published and already available in the live store. Draft: Pages that are in draft with work in progress and haven't been published yet. |\n\n### Content Types\n\nOnce editors click **Create Document** in the Headless CMS interface, they'll be able to select a type from a list of **Content Types** that you, the developer, established.\n\n\n\nContent Types are the building blocks for creating a scalable and maintainable storefront in FastStore. Predefined Content Types are available after onboarding through [FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project), enabling quick setup for pages like Home, Product Listing, and Custom Landing.\n\nContent Types are organized by [Scopes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23scopes), which define the context in which each Content Type can be used. Scopes categorize Content Types based on their functionality. For example, a Content Type with a `pdp` scope can only be used on PDPs.\n\nThe following table provides an overview of the standard Content Types, their IDs, scopes, and their respective purposes.\n\n> These standard Content Types are natively implemented. You can view their structure in the [content-types.json](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/blob/main/packages/core/cms/faststore/content-types.json) file.\n\n| **Content Type** | **ID** | **Scopes** | **Purpose** |\n| -------------------------- | -------------------- | ------------------ | --------------------------------------------------------------------------------- |\n| **Global Sections** | globalSections | global | Defines reusable sections that show across pages. |\n| **Global Header Sections** | globalHeaderSections | global | Defines the content for the global header, displayed at the top of every page. |\n| **Global Footer Sections** | globalFooterSections | global | Defines the content for the global footer, displayed at the bottom of every page. |\n| **Landing Page** | landingPage | landing and custom | Creates custom landing pages with SEO optimization. |\n| **Home** | home | home | Defines the structure and SEO metadata for the homepage. |\n| **Product Page** | pdp | pdp | Defines the structure and template for Product Detail Pages (PDP). |\n| **Product List Page** | plp | plp | Defines the structure and settings for Product Listing Pages (PLP). |\n| **Search Page** | search | plp and search | Defines the structure and settings for search results pages. |\n| **Login** | login | \\- | Defines the structure for the login page. |\n| **Error 500** | 500 | \\- | Defines the structure for the 500 Internal Server Error page. |\n| **Error 400** | 400 | \\- | Defines the structure for the 400 pages, including the 404 Not Found Error page. |\n\n### Sections\n\nEach Content Type has different sections available to build a page. Sections represent key React components, such as Hero or Product Gallery, manageable within the CMS. Editors can visually configure and arrange storefront sections without needing to code. For example, the [Alert component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert) is a FastStore UI component and section that can be used in various Content Types.\n\n\n\nSections are reusable across different pages. Developers determine which sections are available in the CMS. Below is an example of the **Hero** section:\n\n\n\n#### The Children section\n\nThe **Children** section is a special section used to organize and structure content within the Headless CMS interface. It is a global section, meaning it appears on all store pages and represents the core content of each page. This section is only available for the **Global Sections** Content Type.\n\n\n\n> The **Children** section cannot be deleted. Removing it would erase the main content of your store page.\n\nThe **Children** Section ensures that headers and footers (defined in **Global Sections**) are clearly separated from the main content of each page. For example, on a Product Listing Page (PLP), the Children section might include the following sections: Breadcrumb, Hero, Product Gallery, and Product Shelf. These sections are wrapped within the Children section.\n\n\n\nIn summary:\n\n* Headers and footers are defined in the **Global Sections** Content Type and appear on all store pages.\n* The **Children** section wraps the main content of a page, ensuring clear separation from headers and footers.\n\n\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/headless-cms/overview.mdx)\n\n[Managing Secrets« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/webops-managing-secrets)[Managing content with 'scopes' and 'requiredScopes'Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-overview%23before-you-begin)\n\n[Access to a VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-overview%23access-to-a-vtex-account)[Set up your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-overview%23set-up-your-faststore-project)[Set up CMS resources with your VTEX user role](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-overview%23set-up-cms-resources-with-your-vtex-user-role)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-overview%23headless-cms)\n\n[Content Types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-overview%23content-types)[Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-overview%23sections)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/headless-cms/overview.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-overview%23before-you-begin)\n\n[Access to a VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-overview%23access-to-a-vtex-account)[Set up your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-overview%23set-up-your-faststore-project)[Set up CMS resources with your VTEX user role](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-overview%23set-up-cms-resources-with-your-vtex-user-role)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-overview%23headless-cms)\n\n[Content Types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-overview%23content-types)[Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview/docs/guides/faststore/headless-cms-overview%23sections)\n\nOn this page\n\n[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=)"
}
] |
doc_62971903
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides external marketplace integration architecture in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides)\n\nIntegration Guides\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-architecture)\n\nMarketplace / Seller architecture\n\nGiven the separation of concerns between [marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol%23external-marketplace) and seller, creating a custom connector for external systems requires mapping out the equivalent behavior observed in VTEX stores. This step provides an overview of what is expected of each subsystem.\n\n## Business agreements\n\nThe starting point for a marketplace is defining the policies, agreements, and guidelines governing the business relationship between marketplace and sellers.\n\nThese legal agreements will differ in scope and content depending on the specific type of industry and marketplace business model in place, but some concerns are common:\n\n* Commission fees and receipt of sales proceeds\n* Criteria for product selection and exposure\n* Customer support requirements\n* Delivery time and cost requirements\n\n> Consider skimming through the [Program Policies](https://read.calvincode.net/reader?url=https://sellercentral.amazon.com/gp/help/external/help.html?itemID=521%26language=en%5FUS%26ref=efph%5F521%5Fcont%5FSNV3657R94YP9DZ) enforced by Amazon for inspiration. From the technical standpoint, however, these are the requirements for each stakeholder:\n\n| Who | What |\n| ----------- | ---------------------------------------------------------------- |\n| Marketplace | Owns the storefront and is responsible for the checkout process. |\n| Seller | Owns the product and is responsible for the fulfillment process. |\n\nEverything else should be agreed upon between marketplace and sellers, taking into account that additional development may be needed to enforce certain policies.\n\n## Catalog management\n\nWhen dealing with product information, our core assumption is that every business should define its own catalog structure. Due to that, the interaction between marketplaces and sellers is based on offers, which include product information, price, and quantity in stock.\n\nFrom a technical standpoint, this is what each stakeholder must do:\n\n| Who | What |\n| ----------- | -------------------------------------------------------------------------------------------------------------------------------------- |\n| Marketplace | Receive and manage offers made by sellers, deciding how they should be incorporated in their catalog through SKU matching and binding. |\n| Seller | Send offers with the product information, price, and quantity in stock. |\n\n## Pricing & promotions\n\nWhen dealing with prices, our core assumption is that every business should define its own pricing strategy. Due to that, order authorization rules are defined by the seller to deal with scenarios of price divergence.\n\nFrom a technical standpoint, this is what each stakeholder must do:\n\n| Who | What |\n| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Marketplace | Receive price change notifications and update price records accordingly. |\n| Seller | Define prices & promotions that should be applied to the marketplace, define price divergence rules for order authorization to deny orders, send price change notifications, and allow the marketplace to fetch updated prices. |\n\n## Inventory & shipping\n\nWhen dealing with logistics, our core assumption is that sellers manage their shipping strategy, unless the marketplace requires them to adhere to their fulfillment services. This includes defining the inventory and shipping policies available to each sales channel.\n\nFrom a technical standpoint, this is what each stakeholder must do:\n\n| Who | What |\n| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| Marketplace | Receive change notifications and update inventory accordingly. |\n| Seller | Define inventory & shipping policies available to the marketplace, send inventory change notifications, and allow the marketplace to fetch updated inventory, freight costs, and delivery time for products. |\n\n## Storefront & checkout\n\nIn our architecture, the marketplace is responsible for the purchase flow and placing the order correctly to the seller. To avoid placing orders with price divergence (outdated prices) and stockouts (exhausted inventory), the marketplace storefront should perform cart simulations to get updated product information at multiple stages of the purchase flow.\n\nOptionally, the marketplace may establish criteria for seller selection or exposure. This happens when the marketplace wants to incentivize competition between sellers to become the default selection in their buy box or allow shoppers to choose who they are buying their products from.\n\nFrom a technical standpoint, this is what each stakeholder must do:\n\n| Who | What |\n| ----------- | -------------------------------------------------------------------------- |\n| Marketplace | Display products in its storefront, place orders to sellers upon checkout. |\n| Seller | Receive orders placed by the marketplace. |\n\n## Order fulfillment\n\nIn our architecture, each stakeholder is responsible for a part of the [order flow](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/pedidos--2xkTisx4SXOWXQel8Jg8sa/4811ExCe3WrEiRMV3sy9n8). Changes and cancellations can be made within a certain window, which can be configured by the marketplace.\n\n## Payment conditions & commissioning\n\nIn our architecture, the marketplace is usually responsible for defining the payment conditions it will offer and the commission fees they will charge from sellers. Using the [merge payments](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/how-merge-payments-works--3YozHxPuUEg6msoE6oEi84) functionality, however, it may include payment methods provided by it sellers.\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-architecture.md)\n\n[External Marketplace« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture//docs/guides/external-marketplace-integration-guide)[Store setup for VTEX SellerNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture//docs/guides/external-marketplace-integration-vtex-seller-setup)\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Business agreements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-architecture%23business-agreements)\n\n[Catalog management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-architecture%23catalog-management)\n\n[Pricing & promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-architecture%23pricing--promotions)\n\n[Inventory & shipping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-architecture%23inventory--shipping)\n\n[Storefront & checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-architecture%23storefront--checkout)\n\n[Order fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-architecture%23order-fulfillment)\n\n[Payment conditions & commissioning](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-architecture%23payment-conditions--commissioning)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-architecture.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Business agreements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-architecture%23business-agreements)\n\n[Catalog management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-architecture%23catalog-management)\n\n[Pricing & promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-architecture%23pricing--promotions)\n\n[Inventory & shipping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-architecture%23inventory--shipping)\n\n[Storefront & checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-architecture%23storefront--checkout)\n\n[Order fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-architecture%23order-fulfillment)\n\n[Payment conditions & commissioning](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-architecture/docs/guides/external-marketplace-integration-architecture%23payment-conditions--commissioning)\n\nOn this page\n\n[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=)"
}
] |
doc_b678e2e4
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore project structure updating the cli package version in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/troubleshooting)\n\n[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/project-structure-updating-the-cli-package-version/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/developer-tools-overview)\n\n[Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/developer-tools-config-options)\n\n[Custom Cypress integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/developer-tools-custom-cypress)\n\n[FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/developer-tools-faststore-cli)\n\n[Updating the @fastore/cli package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/developer-tools-updating-the-cli-package-version)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/developer-tools-overview)\n\n[Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/developer-tools-config-options)\n\n[Custom Cypress integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/developer-tools-custom-cypress)\n\n[FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/developer-tools-faststore-cli)\n\n[Updating the @fastore/cli package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/developer-tools-updating-the-cli-package-version)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/developer-tools-overview)\n\nUpdating the '@faststore/cli' package version\n\nIf you need to update the [@faststore/cli](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson) package, follow these instructions.\n\n> Since the publication of [this release note](https://read.calvincode.net/reader?url=https://developers.vtex.com/updates/release-notes/2024-09-11-faststore-cli-dependency), the `@faststore/core` package now depends on the `@faststore/cli` package. Before updating the `@faststore/cli` package, make sure to check if this package is already listed in your dependencies. If not, check out the [release note](https://read.calvincode.net/reader?url=https://developers.vtex.com/updates/release-notes/2024-09-11-faststore-cli-dependency) related to this change.\n\n1. Open your FastStore codebase in the code editor of your preference.\n2. Open the terminal and run the following: \n`1 \nyarn add @faststore/cli@latest \n`\n3. Run `yarn dev` to sync the changes to your project.\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developer-tools/updating-the-cli-package-version.mdx)\n\n[FastStore CLI« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/developer-tools-faststore-cli)[StylingNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-cli-package-version/docs/guides/faststore/styling-overview)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developer-tools/updating-the-cli-package-version.mdx)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[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=)"
}
] |
doc_e385bea6
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation 2 basicsetuptodevelopinvtexio in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-2-basicsetuptodevelopinvtexio/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/api-reference)\n\n[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-2-basicsetuptodevelopinvtexio/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/storefront-development)\n\n[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-2-basicsetuptodevelopinvtexio/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/troubleshooting)\n\n[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-2-basicsetuptodevelopinvtexio/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[What is a Pixel app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-pixel-app)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio)\n\n[2\\. Cloning the boilerplate repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository)\n\n[3\\. Configuring your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-4-configuringyourappsettings)\n\n[4\\. Writing the head and body scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-5-writingtheheaderandbodyscripts)\n\n[5\\. Listening to store events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-6-listeningtostoreevents)\n\n[6\\. Structuring the documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-7-structuringthedocumentation)\n\n[7\\. Making your Pixel app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-8-makingyourpixelapppubliclyavailable)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/create-master-data-crud-app)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[What is a Pixel app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-pixel-app)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio)\n\n[2\\. Cloning the boilerplate repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository)\n\n[3\\. Configuring your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-4-configuringyourappsettings)\n\n[4\\. Writing the head and body scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-5-writingtheheaderandbodyscripts)\n\n[5\\. Listening to store events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-6-listeningtostoreevents)\n\n[6\\. Structuring the documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-7-structuringthedocumentation)\n\n[7\\. Making your Pixel app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-8-makingyourpixelapppubliclyavailable)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/create-master-data-crud-app)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/app-development)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-getting-started)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio)\n\nSetting up your development environment\n\nIn this part of the tutorial, you will:\n\n* Install all the necessary tools to develop your own Pixel app.\n* Create a new development workspace.\n* Access your store using a workspace.\n\n## Instructions\n\n### Step 1 - Installing the VTEX IO CLI\n\nAny development in VTEX IO begins and ends with the **VTEX IO CLI**, which works as a communication gateway between your store and the VTEX IO development platform. With VTEX IO’s CLI, you can use the terminal to log in to your VTEX account, manage workspaces, develop apps, and install new ones.\n\n1. Install the VTEX IO CLI on your machine by following [this guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install).\n2. Check if the installation was successful by running `vtex`.\n\n### Step 2 - Logging in to your VTEX account\n\nAfter installing the VTEX IO CLI in your machine, take the following steps to log in to your VTEX account.\n\n1. Log in to your VTEX account by running the following command:\n\n`1\n\nvtex login accountName \n\n`\n\n> Replace `accountName` with the name of your VTEX account.\n\n\n\n1. After running the command, a browser window will open and ask for your credentials. Please enter the information required to log in to your account successfully.\n\n### Step 2 - Creating a development workspace\n\nWhen developing with VTEX IO, you'll use different [**workspaces**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/). Workspaces are environments isolated from one another. They can be understood as different versions of the same VTEX account. In practice, changes performed in a particular workspace do not affect your store's live version or other developers' work.\n\nWhen you log in to a VTEX account using the VTEX IO CLI, you are automatically in the **master** workspace, which is the version of your store available to end-users. Hence, to avoid changing your store's live version, you must create a **development workspace**.\n\n1. Create a development workspace by running the following command:\n\n`1\n\nvtex use exampleworkspace \n\n`\n\n> Replace `exampleworkspace` with a name of your choosing to identify your new workspace.\n\n1. Enter `Y` to create the new workspace.\n\n\n\nAfter running this command, you'll be taken to the `exampleworkspace` workspace, and all your operations will now run in this specified workspace.\n\n### Step 3 - Accessing your store using a workspace\n\nAfter creating a new development workspace, you can access this version of your store by going to: `https://exampleworkspace--accountName.myvtex.com`, where:\n\n* `exampleworkspace` \\- Name of the workspace that you've just created.\n* `accountName` \\- Name of the VTEX account in which you are working.\n\nDone! You're now ready to start developing your Pixel app!\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[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-1-developnativeintegrationswithpixelapps/vtex-io-documentation-2-basicsetuptodevelopinvtexio.md)\n\n[What is a Pixel app« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio//docs/guides/vtex-io-documentation-pixel-app)[2\\. Cloning the boilerplate repositoryNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio//docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository)\n\nSee also\n\n[2\\. Cloning the boilerplate repositoryApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio%23instructions)\n\n[Step 1 - Installing the VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio%23step-1-installing-the-vtex-io-cli)[Step 2 - Logging in to your VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio%23step-2-logging-in-to-your-vtex-account)[Step 2 - Creating a development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio%23step-2-creating-a-development-workspace)[Step 3 - Accessing your store using a workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio%23step-3-accessing-your-store-using-a-workspace)\n\nWas this helpful?\n\n Send feedback\n\n[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-1-developnativeintegrationswithpixelapps/vtex-io-documentation-2-basicsetuptodevelopinvtexio.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio%23instructions)\n\n[Step 1 - Installing the VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio%23step-1-installing-the-vtex-io-cli)[Step 2 - Logging in to your VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio%23step-2-logging-in-to-your-vtex-account)[Step 2 - Creating a development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio%23step-2-creating-a-development-workspace)[Step 3 - Accessing your store using a workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio%23step-3-accessing-your-store-using-a-workspace)\n\nOn this page\n\n[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=)"
}
] |
doc_5cc88800
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore webops managing secrets in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/troubleshooting)\n\n[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/webops-managing-secrets/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-dashboard)\n\n[Configuring production and preview branches in WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-configuring-production-and-preview-branches)\n\n[Managing Secrets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-managing-secrets)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-dashboard)\n\n[Configuring production and preview branches in WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-configuring-production-and-preview-branches)\n\n[Managing Secrets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-managing-secrets)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-dashboard)\n\nManaging Secrets\n\nIn this guide, you'll learn how to manage secrets in your FastStore project using [WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project).\n\nSecrets are sensitive information, such as API keys, passwords, and tokens, that must be securely managed during the FastStore project deployment.\n\n[WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project) centralizes and standardizes secret management, providing a consistent and secure process across all deployment providers. This ensures that sensitive information is kept outside your project codebase and is retrieved securely by WebOps.\n\n> The secrets of stores that don't use WebOps are handled through the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins) secrets plugin. To enable secret management, you need to have an empty `vtex.env` file in the project root. The key-value pairs are stored in the `secrets.revealed.json` file, which is then encrypted into `secrets.hidden.json` before being committed to the main branch. For stores using WebOps, this workflow has been deprecated, and secrets are managed directly through the WebOps interface.\n\n## Local development\n\nFor local development, you must use the `vtex.env` file to define the secrets needed to run your FastStore project locally.\n\nThe `vtex.env` file is only used in local environments and should always be added to `.gitignore` to avoid leaking secrets through version control. By adding it to `.gitignore`, secrets defined in the `vtex.env` file won't be available in deployed environments via WebOps.\n\n## Before you begin\n\nVTEX offers a permissions system, so only users assigned to a role with the required [License Manager resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) can manage secrets.\n\n> The permissions system is in Open Beta. To enable it, open a ticket with [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\nAfter enabling the feature, make sure you have a user associated with a role that contains the following License Manager resources:\n\n* **Product:** FastStore\n* **Category:** Secrets\n* **Resources:** _View Secrets_ and _Edit Secrets_\n\n\n\n## Instructions\n\nTo manage your secrets, go to your [FastStore WebOps dashboard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard) and navigate to the **Settings** tab.\n\n\n\nIn the [Secrets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard%23secrets) section, you can [create](#creating-secrets), [update](#updating-secrets), or [delete](#deleting-secrets) secrets following the steps below.\n\n> After you create, update, or delete a secret, it may take a few minutes for the change to propagate. Wait 5 minutes before triggering a new deployment.\n> \n> If you deployed your storefront immediately after creating, updating, or deleting a secret and the change isn’t reflected in your store, wait a few minutes and run another deploy before opening a support ticket.\n\n### Creating secrets\n\n1. In the `Key` field, enter the name of the secret, which serves as its unique identifier (example: VTEX\\_API\\_TOKEN, NEXT\\_SECRET\\_KEY). In the `Value` field, enter the corresponding sensitive information you want to store (example: the actual token, key, or password). \n> Secrets accessible in the browser (client-side) must start with the prefix `NEXT_PUBLIC_`. Use names without this prefix for all other secrets.\n2. Click `Add`. A pop-up with `New secret added successfully` will open, and you'll see the message `Secrets have changed. Changes will take effect in the next successful deployment.` alongside a `Redeploy` button. \n> When creating multiple secrets, make sure you include all of them before proceeding to the next step. This prevents sync errors.\n3. Wait **5 minutes**, then click `Redeploy` to redeploy your website with the updated secret configuration. You'll see the message `Redeploying with secret changes`, and a pop-up with `Deployment created successfully` will open.\n4. Track the deployment status in the [Deploys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard%23deploys) tab of the WebOps dashboard.\n\nDuring the build process, any secrets added through WebOps will be transformed into environment variables within the code, which automatically loads them into the `process.env` object. You can access these values in your code using `process.env.VARIABLE_NAME`. _Remember to replace `VARIABLENAME` with the name you assigned to your secret in the `Key` field_.\n\nThe secret created will be available in the **Current Keys** section.\n\n\n\n### Updating secrets\n\n1. Go to the `Current Keys` section.\n2. Next to the secret you need to update, click `⋮` and then click `Edit`.\n3. Click `Update`. A pop-up with `Secret updated successfully` will open, and you'll see the message `Secrets have changed. Changes will take effect in the next successful deployment.` alongside a `Redeploy` button.\n4. Wait **5 minutes**, then click `Redeploy` to redeploy your website with the updated secret configuration. You'll see the message `Redeploying with secret changes`, and a pop-up with `Deployment created successfully` will open.\n5. Track the deployment status in the [Deploys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard%23deploys) tab of the WebOps dashboard.\n\n\n\n### Deleting secrets\n\n1. Go to the `Current Keys` section.\n2. Next to the secret you need to delete, click `⋮` and then click `Delete`.\n3. Confirm the secret you want to remove. \n> This action can't be undone.\n4. Click `Delete secret`. A pop-up with `Secret deleted successfully` will open, and you'll see the message `Secrets have changed. Changes will take effect in the next successful deployment.` alongside a `Redeploy` button.\n5. Wait **5 minutes**, then click `Redeploy` to redeploy your website with the updated secret configuration. You'll see the message `Redeploying with secret changes`, and a pop-up with `Deployment created successfully` will open.\n6. Track the deployment status in the [Deploys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard%23deploys) tab of the WebOps dashboard. \n \n> If you tried to create, update, or delete a secret and got the error `Failed to create/update/delete secret. Please, try again.`, repeat the process. If the problem persists, open a ticket with [VTEX support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/webops/managing-secrets.mdx)\n\n[Configuring production and preview branches in WebOps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-configuring-production-and-preview-branches)[Headless CMSNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/headless-cms-overview)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Local development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-managing-secrets%23local-development)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-managing-secrets%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-managing-secrets%23instructions)\n\n[Creating secrets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-managing-secrets%23creating-secrets)[Updating secrets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-managing-secrets%23updating-secrets)[Deleting secrets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-managing-secrets%23deleting-secrets)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/webops/managing-secrets.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Local development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-managing-secrets%23local-development)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-managing-secrets%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-managing-secrets%23instructions)\n\n[Creating secrets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-managing-secrets%23creating-secrets)[Updating secrets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-managing-secrets%23updating-secrets)[Deleting secrets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-managing-secrets/docs/guides/faststore/webops-managing-secrets%23deleting-secrets)\n\nOn this page\n\n[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=)"
}
] |
doc_1d8348fb
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex storefront permissions in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/troubleshooting)\n\n[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-storefront-permissions/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/updates/release-notes)\n\nStorefront Permissions\n\n> The **Storefront Permissions** app is part of VTEX’s [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite) solution, which is a collection of apps that allow stores to manage organizations, storefront roles and permissions, and checkout settings for B2B commerce relationships. We recommend that you use it alongside the other apps in this suite for all functionalities to work as expected.\n\nWhen navigating a B2B store as a customer, it is common for a main user from an organization to have other people under their structure, each with their own information and access privileges.\n\nWithin an organization, each user can have different roles, such as a professional buyer that places orders with budget limits from a predefined cost center or a manager in charge of reviewing and approving orders. These roles can be associated with multiple permissions, depending on the actions this user needs to perform.\n\nThe **Storefront Permissions** app stores a predefined set of roles and app permissions related to what B2B users can access and do in your storefront, making this information available for other integrated apps to check. This is useful for stores who want to set specific app permissions for users with different roles in an organization.\n\n## Available storefront roles\n\nIn the following table, you can see the available storefront roles, their key used for identification in the app’s code, and their description.\n\n| **Role** | **Key** | **Description** |\n| --------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Store Admin | store-admin | Store administrator, that is, a user who has access to the VTEX Admin. |\n| Sales Admin | sales-admin | Sales administrator user who can manage all sales users. |\n| Sales Manager | sales-manager | Sales manager user who can manage sales users in the same organization, as well as assist or impersonate buyers during navigation or purchase. |\n| Sales Representative | sales-representative | Sales representative user who can assist or impersonate buyers in the same cost center during navigation or purchase. |\n| Organization Admin | customer-admin | Main organization user who manages the organization information, as well as its members and cost centers. |\n| Organization Approver | customer-approver | Organization user who can take a saved cart or quote that was created by an **Organization Buyer** and use it to place an order. |\n| Organization Buyer | customer-buyer | Organization user who has the ability to add items to cart. If the **B2B Quotes** app is installed, they are also able to save their cart for future use or create a quote. |\n\n## How it works\n\n**Storefront Permissions** communicates automatically with other [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite) apps, such as [B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations), where it enables different organization management capabilities depending on each user’s role.\n\nIt also allows you to configure available permissions when developing your own app, associate them with the predefined roles, and have these permissions checked by other applications – if you perform the steps described in the [Advanced app integration](#advanced-app-integration-optional) section.\n\nThe **Storefront Permissions** app does not contain an interface – it operates “backstage”, storing the predefined roles and serving as a bridge to communicate with other apps in order to check user permissions. If you would like to manage roles and app permissions using the VTEX Admin interface, you must also install the [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui) app. As an optional feature, you can install the [Admin Customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers) app for additional customer management capabilities.\n\n## Before you begin\n\nMake sure you have the [VTEX IO CLI (Command Line Interface)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install) installed in your machine.\n\nIf you opt to develop your own app and [integrate](#advanced-app-integration-optional) it with **Storefront Permissions**, read our documentation on [Developing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-an-app).\n\n## Installation\n\nYou can install the app by running `vtex install vtex.storefront-permissions` in your terminal, using the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).\n\n## Advanced app integration \\[optional\\]\n\nIf you would like to develop your own app and integrate it with **Storefront Permissions**, follow the steps below.\n\n1. Open your app’s repository.\n2. In the `manifest.json` file, add `vtex.storefront-permissions` under the `builders` property, as follows. \n`1 \n\"builders\": { \n2 \n\"vtex.storefront-permissions\": \"1.x\" \n3 \n} \n`\n3. In the root folder, create a new folder named `vtex.storefront-permissions`.\n4. In the `vtex.storefront-permissions` folder, create a `configuration.json` file. The content of this file should follow the format below. Keep in mind that you must replace the example information with the `name` of your app and its `features`. \n`1 \n{ \n2 \n \"name\": \"My awesome app\", \n3 \n \"features\": [ \n4 \n { \n5 \n \"label\": \"View\", \n6 \n \"value\": \"view-awesome-things\", \n7 \n \"roles\": [\"store-admin\",\"sales-admin\",\"sales-manager\",\"sales-representative\",\"customer-admin\",\"customer-approver\",\"customer-buyer\"] \n8 \n }, \n9 \n { \n10 \n \"label\": \"Create\", \n11 \n \"value\": \"create-awesome-things\", \n12 \n \"roles\": [\"store-admin\",\"sales-admin\",\"sales-manager\",\"sales-representative\"] \n13 \n }, \n14 \n { \n15 \n \"label\": \"Delete\", \n16 \n \"value\": \"delete-awesome-things\", \n17 \n \"roles\": [\"store-admin\",\"sales-admin\",\"sales-manager\",\"sales-representative\"] \n18 \n }, \n19 \n { \n20 \n \"label\": \"Special Access\", \n21 \n \"value\": \"allow-special-access\", \n22 \n \"roles\": [\"store-admin\",\"sales-admin\"] \n23 \n } \n24 \n ] \n25 \n} \n` \nBelow you can find a description of each property. \n| **Property** | **Type** | **Description** | \n| ------------ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | \n| name | string | Name of your app. | \n| features | array of objects | List of features related to your app – the functionalities of your app that you want to set permissions for users to be able to access or not. | \n| ⤷ | object | Object containing information about each feature of your app. | \n| ⤷ label | string | Name or description of the feature. | \n| ⤷ value | string | Identifier key you want to use for the feature, as used in your app’s [custom storefront components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components). Do not use space or special characters in this field. | \n| ⤷ roles | array of strings | List with the keys for all the roles you want to associate with the permission to use the feature by default. You can find more information about each role and its key in the [Available Storefront Roles section](#available-storefront-roles) of this documentation. |\n5. Make sure you refer to the `value` – the identifier key – for each feature you want to set permissions for in your [custom storefront components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components)’ code, when developing your app. \nExample: in the B2B Organizations app, one of the permissions created is represented by the following object. \n`1 \n{ \n2 \n \"label\": \"Create Cost Center\", \n3 \n \"value\": \"create-cost-center-organization\", \n4 \n \"roles\": [\"store-admin\",\"sales-admin\",\"customer-admin\"] \n5 \n} \n` \nTherefore, in a [custom storefront component’s code](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/b2b-organizations/blob/366a28add226eac5d9b104bb13a9f2cd1d574f02/react/components/CostCenterDetails.tsx) in TypeScript, whenever referring to this feature, it uses `create-cost-center-organization`.\n\nOnce you are done developing and installing your own app, if you have [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui), the features of your app associated with each role will be automatically loaded on the **Storefront Permissions** page. For more details on this, read our documentation on the [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui) app.\n\n### GraphQL queries\n\nNow that your app is integrated, you can write a GraphQL query on your app to check the current user's permission within the context of your app.\n\nFirst, you need to associate your test user to a Role containing your app's permission by following the [B2B Organizations documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations%23users).\n\nIt is not necessary to declare your app name nor user credentials, the query will take care of these details.\n\n#### checkUserPermission\n\nThis query allows you to check which permissions a user has in the context of your app. When the query is performed, **Storefront Permissions** checks which app the request is coming from, and returns the current user's permissions for that specific app.\n\nThe response will be a list with all the permissions the current user has on the app.\n\nSample query:\n\n`1\n\nquery permissions { \n\n2\n\n checkUserPermission @context(provider: \"vtex.storefront-permissions\") { \n\n3\n\n role { \n\n4\n\n id \n\n5\n\n name \n\n6\n\n slug \n\n7\n\n } \n\n8\n\n permissions \n\n9\n\n } \n\n10\n\n} \n\n`\n\nSample response:\n\n`1\n\n{ \n\n2\n\n \"data\":{ \n\n3\n\n \"checkUserPermission\": { \n\n4\n\n \"role\": { \n\n5\n\n \"id\": \"00549c22-f39d-11eb-82ac-0a55b612700f\", \n\n6\n\n \"name\": \"Admin\", \n\n7\n\n \"slug\": \"customer-admin\" \n\n8\n\n }, \n\n9\n\n \"permissions\": [\"view-awesome-things\",\"create-awesome-things\",\"delete-awesome-things\"] \n\n10\n\n } \n\n11\n\n } \n\n12\n\n} \n\n`\n\n#### hasUsers\n\nThis query allows you to check if there are any users associated with a specific role. The response will be a boolean, with `\"hasUsers\": true` if there are users with this role or `false` if there are not.\n\nSample query:\n\n`1\n\nquery hasUsers { \n\n2\n\n hasUsers(slug: \"sales-admin\") \n\n3\n\n @context(provider: \"vtex.storefront-permissions\") \n\n4\n\n} \n\n`\n\nSample response:\n\n`1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"hasUsers\": true \n\n4\n\n } \n\n5\n\n} \n\n`\n\n#### checkImpersonation\n\nThis query allows you to check if the current user is [impersonating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations%23impersonate-users) another user, and retrieve information on the impersonated user.\n\nSample query:\n\n`1\n\nquery checkImpersonation { \n\n2\n\n checkImpersonation { \n\n3\n\n firstName \n\n4\n\n lastName \n\n5\n\n email \n\n6\n\n userId \n\n7\n\n error \n\n8\n\n } \n\n9\n\n} \n\n`\n\nSample response:\n\n`1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"checkImpersonation\": { \n\n4\n\n \"firstName\": \"Andrew\", \n\n5\n\n \"lastName\": \"Smith\", \n\n6\n\n \"email\": \"testemail@mail.com\", \n\n7\n\n \"userId\": \"aaaaa-bbbb-cccc-dddd-eeeee\", \n\n8\n\n \"error\": null \n\n9\n\n } \n\n10\n\n } \n\n11\n\n} \n\n`\n\n#### getSessionWatcher\n\nUsing Session Watcher, **Storefront Permissions** detects changes to the user authentication to trigger changes to its cart and navigation, based on associated price tables, collections, profile information and shipping options.\n\nThis query fetches Session Watcher’s status, that is, whether it is active or not. The response will be a boolean, with `true` meaning that it is enabled or `false` meaning it is disabled.\n\nSample query:\n\n`1\n\nquery getSessionWatcher { \n\n2\n\n getSessionWatcher \n\n3\n\n} \n\n`\n\nSample response:\n\n`1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"getSessionWatcher\": false \n\n4\n\n } \n\n5\n\n} \n\n`\n\n### GraphQL mutation\n\n#### impersonateUser\n\nUsing this mutation, you can inform the `userId` to [impersonate an user](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations%23impersonate-users). To remove impersonation, send an empty `userId` instead.\n\nSample mutation:\n\n`1\n\nmutation impersonateUser($userId: ID) \n\n2\n\n@context(provider: \"vtex.storefront-permissions\") { \n\n3\n\n impersonateUser(userId: $userId) { \n\n4\n\n status \n\n5\n\n message \n\n6\n\n } \n\n7\n\n} \n\n`\n\n#### setSessionWatcher\n\nIf your account is not using `vtex.b2b-organizations` you may want to disable the Session Watcher to avoid unnecessary operations. To do so, set the `active` property to `false` in the mutation exemplified below.\n\nThe response will be a boolean, with `true` for a successful operation or `false` for a failure.\n\nSample mutation:\n\n`1\n\nmutation setSessionWatcher { \n\n2\n\n sessionWatcher(active: false) \n\n3\n\n} \n\n`\n\nSample response:\n\n`1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"sessionWatcher\": true \n\n4\n\n } \n\n5\n\n} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/vtex-b2b-suite/vtex-storefront-permissions.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Available storefront roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/guides/vtex-storefront-permissions%23available-storefront-roles)\n\n[How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/guides/vtex-storefront-permissions%23how-it-works)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/guides/vtex-storefront-permissions%23before-you-begin)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/guides/vtex-storefront-permissions%23installation)\n\n[Advanced app integration \\[optional\\]](https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/guides/vtex-storefront-permissions#advanced-app-integration-optional)\n\n[GraphQL queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/guides/vtex-storefront-permissions%23graphql-queries)[GraphQL mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/guides/vtex-storefront-permissions%23graphql-mutation)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/vtex-b2b-suite/vtex-storefront-permissions.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Available storefront roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/guides/vtex-storefront-permissions%23available-storefront-roles)\n\n[How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/guides/vtex-storefront-permissions%23how-it-works)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/guides/vtex-storefront-permissions%23before-you-begin)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/guides/vtex-storefront-permissions%23installation)\n\n[Advanced app integration \\[optional\\]](https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/guides/vtex-storefront-permissions#advanced-app-integration-optional)\n\n[GraphQL queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/guides/vtex-storefront-permissions%23graphql-queries)[GraphQL mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions/docs/guides/vtex-storefront-permissions%23graphql-mutation)\n\nOn this page\n\n[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=)"
}
] |
doc_65d8a3de
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides extensibility in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/vtex-platform-overview)\n\n[Cloud infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/cloud-infrastructure)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/security)\n\n[Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/data-privacy)\n\n[Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/composability)\n\n[Extensibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility)\n\n[Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/store-architecture)\n\n[Developer experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/developer-experience)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/vtex-platform-overview)\n\n[Cloud infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/cloud-infrastructure)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/security)\n\n[Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/data-privacy)\n\n[Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/composability)\n\n[Extensibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility)\n\n[Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/store-architecture)\n\n[Developer experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/developer-experience)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides)\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/vtex-platform-overview)\n\n[Extensibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility)\n\nExtensibility\n\nUnderstand how to extend VTEX capabilities beyond what comes out of the box\n\nVTEX is a [complete platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability%23vtex-composable-and-complete), in the sense that, out of the box, it offers all the features needed to run an ecommerce operation. The VTEX platform is also extensible, providing multiple ways to extend its basic functionality, including integrating third-party solutions and developing custom applications.\n\nIn this guide, we discuss VTEX’s extensibility in four areas divided into the following sections:\n\n* [Data services](#data-services)\n* [Commerce APIs](#commerce-apis)\n* [Development platform](#development-platform)\n* [Composable SaaS (Software as a Service)](#composable-saas)\n\n\n\n## Data services\n\n[Master Data](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw) is a key-document database solution that enables merchants to store, search, expand, and customize data. This solution allows custom data behaviors and creating custom applications using its API endpoints and [VTEX IO clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients).\n\nMaster Data provides the following advantages:\n\n* **Native VTEX solution**: Start working with Master Data out of the box. There is no need to integrate an external database solution.\n* **Scalable**: Store data as needed without worrying about usage limits.\n* **No additional costs**: VTEX does not charge extra. It does not matter how much you use Master Data resources.\n\nThere are two Master Data versions available (v1 and v2). Learn more about each of their features in the [Master Data](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw%23versions-available) guide. By default, Master Data v1 keeps customer data from the stores.\n\nMaster Data has three main concepts about data structure:\n\n* [**Data entities**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw%23data-entities): The definition of the data structures in table format. Each data entity has a name and stores a data type. For instance, in Master Data v1, the CL data entity stores data from store customers.\n* [**Documents**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw%23documents): The table rows, which are records of the data entity. In Master Data v1, each document represents one store customer in the CL data entity.\n* [**Fields**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw%23fields): The table columns, which are the properties of the data entity. In Master Data v1, the CL data entity has the fields name, ID number, email, and phone number.\n\nThe following sections show how Master Data extends the basic functionality of a VTEX store.\n\n### New entities and data schemas\n\nMaster Data comes with a default set of data entities necessary for basic ecommerce operations. Additionally, it allows customization and extension of the data models. This can be done in two ways depending on the Master Data version.\n\nIn Master Data v1, you can create and edit data entities [using its UI](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/data-entity--tutorials%5F1265%23creating-data-entities). In Master Data v2, you can create and edit [data schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-json-schemas-in-master-data-v2) through the [API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2). The table below shows a summary of the data entity capabilities.\n\n**Click here to view the capabilities table**\n\n| **Capability** | **Description** | **Availability** |\n| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |\n| Define data entity name | Define the name of the data entity when it is created. In Master Data v1, you must also choose its acronym, which is composed of two capital letters. For instance, the Address data entity has the acronym AD. | Master Data v1Master Data v2 |\n| Define the fields and their properties | In Master Data v1, you can use the UI to define the data entity fields and their properties. Some of the properties include the field type and if the field is nullable, searchable, or filterable.In Master Data v2, with JSON schema validation, requests that use properties different from what is defined in the selected schema are invalidated. For instance, you will get an error if you try to change a field with string type to the value 2. | Master Data v1Master Data v2 |\n| id field generation | This determines how Master Data v1 generates the id field, which is used to identify documents in the data entities. It can be generated automatically using the **GUID** (Globally Unique Identifier) and **sequential numeric** options or entered manually when creating new documents. | Master Data v1 |\n| Index or alternate keys | Set up additional fields that work with an [index](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components%23index). This allows retrieving documents without using the id. | Master Data v1Master Data v2 |\n| Default fields | Set the default fields. These are the fields shown when reading a document or doing a search and the \\_fields query parameter is not declared in the request. | Master Data v2 |\n| Public fields | Choose the fields that can be accessed without authentication. For instance, this can be useful for showing data publicly on the storefront. | Master Data v1Master Data v2 |\n| Inherit schema | The data entity inherits the declared schemas from other data entities. | Master Data v2 |\n| Triggers | Define automatic custom actions triggered by specific events with the data. For more details, see the [Triggers section](#triggers). | Master Data v1Master Data v2 |\n\n### Endpoints to read and write data\n\nAfter defining the desired structure of the data in the data entities, you can start working with the data. Master Data has a complete CRUD (create, read, update, and delete) functionality. It allows document storage, retrieval, edition, custom searches, and deletion. You can do these operations through the UI in Master Data v1 or using the [API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api) endpoints in both versions.\n\nWith the endpoints, you can extend the store operation with services using the Master Data API. For instance, you can create an application for product reviews and ratings, where the reviews are stored in a reviews data entity.\n\nThe table below shows the Master Data endpoints used to interact with documents:\n\n**Click here to view the Master Data document endpoints table**\n\n| **Endpoint name** | **Method** | **Description** | **Reference** |\n| -------------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Create new document | POST | Create a new document in the chosen data entity. | [Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api/%23post-/api/dataentities/-acronym-/documents)[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/%23post-/api/dataentities/-dataEntityName-/documents) |\n| Create partial document | PATCH | Create a new document in the chosen data entity. | [Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api/%23patch-/api/dataentities/-acronym-/documents)[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/%23patch-/api/dataentities/-dataEntityName-/documents) |\n| Get document | GET | Retrieve a document with the given id. | [Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api/%23get-/api/dataentities/-acronym-/documents/-id-)[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/%23get-/api/dataentities/-dataEntityName-/documents/-id-) |\n| Create document with custom ID or update entire document | PUT | Create a new document in the chosen data entity with a specific id. If there is a document with this id, update the document instead, replacing the whole document with the request body. | [Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api/%23put-/api/dataentities/-acronym-/documents/-id-)[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/%23put-/api/dataentities/-dataEntityName-/documents/-id-) |\n| Update partial document | PATCH | Update the document with the given id. Change only the fields declared in the request body, while the other fields of the document keep the same values. | [Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api/%23patch-/api/dataentities/-acronym-/documents/-id-)[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/%23patch-/api/dataentities/-dataEntityName-/documents/-id-) |\n| Delete document | DELETE | Delete the document with the given id. | [Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api/%23delete-/api/dataentities/-acronym-/documents/-id-)[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/%23delete-/api/dataentities/-dataEntityName-/documents/-id-) |\n| Search documents | GET | Retrieve a list of documents from the given data entity. Use parameters to filter the results, including schemas and indexed fields. | [Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api/%23get-/api/dataentities/-acronym-/search)[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/%23get-/api/dataentities/-dataEntityName-/search) |\n| Scroll documents | GET | Retrieve a large amount of documents. Use parameters to filter the results, including schemas and indexed fields. | [Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api/%23get-/api/dataentities/-acronym-/scroll)[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/%23get-/api/dataentities/-dataEntityName-/scroll) |\n\n### Triggers\n\nA [Master Data Trigger](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw%23triggers) is a mechanism that performs an action after creating or updating a document if the conditions set in the configuration are met. The possible actions with triggers are:\n\n* Send an HTTP request.\n* Send an email.\n* Save a document in another data entity.\n\nThese actions from specific events in the data allows creating automated custom behaviors with the data. For example, you can configure a trigger to send an email to the customer when there is a new document in the CL data entity, which is when the account is created. There are two possible ways to work with triggers depending on the Master Data version.\n\nIn Master Data v1, you configure triggers from the UI. For more details, see [How to create a trigger in Master Data v1](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-trigger-in-master-data--tutorials%5F1270).\n\nIn Master Data v2, you configure triggers in the v-triggers field in a JSON Schema of the data entity. This field is an array of objects, where each object represents a trigger. For more details, see [Setting up triggers in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2).\n\n### Custom Master Data apps with VTEX IO\n\nBesides providing APIs to integrate with custom solutions, VTEX also has its development platform, [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io). By developing an [IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app), you can create a solution that uses Master Data APIs through [clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients). Learn more about development with VTEX IO in the [Development Platform section](#development-platform).\n\nBy developing a Master Data app using VTEX IO, you can have the development environment, the code, and access to Master Data all inside VTEX. The process is different for each Master Data version, but the basic steps are cloning a boilerplate, defining the [policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies), adding the [client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients), and creating the middleware functions. For more details, see the guides [Interacting with Master Data v1 through VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services) and [Create a Master Data CRUD app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app) for Master Data v2.\n\n## Commerce APIs\n\nVTEX is an API-first ecommerce platform, with all our core commerce services accessible through 750+ API endpoints. These endpoints provide many extensibility options, whether through third-party integrations or custom solutions developed with VTEX IO.\n\nYou can find information about VTEX endpoints in our [API reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference) and our [List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis). For details about implementation with our APIs, see the sections for each service in our [API guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides).\n\nWe divide our endpoints into three categories depending on the operations being performed.\n\n### Endpoints to read and write data\n\nMost endpoints go into this category since they are the access points to read and write data. However, they do more than manage data, such as in a database, by enabling all sorts of commerce functionalities in a store. For example, there are endpoints to create product categories, read order details, update a shipping policy, delete a SKU price, and more.\n\nThese endpoints are commonly used in back-office integrations. In this case, merchants use back-office software such as an ERP (Enterprise Resource Planning) or a PIM (Product Information Manager) to manage the commerce operations, which they integrate with VTEX. The endpoints are used to import data to VTEX or access and control the data on VTEX through the back-office software interface. For more details, see our [backend integrations overview](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/7euXDZR5CCnVFSrXyczIhu) and [back-office integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide).\n\n### Hooks and Feeds for orders\n\nHooks and Feeds are specific integrations that allow communication through events. Hooks allow for calling an action right after an event occurs. Feeds are lists of events where the receiver processes the events at its own pace.\n\nOn VTEX, Hooks and Feeds integrate back-office software, such as ERP and VTEX OMS (Order Management System). Hooks and Feeds endpoints are part of the [Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api). They deliver order updates for specific statuses and enable [order processing by the back-office software](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing). Order processing operations include canceling, changing items, and issuing invoices.\n\n[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-feed) is a list of events with order updates. For this type of integration, VTEX provides [endpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23feed-v3) that allow the back-office software to query the items on the list, process the orders, and then remove the items from the list.\n\n[Hook](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-feed%23hook) is a channel for automatically receiving notifications about order updates. For this type of integration, the back-office software provides an [endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/orders/hook/config) for VTEX to send notifications regarding order updates. After receiving a notification, the back-office software may proceed to process the order.\n\nFor more details, see **Middleware configuration** and **Order integration** in our [Backend integrations overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/7euXDZR5CCnVFSrXyczIhu), and the [Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration) guide.\n\n### Extension points to change data flow\n\nExtension points extend VTEX functionality by enabling access to external sources. This is done in two ways: hubs and protocols.\n\n#### Hubs\n\nHubs are central access points for multiple providers, allowing the selection of a service provider. Sometimes, VTEX can be one of the provider options, along with other external providers. Ont VTEX, we have the [Gift Card Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-api), which allows interaction with VTEX Gift Card Provider and external Gift Card providers. The Gift Card options are available at Checkout.\n\n#### Protocols\n\nProtocols are rules defined by VTEX that allow external providers to implement their solutions, so they are available on VTEX. The rules are composed of endpoints that follow a specific structure (path, parameters, request body, response body) and are implemented by the providers. Once the implementation is done, VTEX calls the endpoints to access the provider’s solution.\n\nFor instance, in a payment integration using the Payment Provider Protocol, the [VTEX Payment Gateway](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-payment-gateway--2KH9Wdi7F6swOU4amECSOk) calls the endpoints requesting the payment provider to perform the operations defined by the protocol. Possible payment operations are authorization, settlement, cancellation, and refund.\n\nThe available protocols on VTEX are:\n\n* [Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex)\n* [Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works)\n* [Gift Card Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol)\n* [Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-overview)\n* [External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide)\n* [External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide)\n* [Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide)\n* [Login integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide)\n* [Pick and Pack Last Mile Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-carriers-integration-protocol)\n\n## Development platform\n\n[VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io) is VTEX’s development platform for creating low-code custom solutions, both for the frontend and backend. The VTEX IO framework provides the tools to build and maintain [IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app) by leveraging familiar technologies like [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.js](https://read.calvincode.net/reader?url=https://nodejs.org/en). VTEX IO allows the creation of storefront experiences, Admin panels, integration with VTEX and external services, and more.\n\nThe VTEX IO platform has a cloud-native infrastructure with automatic scaling, which means that developers can focus on the business solution without worrying about infrastructure concerns.\n\nTo learn more about the development details, see the [Developer experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience) guide.\n\n### Frontend\n\nFrontend solutions on VTEX IO are made for storefront and Admin.\n\n* [Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io) are created using the [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework). These apps can be a store theme, that determines the frontend structure of the store, or a collection of [frontend components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components) that focus on specific parts of the shopping experience.\n* [Admin apps](https://read.calvincode.net/reader?url=https://learn.vtex.com/docs/course-admin-lang-en) are apps that have at least one Admin panel. Store operators use these apps to configure and manage the shopping experience. Many useful components can be added to the panels including tables, dashboards, property fields in various formats (text, number, radio list, etc.), and more.\n\n### Backend\n\nBackend solutions on VTEX IO include services, access to APIs, and Pixel apps.\n\n* [Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io) are backend apps that run on Node or .NET. Services expose their functions by implementing REST or GraphQL APIs.\n* IO apps use [Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients) to make API requests, both with REST and GraphQL. Clients enable access to VTEX commerce APIs, external endpoints, and other apps. Also, developers must declare the required [policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies) to allow access to VTEX or external resources.\n* [Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps) are apps that run scripts on pages of a store website. They collect and analyze data for sales tracking, user support, and marketing services.\n\n## Composable SaaS\n\nVTEX is a composable platform for building commerce experiences by combining pre-built components, accelerating the implementation process. For more details about VTEX composable features, see our [Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/composability) guide. On VTEX, we offer two capabilities: VTEX IO apps and App Store apps.\n\n### VTEX IO apps\n\n[VTEX apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app) are enclosed solutions created with VTEX IO that extend the functionalities of the VTEX platform. VTEX IO not only provides the tools for developers to develop apps, but also to publish and distribute them. After a developer makes an app public, merchants can install the app in their stores at will. To [install VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app), use the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).\n\nMultiple apps, both from VTEX and third-party developers, are publicly available and address all kinds of ecommerce scenarios. Some solution examples that IO apps provide are frontend components, additional shopping experiences, payment connectors, marketing and analytics tools, and more. See details about each available app in the [VTEX IO Apps section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps).\n\n> We strongly recommend reading the app documentation before installation to avoid undesired behavior.\n\n### App Store apps\n\nAnother way to use composability in a VTEX store is with Plug-and-Play apps from the [VTEX App Store](https://read.calvincode.net/reader?url=https://apps.vtex.com). Merchants can navigate the App Store and install apps with just a few steps, without code interaction.\n\nMore than 100 apps developed by VTEX and third-party providers offer many commerce solutions. Some available functionalities are social marketing integrations, data collection and analytics, marketplace integrations, gift lists, and more. See more details in the [App Store](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/extensions-hub--AW7klkYMh557y5IUOgzco/2LDRvGujYsumxi7IlE7CEJ) article.\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/henriquessb)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Platform-Overview/Extensibility/extensibility.md)\n\n[Interactive Marchitecture tool« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility//docs/guides/interactive-marchitecture-tool)[Store architectureNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility//docs/guides/store-architecture)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[Data services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23data-services)\n\n[New entities and data schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23new-entities-and-data-schemas)[Endpoints to read and write data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23endpoints-to-read-and-write-data)[Triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23triggers)[Custom Master Data apps with VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23custom-master-data-apps-with-vtex-io)\n\n[Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23commerce-apis)\n\n[Endpoints to read and write data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23endpoints-to-read-and-write-data)[Hooks and Feeds for orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23hooks-and-feeds-for-orders)[Extension points to change data flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23extension-points-to-change-data-flow)\n\n[Development platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23development-platform)\n\n[Frontend](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23frontend)[Backend](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23backend)\n\n[Composable SaaS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23composable-saas)\n\n[VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23vtex-io-apps)[App Store apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23app-store-apps)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Platform-Overview/Extensibility/extensibility.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Data services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23data-services)\n\n[New entities and data schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23new-entities-and-data-schemas)[Endpoints to read and write data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23endpoints-to-read-and-write-data)[Triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23triggers)[Custom Master Data apps with VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23custom-master-data-apps-with-vtex-io)\n\n[Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23commerce-apis)\n\n[Endpoints to read and write data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23endpoints-to-read-and-write-data)[Hooks and Feeds for orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23hooks-and-feeds-for-orders)[Extension points to change data flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23extension-points-to-change-data-flow)\n\n[Development platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23development-platform)\n\n[Frontend](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23frontend)[Backend](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23backend)\n\n[Composable SaaS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23composable-saas)\n\n[VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23vtex-io-apps)[App Store apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extensibility/docs/guides/extensibility%23app-store-apps)\n\nOn this page\n\n[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=)"
}
] |
doc_bef903e4
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore schema inputs in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/troubleshooting)\n\n[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/schema-inputs/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/faststore-api-overview)\n\n[Queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-queries)\n\n[Mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-mutations)\n\n[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-objects)\n\n[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs)\n\n[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-enums)\n\n[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-scalars)\n\n[Configuring GraphQL cache control for GET requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/faststore-api-configuring-graphql-cache-control)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/faststore-api-overview)\n\n[Queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-queries)\n\n[Mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-mutations)\n\n[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-objects)\n\n[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs)\n\n[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-enums)\n\n[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-scalars)\n\n[Configuring GraphQL cache control for GET requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/faststore-api-configuring-graphql-cache-control)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/faststore-api-overview)\n\nInputs\n\n### IGeoCoordinates\n\n| Field | Type | Description |\n| ------------- | -------------------------------------------------------------------------------- | -------------------------------------------- |\n| **latitude** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | The latitude of the geographic coordinates. |\n| **longitude** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | The longitude of the geographic coordinates. |\n\n### IPersonNewsletter\n\nPerson data input to the newsletter.\n\n| Field | Type | Description |\n| --------- | ---------------------------------------------------------------------------------- | --------------- |\n| **name** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Person's name. |\n| **email** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Person's email. |\n\n### IShippingItem\n\nShipping Simulation item input.\n\n| Field | Type | Description |\n| ------------ | ---------------------------------------------------------------------------------- | ---------------------------------------- |\n| **id** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | ShippingItem ID / Sku. |\n| **quantity** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int)! | Number of items. |\n| **seller** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Seller responsible for the ShippingItem. |\n\n### IStoreCart\n\nShopping cart input.\n\n| Field | Type | Description |\n| --------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |\n| **order** | [IStoreOrder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istoreorder)! | Order information, including orderNumber, acceptedOffer and shouldSplitItem. |\n\n### IStoreCurrency\n\n| Field | Type | Description |\n| ---------- | ---------------------------------------------------------------------------------- | ------------------------- |\n| **code** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Currency code (e.g: USD). |\n| **symbol** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Currency symbol (e.g: $). |\n\n### IStoreDeliveryMode\n\n| Field | Type | Description |\n| ------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ |\n| **deliveryChannel** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | The delivery channel information of the session. |\n| **deliveryMethod** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | The delivery method information of the session. |\n| **deliveryWindow** | [IStoreDeliveryWindow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istoredeliverywindow) | The delivery window information of the session. |\n\n### IStoreDeliveryWindow\n\nDelivery window information.\n\n| Field | Type | Description |\n| ------------- | ---------------------------------------------------------------------------------- | ------------------------------------------- |\n| **startDate** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | The delivery window start date information. |\n| **endDate** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | The delivery window end date information. |\n\n### IStoreGeoCoordinates\n\n| Field | Type | Description |\n| ------------- | -------------------------------------------------------------------------------- | -------------------------------------------- |\n| **latitude** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | The latitude of the geographic coordinates. |\n| **longitude** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | The longitude of the geographic coordinates. |\n\n### IStoreImage\n\nImage input.\n\n| Field | Type | Description |\n| ----------------- | ---------------------------------------------------------------------------------- | -------------------------- |\n| **url** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Image input URL. |\n| **alternateName** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Alias for the input image. |\n\n### IStoreOffer\n\nOffer input.\n\n| Field | Type | Description |\n| --------------- | --------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |\n| **price** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | Also known as spot price. |\n| **listPrice** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | This is displayed as the \"from\" price in the context of promotions' price comparison. This may change before it reaches the shelf. |\n| **seller** | [IStoreOrganization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istoreorganization)! | Seller responsible for the offer. |\n| **itemOffered** | [IStoreProduct](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istoreproduct)! | Information on the item being offered. |\n| **quantity** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int)! | Number of items offered. |\n\n### IStoreOrder\n\nOrder input.\n\n| Field | Type | Description |\n| ------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |\n| **orderNumber** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | ID of the order in [VTEX order management](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources-oms--60QcBsvWeum02cFi3GjBzg%23). |\n| **acceptedOffer** | \\[[IStoreOffer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istoreoffer)!\\]! | Array with information on each accepted offer. |\n| **shouldSplitItem** | [Boolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23boolean) | Indicates whether or not items with attachments should be split. |\n\n### IStoreOrganization\n\nOrganization input.\n\n| Field | Type | Description |\n| -------------- | ---------------------------------------------------------------------------------- | ---------------- |\n| **identifier** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Organization ID. |\n\n### IStorePerson\n\nClient profile data.\n\n| Field | Type | Description |\n| -------------- | ---------------------------------------------------------------------------------- | ------------------ |\n| **id** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Client ID. |\n| **email** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Client email. |\n| **givenName** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Client first name. |\n| **familyName** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Client last name. |\n\n### IStoreProduct\n\nProduct input. Products are variants within product groups, equivalent to VTEX [SKUs](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u%23). For example, you may have a **Shirt** product group with associated products such as **Blue shirt size L**, **Green shirt size XL** and so on.\n\n| Field | Type | Description |\n| ---------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |\n| **sku** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Stock Keeping Unit. Merchant-specific ID for the product. |\n| **name** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Product name. |\n| **image** | \\[[IStoreImage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istoreimage)!\\]! | Array of product images. |\n| **additionalProperty** | \\[[IStorePropertyValue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istorepropertyvalue)!\\] | Custom Product Additional Properties. |\n\n### IStorePropertyValue\n\n| Field | Type | Description |\n| ------------------ | -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |\n| **propertyID** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Property id. This propert changes according to the content of the object. |\n| **value** | [ObjectOrString](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23objectorstring)! | Property value. May hold a string or the string representation of an object. |\n| **name** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Property name. |\n| **valueReference** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Specifies the nature of the value |\n\n### IStoreSelectedFacet\n\nSelected search facet input.\n\n| Field | Type | Description |\n| --------- | ---------------------------------------------------------------------------------- | ---------------------------- |\n| **key** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Selected search facet key. |\n| **value** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Selected search facet value. |\n\n### IStoreSession\n\nSession input.\n\n| Field | Type | Description |\n| ------------------ | ------------------------------------------------------------------------------------------------------------ | ----------------------------- |\n| **locale** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Session input locale. |\n| **currency** | [IStoreCurrency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istorecurrency)! | Session input currency. |\n| **country** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Session input country. |\n| **channel** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Session input channel. |\n| **deliveryMode** | [IStoreDeliveryMode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istoredeliverymode) | Session input delivery mode. |\n| **addressType** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Session input address type. |\n| **postalCode** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Session input postal code. |\n| **geoCoordinates** | [IStoreGeoCoordinates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istoregeocoordinates) | Session input geoCoordinates. |\n| **person** | [IStorePerson](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istoreperson) | Session input person. |\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/faststore-api/schema/inputs.mdx)\n\n[Objects« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-objects)[EnumsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-enums)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[IGeoCoordinates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23igeocoordinates)\n\n[IPersonNewsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23ipersonnewsletter)[IShippingItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23ishippingitem)[IStoreCart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istorecart)[IStoreCurrency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istorecurrency)[IStoreDeliveryMode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoredeliverymode)[IStoreDeliveryWindow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoredeliverywindow)[IStoreGeoCoordinates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoregeocoordinates)[IStoreImage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoreimage)[IStoreOffer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoreoffer)[IStoreOrder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoreorder)[IStoreOrganization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoreorganization)[IStorePerson](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoreperson)[IStoreProduct](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoreproduct)[IStorePropertyValue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istorepropertyvalue)[IStoreSelectedFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoreselectedfacet)[IStoreSession](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoresession)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/faststore-api/schema/inputs.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[IGeoCoordinates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23igeocoordinates)\n\n[IPersonNewsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23ipersonnewsletter)[IShippingItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23ishippingitem)[IStoreCart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istorecart)[IStoreCurrency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istorecurrency)[IStoreDeliveryMode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoredeliverymode)[IStoreDeliveryWindow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoredeliverywindow)[IStoreGeoCoordinates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoregeocoordinates)[IStoreImage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoreimage)[IStoreOffer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoreoffer)[IStoreOrder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoreorder)[IStoreOrganization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoreorganization)[IStorePerson](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoreperson)[IStoreProduct](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoreproduct)[IStorePropertyValue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istorepropertyvalue)[IStoreSelectedFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoreselectedfacet)[IStoreSession](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs/docs/guides/faststore/schema-inputs%23istoresession)\n\nOn this page\n\n[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=)"
}
] |
doc_430ab813
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation workspace behavior with app installations in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-workspace-behavior-with-app-installations/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/api-reference)\n\n[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-workspace-behavior-with-app-installations/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/storefront-development)\n\n[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-workspace-behavior-with-app-installations/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/troubleshooting)\n\n[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-workspace-behavior-with-app-installations/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace)\n\n[Creating a Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-creating-a-development-workspace)\n\n[Creating a Development workspace for a Legacy CMS store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy)\n\n[Creating a Production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-creating-a-production-workspace)\n\n[Workspace behavior with app installations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations)\n\n[Best practices on workspaces management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspaces-best-practices)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace)\n\n[Creating a Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-creating-a-development-workspace)\n\n[Creating a Development workspace for a Legacy CMS store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy)\n\n[Creating a Production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-creating-a-production-workspace)\n\n[Workspace behavior with app installations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations)\n\n[Best practices on workspaces management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspaces-best-practices)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/app-development)\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace)\n\n[Workspace behavior with app installations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations)\n\nWorkspace behavior with app installations\n\nOn VTEX IO, [workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace) function similarly to [Git branches](https://read.calvincode.net/reader?url=https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) with automatic [rebase](https://read.calvincode.net/reader?url=https://git-scm.com/book/en/v2/Git-Branching-Rebasing). Your work in development and production workspaces is always based on what's in the master workspace.\n\nBelow is an example to illustrate the behavior of apps when performing operations on workspaces.\n\nImagine there is a VTEX account with four identical workspaces:\n\n* `master`: `appA@1.x`\n* `prod1`: `appA@1.x`\n* `prod2`: `appA@1.x`\n* `dev1`: `appA@1.x`\n\nThe following sections present scenarios based on this example. Check what happens when you:\n\n* [Install an app on development or production](#install-an-app-on-development-or-production)\n* [Install an app on master](#install-an-app-on-master)\n* [Promote a workspace](#promote-a-workspace)\n\n## Install an app on development or production\n\n[Installing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) on a development or production workspace does not affect other workspaces.\n\nConsidering the given example, imagine the following actions:\n\n* Installing `appA@2.x` on `prod1`\n* Installing `appC@2.x` on `prod2`\n* Installing `appC@3.x` on `dev1`\n\nThis would be the result:\n\n* `master`: `appA@1.x`\n* `prod1`: `appA@2.x`\n* `prod2`:`appA@1.x`, `appC@2.x`\n* `dev1`: `appA@1.x`, `appC@3.x`\n\n## Install an app on master\n\nWhen you install an app on the master workspace, it is installed on every workspace that does not have this app installed. If a workspace has the same app installed with another major version, the app version on this workspace is unchanged.\n\nConsidering the given example, imagine the following action:\n\n* Installing `appB@0.x` on `master`\n\nThis would be the result:\n\n* `master`: `appA@1.x`, `appB@0.x`\n* `prod1`: `appA@2.x`, `appB@0.x`\n* `prod2`:`appA@1.x`, `appB@0.x`, `appC@2.x`\n* `dev1`: `appA@1.x`, `appB@0.x`, `appC@3.x`\n\n## Promote a workspace\n\nWhen a production workspace is [promoted to master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master), all the other workspaces are updated to reflect the changes seen in the promoted workspace.\n\nConsidering the given example, after promoting `prod2` to `master`, this is the result:\n\n* `master`: `appA@1.x`, `appB@0.x`, `appC@2.x`\n* `prod1`: `appA@2.x`, `appB@0.x`, `appC@2.x`\n* `dev1`: `appA@1.x`, `appB@0.x`, `appC@3.x`\n\n> After promoting a workspace, the name of the promoted workspace will not appear in the [list of workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference%23workspace-list), since it became the new master workspace.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/configuring-workspaces/vtex-io-documentation-workspace-behavior-with-app-installations.md)\n\n[Creating a Production workspace« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations//docs/guides/vtex-io-documentation-creating-a-production-workspace)[Best practices on workspaces managementNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations//docs/guides/vtex-io-documentation-workspaces-best-practices)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Install an app on development or production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations%23install-an-app-on-development-or-production)\n\n[Install an app on master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations%23install-an-app-on-master)\n\n[Promote a workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations%23promote-a-workspace)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/configuring-workspaces/vtex-io-documentation-workspace-behavior-with-app-installations.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Install an app on development or production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations%23install-an-app-on-development-or-production)\n\n[Install an app on master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations%23install-an-app-on-master)\n\n[Promote a workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations%23promote-a-workspace)\n\nOn this page\n\n[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=)"
}
] |
doc_54533120
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides checkout overview in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/getting-started)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/catalog-overview)\n\n[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/marketplace-overview)\n\n[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/orders-overview)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/payments-overview)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/fulfillment)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/search-overview)\n\n[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/pricing-overview)\n\n[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/promotions-overview)\n\n[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/subscriptions)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/getting-started)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/catalog-overview)\n\n[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/marketplace-overview)\n\n[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/orders-overview)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/payments-overview)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/fulfillment)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/search-overview)\n\n[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/pricing-overview)\n\n[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/promotions-overview)\n\n[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/subscriptions)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/getting-started)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview)\n\nCheckout\n\n> **Help us improve our documentation!** Tell us about your experience with this article by completing [this form](https://read.calvincode.net/reader?url=https://forms.gle/fQoELRA1yfKDqmAb8).\n\n## Customizing the Checkout UI\n\nAll VTEX stores have a native Checkout UI ready to be used from the start of their operations on the platform. However, if the merchant wants to change some features on this UI, VTEX offers the option of customizing the Checkout. See the links below for helpful information and apps to customize the Checkout UI of your store.\n\n* [Checkout customization guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/checkout-customization-guide)\n* [Checkout UI Custom app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0)\n* [Checkout UI Settings app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-settings)\n* [Checkout Settings (B2B)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings)\n* [Customizing the Header and Footer blocks by page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)\n* [Customizing checkout confirmation pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/customize-checkout-confirmation-pages)\n* [Enabling an Observation field on the Checkout page](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/enable-an-observation-field-on-the-checkout-page)\n* [Layout Development Guide for payment methods in Smart Checkout VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/layout-development-guide-for-payment-methods-in-smart-checkout-vtex)\n* [How to set up and use checkout data from the customer side (vtex.js for Checkout)](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/vtexjs-for-checkout)\n* [Changing payment methods on Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/change-payment-method-names-in-checkout)\n\nSmart Checkout - Payment layout customization example:\n\n\n\n## Understanding Checkout data structures\n\nIn the VTEX Checkout architecture, the main data structure is the `orderForm` object. This object has several sections and fields that allow you to control all the important information about the order. See the links below for helpful information and endpoints related to the `orderForm` object.\n\n* [OrderForm overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields)\n* [Setting discounts using the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/set-a-discount-using-the-checkout-api)\n* [Enabling orderForm optimization - Store Framework only](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n* [GET - Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getorderformconfiguration)\n* [POST - Update orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/updateorderformconfiguration)\n* [POST - Clear orderForm messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/clearorderformmessages)\n\n## Collecting custom customer information\n\nTo request additional customer information besides what the `orderForm` collects, stores can create `custom fields`. See the links below for helpful information and endpoints related to custom customer information.\n\n* [Adding and handling custom information in the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order)\n* [Custom fields created by the Mercado Libre connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/get-payment-data-mercado-libre-orders-api%23understanding-customdata)\n* [PUT - Set multiple custom field values](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/setmultiplecustomfieldvalues)\n* [PUT - Set single custom field value](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/setsinglecustomfieldvalue)\n* [DELETE - Remove single custom field value](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/removesinglecustomfieldvalue)\n\n> This module may process personal or sensitive information. Learn more about how VTEX handles data privacy at our [Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-privacy) guide.\n\n## Accessing customer information\n\nOnce you have the customer information, you can check their profile information or even add them to a specific cart. See the links below to access endpoints related to customer information.\n\n* [Enable the Save user information opt-in](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/enable-the-save-user-data-opt-in)\n* [GET - Get customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getclientprofilebyemail)\n* [POST - Add customer profile](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addclientprofile)\n* [POST - Add customer preferences](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addclientpreferences)\n* [POST - Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addshippingaddress)\n\n## Accessing seller information\n\nIn a marketplace, you can check the seller database to find out which sellers are available in a given region and configure the exchange of sellers that fulfill an order. See the links below to access endpoints related to seller information.\n\n* [GET - Get sellers by region or address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/regions/-regionId-)\n* [GET - Get the seller change window](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getwindowtochangeseller)\n* [POST - Update the seller change window](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/updatewindowtochangeseller)\n\n## Handling the shopping cart\n\nIn your store, you can perform many actions related to the shopping cart, including adding security items, simulating carts, changing the number of items, among others. See the links below for helpful information and endpoints related to handling the store shopping cart.\n\n* [Minicart - Configuration and customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart)\n* [ADD TO CART button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button%23configuration)\n* [reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/recaptcha)\n* [Implementing reCAPTCHA in integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/implementing-recaptcha-in-integrations)\n* [Enabling Manual Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/enable-the-manual-price)\n* [Checking marketing UTMs used at Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/check-marketing-utms-used-at-checkout)\n* [POST - Cart simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/cartsimulation)\n* [GET - Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/orderForm)\n* [GET - Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getcartinformationbyid)\n* [POST - Remove all items](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/removeallitems)\n* [GET - Remove all personal data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/removeallpersonaldata)\n* [PATCH - Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/itemsupdate)\n* [PUT - Change price](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/pricechange)\n* [PATCH - Ignore profile data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/ignoreprofiledata)\n* [GET - Cart installments](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getcartinstallments)\n* [POST - Add marketing data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addmarketingdata)\n* [POST - Add payment data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addpaymentdata)\n* [POST - Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addcoupons) \n Minicart view: \n \n \n \n reCAPTCHA view:\n\n\n\n## Getting information and simulating shipping logistics\n\nBy verifying addresses, pickup points, and fulfillment simulations, you can have an overview of how the shipping process will be carried out in your store. Additionally, you can configure your store to allow shipping to other countries. See the links below to access endpoints related to shipping.\n\n* [Calculating SLA](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/calculatesla)\n* [Configuring Global Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/configure-the-global-checkout)\n* [GET - List pickup points by location](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/listpickupppointsbylocation)\n* [GET - Get address by postal code](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getaddressbypostalcode)\n* [POST - Fulfillment simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation%23request-body-example---checkout-simulation)\n\n## Creating orders via API\n\nAPIs allow you to simulate all the order steps a customer goes through. See the links below for helpful information and endpoints related to the order flow.\n\n* [Creating a regular order using the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/create-a-regular-order-using-the-checkout-api)\n* [Creating a regular order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart)\n* [PUT - Place an order (no cart information available)](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/placeorder)\n* [POST - Place an order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/placeorderfromexistingorderform)\n* [POST - Process order](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/processorder)\n\n## Configuring tax customization systems\n\nWhen your store sells products in several regions or has inventories in different locations, you may need to calculate different taxes for each order. To facilitate this, VTEX allows you to integrate an external tax calculation provider. See the links below to access information on how to integrate an external tax calculation provider with your store.\n\n* [Tax service - Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/tax-services-overview)\n* [Tax service - Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/tax-services-specification%23checkout-configuration)\n* [Tax service - Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/tax-services-recipe)\n* [Tax service - Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/tax-services-reference-implementation)\n\n## Integrating Checkout with apps\n\nOn VTEX checkout, some features are activated through apps. See the links below for information about available apps for your store checkout.\n\n* [Setting up Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23creating-variables)\n* [Migrating Google Tag Manager app from major 2.x to major 3.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app%23before-you-start)\n* [Hotjar App - Website Heatmaps & Behavior Analytics Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-hotjar)\n* [PowerReviews App - UGC (User Generated Content) Ratings & Reviews Tool](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews) \n Hotjar heatmap example:\n\n\n\n \nProduct review example: \n\n\n\nContributors\n\n5\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/checkout-overview.md)\n\n[Orders« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview//docs/guides/orders-overview)[PaymentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview//docs/guides/payments-overview)\n\nSee also\n\n[Checkout APIAPI Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/api-reference/checkout-api%23overview)\n\nContributors\n\n5\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Customizing the Checkout UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23customizing-the-checkout-ui)\n\n[Understanding Checkout data structures](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23understanding-checkout-data-structures)\n\n[Collecting custom customer information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23collecting-custom-customer-information)\n\n[Accessing customer information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23accessing-customer-information)\n\n[Accessing seller information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23accessing-seller-information)\n\n[Handling the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23handling-the-shopping-cart)\n\n[Getting information and simulating shipping logistics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23getting-information-and-simulating-shipping-logistics)\n\n[Creating orders via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23creating-orders-via-api)\n\n[Configuring tax customization systems](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23configuring-tax-customization-systems)\n\n[Integrating Checkout with apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23integrating-checkout-with-apps)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/checkout-overview.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Customizing the Checkout UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23customizing-the-checkout-ui)\n\n[Understanding Checkout data structures](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23understanding-checkout-data-structures)\n\n[Collecting custom customer information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23collecting-custom-customer-information)\n\n[Accessing customer information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23accessing-customer-information)\n\n[Accessing seller information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23accessing-seller-information)\n\n[Handling the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23handling-the-shopping-cart)\n\n[Getting information and simulating shipping logistics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23getting-information-and-simulating-shipping-logistics)\n\n[Creating orders via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23creating-orders-via-api)\n\n[Configuring tax customization systems](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23configuring-tax-customization-systems)\n\n[Integrating Checkout with apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview/docs/guides/checkout-overview%23integrating-checkout-with-apps)\n\nOn this page\n\n[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=)"
}
] |
doc_d7862d73
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX store components productdescription app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/troubleshooting)\n\n[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.store-components/productdescription/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides/store-components)\n\n[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/autocompleteresults)\n\n[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/availabilitysubscriber)\n\n[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/backtotopbutton)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/image)\n\n[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/infocard)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/logo)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/notification)\n\n[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productbrand)\n\n[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productdescription)\n\n[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productimages)\n\n[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productname)\n\n[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productskuattributes)\n\n[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/searchbar)\n\n[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/share)\n\n[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/shippingsimulator)\n\n[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/skuselector)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides/store-components)\n\n[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/autocompleteresults)\n\n[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/availabilitysubscriber)\n\n[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/backtotopbutton)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/image)\n\n[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/infocard)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/logo)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/notification)\n\n[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productbrand)\n\n[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productdescription)\n\n[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productimages)\n\n[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productname)\n\n[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productskuattributes)\n\n[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/searchbar)\n\n[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/share)\n\n[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/shippingsimulator)\n\n[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/skuselector)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/vtex-io-apps)\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/guides/store-components)\n\nProduct Description\n\n[vtex.store-components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components)\n\nVersion: 3.178.5\n\nLatest version: 3.178.5\n\nThe `product-description` block displays the description of a product. This Component can be imported and used by any VTEX App.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.store-components\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-description` block to any child of the `store.product` template (Product Details Page template). For example:\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#product\", \n\n4\n\n ] \n\n5\n\n }, \n\n6\n\n \"flex-layout.row#product\": { \n\n7\n\n \"children\": [ \n\n8\n\n+ \"product-description\" \n\n9\n\n ] \n\n10\n\n } \n\n`\n\n1. Then, declare the `product-description` block using the props stated in the [Props](#props) table.\n\n### Props\n\n| Prop name | Type | Description | Default |\n| --------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------- |\n| classes | CustomCSSClasses | Overrides default CSS handles. To better understand how this prop works, check [this document](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Note that this is only helpful if you're using this block as a React component. | undefined |\n| collapseContent | Boolean | If true, whenever the product description is too big, it will collapse and show a \"Show More\" button. When false, it will never collapse and will always show the whole description. | true |\n| showTitle | boolean | Define whether or not to show the title. | true |\n| title | string | Defines a custom title for the description section. | undefined |\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| --------------------------- |\n| productDescriptionContainer |\n| productDescriptionText |\n| productDescriptionTitle |\n\n[Product Brand« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productbrand)[Product ImagesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productimages)\n\nSee also\n\n[Vtex.store ComponentsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productdescription%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productdescription%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productdescription/docs/apps/vtex.store-components/productdescription%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_db72d57b
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides categories in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/alternative-api-requests)\n\n[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/how-to-implement-product-color-variation)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/alternative-api-requests)\n\n[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/how-to-implement-product-color-variation)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories)\n\nCategories\n\nCategories organize your product assortment within your ecommerce. They work as hierarchical levels of product classification, making your client’s search for a product easier and keeping your store organized.\n\n## Category tree\n\nThe category tree is the backbone of the Catalog, so it needs to be carefully planned and validated before importing to VTEX.\n\nWe strongly recommend starting to work on the category tree by creating a table similar to this one:\n\n\n\nThe idea behind this template is to allow easy visualization of how the tree is organized and how the specifications are being presented.\n\nVTEX does not limit the number of categories that can be created. We strongly recommend having a maximum of three levels of categories.\n\n## Limitations\n\n* **Moving categories**: Although it is possible to move categories to different levels (higher/lower) and/or different departments, this is too risky because of the specifications attached to this category. This action can negatively affect product information, because products can inherit not only the previous specifications but also the new ones. To avoid issues, we recommend following the workaround described in [Deactivating and reorganizing categories](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/deactivating-and-reorganizing-categories--tutorials%5F264%23changing-the-category-tree).\n* **Deleting categories**: You cannot delete a category unless you make a [full cleanup](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/database-maintenance-full-cleanup--34P9LGs7BCIQK6acQom802) of the catalog. This means you cannot delete categories unless you clear the entire catalog.\n\n## Category inheritance\n\nAll specifications registered in the upper levels of the hierarchy are inherited by the lower categories. In the example above, we have what we call the root category \"level zero\". This means that all specs registered at this level (Gender, Simple Color, and Country) will be inherited by level 1.\n\nNote that the Shirt category (level 2) has the `Style` field as a specification. This means that the product contained in this category will have as attributes the `Style` field and all others defined in the upper level, in this case, the root level.\n\nProducts must be associated with the categories at the lowest level of the category tree. In this example, they must be associated with the category: `Jeans` with `Pants` or `Polo` with `Shirt`.\n\n## Create a category\n\nCreating a category is the most basic configuration you must do in Catalog. For a product to exist, it must have a category associated with it.\n\nTo create a category, one can use the [Create category](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-post-category) endpoint. See the request body example below of the creation of a category called Clothing:\n\n**Request body**\n\n`1\n\n{ \n\n2\n\n \"Name\": \"Clothing\", \n\n3\n\n \"FatherCategoryId\": null, \n\n4\n\n \"Title\": \"Clothing\", \n\n5\n\n \"Description\": \"Shop from brands like Patagonia, The North Face, Billabong, Columbia, and more to dress yourself for success.\", \n\n6\n\n \"Keywords\": \"Clothing,apparel,clothes, clothing department\", \n\n7\n\n \"IsActive\": true, \n\n8\n\n \"ShowInStoreFront\": true, \n\n9\n\n \"ShowBrandFilter\": true, \n\n10\n\n \"ActiveStoreFrontLink\": true, \n\n11\n\n \"GlobalCategoryId\": 772, \n\n12\n\n \"StockKeepingUnitSelectionMode\": \"SPECIFICATION\", \n\n13\n\n \"Score\": null \n\n14\n\n} \n\n`\n\n**Response body**\n\n`1\n\n{ \n\n2\n\n \"Id\": 2000089, \n\n3\n\n \"Name\": \"Clothing\", \n\n4\n\n \"FatherCategoryId\": null, \n\n5\n\n \"Title\": null, \n\n6\n\n \"Description\": \"Shop from brands like Patagonia, The North Face, Billabong, Columbia, and more to dress yourself for success.\", \n\n7\n\n \"Keywords\": \"Clothing,apparel,clothes, clothing department\", \n\n8\n\n \"IsActive\": true, \n\n9\n\n \"ShowInStoreFront\": true, \n\n10\n\n \"ShowBrandFilter\": true, \n\n11\n\n \"ActiveStoreFrontLink\": true, \n\n12\n\n \"GlobalCategoryId\": 772, \n\n13\n\n \"StockKeepingUnitSelectionMode\": \"SPECIFICATION\", \n\n14\n\n \"Score\": null, \n\n15\n\n \"LinkId\": null, \n\n16\n\n \"HasChildren\": false \n\n17\n\n} \n\n`\n\nIn this example, the created category is a parent category, which means that it is not inside another category. A _parent category_ can have subcategories, or _children categories_, associated with it. To create a subcategory, you must insert the parent category ID on the `\"FatherCategoryId\"`.\n\n> Do not forget to activate the categories, otherwise the products will not be indexed and thereafter will not be displayed on the website.\n\n## Edit a category\n\nYou can edit an existing category by using the [Update Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-put-category) endpoint.\n\n## Get category tree\n\nYou can get information of all the category tree or just some specific level by using the [Get Category Tree](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-category-tree) endpoint.\n\n## Get a category\n\nYou can get information about a specific category by using the [Get Category by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-category)endpoint.\n\n## FAQ\n\nSee below the answer to some frequently asked questions.\n\n### When should I choose to import categories manually or by an integration via API?\n\nIt is not common for the customer to change the category tree once it is defined. Usually, specific changes may be required and can be made manually under VTEX Admin rather than having one more integration to take care of. Potentially we can find some cases where the category tree is built progressively according to the evolution of the store. But this typically happens during the validation of a new business. In that case, having category integration can be useful.\n\n### What category fields are actually used by VTEX Intelligent Search?\n\n* Title\n* Description\n\n### What are the best practices for Title and Meta Tag Description for SEO?\n\n* The Title should be about 55 to 60 characters long.\n* When writing the Meta Tag Description, aim for about 1-2 sentences (140-160 characters) long. Offer a compelling reason to visit the webpage. Add a clear call to action, address an emotional pain point, or offer a specific benefit to visitors.\n\n> Department, Category, and Subcategory titles can be customized using VTEX Intelligent Search. So on the search navigation bar, the store can present different titles for each category level.\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/catalog-integration/categories.md)\n\n[Catalog« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories//docs/guides/catalog-integration)[BrandsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories//docs/guides/brands)\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Category tree](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23category-tree)\n\n[Limitations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23limitations)\n\n[Category inheritance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23category-inheritance)\n\n[Create a category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23create-a-category)\n\n[Edit a category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23edit-a-category)\n\n[Get category tree](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23get-category-tree)\n\n[Get a category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23get-a-category)\n\n[FAQ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23faq)\n\n[When should I choose to import categories manually or by an integration via API?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23when-should-i-choose-to-import-categories-manually-or-by-an-integration-via-api)[What category fields are actually used by VTEX Intelligent Search?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23what-category-fields-are-actually-used-by-vtex-intelligent-search)[What are the best practices for Title and Meta Tag Description for SEO?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23what-are-the-best-practices-for-title-and-meta-tag-description-for-seo)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/catalog-integration/categories.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Category tree](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23category-tree)\n\n[Limitations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23limitations)\n\n[Category inheritance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23category-inheritance)\n\n[Create a category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23create-a-category)\n\n[Edit a category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23edit-a-category)\n\n[Get category tree](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23get-category-tree)\n\n[Get a category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23get-a-category)\n\n[FAQ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23faq)\n\n[When should I choose to import categories manually or by an integration via API?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23when-should-i-choose-to-import-categories-manually-or-by-an-integration-via-api)[What category fields are actually used by VTEX Intelligent Search?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23what-category-fields-are-actually-used-by-vtex-intelligent-search)[What are the best practices for Title and Meta Tag Description for SEO?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories/docs/guides/categories%23what-are-the-best-practices-for-title-and-meta-tag-description-for-seo)\n\nOn this page\n\n[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=)"
}
] |
doc_91a3c69d
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore developer tools custom cypress in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/troubleshooting)\n\n[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/developer-tools-custom-cypress/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-overview)\n\n[Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-config-options)\n\n[Custom Cypress integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress)\n\n[FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-faststore-cli)\n\n[Updating the @fastore/cli package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-updating-the-cli-package-version)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-overview)\n\n[Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-config-options)\n\n[Custom Cypress integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress)\n\n[FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-faststore-cli)\n\n[Updating the @fastore/cli package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-updating-the-cli-package-version)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-overview)\n\nCustom Cypress integration\n\n> This is an experimental feature.\n\nThe `enableCypressExtension` experimental feature flag allows you to leverage [Cypress](https://read.calvincode.net/reader?url=https://www.cypress.io/) extensions within your FastStore project, enabling you to seamlessly run custom Cypress tests.\n\nCypress extensions enhance the testing capabilities of your Faststore project by enabling the incorporation of custom Cypress tests alongside the native integration tests provided by Faststore.\n\nWith `enableCypressExtension`, you can implement custom integration tests into a dedicated Cypress folder within your storefront project. This integration ensures the smooth execution of both the native tests and the custom ones you create as part of the continuous integration (CI) pipeline. Learn how to add custom integration tests in the following steps.\n\n---\n\n## Before you begin\n\n* Please be aware that this feature is experimental and may not be suitable for all use cases.\n* Refer to [Cypress documentation](https://read.calvincode.net/reader?url=https://docs.cypress.io/guides/overview/why-cypress) for more information on this testing tool.\n* Ensure you are using `@faststore/core` `2.1.56` version or above and `@faststore/cli` version `2.2.9` or above. If you have versions lower than these requirements, update them as follows: \n 1. In your storefront project, open the `package.json` file. \n 2. Navigate to the `@faststore/core` and update it to at least `2.1.56`. \n 3. Navigate to the `@faststore/cli` and update it to at least `2.2.9`. \n 4. Run `yarn dev` to apply these changes.\n\n---\n\n## Step 1: Enabling `enableCypressExtension`\n\n1. Open the `discovery.config.js` file.\n2. Add the `experimental` object and set the `enableCypressExtension` value to `true`:\n\ndiscovery.config.js\n\n`1\n\n experimental: { \n\n2\n\n enableCypressExtension: true, \n\n3\n\n } \n\n`\n\n## Step 2: Integrating custom Cypress tests into your FastStore project\n\nLike any other project using Cypress, you'll follow standard practices, including setting up standard Cypress folders and configuration files. This allows you to seamlessly add and execute your custom integration tests within your project. For further details on Cypress configuration, refer to the official [Cypress configuration](https://read.calvincode.net/reader?url=https://docs.cypress.io/guides/references/configuration) guide.\n\n1. In the root directory of your storefront project, create a new folder named `cypress`.\n2. Add your custom integration tests within the `cypress/integration` folder.\n3. With the local server running, run `yarn test` to open the Cypress app and check your test execution.\n4. Open a pull request with the changes you have made.\n5. Within the pull request, navigate to **Checks > Integration Tests** and check the **Details** section.\n\n\n\n1. Review the results to check the execution status of your custom integration tests.\n\n---\n\n## Running only custom Cypress tests in FastStore projects\n\nAs storefront projects evolve, changes to component and page code may lead to errors in the default end-to-end tests conducted for all FastStore projects.\n\nIn such cases, you can override FastStore's default tests using custom tests with the same name as the original test files. For example:\n\nplp.test.js\n\n`1\n\nimport { cypress } from '../../discovery.config' \n\n2\n\n \n3\n\nconst { pages } = cypress \n\n4\n\n \n5\n\ndescribe('Custom PLP tests', () => { \n\n6\n\n it('visit collection page', () => { \n\n7\n\n cy.visit(pages.collection) \n\n8\n\n cy.get('[data-testid=\"product-gallery\"]').should('exist').and('be.visible') \n\n9\n\n }) \n\n10\n\n}) \n\n`\n\n> Although exclusive execution of custom tests is possible for projects using Cypress version 12.x, we do not recommend this approach. If possible, keep the default Cypress tests.\n\nSome projects may prefer exclusive execution of its custom Cypress tests. Although it is not our recommendation, for projects using Cypress version 12.x or higher, there is the possibility of running the **Integration Tests** check only for your custom tests.\n\nFollow the steps below to configure your project to only run custom Cypress tests:\n\n### Instructions\n\n#### Step 1 - Setting Cypress version\n\nFirst, ensure that you use Cypress version 12 by setting the `cypressVersion` experimental feature flag:\n\n1. Open the `discovery.config.js` file.\n2. Inside the `experimental` object, add the `cypressVersion` property.\n3. Set the `cypressVersion` value to `12`.\n\ndiscovery.config.js\n\n`1\n\n experimental: { \n\n2\n\n enableCypressExtension: true, \n\n3\n\n cypressVersion: 12, \n\n4\n\n } \n\n`\n\n#### Step 2 - Updating the Cypress configuration file\n\nEnsure that your Cypress configuration file (`cypress.json`) matches the latest Cypress configuration file format. To do so, refer to the official [Cypress configuration file](https://read.calvincode.net/reader?url=https://docs.cypress.io/guides/references/configuration) guide.\n\n#### Step 3 - Changing the custom Cypress tests directory\n\nNow, change your custom Cypress tests directory from `cypress/integration` to `cypress/e2e`:\n\n1. In your storefront project, rename the folder from `cypress/integration` to `cypress/e2e`.\n2. Update your new Cypress configuration file `cypress.config.ts` to match the new custom tests folder `cypress/e2e` by specifying the `specPattern`:\n\ncypress.config.ts\n\n`1\n\nimport { defineConfig } from 'cypress' \n\n2\n\n \n3\n\nexport default defineConfig({ \n\n4\n\n ..., \n\n5\n\n e2e: { \n\n6\n\n ..., \n\n7\n\n specPattern: 'cypress/e2e/**/*.test.{js,jsx,ts,tsx}', \n\n8\n\n }, \n\n9\n\n}) \n\n`\n\n1. Run `yarn dev` in the terminal to sync the changes you have made.\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developer-tools/custom-cypress.mdx)\n\n[Configuration options for discovery.config.js« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-config-options)[FastStore CLINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-faststore-cli)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23before-you-begin)\n\n[Step 1: Enabling enableCypressExtension](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23step-1-enabling-enablecypressextension)\n\n[Step 2: Integrating custom Cypress tests into your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23step-2-integrating-custom-cypress-tests-into-your-faststore-project)\n\n[Running only custom Cypress tests in FastStore projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23running-only-custom-cypress-tests-in-faststore-projects)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developer-tools/custom-cypress.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23before-you-begin)\n\n[Step 1: Enabling enableCypressExtension](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23step-1-enabling-enablecypressextension)\n\n[Step 2: Integrating custom Cypress tests into your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23step-2-integrating-custom-cypress-tests-into-your-faststore-project)\n\n[Running only custom Cypress tests in FastStore projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23running-only-custom-cypress-tests-in-faststore-projects)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-custom-cypress/docs/guides/faststore/developer-tools-custom-cypress%23instructions)\n\nOn this page\n\n[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=)"
}
] |
doc_f01d087f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides enable the save user data opt in in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/features)\n\n[Enable the Manual Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/enable-the-manual-price)\n\n[Enable the Save user data opt-in](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/enable-the-save-user-data-opt-in)\n\n[Enable the Region for SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/enable-the-region-for-skus)\n\n[Configure the Global Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/configure-the-global-checkout)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/features)\n\n[Enable the Manual Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/enable-the-manual-price)\n\n[Enable the Save user data opt-in](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/enable-the-save-user-data-opt-in)\n\n[Enable the Region for SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/enable-the-region-for-skus)\n\n[Configure the Global Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/configure-the-global-checkout)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/checkout-api-overview)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/features)\n\n[Enable the Save user data opt-in](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/enable-the-save-user-data-opt-in)\n\nEnable the Save user data opt-in\n\nTo comply with GDPR (General Data Protection Regulation - Europe) and LGPD - Lei Geral de Proteção de Dados (General Data Protection Law - Brazil), among other solutions, VTEX offers the **Save User Data opt-in** functionality. Through it, users can select whether they want the store to keep their personal and payment data saved.\n\n> The **Save user data opt-in** feature is only available for Checkout v6.\n\n## Save user data opt-in activation\n\nTo use the **Save user data opt-in** functionality in your store, you must first enable it. Then, follow the settings below:\n\n1. Make a `GET` request using the endpoint [Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pvt/configuration/orderForm).\n2. Make a `POST` request using the endpoint [Update orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pvt/configuration/orderForm) with the same data obtained in the GET request, just modifying the value of the `savePersonalDataAsOptIn` parameter from `null` to `true`.\n3. Make a new `GET` request using the endpoint [Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pvt/configuration/orderForm) to confirm activation. This will be indicated by the presence of the `savePaymentData` and `savePersonalData` fields under the `clientPreferencesData` object in the `orderForm`.\n\n\n\n> Under the `storePreferencesData` object, the `saveUserData` field may be indicated as `true`. This field is ignored, and kept in this configuration for backwards compatibility only.\n\n\n\n## Saving personal and payment data\n\nOnce the **Save user data opt-in** is enabled, the user will have access to checkboxes on the Checkout page to select whether their personal and payment data should be kept by the store and used in future orders.\n\nCheckbox for saving personal data:\n\n\n\n> Previously, it was possible to display this checkbox by modifying the `display` property of the `.save-data` element, via CSS. However, with the **Save user data opt-in** enabled, the method through CSS is no longer recommended.\n\nCheckbox for saving payment data:\n\n\n\n> The checkbox for saving payment data will only be shown if the user has already selected the option to save their personal data.\n\nCheckbox not available to save payment data if (the user has not previously selected the option to save personal data):\n\n\n\nIf the user chooses to use two cards to pay for the purchase, when selecting the option to save payment data, the data of both cards will be saved. There is no option to save only one of the cards.\n\nCheckbox to save payment data from both cards:\n\n\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/features/enable-the-save-user-data-opt-in.md)\n\n[Enable the Manual Price« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in//docs/guides/enable-the-manual-price)[Enable the Region for SKUsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in//docs/guides/enable-the-region-for-skus)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[Save user data opt-in activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/enable-the-save-user-data-opt-in%23save-user-data-opt-in-activation)\n\n[Saving personal and payment data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/enable-the-save-user-data-opt-in%23saving-personal-and-payment-data)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/features/enable-the-save-user-data-opt-in.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Save user data opt-in activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/enable-the-save-user-data-opt-in%23save-user-data-opt-in-activation)\n\n[Saving personal and payment data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-save-user-data-opt-in/docs/guides/enable-the-save-user-data-opt-in%23saving-personal-and-payment-data)\n\nOn this page\n\n[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=)"
}
] |
doc_761873a9
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain troubleshooting modal layout closes when i click a sku in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting)\n\nDevelopment\n\nModal Layout closes when I click a SKU\n\nWhen using Product Summary within a storefront modal, the modal closes when you click a SKU.\n\n**Keywords:** Modal Layout | SKU Selector | Product Summary | SKU | Product | Storefront\n\nThe [Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout) component provides blocks to create modals in your storefront. Within a [Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary) component such as the [Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/) in a search results page, when you define [SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/skuselector) as a prop in the `modal-content` block, the component will display all the SKUs available for a given product. However, if you click a SKU option, the modal will close, as shown below.\n\n\n\nThis behavior will occur every time you click a SKU from the [SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/skuselector) component inside the modal because it expects you to be on the product page with that SKU highlighted. When you pick a size, the URL changes — the SKU ID is added to the end of the URL as a query parameter (e.g., `?skuId=880021`), and the component closes since it is considered a new page.\n\n## Solution\n\nTo solve this issue, you must replace the [SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/skuselector) component with the [Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-summary-productsummaryskuselector), which represents the SKU Selector inside a Product Summary component, such as the Shelf, on a search results page.\n\n1. Add the `product-summary-sku-selector` block to your code, declaring it as a child of the `modal-content` block, as in the example below: \n`1 \n\"modal-content#quickview\": { \n2 \n \"children\":[ \n3 \n \"product-summary-name\", \n4 \n \"product-images\", \n5 \n \"product-summary-sku-selector\", \n6 \n \"product-summary-quantity\", \n7 \n \"add-to-cart-button\" \n8 \n ], \n9 \n \"props\":{ \n10 \n \"blockClass\": \"quickviewContent\" \n11 \n } \n12 \n}, \n13 \n\"product-summary-sku-selector\": { \n14 \n \"props\":{ \n15 \n \"showVariations Labels\": [\"false\"] \n16 \n } \n17 \n}, \n`\n2. Run `vtex link` to see your changes reflected in the workspace.\n\nYou should then be able to see and interact with the component without the modal closing, as illustrated below:\n\n\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/modal-layout-closes-when-i-click-a-sku.md)\n\n[My store does not reflect the overrides I created« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)[The Price in the shelf or in the search results is different from the product pageNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku%23solution)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/modal-layout-closes-when-i-click-a-sku.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku%23solution)\n\nOn this page\n\n[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=)"
}
] |
doc_8afdc0c3
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides notification 1 in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/vtex-shipping-network)\n\n[Getting started with VTEX IO for VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/getting-started-with-vtex-io-for-vtex-shipping-network)\n\n[Integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/integration-flow)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/notification-1)\n\n[Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/tracking-1)\n\n[VTEX Shipping Network Labels Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/vtex-shipping-network-labels-integration)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/multilevel-omnichannel-inventory)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/setting-up-white-label-seller-as-pickup-point)\n\n[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/delivery-promise)\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/vtex-shipping-network)\n\n[Getting started with VTEX IO for VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/getting-started-with-vtex-io-for-vtex-shipping-network)\n\n[Integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/integration-flow)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/notification-1)\n\n[Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/tracking-1)\n\n[VTEX Shipping Network Labels Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/vtex-shipping-network-labels-integration)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/multilevel-omnichannel-inventory)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/setting-up-white-label-seller-as-pickup-point)\n\n[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/delivery-promise)\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides)\n\nLogistics\n\n[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/vtex-shipping-network)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/notification-1)\n\nNotification\n\nAccess the [boilerplate repository for the notification app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/carrier-hubs-examples/tree/main/carrier-notifier-example) to clone it and begin development.\n\nA notification app published by a carrier will include an endpoint like this one:`https://app.io.vtex.com/{app_name}/{app_version}/{account}/{workspace}/notify`\n\nAfter an order is invoiced, the VTEX notification hub automatically makes a `POST` request to this endpoint with the package’s details. Then the app should respond with the order’s tracking number. See the examples below, and to learn more about this request, access the [notification API request documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/reference/vtex-log-notification-app).\n\nRequest body example:\n\n`1\n\n{ \n\n2\n\n \"email\": \"email\", \n\n3\n\n \"dispatchOrder\": { \n\n4\n\n \"id\": \"653560c2-7965-4614-a730-8e45c89bf284\", \n\n5\n\n \"packages\": [ \n\n6\n\n { \n\n7\n\n \"id\": \"6bb4c320-932b-46b6-a628-b61b133052e9\", \n\n8\n\n \"orderId\": \"00-1053722798105-01\", \n\n9\n\n \"items\": [ \n\n10\n\n { \n\n11\n\n \"id\": \"148350\", \n\n12\n\n \"name\": \"Kit Capacho Geométrico por Marcelo Nunes - 3 Novelos\", \n\n13\n\n \"quantity\": 1 \n\n14\n\n } \n\n15\n\n ], \n\n16\n\n \"dimension\": { \n\n17\n\n \"height\": 20.0, \n\n18\n\n \"length\": 20.0, \n\n19\n\n \"width\": 30.0, \n\n20\n\n \"weight\": 1458.0 \n\n21\n\n }, \n\n22\n\n \"recipientPostalCode\": \"03681-030\", \n\n23\n\n \"recipient\": { \n\n24\n\n \"cpf\": \"00000000000\", \n\n25\n\n \"id\": null, \n\n26\n\n \"name\": \"Fake Person\", \n\n27\n\n \"address\": { \n\n28\n\n \"postalCode\": \"00000-000\", \n\n29\n\n \"country\": { \n\n30\n\n \"code\": \"BRA\", \n\n31\n\n \"name\": \"BRA\" \n\n32\n\n }, \n\n33\n\n \"subregion1\": { \n\n34\n\n \"code\": \"SP\", \n\n35\n\n \"name\": \"SP\" \n\n36\n\n }, \n\n37\n\n \"subregion2\": { \n\n38\n\n \"code\": \"São Paulo\", \n\n39\n\n \"name\": \"São Paulo\" \n\n40\n\n }, \n\n41\n\n \"subregion3\": { \n\n42\n\n \"code\": \"Burgo Paulista\", \n\n43\n\n \"name\": \"Burgo Paulista\" \n\n44\n\n }, \n\n45\n\n \"street\": \"Rua Exemplo\", \n\n46\n\n \"number\": \"01\", \n\n47\n\n \"complement\": null, \n\n48\n\n \"location\": { \n\n49\n\n \"lat\": -46.48582077026367, \n\n50\n\n \"lng\": -23.521709442138672 \n\n51\n\n } \n\n52\n\n }, \n\n53\n\n \"email\": null, \n\n54\n\n \"phone\": \"+5511111111111\" \n\n55\n\n }, \n\n56\n\n \"invoiceData\": { \n\n57\n\n \"number\": \"445494\", \n\n58\n\n \"value\": 6909.0, \n\n59\n\n \"url\": \"\", \n\n60\n\n \"date\": \"2020-08-14T19:43:09.4740645+00:00\", \n\n61\n\n \"invoiceAccessKeys\": [ \n\n62\n\n \"35200844913721000168550010004454941205352231\" \n\n63\n\n ], \n\n64\n\n \"hasIcms\": false, \n\n65\n\n \"hasInsurance\": false \n\n66\n\n }, \n\n67\n\n \"trackingData\": { \n\n68\n\n \"number\": \"OM265512653BR\", \n\n69\n\n \"log\": [], \n\n70\n\n \"finished\": false, \n\n71\n\n \"finishedDate\": null \n\n72\n\n }, \n\n73\n\n \"origin\": \"Fulfillment\", \n\n74\n\n \"status\": \"invoiced\", \n\n75\n\n \"orderCreationDate\": \"2020-08-11T19:46:40.0305809+00:00\", \n\n76\n\n \"labelIssuedDate\": null, \n\n77\n\n \"shippingEstimate\": \"13bd\", \n\n78\n\n \"shippingEstimateDate\": \"2020-08-31T21:00:00+00:00\", \n\n79\n\n \"shippingData\": { \n\n80\n\n \"shippingPolicyName\": \"VTEXLOG EXAMPLE\", \n\n81\n\n \"shippingPolicyId\": \"vtexlog_policy_id\", \n\n82\n\n \"carrierName\": \"vtexlog\" \n\n83\n\n } \n\n84\n\n } \n\n85\n\n ], \n\n86\n\n \"sender\": { \n\n87\n\n \"cnpj\": \"00000000000000\", \n\n88\n\n \"fantasyName\": null, \n\n89\n\n \"stateRegistration\": null, \n\n90\n\n \"id\": null, \n\n91\n\n \"name\": \"LTDA\", \n\n92\n\n \"address\": { \n\n93\n\n \"postalCode\": \"03475015\", \n\n94\n\n \"country\": { \n\n95\n\n \"code\": \"Brasil\", \n\n96\n\n \"name\": \"Brasil\" \n\n97\n\n }, \n\n98\n\n \"subregion1\": { \n\n99\n\n \"code\": \"SP\", \n\n100\n\n \"name\": \"SP\" \n\n101\n\n }, \n\n102\n\n \"subregion2\": { \n\n103\n\n \"code\": \"São Paulo\", \n\n104\n\n \"name\": \"São Paulo\" \n\n105\n\n }, \n\n106\n\n \"subregion3\": { \n\n107\n\n \"code\": \"Vila Antonieta\", \n\n108\n\n \"name\": \"Vila Antonieta\" \n\n109\n\n }, \n\n110\n\n \"street\": \"Rua Exemplo\", \n\n111\n\n \"number\": \"01\", \n\n112\n\n \"complement\": \"\", \n\n113\n\n \"location\": null \n\n114\n\n }, \n\n115\n\n \"email\": null, \n\n116\n\n \"phone\": \"+5511111111111\" \n\n117\n\n }, \n\n118\n\n \"carrier\": { \n\n119\n\n \"cnpj\": \"00000000000000\", \n\n120\n\n \"fantasyName\": \"carrier\", \n\n121\n\n \"stateRegistration\": \"096/3624636\", \n\n122\n\n \"id\": \"vtexlog_exemplo\", \n\n123\n\n \"name\": \"Carrier LTDA.\", \n\n124\n\n \"address\": { \n\n125\n\n \"postalCode\": \"90200001\", \n\n126\n\n \"country\": { \n\n127\n\n \"code\": \"BRA\", \n\n128\n\n \"name\": \"Brasil\" \n\n129\n\n }, \n\n130\n\n \"subregion1\": { \n\n131\n\n \"code\": \"RS\", \n\n132\n\n \n133\n\n \"name\": \"Rio Grande do Sul\" \n\n134\n\n }, \n\n135\n\n \"subregion2\": { \n\n136\n\n \"code\": \"Porto_Alegre\", \n\n137\n\n \"name\": \"Porto Alegre\" \n\n138\n\n }, \n\n139\n\n \"subregion3\": { \n\n140\n\n \"code\": \"Anchieta\", \n\n141\n\n \"name\": \"Anchieta\" \n\n142\n\n }, \n\n143\n\n \"street\": \"Rua Exemplo\", \n\n144\n\n \"number\": \"01\", \n\n145\n\n \"complement\": \"Pavilhão 6\", \n\n146\n\n \"location\": null \n\n147\n\n }, \n\n148\n\n \"email\": \"email\", \n\n149\n\n \"phone\": \"+5511111111111\" \n\n150\n\n } \n\n151\n\n } \n\n152\n\n} \n\n`\n\nResponse body example:\n\n`1\n\n{ \n\n2\n\n <packageId> : { \n\n3\n\n \"tracking\": { \n\n4\n\n \"number\": string, \n\n5\n\n \"url\": string \n\n6\n\n }, \n\n7\n\n \"notification\": { \n\n8\n\n \"id\": string \n\n9\n\n } \n\n10\n\n } \n\n11\n\n} \n\n`\n\n## Learn more\n\nSee this guide on [how to develop carrier apps on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/getting-started-with-vtex-io-for-carriers). You can also learn more about the [integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/integration-flow) and [tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/tracking-1) for carrier apps.\n\nContributors\n\n1\n\n[](https://github.com/Isabella-Veloso)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Fulfillment/vtex-shipping-network/notification-1.md)\n\n[Integration flow« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1//docs/guides/integration-flow)[TrackingNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1//docs/guides/tracking-1)\n\nContributors\n\n1\n\n[](https://github.com/Isabella-Veloso)\n\nON THIS PAGE\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/notification-1%23learn-more)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Fulfillment/vtex-shipping-network/notification-1.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/notification-1/docs/guides/notification-1%23learn-more)\n\nOn this page\n\n[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=)"
}
] |
doc_651f0466
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides services 2 handling and receiving events in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-service)\n\n[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/developing-services-on-vtex-io)\n\n[1\\. Getting started with the boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-1-getting-started-with-the-boilerplate)\n\n[2\\. Handling and receiving events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events)\n\n[3\\. Using the Analytics client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-3-using-the-analytics-client)\n\n[4\\. Using events as triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-4-using-events-as-triggers)\n\n[5\\. Using the Master Data client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-5-using-the-master-data-client)\n\n[6\\. Using GraphQL to retrieve data from Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-6-graphql-retrieving-data-from-master-data)\n\n[7\\. Using GraphiQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-conclusion)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-service)\n\n[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/developing-services-on-vtex-io)\n\n[1\\. Getting started with the boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-1-getting-started-with-the-boilerplate)\n\n[2\\. Handling and receiving events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events)\n\n[3\\. Using the Analytics client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-3-using-the-analytics-client)\n\n[4\\. Using events as triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-4-using-events-as-triggers)\n\n[5\\. Using the Master Data client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-5-using-the-master-data-client)\n\n[6\\. Using GraphQL to retrieve data from Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-6-graphql-retrieving-data-from-master-data)\n\n[7\\. Using GraphiQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-conclusion)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/vtex-io-documentation-service)\n\n[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/developing-services-on-vtex-io)\n\n[2\\. Handling and receiving events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events)\n\n2\\. Handling and receiving events\n\nSome interactions on VTEX IO can generate events and be used as triggers for actions. For instance, an app listening for order placement events can respond by sending a confirmation email. In this course, we'll explore the process of firing events using the [events-example](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/events-example) app and then demonstrate how the `service-course-template` app can effectively listen to and handle these events.\n\nservice-course-templateevents-exampleFires eventsloop\\[Every 3seconds\\]Listens to events-example eventsHandles eventsservice-course-templateevents-example\n\n> Events are _workspace and account-bound_, meaning they are only visible for the account and workspace where they were fired. Events fired on your personal workspace will only be listened to by apps linked to this same workspace.\n\n## Logging into your account\n\nTo begin, log in to your VTEX account and create a devolopment [workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/) using the terminal. Replace `{accountName}` with your VTEX account name.\n\n## Cloning the app responsible for firing events\n\nNow, let's clone the `events-example` app, responsible for firing the events that the `service-course-template` will listen to.\n\n## Linking the app to a development workspace\n\nChange to the `events-example` directory and link the app to your development workspace. After running `vtex link` on the `events-example` app, the terminal should prompt a healthcheck route. Access the healthcheck route using your browser. You should see an `ok` text.\n\n> Accessing the healthcheck route creates a cache context needed for the VTEX IO to fire events. Without it, the `events-example` app won't be able to fire the events our app is going to listen to.\n\n## Handling events\n\nNow, let's return to the `service-course-template` app to manage events triggered by the `events-example` app effectively. This involves the following steps:\n\n* Set up the `service-course-template` app to listen to events emitted by the `events-example` app.\n* Create an event handler function for processing the events received from the `events-example` app.\n* Configure the `service-course-template` app to use the handler function to handle the listened events.\n\n### Listening to events\n\nIn order to listen to the events sent by the `events-example` app, open the `service.json` file and declare the highlighted code to give the app's service this capability. Note that we declare this by using the `events` resolver, the reference of the app that fires the event (`sender`), and the event reference key (`keys`).\n\n### Creating an event handler function\n\nOnce we are able to listen to the events sent by the `events-example` app, let's create a function to handle these events. For now, let's create a log when receiving an event. To do so, open the `/node/event` directory and update the `liveUsersUpdate.ts` file with the code presented.\n\n### Defining the event handler\n\nNow, we need to specify how the event handler function will be used. Open the `service-course-template/node/index.ts` file and update the `Service` declaration with the highlighted lines.\n\n### Configuring the event handler behavior\n\nWe can now specify how the event handler will behave. In the `service-course-template/node/index.ts` file, update the `Service` declaration with the highlighted lines. Going by each configuration, we have the following:\n\n| Field | Type | Description |\n| ----------------------------- | ------- | -------------------------------------------------------------------------------------- |\n| exponentialTimeoutCoefficient | Integer | Exponential factor by which the timeout will increase in each retry, in seconds. |\n| exponentialBackoffCoefficient | Integer | Exponential factor by which the backoff delay will increase in each retry, in seconds. |\n| initialBackoffDelay | Integer | Time, in seconds, that the app will wait until the next retry. |\n| retries | Integer | Maximum times the app will retry. |\n| timeout | Integer | Timeout until the attempt is considered a failure, in seconds. |\n| concurrency | Integer | Amount of simultaneous processes the event is able to perform. |\n\nBy adding this code to the `Service`, we are adding to the `Client` of this `Service`, the capability to handle events. At this point, we are not yet using the `Client` itself when handling the event.\n\n## Linking the event handler app\n\nIn the `service-course-template` directory, run `vtex link` and wait for the event to be fired by the `events-example` app. Upon successful reception, a log entry should appear in the console.\n\n`1\n\nvtex login {accountName} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/services/services-2-handling-and-receiving-events.mdx)\n\n[1\\. Getting started with the boilerplate« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events//docs/guides/services-1-getting-started-with-the-boilerplate)[3\\. Using the Analytics clientNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events//docs/guides/services-3-using-the-analytics-client)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Logging into your account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23logging-into-your-account)\n\n[Cloning the app responsible for firing events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23cloning-the-app-responsible-for-firing-events)\n\n[Linking the app to a development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23linking-the-app-to-a-development-workspace)\n\n[Handling events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23handling-events)\n\n[Listening to events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23listening-to-events)[Creating an event handler function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23creating-an-event-handler-function)[Defining the event handler](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23defining-the-event-handler)[Configuring the event handler behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23configuring-the-event-handler-behavior)\n\n[Linking the event handler app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23linking-the-event-handler-app)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/services/services-2-handling-and-receiving-events.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Logging into your account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23logging-into-your-account)\n\n[Cloning the app responsible for firing events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23cloning-the-app-responsible-for-firing-events)\n\n[Linking the app to a development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23linking-the-app-to-a-development-workspace)\n\n[Handling events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23handling-events)\n\n[Listening to events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23listening-to-events)[Creating an event handler function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23creating-an-event-handler-function)[Defining the event handler](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23defining-the-event-handler)[Configuring the event handler behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23configuring-the-event-handler-behavior)\n\n[Linking the event handler app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-2-handling-and-receiving-events/docs/guides/services-2-handling-and-receiving-events%23linking-the-event-handler-app)\n\nOn this page\n\n[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=)"
}
] |
doc_d27642c2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain the VTEX api reference catalog api API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/catalog-api/)\n\nCategory\n\nCategory Specification\n\nBrand\n\nSpecification Group\n\nSpecification\n\nSpecification Value\n\nProduct\n\nProduct Specification\n\nSKU\n\nSKU Specification\n\nSKU File\n\nSKU Complement\n\nSKU EAN\n\nAttachment\n\nSKU Attachment\n\nSKU Service\n\nSKU Kit\n\nSKU Seller\n\nMulti-language beta\n\nSimilar Category\n\nCollection\n\nSubcollection\n\nSeller\n\nSupplier\n\nTrade Policy\n\nProduct Indexing\n\nCommercial Conditions\n\nGift List\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/catalog-api/)\n\nCategory\n\nCategory Specification\n\nBrand\n\nSpecification Group\n\nSpecification\n\nSpecification Value\n\nProduct\n\nProduct Specification\n\nSKU\n\nSKU Specification\n\nSKU File\n\nSKU Complement\n\nSKU EAN\n\nAttachment\n\nSKU Attachment\n\nSKU Service\n\nSKU Kit\n\nSKU Seller\n\nMulti-language beta\n\nSimilar Category\n\nCollection\n\nSubcollection\n\nSeller\n\nSupplier\n\nTrade Policy\n\nProduct Indexing\n\nCommercial Conditions\n\nGift List\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PoCreate Category« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/catalog-api-seller-portal%23post-/api/catalog-seller-portal/category-tree/categories)[GeGet Category TreeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pub/category/tree/-categoryLevels-)\n\n[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=)"
}
] |
doc_ba12dcc0
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX category menu app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/troubleshooting)\n\n[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.category-menu/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.reviews-and-ratings)\n\n[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.reviews-and-ratings)\n\n[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/guides/advanced-components)\n\nCategory Menu\n\nOfficial extension\n\nVersion: 2.18.1\n\nLatest version: 2.18.1\n\n[](#contributors-)\n\nThe Category Menu is a store component that displays a list of departments in a configurable menu layout. It helps organize and present categories and subcategories to improve navigation.\n\n> An error occurred while loading the image https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/docs/vtex-menu-0.png\n\n## Configuration\n\n1. Add the app to your store theme's dependencies in the `manifest.json`.\n\n`1\n\n dependencies: { \n\n2\n\n \"vtex.category-menu\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `category-menu` block to your store theme.\n\n`1\n\n{ \n\n2\n\n \"category-menu\": { \n\n3\n\n \"props\": { \n\n4\n\n \"showAllDepartments\": true, \n\n5\n\n \"showSubcategories\": true, \n\n6\n\n \"menuDisposition\": \"center\", \n\n7\n\n \"departments\": [], \n\n8\n\n \"sortSubcategories\": \"name\" \n\n9\n\n } \n\n10\n\n } \n\n11\n\n} \n\n`\n\n### `category-menu` props\n\n| Prop name | Type | Description | Default Value |\n| ------------------ | ------------ | --------------------------------------------------------------------------------- | ------------- |\n| showAllDepartments | Boolean | Shows all department categories in the menu | true |\n| menuDisposition | Enum | Indicates the menu's position on the screen. Possible values: left, center, right | center |\n| showSubcategories | Boolean | Defines if the subcategories will be displayed | true |\n| departments | Array(items) | List of department items to be displayed on the menu | \\[\\] |\n| mobileMode | Boolean | Renders the category menu in a sidebar if set to true | false |\n| sortSubcategories | Enum | Determines how subcategories are sorted. Possible value: name | |\n\n### `category-menu` items\n\n| Prop name | Type | Description |\n| --------- | ------ | --------------------------------------------- |\n| id | Number | The department ID to be displayed on the menu |\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles |\n| ------------------------- |\n| container |\n| departmentLink |\n| departmentList |\n| firstLevelLink |\n| firstLevelLinkContainer |\n| firstLevelList |\n| itemContainer |\n| itemContainer--category |\n| itemContainer--department |\n| menuContainer |\n| secondLevelLink |\n| secondLevelLinkContainer |\n| secondLevelList |\n| section--category |\n| section--department |\n| sidebar |\n| sidebarContainer |\n| sidebarContent |\n| sidebarHeader |\n| sidebarItem |\n| sidebarItemContainer |\n| sidebarOpen |\n| sidebarScrim |\n| submenuItem |\n| submenuList |\n\n[Availability Notify« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.availability-notify)[Kit LookNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtexbr.kitlook)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.category-menu%23configuration)\n\n[category-menu props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.category-menu%23category-menu-props)[category-menu items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.category-menu%23category-menu-items)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.category-menu/docs/apps/vtex.category-menu%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_053c5b44
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore schema scalars in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/troubleshooting)\n\n[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/schema-scalars/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/faststore-api-overview)\n\n[Queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-queries)\n\n[Mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-mutations)\n\n[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-objects)\n\n[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-inputs)\n\n[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-enums)\n\n[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars)\n\n[Configuring GraphQL cache control for GET requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/faststore-api-configuring-graphql-cache-control)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/faststore-api-overview)\n\n[Queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-queries)\n\n[Mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-mutations)\n\n[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-objects)\n\n[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-inputs)\n\n[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-enums)\n\n[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars)\n\n[Configuring GraphQL cache control for GET requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/faststore-api-configuring-graphql-cache-control)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/faststore-api-overview)\n\nScalars\n\n## Scalars\n\n### ActiveVariations\n\nThe `ActiveVariations` scalar type represents a combination of active product variations.\n\nExample:\n\n`1\n\n{ \n\n2\n\n Color: 'Red', Size: '42' \n\n3\n\n} \n\n`\n\n### Boolean\n\nThe `Boolean` scalar type represents `true` or `false`.\n\n### Float\n\nThe `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/IEEE%5Ffloating%5Fpoint).\n\n### FormattedVariants\n\nThe `FormattedVariants` scalar type represents a collection of product variations with additional details like image source, description, and values.\n\nExample:\n\n`1\n\n{ \n\n2\n\n Color: [ \n\n3\n\n { \n\n4\n\n src: \"https://storecomponents.vtexassets.com/...\", \n\n5\n\n alt: \"...\", \n\n6\n\n label: \"...\", \n\n7\n\n value: \"...\" \n\n8\n\n }, \n\n9\n\n { \n\n10\n\n src: \"https://storecomponents.vtexassets.com/...\", \n\n11\n\n alt: \"...\", \n\n12\n\n label: \"...\", \n\n13\n\n value: \"...\" \n\n14\n\n } \n\n15\n\n ], \n\n16\n\n Size: [ \n\n17\n\n { \n\n18\n\n src: \"https://storecomponents.vtexassets.com/...\", \n\n19\n\n alt: \"...\", \n\n20\n\n label: \"...\", \n\n21\n\n value: \"...\" \n\n22\n\n } \n\n23\n\n ] \n\n24\n\n} \n\n`\n\n### ID\n\nThe `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `\"4\"`) or integer (such as `4`) input value will be accepted as an ID.\n\n### Int\n\nThe `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.\n\n### ObjectOrString\n\nA string or the string representation of an object (a stringified object).\n\n### SlugsMap\n\nExample:\n\n`1\n\n{ \n\n2\n\n 'Color-Red-Size-40': 'classic-shoes-37' \n\n3\n\n} \n\n`\n\n### String\n\nThe `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.\n\n### VariantsByName\n\nThe `VariantsByName` scalar type represents a collection of variations listed by their names, like a list of available `Color` options or `Size` options.\n\nExample:\n\n`1\n\n{ \n\n2\n\n Color: [ \"Red\", \"Blue\", \"Green\" ], \n\n3\n\n Size: [ \"40\", \"41\" ] \n\n4\n\n} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/faststore-api/schema/scalars.mdx)\n\n[Enums« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-enums)[Configuring GraphQL cache control for GET requestsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/faststore-api-configuring-graphql-cache-control)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23scalars)\n\n[ActiveVariations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23activevariations)[Boolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23boolean)[Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23float)[FormattedVariants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23formattedvariants)[ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23id)[Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23int)[ObjectOrString](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23objectorstring)[SlugsMap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23slugsmap)[String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23string)[VariantsByName](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23variantsbyname)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/faststore-api/schema/scalars.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23scalars)\n\n[ActiveVariations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23activevariations)[Boolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23boolean)[Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23float)[FormattedVariants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23formattedvariants)[ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23id)[Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23int)[ObjectOrString](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23objectorstring)[SlugsMap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23slugsmap)[String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23string)[VariantsByName](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars/docs/guides/faststore/schema-scalars%23variantsbyname)\n\nOn this page\n\n[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=)"
}
] |
doc_a045ee70
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides external marketplace integration order logs in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides)\n\nIntegration Guides\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-guide)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders)\n\nNew Order Integration\n\n> If you used our previous method for integrating orders, you can still find their documentation in [Order Logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-order-logs) and [How to collect orders from sales channels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels). The previous method, however, will not be maintained. If you are integrating orders for the first time, we recommend you use the instructions in this article.\n\n## Authentication/authorization\n\nWhen sending a request to our APIs, you must inform in the headers a X-VTEX-API-AppKey + X-VTEX-API-AppToken pair or a VtexIdclientAutCookie (the connector’s app token, if using our [App Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template)) that has access to the specified account.\n\n## API Reference: New order Integration\n\nUse the request example below to Place an order. The description and requirement of each of the fields present in the request body are found in our [API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/order-integration/orders).\n\nIt’s important to note that although some fields are optional in our API, depending on the order's country of origin or trade policy, they may be mandatory for Checkout/Fulfillment. In such cases, when trying to process the order, we will return the validation error in question to the connector, as well as other possible errors and success notifications.\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": string, \n\n3\n\n \"connectorName\": string, \n\n4\n\n \"connectorEndpoint\": string, \n\n5\n\n \"marketplaceOrderStatus\": string, \n\n6\n\n \"marketplacePaymentValue\": int, \n\n7\n\n \"marketplaceInterestValue\": int, \n\n8\n\n \"priceDivergenceAllowanceRate\": decimal, \n\n9\n\n \"allowFranchises\": bool, \n\n10\n\n \"pickupAccountName\": string, \n\n11\n\n \"items\": [ \n\n12\n\n { \n\n13\n\n \"id\": string, \n\n14\n\n \"price\": int, \n\n15\n\n \"quantity\": int \n\n16\n\n } \n\n17\n\n ], \n\n18\n\n \"clientProfileData\": { \n\n19\n\n \"email\": string, \n\n20\n\n \"firstName\": string, \n\n21\n\n \"lastName\": string, \n\n22\n\n \"phone\": string, \n\n23\n\n \"document\": string, \n\n24\n\n \"corporateDocument\": string, \n\n25\n\n \"corporatePhone\": string, \n\n26\n\n \"corporateName\": string, \n\n27\n\n \"tradeName\": string, \n\n28\n\n \"stateInscription\": string \n\n29\n\n }, \n\n30\n\n \"shippingData\": { \n\n31\n\n \"logisticsInfo\": [ \n\n32\n\n { \n\n33\n\n \"price\": int, \n\n34\n\n \"selectedDeliveryChannel\": string, \n\n35\n\n \"selectedSla\": string, \n\n36\n\n \"lockTTL\": string, \n\n37\n\n \"shippingEstimate\": string, \n\n38\n\n \"deliveryIds\": [ \n\n39\n\n { \n\n40\n\n \"warehouseId\": string \n\n41\n\n } \n\n42\n\n ] \n\n43\n\n } \n\n44\n\n ], \n\n45\n\n \"selectedAddresses\": [ \n\n46\n\n { \n\n47\n\n \"addressType\": string, \n\n48\n\n \"addressId\": string, \n\n49\n\n \"receiverName\": string, \n\n50\n\n \"postalCode\": string, \n\n51\n\n \"city\": string, \n\n52\n\n \"state\": string, \n\n53\n\n \"country\": string, \n\n54\n\n \"street\": string, \n\n55\n\n \"number\": string, \n\n56\n\n \"neighborhood\": string, \n\n57\n\n \"complement\": string, \n\n58\n\n \"geoCoordinates\": { \n\n59\n\n \"latitude\": double, \n\n60\n\n \"longitude\": double \n\n61\n\n } \n\n62\n\n } \n\n63\n\n ], \n\n64\n\n \"isFob\": bool, \n\n65\n\n \"isMarketplaceFulfillment\": bool, \n\n66\n\n \"trackingHints\": [ \n\n67\n\n { \n\n68\n\n \"trackingId\": string, \n\n69\n\n \"courierName\": string, \n\n70\n\n \"trackingUrl\": string, \n\n71\n\n \"trackingLabel\": string \n\n72\n\n } \n\n73\n\n ] \n\n74\n\n }, \n\n75\n\n \"invoiceData\": { \n\n76\n\n \"userPaymentInfo\": { \n\n77\n\n \"paymentMethods\": string[] \n\n78\n\n } \n\n79\n\n }, \n\n80\n\n \"customData\": { \n\n81\n\n \"customApps\": [ \n\n82\n\n { \n\n83\n\n \"id\": string, \n\n84\n\n \"major\": int, \n\n85\n\n \"fields\": { \n\n86\n\n string: string \n\n87\n\n } \n\n88\n\n } \n\n89\n\n ] \n\n90\n\n }, \n\n91\n\n \"taxData\": [ \n\n92\n\n { \n\n93\n\n \"skuId\": string, \n\n94\n\n \"value\": int \n\n95\n\n } \n\n96\n\n ], \n\n97\n\n \"openTextField\": string \n\n98\n\n} \n\n`\n\n### Response Notifications\n\nTo receive notifications from our service, the connector must implement some API routes in the base endpoint informed in connectorEndpoint (be in the request or the App Template). Order Processing Result\n\nNotifications with the orders processing result are sent through the following request: POST {connectorEndpoint}/order-integration/notification/processing-result?an={accountName}. The body is the same as described here.\n\n#### Response Body\n\nAll API responses and order notifications from our service return the same data contract, as detailed bellow:\n\n`1\n\n{ \n\n2\n\n \"accountName\": string, \n\n3\n\n \"success\": bool, \n\n4\n\n \"flow\": string, \n\n5\n\n \"operationId\": string, \n\n6\n\n \"marketplaceOrderId\": string, \n\n7\n\n \"code\": string, \n\n8\n\n \"message\": string, \n\n9\n\n \"errors\": \n\n10\n\n [ \n\n11\n\n { \n\n12\n\n \"source\": string, \n\n13\n\n \"code\": string, \n\n14\n\n \"description\": string \n\n15\n\n } \n\n16\n\n ], \n\n17\n\n \"fields\": { \n\n18\n\n \"mainOrderId\": string, \n\n19\n\n \"franchiseOrderId\": string \n\n20\n\n } \n\n21\n\n} \n\n`\n\nSome fields can return as null in some cases, such as accountName, marketplaceOrderId and operationId, for example.\n\n#### Response Codes\n\n| Code | Description |\n| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| SOI001 | The order was integrated into VTEX successfully |\n| SOI002 | The order was approved in VTEX successfully |\n| SOI003 | The order was successfully enqueued in our service for processing |\n| EOI000 | An unknown error occurred when processing the order, and in this case, the solution would be contacting VTEX for support |\n| EOI001 | An unmapped error occurred when processing the order, and more details about the error can be found in the response error list |\n| EOI002 | There are no SLAs or items available to fulfill this order. That is: the item(s) can be without stock, inactive in the catalog or not included in connector’s trade policy; the SLA/pickup point chosen in the order is not available or doesn’t have stock for the order’s items; or there aren’t any SLAs available at all to fulfill the order |\n| EOI003 | The order total payment value differs from what is expected by the seller, and they do not have Order Authorization rules set up to deal with price divergence |\n| EOI004 | This order's cart is invalid. That can mean that either the item(s) in it don’t exist in VTEX catalog or the order's data doesn’t comply with the store configuration (for example, the minimum total value or quantity of items set by the seller was not reached in the order) |\n| EOI005 | A validation error occurred while trying to process the order. That is, some field/value sent in the order’s contract is invalid and not filled according to our’s or Checkout/Fulfillment’s documentation |\n| EOI006 | An unexpected error occurred in one of VTEX's internal services. Please try to send the request again later, as it’s possible one of our services is going through instabilities |\n| EOI007 | The order specified already exists in VTEX and we are not able to create duplicated orders |\n| EOI008 | The order cannot be approved because it’s not integrated in VTEX yet |\n| EOI009 | This order is out of the valid status to approve, such as canceled, for example |\n| EOI010 | The request to our API timed out, meaning we exceeded the response time limit |\n| EOI011 | The order was integrated with a price divergence, and we cannot approve it yet because we are waiting for the seller's manual authorization before proceeding |\n\n#### Order Notification Results\n\n* Error \n * EOI000 - Unknown error \n * EOI001 - Unmapped error \n * EOI002 - SLA not available \n * EOI003 - Price divergence \n * EOI004 - Invalid cart \n * EOI005 - Validation error \n * EOI006 - VTEX unexpected error \n * EOI007 - Duplicated order\n* Success \n * SOI001 - Order integrated\n\n## Scenario 1: new order, with pending payment\n\nTo integrate orders with pending payment, you just need to set the marketplaceOrderStatus field to NEW in the [New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/order-integration/orders) request.\n\n### Response\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": null, \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI003\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": null, \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": null, \n\n10\n\n \"message\": \"Order successfully enqueued\" \n\n11\n\n} \n\n`\n\n### Notification\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": \"123456789\", \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI001\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": \"a1a0e124-6cfc-404e-a8c5-95f5a494dc86\", \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": { \n\n10\n\n \"mainOrderId\": \"MKP-123456789\", \n\n11\n\n \"franchiseOrderId\": null \n\n12\n\n }, \n\n13\n\n \"message\": \"Order integrated successfully\" \n\n14\n\n} \n\n`\n\n## Scenario 2: Approved order, with approved payment\n\nTo integrate orders with approved payment (automatically approving them afterwards) you just need to set the `marketplaceOrderStatus` field to `approved` in the [New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/order-integration/orders) API request.\n\n### Response\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": null, \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI003\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": null, \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": null, \n\n10\n\n \"message\": \"Order successfully enqueued\" \n\n11\n\n} \n\n`\n\n### Notification\n\n**Integration:**\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": \"123456789\", \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI001\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": \"8cd93fe7-db90-4e1b-b55f-890a61e72bad\", \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": { \n\n10\n\n \"mainOrderId\": \"MKP-123456789\", \n\n11\n\n \"franchiseOrderId\": null \n\n12\n\n }, \n\n13\n\n \"message\": \"Order integrated successfully\" \n\n14\n\n} \n\n`\n\n**Approval:**\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": \"123456789\", \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI002\", \n\n5\n\n \"flow\": \"ApproveOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": \"8cd93fe7-db90-4e1b-b55f-890a61e72bad\", \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": { \n\n10\n\n \"mainOrderId\": \"MKP-123456789\", \n\n11\n\n \"franchiseOrderId\": null \n\n12\n\n }, \n\n13\n\n \"message\": \"Order approved successfully\" \n\n14\n\n} \n\n`\n\n## Scenario 3: order with interest\n\nTo integrate orders with additional interest values, you need to fill in the marketplaceInterestValue field, with the desired amount in the [New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/order-integration/orders) API request.\n\n### Response\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": null, \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI003\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": null, \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": null, \n\n10\n\n \"message\": \"Order successfully enqueued\" \n\n11\n\n} \n\n`\n\n### Notification\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": \"123456789\", \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI001\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": \"7425f2ef-0849-4b73-94c7-355982119e51\", \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": { \n\n10\n\n \"mainOrderId\": \"MKP-123456789\", \n\n11\n\n \"franchiseOrderId\": null \n\n12\n\n }, \n\n13\n\n \"message\": \"Order integrated successfully\" \n\n14\n\n} \n\n`\n\n## Scenario 4: Order with discounts\n\nTo integrate orders with discounts, you need to apply the discount directly in the order in the[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/order-integration/orders) API request, before sending it to our service. This means:\n\n* If shipping costs $10 for a SKU, but the marketplace is offering a 10% discount on it, the `price` in `logisticsInfo` should be $9 (in integer format, 900).\n* If the SKU is priced at $100, and the marketplace is offering a 10% discount on it, the `price` of the SKU in `items` should be $90 (in integer format, 9000).\n* And when the marketplace is offering a discount applied to all shipping or all SKUs in the order, this value should be split between the items, for example: \n * SKU 1 price: $10, SKU 2 price: $40\\. Marketplace discount: $10\\. SKU 1 final `price` in `items` should be $5 (in integer format, 500) and SKU 2 final `price` should be $35 (in integer format, 3500).\n\n### Response\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": null, \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI003\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": null, \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": null, \n\n10\n\n \"message\": \"Order successfully enqueued\" \n\n11\n\n} \n\n`\n\n### Notification\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": \"123456789\", \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI001\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": \"9e396ae7-1e76-4915-b1ba-adb860e177bd\", \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": { \n\n10\n\n \"mainOrderId\": \"MKP-123456789\", \n\n11\n\n \"franchiseOrderId\": null \n\n12\n\n }, \n\n13\n\n \"message\": \"Order integrated successfully\" \n\n14\n\n} \n\n`\n\n## Scenario 5: Order delivered by the seller\n\nTo input an order delivered by the seller, you must do the following in the[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/order-integration/orders) API request:\n\n* Fill the `selectedDeliveryChannel` field with the value `delivery`.\n* Fill the `selectedSla` field with the name of the seller’s SLA selected to deliver this order. In this case, this field can also be left empty, and Fulfillment’s service will choose an available SLA automatically, if there’s any.\n\n### Response\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": null, \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI003\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": null, \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": null, \n\n10\n\n \"message\": \"Order successfully enqueued\" \n\n11\n\n} \n\n`\n\n### Notification\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": \"123456789\", \n\n3\n\n \"accountName\": \"grocery1\", \n\n4\n\n \"code\": \"SOI001\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": \"e30cf30c-7b89-4a04-aa20-eb3d116e2ac7\", \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": { \n\n10\n\n \"mainOrderId\": \"MKP-123456789\", \n\n11\n\n \"franchiseOrderId\": null \n\n12\n\n }, \n\n13\n\n \"message\": \"Order integrated successfully\" \n\n14\n\n} \n\n`\n\n## Scenario 6: Order delivered by seller’s franchise (Multilevel Omnichannel Inventory)\n\nTo input an order delivered by a seller’s franchise, to allow the Multilevel Omnichannel Inventory feature, in the [New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/order-integration/orders) API request, you must do the following:\n\n* Fill the `selectedDeliveryChannel` field with the value `delivery`;\n* Fill the `selectedSla` field with the name of the seller’s SLA selected to deliver this order;\n* Set the `allowFranchises` field to `true`.\n\n### Response\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": null, \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI003\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": null, \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": null, \n\n10\n\n \"message\": \"Order successfully enqueued\" \n\n11\n\n} \n\n`\n\n### Notification\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": \"123456789\", \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI001\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": \"e1d447aa-c885-4b03-97c4-ddf20090a3c3\", \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": { \n\n10\n\n \"mainOrderId\": \"MKP-123456789-01\", \n\n11\n\n \"franchiseOrderId\": \"MKT-MKP-123456789-01\" \n\n12\n\n }, \n\n13\n\n \"message\": \"Order integrated successfully\" \n\n14\n\n} \n\n`\n\n## Scenario 7: Order delivered by the marketplace (with stock in the seller)\n\nTo input an order delivered by the marketplace with the stock in the seller, in the [New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/order-integration/orders) API request, you must do the following:\n\n* Fill the `selectedDeliveryChannel` field with the value `delivery`.\n* Don’t fill the `selectedSla` field.\n* Set the `isFob` field to `true`.\n* Set the `isMarketplaceFulfillment` to false.\n\n### Response\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": null, \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI003\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": null, \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": null, \n\n10\n\n \"message\": \"Order successfully enqueued\" \n\n11\n\n} \n\n`\n\n### Notification\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": \"123456789\", \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI001\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": \"94c3242a-74b9-4261-9820-8e26bb73dbbd\", \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": { \n\n10\n\n \"mainOrderId\": \"MKP-123456789\", \n\n11\n\n \"franchiseOrderId\": null \n\n12\n\n }, \n\n13\n\n \"message\": \"Order integrated successfully\" \n\n14\n\n} \n\n`\n\n## Scenario 8: Order delivered by the marketplace (with stock in the marketplace)\n\nTo input an order delivered by and with the stock in the marketplace, in the [New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/order-integration/orders) API request, you must do the following:\n\n* Fill the `selectedDeliveryChannel` field with the value `delivery`;\n* Don’t fill the `selectedSla` field;\n* Set the `isFob` field to `true`;\n* Set the `isMarketplaceFulfillment` to `true`;\n* Fill the `warehouseId` within the `deliveryIds` field with the id of the warehouse set by the seller to handle orders from the marketplace.\n\n### Response\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": null, \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI003\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": null, \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": null, \n\n10\n\n \"message\": \"Order successfully enqueued\" \n\n11\n\n} \n\n`\n\n### Notification\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": \"123456789\", \n\n3\n\n \"accountName\": \"grocery1\", \n\n4\n\n \"code\": \"SOI001\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": \"42ca5760-e229-49b1-a731-73bebd0c48a0\", \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": { \n\n10\n\n \"mainOrderId\": \"MKP-123456789\", \n\n11\n\n \"franchiseOrderId\": null \n\n12\n\n }, \n\n13\n\n \"message\": \"Order integrated successfully\" \n\n14\n\n} \n\n`\n\n## Scenario 9: Order with pickup-in-point\n\nTo input a pickup-in-point order, where the customer’ll be responsible for retrieving the products in a specified store, you must do the following in the [New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/order-integration/orders) API request:\n\n* Fill the `selectedDeliveryChannel` field with the value `pickup-in-point`.\n* Fill the `selectedAddresses` list with the pickup point address, instead of the customers’s, specifying: \n * In the `addressType` field the value `pickup`. \n * In the `addressId` field the pickup point’s ID in VTEX’s logistics system.\n* Fill the `geoCoordinates` field with the geo coordinates from the pickup address.\n* The `isFob` field cannot be set to `true` if the order’s delivery type is pickup-in-point.\n* The `selectedSla` should be left empty for `pickup-in-point` orders as well.\n\n### Response\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": null, \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI003\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": null, \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": null, \n\n10\n\n \"message\": \"Order successfully enqueued\" \n\n11\n\n} \n\n`\n\n### Notification\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": \"123456789\", \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI001\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": \"b830df0e-3377-4b44-9601-85ecfd848b41\", \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": { \n\n10\n\n \"mainOrderId\": \"MKP-123456789\", \n\n11\n\n \"franchiseOrderId\": null \n\n12\n\n }, \n\n13\n\n \"message\": \"Order integrated successfully\" \n\n14\n\n} \n\n`\n\n## Scenario 10: Order with a franchise pickup-in-point (Multilevel Omnichannel Inventory)\n\nTo input a franchise pickup-in-point order, where the customer’ll be responsible for retrieving the products in a specified seller’s franchise store, you must do the following in the [New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/order-integration/orders) API request:\n\n* Fill the `selectedDeliveryChannel` field with the value `pickup-in-point`.\n* Fill the `selectedAddresses` list with the pickup point address, instead of the customers’s, specifying: \n * In the `addressType` field the value `pickup`. \n * In the `addressId` field the pickup point’s ID in VTEX’s logistics system.\n* Set the `allowFranchises` field to `true`.\n* Fill the `pickupAccountName` field, indicating from which account name the pickup point selected in the order is from, even if it’s from the main account.\n* Fill the `geoCoordinates` field with the geo coordinates from the pickup address.\n* The `isFob` field cannot be set to true if the order’s delivery type is pickup-in-point.\n* The `selectedSla` should be left empty for `pickup-in-point` orders as well.\n\n### Response\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": null, \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI003\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": null, \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": null, \n\n10\n\n \"message\": \"Order successfully enqueued\" \n\n11\n\n} \n\n`\n\n### Notification\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": \"123456789\", \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI001\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": \"c1f00956-801c-4ab5-b343-b05c1d33863e\", \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": { \n\n10\n\n \"mainOrderId\": \"MKP-123456789-01\", \n\n11\n\n \"franchiseOrderId\": \"MKT-MKP-123456789-01\" \n\n12\n\n }, \n\n13\n\n \"message\": \"Order integrated successfully\" \n\n14\n\n} \n\n`\n\n## Scenario 11: Order with taxes\n\nTo integrate orders with additional taxes values, in the [New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/order-integration/orders) API request, you need to fill in the taxData field, a list containing all taxes, one per SKU. If you don’t have the value individually by SKU, you can add only one item in the list, using one SKU ID from the order and adding all the taxes in field value.\n\n### Response\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": null, \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI003\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": null, \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": null, \n\n10\n\n \"message\": \"Order successfully enqueued\" \n\n11\n\n} \n\n`\n\n### Notification\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": \"123456789\", \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI001\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": \"7425f2ef-0849-4b73-94c7-355982119e51\", \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": { \n\n10\n\n \"mainOrderId\": \"MKP-123456789\", \n\n11\n\n \"franchiseOrderId\": null \n\n12\n\n }, \n\n13\n\n \"message\": \"Order integrated successfully\" \n\n14\n\n} \n\n`\n\n## Scenario 12: Order with tracking hints\n\nTo integrate orders with label information, in the [New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/order-integration/orders) API request, you need to fill in the trackingHints field, a list containing all infos related to order label.\n\n### Response\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": null, \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI003\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": null, \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": null, \n\n10\n\n \"message\": \"Order successfully enqueued\" \n\n11\n\n} \n\n`\n\n### Notification\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": \"123456789\", \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI001\", \n\n5\n\n \"flow\": \"PlaceOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": \"7425f2ef-0849-4b73-94c7-355982119e51\", \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": { \n\n10\n\n \"mainOrderId\": \"MKP-123456789\", \n\n11\n\n \"franchiseOrderId\": null \n\n12\n\n }, \n\n13\n\n \"message\": \"Order integrated successfully\" \n\n14\n\n} \n\n`\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-collect-orders.md)\n\n[Recommendations« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs//docs/guides/external-marketplace-integration-recommendations)[Update Order StatusNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs//docs/guides/external-marketplace-update-order-status)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Authentication/authorization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23authenticationauthorization)\n\n[API Reference: New order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23api-reference-new-order-integration)\n\n[Response Notifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response-notifications)\n\n[Scenario 1: new order, with pending payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-1-new-order-with-pending-payment)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 2: Approved order, with approved payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-2-approved-order-with-approved-payment)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 3: order with interest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-3-order-with-interest)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 4: Order with discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-4-order-with-discounts)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 5: Order delivered by the seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-5-order-delivered-by-the-seller)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 6: Order delivered by seller’s franchise (Multilevel Omnichannel Inventory)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-6-order-delivered-by-sellers-franchise-multilevel-omnichannel-inventory)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 7: Order delivered by the marketplace (with stock in the seller)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-7-order-delivered-by-the-marketplace-with-stock-in-the-seller)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 8: Order delivered by the marketplace (with stock in the marketplace)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-8-order-delivered-by-the-marketplace-with-stock-in-the-marketplace)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 9: Order with pickup-in-point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-9-order-with-pickup-in-point)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 10: Order with a franchise pickup-in-point (Multilevel Omnichannel Inventory)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-10-order-with-a-franchise-pickup-in-point-multilevel-omnichannel-inventory)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 11: Order with taxes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-11-order-with-taxes)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 12: Order with tracking hints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-12-order-with-tracking-hints)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-collect-orders.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Authentication/authorization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23authenticationauthorization)\n\n[API Reference: New order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23api-reference-new-order-integration)\n\n[Response Notifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response-notifications)\n\n[Scenario 1: new order, with pending payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-1-new-order-with-pending-payment)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 2: Approved order, with approved payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-2-approved-order-with-approved-payment)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 3: order with interest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-3-order-with-interest)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 4: Order with discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-4-order-with-discounts)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 5: Order delivered by the seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-5-order-delivered-by-the-seller)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 6: Order delivered by seller’s franchise (Multilevel Omnichannel Inventory)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-6-order-delivered-by-sellers-franchise-multilevel-omnichannel-inventory)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 7: Order delivered by the marketplace (with stock in the seller)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-7-order-delivered-by-the-marketplace-with-stock-in-the-seller)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 8: Order delivered by the marketplace (with stock in the marketplace)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-8-order-delivered-by-the-marketplace-with-stock-in-the-marketplace)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 9: Order with pickup-in-point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-9-order-with-pickup-in-point)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 10: Order with a franchise pickup-in-point (Multilevel Omnichannel Inventory)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-10-order-with-a-franchise-pickup-in-point-multilevel-omnichannel-inventory)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 11: Order with taxes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-11-order-with-taxes)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\n[Scenario 12: Order with tracking hints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23scenario-12-order-with-tracking-hints)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-order-logs/docs/guides/external-marketplace-integration-collect-orders%23notification)\n\nOn this page\n\n[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=)"
}
] |
doc_c1f268bd
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore overrides component props in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/troubleshooting)\n\n[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/overrides-component-props/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Section override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-overview)\n\n[Overriding native component's props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-component-props)\n\n[Overriding a native component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-native-component)\n\n[Overriding section styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-section-styles)\n\n[\\`getOverriddenSection\\` function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-getoverriddensection-function)\n\n[Syncing components with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms)\n\n[Migrating Overrides v1 to v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-migrating-v1-to-v2)\n\n[Overriding native components and props (v1)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-components-and-props-v1)\n\n[Section override - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/override-use-cases-overview)\n\n[Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section)\n\n[List of native sections and overridable components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections)\n\n[Experimental exports - Hooks and Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/developing-and-overriding-components-experimental-exports-hooks-and-components)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Section override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-overview)\n\n[Overriding native component's props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-component-props)\n\n[Overriding a native component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-native-component)\n\n[Overriding section styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-section-styles)\n\n[\\`getOverriddenSection\\` function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-getoverriddensection-function)\n\n[Syncing components with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms)\n\n[Migrating Overrides v1 to v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-migrating-v1-to-v2)\n\n[Overriding native components and props (v1)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-components-and-props-v1)\n\n[Section override - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/override-use-cases-overview)\n\n[Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section)\n\n[List of native sections and overridable components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections)\n\n[Experimental exports - Hooks and Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/developing-and-overriding-components-experimental-exports-hooks-and-components)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Section override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-overview)\n\nOverriding native component's props\n\nOverriding props allows you to customize a component's behavior while preserving its native integration. This approach is useful when you want to customize specific aspects of a native component, for example, an icon or a button label.\n\nFor this guide, we'll use the [Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button) component to make the customization.\n\nHere's how the initial component looks with the `size` prop set as `regular` in the Product Details Page (PDP):\n\n\n\n## Before you begin\n\nMake sure your `@faststore/core` package has the 3.x version or above. If you need to update it, refer to this [release note](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/releases/tag/v3.0.0).\n\n## Instructions\n\n### Step 1 - Setting up the component file\n\n1. After choosing a native section to be customized from the [list of available native sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections), open your FastStore project in any code editor of your preference.\n2. Create a new branch to work with the custom component you will create.\n3. Go to the `src` folder, create the `components` folder, and inside it, create the `sections` folder. You can run the following command to create them: \n> The naming of the `sections` folder is arbitrary, as overrides can be created in any file since the import is made in the `src/components/index.tsx` file. \nmacOS and Linux \nWindows \n`bash copy mkdir src/components src/components/sections `\n4. In the `sections` folder, create a new file for your customized section. For example, create a new file named `ProductDetailsWithCustomButton.tsx` under the `src/components/sections` directory. \nmacOS and Linux \nWindows \n`bash copy touch src/components/sections/ProductDetailsWithCustomButton.tsx `\n5. Copy and paste the following code snippet into the file: \nProductDetailsWithCustomButton.tsx \n`1 \nimport { ProductDetailsSection, getOverriddenSection } from '@faststore/core' \n2 \n \n3 \nconst ProductDetailsWithCustomButton = getOverriddenSection({ \n4 \nSection: ProductDetailsSection, \n5 \ncomponents: {}, \n6 \n}) \n7 \n \n8 \nexport default ProductDetailsWithCustomButton; \n` \n> Change the value of the `Section` variable to the section you wish to override. In the given example, we set the `Section` variable to the component `ProductDetailsSection` to override this specific section.\n6. Save your changes.\n\n### Step 2 - Setting up the override\n\n1. Open the `ProductDetailsWithCustomButton.tsx` file created in the [Step 1 - Setting up the component file](#step-1-setting-up-the-overrides-folder) and add the following code: \nProductDetailsWithCustomButton.tsx \n`1 \nimport { ProductDetailsSection, getOverriddenSection } from '@faststore/core' \n2 \n \n3 \nconst ProductDetailsWithCustomButton = getOverriddenSection({ \n4 \nSection: ProductDetailsSection, \n5 \ncomponents: { \n6 \n BuyButton: { props: { size: \"small\", iconPosition: \"right\" } } \n7 \n}, \n8 \n}); \n9 \n \n10 \nexport default ProductDetailsWithCustomButton; \n`\n2. In the `components` folder, create the `index.tsx` file and add the following. This code overrides the `BuyButton` props `size` and `iconPosition`. \nindex.tsx \n`1 \nimport ProductDetailsWithCustomButton from \"./sections/ProductDetailsWithCustomButton\"; \n2 \n \n3 \nconst sections = { \n4 \n \n5 \nProductDetails: ProductDetailsWithCustomButton \n6 \n}; \n7 \nexport default sections; \n`\n3. Open the terminal, and run `yarn dev` to sync the new custom component to your store preview.\n4. Open the localhost available after running `yarn dev`. You'll see a smaller button than the initial one, and the cart icon positioned on the right side.\n\n### Step 3 - Publishing your changes\n\nIf your changes are working locally and you want to publish them in production, follow the steps below:\n\n1. Publish your branch with the custom components files.\n2. Open a pull request in the store's GitHub repository.\n3. Review the pull request\n4. Merge the changes from this branch to the `main` one and the new component will be available in the live store.\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developing-and-overriding-components/overrides/component-props.mdx)\n\n[Section override« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-overview)[Overriding a native componentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-native-component)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-component-props%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-component-props%23instructions)\n\n[Step 1 - Setting up the component file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-component-props%23step-1-setting-up-the-component-file)[Step 2 - Setting up the override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-component-props%23step-2-setting-up-the-override)[Step 3 - Publishing your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-component-props%23step-3-publishing-your-changes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developing-and-overriding-components/overrides/component-props.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-component-props%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-component-props%23instructions)\n\n[Step 1 - Setting up the component file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-component-props%23step-1-setting-up-the-component-file)[Step 2 - Setting up the override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-component-props%23step-2-setting-up-the-override)[Step 3 - Publishing your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props/docs/guides/faststore/overrides-component-props%23step-3-publishing-your-changes)\n\nOn this page\n\n[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=)"
}
] |
doc_40d1dc29
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore getting started setting up the headless cms in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/troubleshooting)\n\n[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/getting-started-setting-up-the-headless-cms/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[Setting up the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms)\n\n[Structuring Content Types and Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-structuring-content-types-and-sections)\n\n[Promoting your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[Setting up the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms)\n\n[Structuring Content Types and Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-structuring-content-types-and-sections)\n\n[Promoting your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-overview)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\nSetting up the Headless CMS\n\nDefine your first Content Type and sync it with Headless CMS to make it available for editing in VTEX Admin.\n\nNow that [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview) is integrated with your FastStore project, you'll define your own **Content Types** and **Sections** so editors can create and manage pages in the VTEX Admin.\n\n## What you'll accomplish\n\nBy the end of this step, you will have:\n\n* Created the CMS folder structure in your project for content type definitions\n* Defined your first Content Type (Landing Page) with SEO settings\n* Synced your CMS definitions to the Headless CMS app\n* Verified that your Content Type appears in the Headless CMS interface\n\nThis establishes the foundation for content editing workflows. In the next step, you'll learn to structure more complex Content Types and Sections.\n\n## Before you begin\n\nThis guide assumes you are starting without existing CMS-related files. If your project already includes `content-types.json` or `sections.json`, create only what’s missing. See [Step 1: Creating the CMS folder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-2-setting-up-the-headless-cms%23step-1-creating-the-cms-folder).\n\n## Instructions\n\n### Step 1: Creating the CMS folder\n\n1. Open the terminal and change to the root directory of your FastStore project.\n2. Create a new folder named `cms` at the root of your FastStore project and a subfolder named `faststore` inside the `cms` folder. Run the following command to create them:\n\nmacOS and Linux\n\nWindows\n\n`1\n\nmkdir -p cms/faststore \n\n`\n\n1. Create the two files below inside the `faststore` folder by running the following command:\n\n> If your project already includes the CMS-related files: `content-types.json` or `sections.json`, create only the necessary files for your project's requirements.\n\nmacOS and Linux\n\nWindows\n\n`1\n\ntouch cms/faststore/content-types.json cms/faststore/sections.json \n\n`\n\n| File name | Description |\n| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| content-types.json | An array of JSON objects that describes the **Content Types** available for customization in the Headless CMS app. |\n| sections.json | An array of JSON objects that describes the content structure of the frontend **Section** components available for customization in the Headless CMS app. |\n\n1. Update the `sections.json` file with an empty array:\n\n`1\n\necho \"[]\" > cms/faststore/sections.json \n\n`\n\n1. Open the `content-types.json` file in any code editor of your choice and add the following code:\n\ncms/faststore/content-types.json\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"id\": \"landingPage\", \n\n4\n\n \"name\": \"Landing Page\", \n\n5\n\n \"configurationSchemaSets\": [ \n\n6\n\n { \n\n7\n\n \"name\": \"Settings\", \n\n8\n\n \"configurations\": [ \n\n9\n\n { \n\n10\n\n \"name\": \"seo\", \n\n11\n\n \"schema\": { \n\n12\n\n \"title\": \"SEO\", \n\n13\n\n \"description\": \"Search Engine Optimization options\", \n\n14\n\n \"type\": \"object\", \n\n15\n\n \"widget\": { \n\n16\n\n \"ui:ObjectFieldTemplate\": \"GoogleSeoPreview\" \n\n17\n\n }, \n\n18\n\n \"required\": [\"slug\", \"title\", \"description\"], \n\n19\n\n \"properties\": { \n\n20\n\n \"slug\": { \n\n21\n\n \"title\": \"Path\", \n\n22\n\n \"type\": \"string\", \n\n23\n\n \"default\": \"/\" \n\n24\n\n }, \n\n25\n\n \"title\": { \n\n26\n\n \"title\": \"Default page title\", \n\n27\n\n \"description\": \"Display this title when no other title is available\", \n\n28\n\n \"type\": \"string\", \n\n29\n\n \"default\": \"FastStore Starter\" \n\n30\n\n }, \n\n31\n\n \"description\": { \n\n32\n\n \"title\": \"Meta tag description\", \n\n33\n\n \"type\": \"string\", \n\n34\n\n \"default\": \"A beautifully designed store\" \n\n35\n\n }, \n\n36\n\n \"canonical\": { \n\n37\n\n \"title\": \"Canonical url for the page\", \n\n38\n\n \"type\": \"string\" \n\n39\n\n } \n\n40\n\n } \n\n41\n\n } \n\n42\n\n } \n\n43\n\n ] \n\n44\n\n } \n\n45\n\n ] \n\n46\n\n } \n\n47\n\n] \n\n`\n\n> Don't worry about the structure of this file for now, as we'll learn more about it later in this tutorial. However, notice that we have defined the **Custom Page** Content Type.\n\n1. Save your changes in the `content-types.json` file.\n2. Open the terminal and run `yarn dev` to enable the watch mode for the FastStore CLI. This command will monitor any changes in the project, including the new section you have created, and automatically merge it with the default sections available in [faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson).\n\n### Step 2: Syncing your changes\n\nLet's now sync the changes with the Headless CMS app and see what happens.\n\n1. Open another terminal and log in to your VTEX account.\n2. Create a new development workspace by running the following command. _Remember to replace the values between curly brackets according to your scenario_:\n\n`1\n\nvtex use {workspace} \n\n`\n\n> Use a development workspace to try your definitions of Sections and Content Types before syncing them with the VTEX `master` workspace.\n\n1. Change to the root directory of your FastStore project.\n2. Sync your changes in the `cms` folder with the Headless CMS app:\n\n`1\n\nyarn cms-sync \n\n`\n\n> If you have the `@vtex/cli-plugin-cms@1.0.7` installed, you can use the `{builderName}` argument to synchronize a specific builder: `vtex cms:sync {builderName}`.\n\nOnce your changes are synced with the Headless CMS, the terminal will show the following message:\n\n`1\n\nCMS synced successfully... \n\n`\n\n### Step 3: Checking your changes\n\n1. Access the VTEX Admin using the workspace you created in [Step 2 - Syncing your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-2-setting-up-the-headless-cms%23step-2-syncing-your-changes) by navigating to the following path: `https://{workspace}--{account}.myvtex.com/admin`. Make sure to replace `{workspace}` with the designated workspace name and `{account}` with your VTEX account.\n2. Go to **Storefront > Headless CMS**.\n3. Click on **Create New**.\n\n\n\nYou should now see the content type we created in the previous step available for use in the Headless CMS app. However, no Sections will be available yet. We'll learn more about this in the following part of this track, [Structuring Content Types and Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-3-adding-content-types-and-sections).\n\n## Next step\n\nNow that you've created your first Content Type, learn to structure more complex Content Types and Sections: [Structuring Content Types and Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-3-adding-content-types-and-sections)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/setting-up-the-headless-cms.mdx)\n\n[5\\. Integrating your project with the Headless CMS« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)[Structuring Content Types and SectionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-structuring-content-types-and-sections)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms%23what-youll-accomplish)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms%23instructions)\n\n[Step 1: Creating the CMS folder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms%23step-1-creating-the-cms-folder)[Step 2: Syncing your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms%23step-2-syncing-your-changes)[Step 3: Checking your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms%23step-3-checking-your-changes)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms%23next-step)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/setting-up-the-headless-cms.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms%23what-youll-accomplish)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms%23instructions)\n\n[Step 1: Creating the CMS folder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms%23step-1-creating-the-cms-folder)[Step 2: Syncing your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms%23step-2-syncing-your-changes)[Step 3: Checking your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms%23step-3-checking-your-changes)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-setting-up-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms%23next-step)\n\nOn this page\n\n[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=)"
}
] |
doc_7123ce76
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides changes in vtex features behavior to handle pii data in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/data-protection-plus)\n\n[PII Data Architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/pii-data-architecture-specifications)\n\n[Data residency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/data-residency)\n\n[Profile System integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/profile-system)\n\n[Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/working-with-schemas-in-the-profile-system)\n\n[Changes in VTEX features behavior to handle PII data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)\n\n[Limitations of the PII data architecture during closed beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/data-protection-plus)\n\n[PII Data Architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/pii-data-architecture-specifications)\n\n[Data residency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/data-residency)\n\n[Profile System integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/profile-system)\n\n[Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/working-with-schemas-in-the-profile-system)\n\n[Changes in VTEX features behavior to handle PII data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)\n\n[Limitations of the PII data architecture during closed beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides)\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/data-protection-plus)\n\n[Changes in VTEX features behavior to handle PII data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)\n\nChanges in VTEX features behavior to handle PII data\n\n> **Closed beta:** [Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-protection-plus) is in closed beta and is only available in select regions.\n\n> This feature is part of [VTEX Shield](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh), meaning _additional fees may apply._\n> \n> If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ).\n> \n> If you are not yet a customer but are interested in this solution, please complete our [contact form](https://read.calvincode.net/reader?url=https://vtex.com/us-en/contact/).\n\nThis document outlines the changes in the default behavior of certain VTEX features, which apply to stores using [Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-protection-plus).\n\nTo handle PII data, we provide alternative approaches that are necessary to ensure data privacy best practices. As a result, some commerce features of the VTEX platform require adaptations when implemented by the store.\n\nIn this guide, you can learn about the changes you must be aware of when managing your customers' information with the [Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system).\n\n### Promotions - Customer cluster\n\nTo set up promotions for specific customer clusters in a way that is compatible with the PII data architecture, you must use the `piiClusterExpressions` field instead of `clusterExpressions` in [Promotions and Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api%23post-/api/rnb/pvt/calculatorconfiguration).\n\n### Order Management\n\nThere are no restrictions to the use of these Order Management features for PII data architecture accounts:\n\n* Subscriptions\n* VTEX DO\n* Conversation tracker\n* Shipping notifications\n\nHowever, API requests to `/do`, `/conversationtracker`, `/subscriptions`, and `/shipping-tracker` paths must include the query parameter `reason` in order to retrieve unmasked PII information.\n\n#### Orders API: PII data architecture endpoints\n\nIn order to use Orders API, you should adapt your integrations to use new endpoints, for features you may already have implemented in your store, such as retrieving order information or notifying invoices. See the table below to know which endpoints need adaptation and where to find the new reference.\n\n| **Feature** | **Previous endpoint** | **New endpoint (PII data architecture)** | **Payload changed** |\n| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------- |\n| Get order | GET [/api/oms/orders/{orderId}](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders/-orderId-) | GET [/api/orders/pvt/document/{orderId}](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version%23get-/api/orders/pvt/document/-orderId-) | No |\n| List orders | GET [/api/oms/pvt/orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders) | POST [/api/orders/extendsearch/orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version%23post-/api/orders/extendsearch/orders) | Yes |\n| Start handling order | POST [api/oms/orders/{orderId}/start-handling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/start-handling) | POST [/api/orders/pvt/document/{orderId}/actions/start-handling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version%23post-/api/orders/pvt/document/-orderId-/actions/start-handling) | No |\n| Cancel order | POST [api/oms/pvt/orders/{orderId}/cancel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/cancel) | POST [/api/orders/pvt/document/{orderId}/cancel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version%23post-/api/orders/pvt/document/-orderId-/cancel) | No |\n| Order invoice notification | POST [api/oms/orders/{orderId}/invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/invoice) | POST [api/orders/pvt/document/{orderId}/invoices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version%23post-/api/orders/pvt/document/-orderId-/invoices) | Yes |\n| Send payment notification | POST [/api/oms/pvt/orders/{orderId}/payments/{paymentId}/payment-notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api/%23post-/api/oms/pvt/orders/-orderId-/payments/-paymentId-/payment-notification) | POST [/api/orders/pvt/document/{orderId}/payment/{paymentId}/notify-payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version%23post-/api/orders/pvt/document/-orderId-/payment/-paymentId-/notify-payment) | No |\n\n> To display the unmasked contact information (`contactInformation`) with the PII-compliant [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version%23get-/api/orders/pvt/document/-orderId-) endpoint, the `contactId` property must be provided. This property should be available in the Profile System via the [Address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-).\n> \n> More specifically, the `shippingAttachment` of the orderForm must contain the `contactId` that the address is related to. This is sent in the request for [Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/attachments/shippingData), where `address.contactId` must match the `contactInformation[0].id`.\n\n#### Orders Admin interface\n\nThe PII rules have also been applied to the [Orders List (Beta)](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/order-list-beta--2QTduKHAJMFIZ3BAsi6Pi) and [Order details](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/order-details-page-beta--2Y75n54Cc9VizrlG1N6ZNl) pages. The pages have been adjusted so that:\n\n* By default, the account will see all data masked.\n* Searches by name only work with the shopper's full name.\n* Searches by document only work with the shopper's full document ID.\n\nIt is possible to configure PII preferences on OMS' interface of your VTEX Admin, by following these instructions:\n\n1. Access the VTEX Admin, go to the **Orders** menu, then click **All Orders**.\n2. Click an order on the list.\n3. Under the Customer information card, click `PII Preferences`.\n4. Select one of the following options to configure how you will view customer's PII and be audited depending on your choice: a. **On all orders:** View personal information and be audited on all orders. b. **This order only:** View PII content and be audited on this order only. c. **Hide and do not audit:** Browse orders without displaying personal information.\n5. Click `Confirm`.\n\n#### Subscriptions\n\nThe subscription feature is compatible with the PII data architecture.\n\nHowever, the **Subscriptions** Admin interface displays only masked PII. If you wish to see unmasked PII, you must use the [Subscriptions v3 API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3) endpoints, while sending the `reason` query parameter. Learn more about [retrieving unmasked data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system%23masked-data).\n\n### Message Center\n\nWhen you edit an email template on the **Message Center** Admin interface, you can see information about the last email sent from that template, rendered as an email. Currently, all values on the JSON Data will be masked.\n\n### Master Data - CL, AD, BK entities\n\nIn the PII data architecture, [Master Data](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw) does not have CL, AD, BK entities. There will be a new isolated system to protect those information, [Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system).\n\nIf you are integrated to Master Data API to get any of this data (CL, AD, BK entities) you will need to integrate with the new [Profile System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system).\n\n### Checkout\n\nAlthough [Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) endpoints that retrieve order information use the same path, they may behave differently. Contracts are the same for masked data, but for complete data, you must include the query parameter: `reason`. Learn more about [retrieving unmasked data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system%23masked-data).\n\n### Payments\n\nIn order to be able to view transaction logs, store users must be assigned a role with the resource `View Payments Sensitive Data`, from the `PCI Gateway` product in the License Manager. Learn more about [License Manager resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) and how to [Create roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc%23creating-a-role).\n\n## Limitations\n\n### Master Data\n\nNote that **Master Data** features may be impacted in the following three aspects.\n\n#### Triggers\n\nAt the moment, triggers are not supported by the PII platform version Profile System.\n\n#### Orders Index\n\nThis is a legacy integration that was deprecated and it should not be used.\n\n#### CL\n\nCurrently, Master Data custom CL fields are not supported.\n\n### Pricing - Price tables\n\nThe [Price tables](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-price-tables--58YmY2Iwggyw4WeSCGg24S%23) feature is not supported at this moment.\n\n### Order Management\n\nVTEX’s Order Management System is impacted on a few different aspects. See details below.\n\n#### Call center\n\nYou must disable call center impersonation at the License Manager.\n\n#### Orders Admin interface\n\nThe PII rules have also been applied to the [Orders List (Beta)](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/order-list-beta--2QTduKHAJMFIZ3BAsi6Pi) and [Order details](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/order-details-page-beta--2Y75n54Cc9VizrlG1N6ZNl) pages. The pages have been adjusted so that:\n\n* By default, the account will see all data masked.\n* Searches by name only work with the shopper's full name.\n* Searches by document only work with the shopper's full document ID.\n\nIt is possible to configure PII preferences on OMS' interface of your VTEX Admin, by following these instructions:\n\n1. In your VTEX Admin, in the **Orders** menu, then **All Orders**.\n2. Click an order on the list.\n3. Under the Customer information card, click `PII Preferences`.\n4. Select one of the following options to configure how you will view customer's PII and be audited depending on your choice: a. **On all orders:** View personal information and be audited on all orders. b. **This order only:** View PII content and be audited on this order only. c. **Hide and do not audit:** Browse orders without displaying personal information.\n5. Click `Confirm`.\n\n#### Subscriptions\n\nThe subscription feature is compatible with the PII data architecture.\n\nHowever, the **Subscriptions** Admin interface displays only masked PII. If you wish to see unmasked PII, you must use the [Subscriptions v3 API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3) endpoints, while sending the `reason` query parameter. Learn more about [retrieving unmasked data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system%23masked-data).\n\n### Message Center\n\nWhen you edit an email template on the **Message Center** Admin interface, you can see information about the last email sent from that template, rendered as an email. Currently, all values on the JSON Data will be masked.\n\n### Gift card\n\nThe [gift card](https://read.calvincode.net/reader?url=https://help.vtex.com/en/subcategory/gift-card--3qWeS7abxCyC0G0GMq42gA%23) feature is not supported for PII platform version accounts yet.\n\n### Customer Credit\n\nCurrently, the [Customer Credit](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0) feature is not supported.\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/data-privacy/changes-in-vtex-features-behavior-to-handle-pii-data.md)\n\n[Working with schemas in the Profile System« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data//docs/guides/working-with-schemas-in-the-profile-system)[Limitations of the PII data architecture during closed betaNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data//docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)\n\nSee also\n\n[Data Protection PlusGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/data-protection-plus)[Data residencyGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/data-residency)[Profile System integrationGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/profile-system)[PII Data Architecture specificationsGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/pii-data-architecture-specifications)[Limitations of the PII data architecture during closed betaGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Limitations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data%23limitations)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data%23master-data)[Pricing - Price tables](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data%23pricing-price-tables)[Order Management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data%23order-management)[Message Center](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data%23message-center)[Gift card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data%23gift-card)[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data%23customer-credit)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/data-privacy/changes-in-vtex-features-behavior-to-handle-pii-data.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Limitations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data%23limitations)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data%23master-data)[Pricing - Price tables](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data%23pricing-price-tables)[Order Management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data%23order-management)[Message Center](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data%23message-center)[Gift card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data%23gift-card)[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data%23customer-credit)\n\nOn this page\n\n[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=)"
}
] |
doc_47a01ad9
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides integrating an app with a graphql api in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/graphql-in-vtex-io)\n\n[List of GraphQL APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-graphql-api-list)\n\n[Developing a GraphQL API in service apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/developing-a-graphql-api-in-service-apps)\n\n[GraphQL authorization in IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/graphql-authorization-in-io-apps)\n\n[Integrating an app with a GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api)\n\n[Implementing cache in GraphQL APIs for IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/implementing-cache-in-graphql-apis-for-io-apps)\n\n[Admin GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/graphql-ide)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/graphql-in-vtex-io)\n\n[List of GraphQL APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-graphql-api-list)\n\n[Developing a GraphQL API in service apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/developing-a-graphql-api-in-service-apps)\n\n[GraphQL authorization in IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/graphql-authorization-in-io-apps)\n\n[Integrating an app with a GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api)\n\n[Implementing cache in GraphQL APIs for IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/implementing-cache-in-graphql-apis-for-io-apps)\n\n[Admin GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/graphql-ide)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/app-development)\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/graphql-in-vtex-io)\n\n[Integrating an app with a GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api)\n\nIntegrating an app with a GraphQL API\n\nLearn how to query GraphQL APIs from an app.\n\nWhen developing a VTEX IO app, you may need to interact with other apps that expose GraphQL APIs, such as retrieving data or triggering actions. To do this, you must [implement a custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-how-to-create-and-use-clients) that handles authenticated requests to the target app.\n\nOnce registered with the VTEX IO clients pattern (`IOClients`), the client becomes available throughout your app. You can then call it directly from resolvers or middleware functions to integrate external GraphQL capabilities into your [service app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service).\n\n## Before you begin\n\nEnsure you meet the technical requirements to follow this guide:\n\n* [VTEX IO CLI is installed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install) on your computer.\n* Access to a VTEX store with a [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace) and the Admin environment.\n* Familiarity with GraphQL concepts, such as [queries](https://read.calvincode.net/reader?url=https://graphql.org/learn/queries/), [schema](https://read.calvincode.net/reader?url=https://graphql.org/learn/schema/), and [resolvers](https://read.calvincode.net/reader?url=https://graphql.org/learn/execution/).\n* Experience developing in the [TypeScript](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/) language.\n\n## Implementation\n\n### 1\\. Starting with a template\n\nWe recommend cloning a VTEX IO app template to your computer if you are developing an app from scratch. In this tutorial, we will use the [service-example](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/service-example) template. Clone the repository using the following command in a terminal:\n\n`1\n\ngit clone https://github.com/vtex-apps/service-example \n\n`\n\n### 2\\. Implementing your custom client\n\nVTEX IO provides `AppGraphQLClient` as a base class for making GraphQL requests between apps. Your custom client should extend this class, specifying the target app, which exposes the GraphQL API, in the `super` constructor. In this class, you must also define the methods you want to use in your middleware functions or resolvers.\n\nIn the following example, we define a client that uses the [Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages)'s `translate` query for string translations.\n\nnode/clients/translation-graphql.ts\n\n`` 1\n\nimport { AppGraphQLClient, InstanceOptions, IOContext } from '@vtex/api' \n\n2\n\n \n3\n\ninterface TranslatePayload { \n\n4\n\n indexedByFrom: { from: string; messages: object[] }[]; \n\n5\n\n to: string; \n\n6\n\n} \n\n7\n\n \n8\n\nexport default class TranslationGraphQL extends AppGraphQLClient { \n\n9\n\n constructor(ctx: IOContext, options?: InstanceOptions) { \n\n10\n\n super('vtex.messages@1', ctx, options) \n\n11\n\n } \n\n12\n\n \n13\n\n public translate = (args: TranslatePayload) => { \n\n14\n\n return this.graphql.query({ \n\n15\n\n query: `query GetTranslation($args: TranslateArgs!) { \n\n16\n\n translate(args: $args) \n\n17\n\n }`, \n\n18\n\n variables: { args }, \n\n19\n\n }) \n\n20\n\n } \n\n21\n\n} \n\n ``\n\nSome details about this implementation:\n\n1. **Target app:** In the client's constructor, define the app you want to query using the format `{vendor}.{app-name}@{version}`. In this example, we use `vtex.messages@1`, specifying only the app's major version. You can also specify the exact version with minor and patch values (for example, `vtex.messages@1.0.0`). In this constructor, you can include other options in the `options` parameter, such as [authentication tokens in the headers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens) for [authenticated queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps).\n2. **Client functions:** Create functions for each query and mutation you need. This example shows a simplified implementation to call the `translate` query. To make the query, use the function `this.graphql.query` with the following arguments: \n * `query`: Insert the query here in a [template string](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template%5Fliterals) format, surrounded by backticks (`` ` ``), which allows multi-line separation and usage of variables. In this example, we declare the [GraphQL object](https://read.calvincode.net/reader?url=https://graphql.org/learn/schema/%23object-types-and-fields) `GetTranslation` and use the `$args` variable as [input](https://read.calvincode.net/reader?url=https://graphql.org/learn/schema/%23input-object-types). Notice that query variables start with the `$` symbol. You must use the same names for the queries and variables as in the schema definition. Here we use the `translate` query and the `TranslateArgs!` type for the variable `$args`. You can find the type names in the app documentation (for example, [Messages GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api)), using an [Introspection Query](https://read.calvincode.net/reader?url=https://graphql.org/learn/introspection/), or, if you have access, in the app's source code. \n * `variables`: Insert the query variables here as an object, where the property keys are the variable names in the query. In this example, `variables.args` is used as the variable `$args` in the query.\n\n> If you want to use mutations, use the function `this.graphql.mutate` and insert the template string as the `mutate` argument's value.\n\n### 3\\. Registering the client\n\nAfter you implement the client, register it in your app's list of clients. This step makes the client available in the context of your app's resolvers. To do this, open the `node/clients/index.ts` file, import your client, and add it to the `Clients` class, as shown in the following example:\n\nnode/clients/index.ts\n\n`1\n\nimport { IOClients } from '@vtex/api' \n\n2\n\n \n3\n\nimport TranslationGraphQL from './translation-graphql' \n\n4\n\n \n5\n\nexport class Clients extends IOClients { \n\n6\n\n public get translationGraphQL() { \n\n7\n\n return this.getOrSet('translationGraphQL', TranslationGraphQL) \n\n8\n\n } \n\n9\n\n} \n\n`\n\n### 4\\. Using the client\n\nYou can now use your custom client to request the target app from your app's handler functions by accessing it via context (`ctx.clients`).\n\nIn this example, we implement a REST API to access the translation query from the Messages app.\n\nnode/middlewares/translateMessages.ts\n\n`1\n\nimport { json } from 'co-body' \n\n2\n\n \n3\n\nexport async function translateMessages(ctx: Context, next: () => Promise<any>) { \n\n4\n\n const { \n\n5\n\n clients: { translationGraphQL } \n\n6\n\n } = ctx \n\n7\n\n \n8\n\n const requestBody = await json(ctx.req) \n\n9\n\n const { from, messages, to } = requestBody \n\n10\n\n \n11\n\n if (!from || !messages || !to) { \n\n12\n\n ctx.status = 400 \n\n13\n\n ctx.body = { error: 'Missing required fields: from, messages, to' } \n\n14\n\n return \n\n15\n\n } \n\n16\n\n \n17\n\n const translateArgs = { \n\n18\n\n indexedByFrom: [{ from, messages }], \n\n19\n\n to, \n\n20\n\n } \n\n21\n\n \n22\n\n const response = await translationGraphQL.translate(translateArgs) \n\n23\n\n ctx.status = 200 \n\n24\n\n ctx.body = response \n\n25\n\n \n26\n\n await next() \n\n27\n\n} \n\n`\n\n### 5\\. Defining the service route\n\nWe need to define a route, as we are implementing a REST API to access the middleware. Go to the `node/service.json` file, define a public route with the name of the middleware function, and set the path using the format `\"/_v/{app-name}/{middleware-name}\"`. For this implementation, we use:\n\nnode/service.json\n\n`1\n\n{ \n\n2\n\n ... \n\n3\n\n \"routes\": { \n\n4\n\n \"translateMessages\": { \n\n5\n\n \"path\": \"/_v/graphql-integration/translateMessages\", \n\n6\n\n \"public\": true \n\n7\n\n } \n\n8\n\n } \n\n9\n\n} \n\n`\n\n### 6\\. Relating a route to a middleware\n\nUpdate the `node/index.ts` file to relate a route to a middleware. The routes section associates the `translateMessages` route with the `translateMessages` middleware function. The `POST` method is mapped to the `translateMessages` function. We use the `POST` method as we will send the content to be translated in the request body.\n\nTherefore, when a `POST` request is made to the previously defined `translateMessages` route, it triggers the `translateMessages` function, which, in turn, executes the `TranslationGraphQL` client's `translate` method.\n\nnode/index.ts\n\n`1\n\nimport { translateMessages } from './middlewares/translateMessages' \n\n2\n\n \n3\n\nexport default new Service({ \n\n4\n\n clients, \n\n5\n\n routes: { \n\n6\n\n translateMessages: method({ \n\n7\n\n POST: translateMessages, \n\n8\n\n }) \n\n9\n\n }, \n\n10\n\n}) \n\n`\n\n### 7\\. Add the policies\n\nFor your app to have permission to access any external resource, you must declare the related [policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies) in your app's `manifest.json` file. In the case of a GraphQL API from another app, this is a role-based policy, so you must add the app name and policy name. You can find the policy name and description in the `policies.json` file from the app's source code.\n\nHere is the role-based policy from the Messages app for its GraphQL API:\n\nvtex.messages/policies.json\n\n`1\n\n[ \n\n2\n\n ... \n\n3\n\n { \n\n4\n\n \"name\": \"graphql-translate-messages\", \n\n5\n\n \"description\": \"Allows access the translation API\", \n\n6\n\n \"statements\": [ \n\n7\n\n { \n\n8\n\n \"actions\": [\"get\", \"post\"], \n\n9\n\n \"effect\": \"allow\", \n\n10\n\n \"resources\": [ \n\n11\n\n \"vrn:vtex.messages:{{region}}:{{account}}:{{workspace}}:/_v/graphql\" \n\n12\n\n ] \n\n13\n\n } \n\n14\n\n ] \n\n15\n\n }, \n\n16\n\n ... \n\n17\n\n] \n\n`\n\nAdd the policy to your app using the format `\"name\": \"{vendor}.{app-name}:{policy-name}\"`. For the Messages app example, we use:\n\nmanifest.json\n\n`1\n\n\"policies\": [ \n\n2\n\n { \n\n3\n\n \"name\": \"vtex.messages:graphql-translate-messages\" \n\n4\n\n } \n\n5\n\n] \n\n`\n\n### 8\\. Link your app\n\nTo test your app, [link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) it to the VTEX platform to enable it to run and accept requests.\n\nOpen a terminal and switch to a [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace). Then, use the `vtex link` command.\n\n### 9\\. Test your integration\n\nWith your app running, you can test the implemented integration. In our example, we implement a REST API in a service app linked to a middleware function. Therefore, we will call the endpoint that executes this function, which invokes the translation query.\n\nHere is a cURL example to call the translation endpoint:\n\n`1\n\ncurl --request post \\ \n\n2\n\n --url 'https://{{workspace}}--{{accountname}}.myvtex.com/_v/graphql-integration/translateMessages' \\ \n\n3\n\n --header 'Accept: application/json' \\ \n\n4\n\n --header 'Content-Type: application/json' \\ \n\n5\n\n --header 'VtexIdclientAutCookie: {{vtex-cookie}}' \\ \n\n6\n\n --data '{\"from\": \"en-US\", \"messages\": [{\"content\": \"shoe\"}, {\"content\": \"ball\"}], \"to\": \"pt-BR\"}' \n\n`\n\nAnd we get the following response:\n\n`1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"translate\": [ \n\n4\n\n \"sapato\", \n\n5\n\n \"bola\" \n\n6\n\n ] \n\n7\n\n } \n\n8\n\n} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/GraphQL/integrating-an-app-with-a-graphql-api.mdx)\n\n[GraphQL authorization in IO apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api//docs/guides/graphql-authorization-in-io-apps)[Implementing cache in GraphQL APIs for IO appsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api//docs/guides/implementing-cache-in-graphql-apis-for-io-apps)\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%23before-you-begin)\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%23implementation)\n\n[1\\. Starting with a template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%231-starting-with-a-template)[2\\. Implementing your custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%232-implementing-your-custom-client)[3\\. Registering the client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%233-registering-the-client)[4\\. Using the client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%234-using-the-client)[5\\. Defining the service route](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%235-defining-the-service-route)[6\\. Relating a route to a middleware](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%236-relating-a-route-to-a-middleware)[7\\. Add the policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%237-add-the-policies)[8\\. Link your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%238-link-your-app)[9\\. Test your integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%239-test-your-integration)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/GraphQL/integrating-an-app-with-a-graphql-api.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%23before-you-begin)\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%23implementation)\n\n[1\\. Starting with a template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%231-starting-with-a-template)[2\\. Implementing your custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%232-implementing-your-custom-client)[3\\. Registering the client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%233-registering-the-client)[4\\. Using the client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%234-using-the-client)[5\\. Defining the service route](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%235-defining-the-service-route)[6\\. Relating a route to a middleware](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%236-relating-a-route-to-a-middleware)[7\\. Add the policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%237-add-the-policies)[8\\. Link your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%238-link-your-app)[9\\. Test your integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-an-app-with-a-graphql-api/docs/guides/integrating-an-app-with-a-graphql-api%239-test-your-integration)\n\nOn this page\n\n[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=)"
}
] |
doc_1786dd42
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore getting started 2 setting up the project in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/troubleshooting)\n\n[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/getting-started-2-setting-up-the-project/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-overview)\n\n3\\. Running the project locally\n\nRun your FastStore project in a local development environment to preview changes in real time.\n\nIn this step, you'll set up your local development environment, allowing you to iterate quickly and safely before shipping changes. Running the project locally gives you hot reload, faster feedback, and a stable foundation for customization.\n\n## What you'll accomplish\n\nBy the end of this step, you will have:\n\n* Run your project locally (<http://localhost:3000/>)\n* Made your first customization by applying a new theme to your storefront\n\n## Before you begin\n\n### Required tooling\n\nBefore cloning your store’s repository, make sure the following tools are installed on your machine:\n\nNode.js\n\nTo run your FastStore project, install the latest Node.js or a version higher than `15.0.0`.\n\n* [Install Node.js](https://read.calvincode.net/reader?url=https://nodejs.org/en/download)\nYarn\n\nUse the [Yarn](https://read.calvincode.net/reader?url=https://yarnpkg.com/) CLI to manage dependencies and run tasks, such as starting the development server.\n\nInstall Yarn on macOS by running the following:\n\n`1\n\nbrew install yarn \n\n`\n\nInstall Yarn on Windows by running the following:\n\n`1\n\nnpm install -g yarn \n\n`\n\nGit\n\nWhen developing your store's website, you will use [Git](https://read.calvincode.net/reader?url=https://git-scm.com/) to push your code to the cloud. You will also use Git to download and install the required files for your project.\n\n* [Install Git on macOS using Homebrew](https://read.calvincode.net/reader?url=https://git-scm.com/download/mac)\n* [Install Git on Windows](https://read.calvincode.net/reader?url=https://git-scm.com/download/win)\n* [Install Git on Linux](https://read.calvincode.net/reader?url=https://git-scm.com/download/linux)\nVisual Studio Code - Code Editor\n\nWhen developing your store's website, you will need a code editor to write the code for your project, such as [Visual Studio Code](https://read.calvincode.net/reader?url=https://code.visualstudio.com/) (also known as VS Code). Visit the [VS Code](https://read.calvincode.net/reader?url=https://code.visualstudio.com/) website, download, and install the version compatible with your operating system.\n\n> Although you might opt to use an alternative code editor, note that [Visual Studio Code](https://read.calvincode.net/reader?url=https://code.visualstudio.com/) might help you follow along with the FastStore documentation since our documentation may include screenshots from VS Code.\n\n### Enabling Developer Mode (Windows users)\n\nWe strongly recommend enabling Developer Mode when using the terminal for FastStore projects. Since FastStore projects rely on creating symlinks, this mode grants the necessary permissions and privileges, reducing the chance of errors during development. To activate Developer Mode, refer to Microsoft's official guide on [Enabling your device for development](https://read.calvincode.net/reader?url=https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development%23accessing-settings-for-developers).\n\n> Running the FastStore project as an Administrator is not recommended.\n\n## Step 1: Cloning the store's repository\n\n1. Open the terminal and navigate to the directory where you want to store your project. \n> For Windows users, we highly recommend enabling the [Developer Mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project%23enabling-developer-mode-windows-users) to run the terminal.\n2. Clone the repository created during the [FastStore Onboarding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project%23step-2-deploying-the-project) by running the following command in the terminal: \n`1 \ngit clone https://github.com/{orgName}/{storeName} \n` \n> Replace `{orgName}` with the GitHub organization where your store's repository is located, and `{storeName}` with the name of your store's repository.\n3. Change into the working directory by running the following command: \n`1 \ncd {storeName} \n`\n4. Install all the dependencies listed in the `package.json` file by running the following command: \n`1 \nyarn install \n`\n5. Open your FastStore project in any code editor of your choice.\n\n> Note that your store configuration was already set during the [FastStore Onboarding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project). Therefore, there is no need to connect your project to your VTEX account.\n\nIf you want to review these configurations, you can access the [discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options) file in the root directory of your project's repository.\n\n## Step 2: Running a local server\n\nLet's check what the project looks like in a web browser so far.\n\n1. Start a local development server to serve your website: \n`1 \n yarn dev \n` \nThis may take a few minutes. Once your development server is ready, the command line will output a similar message as the following: \n`1 \n ready - started server on 0.0.0.0:3000, url: http://localhost:3000 \n2 \n event - compiled client and server successfully in 333 ms (951 modules) \n` \n> The `dev` command is part of the [FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli), a pre-configured command line interface in your starter project. Using the CLI, this command enables you to execute code to keep your store's project up-to-date with the [@faststore/core package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson).\n2. Now, open your browser and go to <http://localhost:3000>. \n\n\nWhile the development server is running, changes you save are hot-reloaded in the browser. To stop the server, press `Ctrl + C` in the terminal. To restart it, run `yarn dev` again.\n\n## Step 3: Making the first change in your store frontend\n\nNow that your store is up and running locally, let's make a simple change in the storefront.\n\nWe will start updating the store's [theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview%23available-themes). For this customization, we will use the [Soft Blue theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue).\n\n1. Create a new file named `soft-blue.scss` in `src/themes`. This will be the new theme of your store.\n2. Add the following styles to `src/themes/soft-blue.scss`: \nsrc/themes/soft-blue.scss \n`1 \n// ---------------------------------------------------------- \n2 \n// GLOBAL TOKENS \n3 \n// Theme Soft Blue \n4 \n// ---------------------------------------------------------- \n5 \n \n6 \n@layer theme { \n7 \n .theme { \n8 \n // -------------------------------------------------------- \n9 \n // Colors (Branding Core) \n10 \n // -------------------------------------------------------- \n11 \n \n12 \n // PALETTE \n13 \n --fs-color-main-0: #ecf0ff; \n14 \n --fs-color-main-1: #d8e2ff; \n15 \n --fs-color-main-2: #00419e; \n16 \n --fs-color-main-3: #002c71; \n17 \n --fs-color-main-4: #001947; \n18 \n \n19 \n --fs-color-accent-0: #ebdcff; \n20 \n --fs-color-accent-1: #8d50fd; \n21 \n --fs-color-accent-2: #732fe2; \n22 \n --fs-color-accent-3: #5900c8; \n23 \n --fs-color-accent-4: #4700a0; \n24 \n \n25 \n // HIERARCHY \n26 \n --fs-color-primary-bkg: var(--fs-color-main-4); \n27 \n --fs-color-primary-bkg-active: var(--fs-color-main-2); \n28 \n --fs-color-primary-bkg-light: var(--fs-color-main-0); \n29 \n --fs-color-primary-bkg-light-active: var(--fs-color-main-1); \n30 \n \n31 \n // SITUATIONS \n32 \n --fs-color-success-bkg: #cee8de; \n33 \n --fs-color-warning-bkg: #f6e0ba; \n34 \n \n35 \n // COMPONENTS & STATES \n36 \n --fs-color-text-display: var(--fs-color-main-4); \n37 \n \n38 \n --fs-color-action-bkg: var(--fs-color-accent-3); \n39 \n --fs-color-action-bkg-hover: var(--fs-color-accent-2); \n40 \n --fs-color-action-bkg-active: var(--fs-color-accent-1); \n41 \n \n42 \n // -------------------------------------------------------- \n43 \n // Typography (Branding Core) \n44 \n // -------------------------------------------------------- \n45 \n \n46 \n // FACE \n47 \n --fs-text-face-body: 'Lato', -apple-system, system-ui, BlinkMacSystemFont, sans-serif; \n48 \n \n49 \n // -------------------------------------------------------- \n50 \n // Refinements \n51 \n // -------------------------------------------------------- \n52 \n \n53 \n // BORDERS \n54 \n --fs-border-radius: 0.25rem; \n55 \n \n56 \n // SHADOW \n57 \n --fs-shadow: none; \n58 \n --fs-shadow-darker: 0 0 10px rgb(0 0 0 / 20%); \n59 \n --fs-shadow-hover: 0 1px 4px rgb(0 0 0 / 10%), 0 6px 8px rgb(0 0 0 / 10%); \n60 \n \n61 \n // -------------------------------------------------------- \n62 \n // FS UI Components \n63 \n // -------------------------------------------------------- \n64 \n // Add here the customizations for FastStore UI components. \n65 \n \n66 \n --fs-logo-width: 8rem; \n67 \n \n68 \n [data-fs-product-card] { \n69 \n --fs-product-card-border-color: transparent; \n70 \n --fs-product-card-border-color-hover: var(--fs-border-color-light); \n71 \n \n72 \n &[data-fs-product-card-bordered='true'] { \n73 \n --fs-product-card-border-color: var(--fs-border-color-light); \n74 \n } \n75 \n } \n76 \n } \n77 \n} \n`\n3. Open the `discovery.config.js` file and change the `theme` from `custom-theme` to `soft-blue`. \ndiscovery.config.js \n`1 \n theme: 'soft-blue', \n`\n4. Restart the server and check in the browser the new theme applied to your store. You may need to refresh the page. \n \n> It is important to highlight that the store's logo is set through the [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview).\n\n## Next step\n\nNow that your local environment is running, learn about your project's structure to understand where to make customizations: [4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-project-structure)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/3-running-the-project-locally.mdx)\n\n[2\\. Starting a new FastStore project« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-2-starting-the-project)[4\\. Understanding the project structureNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally%23what-youll-accomplish)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally%23before-you-begin)\n\n[Required tooling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally%23required-tooling)[Enabling Developer Mode (Windows users)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally%23enabling-developer-mode-windows-users)\n\n[Step 1: Cloning the store's repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-1-cloning-the-stores-repository)\n\n[Step 2: Running a local server](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-2-running-a-local-server)\n\n[Step 3: Making the first change in your store frontend](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-3-making-the-first-change-in-your-store-frontend)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally%23next-step)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/3-running-the-project-locally.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally%23what-youll-accomplish)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally%23before-you-begin)\n\n[Required tooling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally%23required-tooling)[Enabling Developer Mode (Windows users)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally%23enabling-developer-mode-windows-users)\n\n[Step 1: Cloning the store's repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-1-cloning-the-stores-repository)\n\n[Step 2: Running a local server](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-2-running-a-local-server)\n\n[Step 3: Making the first change in your store frontend](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-3-making-the-first-change-in-your-store-frontend)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally%23next-step)\n\nOn this page\n\n[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=)"
}
] |
doc_1d21ccef
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides configure the global checkout in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/features)\n\n[Enable the Manual Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/enable-the-manual-price)\n\n[Enable the Save user data opt-in](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/enable-the-save-user-data-opt-in)\n\n[Enable the Region for SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/enable-the-region-for-skus)\n\n[Configure the Global Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/configure-the-global-checkout)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/features)\n\n[Enable the Manual Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/enable-the-manual-price)\n\n[Enable the Save user data opt-in](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/enable-the-save-user-data-opt-in)\n\n[Enable the Region for SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/enable-the-region-for-skus)\n\n[Configure the Global Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/configure-the-global-checkout)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/checkout-api-overview)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/features)\n\n[Configure the Global Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/configure-the-global-checkout)\n\nConfigure the Global Checkout\n\nGlobal Checkout is a setting in your store that allows you to sell to many different countries regardless of the country of origin of your VTEX account.\n\nFor a complete Global Checkout experience, it is also important that your store be displayed in other languages. For more information about these settings, visit the article about [displaying store in another language](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/displaying-the-store-in-another-language).\n\n## New document and phone fields\n\nTo display document and phone typing options different from those used by the store country, follow the steps below:\n\n1. On the Admin menu, access **Checkout**.\n2. Click on the `blue gear` on the website you want to edit.\n3. Select the **Code** tab.\n4. On **Files**, click on `checkout6-custom.css`.\n5. Add the code below.\n\n`1\n\n/*Displays the option to enter a foreign document*/ \n\n2\n\n.document-box { display: block; } \n\n3\n\n \n4\n\n/*Displays the option to enter an international phone*/ \n\n5\n\n.phone-box { display: block; } \n\n`\n\n1. Click on `Save`. \n\n\nAfter saving this configuration, two new buttons will be shown in your Checkout:\n\n* \"I don't have CPF.\"\n* \"I don't have a Brazilian phone.\"\n\n## New delivery and invoice addresses\n\n### Deliveries\n\nTo allow deliveries to a new country (for example, you want to deliver products to a customer located in England), the following actions must be performed:\n\n1. [Create a new carrier](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/registering-a-carrier/).\n2. For the new carrier, create a shipping worksheet with the column “Country”.\n\n> The value of the column “Country” must be the 3-digit ISO code of the countries (e.g., for England, you will use the “GBR” value). To check the codes, we recommend the website `https://countrycode.org/`.\n\nAfter defining the delivery settings for the countries intended, a new field will be shown on your checkout's delivery form, allowing the user to choose the desired international delivery option.\n\n### Invoices\n\nBy unchecking the **My invoice address is the same as the delivery** box on the Checkout page, the user can enter a new invoice address among the available countries for delivery. However, nothing prevents this user from having an international credit card from other countries not available in your store.\n\nTo allow billing for a credit card whose invoice address is in another country, you must make on your store page a country select field appear on **Invoice Address**.\n\nAlso, if you want the option to display all countries in the Invoice Address field, you must enable it in your store layout (CSS) using the code below:\n\n`1\n\n/*Show all countries*/ \n\n2\n\n.CountrySelector--all-countries { display: block; } \n\n3\n\n \n4\n\n/*Hide delivery countries*/ \n\n5\n\n.CountrySelector { display: none; } \n\n`\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/features/configure-the-global-checkout.md)\n\n[Enable the Region for SKUs« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout//docs/guides/enable-the-region-for-skus)[Order PlacementNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout//docs/guides/orders-2)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[New document and phone fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/configure-the-global-checkout%23new-document-and-phone-fields)\n\n[New delivery and invoice addresses](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/configure-the-global-checkout%23new-delivery-and-invoice-addresses)\n\n[Deliveries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/configure-the-global-checkout%23deliveries)[Invoices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/configure-the-global-checkout%23invoices)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/features/configure-the-global-checkout.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[New document and phone fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/configure-the-global-checkout%23new-document-and-phone-fields)\n\n[New delivery and invoice addresses](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/configure-the-global-checkout%23new-delivery-and-invoice-addresses)\n\n[Deliveries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/configure-the-global-checkout%23deliveries)[Invoices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-global-checkout/docs/guides/configure-the-global-checkout%23invoices)\n\nOn this page\n\n[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=)"
}
] |
doc_f5c22c28
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides layout apps in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.tab-layout)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.tab-layout)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/vtex-io-apps)\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps/docs/guides/guides/layout-apps)\n\nLayout Apps\n\nCheck our layout components for creating seamless and responsive store designs.\n\n[Condition LayoutAllows rendering a block under pre-defined conditions.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout)[Flex LayoutBuilds a complex custom layout using the rows and columns concept, setting the desired structure and positioning blocks on a page.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout)[Disclosure LayoutBuilds an accordion or any component that controls the visibility of a content section.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.disclosure-layout)[Modal LayoutProvides blocks that help you create modals in your store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout)[Overlay LayoutHelps you create a dropdown, select, or tooltip component.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout)[Responsive LayoutDeclares layout structures that will only be rendered in a specific screen-size breakpoint.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout)[Slider LayoutFlexible solution for building block sliders within your store theme.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout)[Stack LayoutRenders blocks on top of other blocks.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.stack-layout)[Sticky LayoutProvides layout structures to help build elements that should have a fixed position.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sticky-layout)[Tab LayoutBuilds custom tabbed layouts. In other words, it allows you to build the store layout using tabs.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/layout-apps.md)\n\n[Affiliates Program« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps//docs/guides/affiliates-program-app)[Condition LayoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps//docs/apps/vtex.condition-layout)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/layout-apps.md)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[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=)"
}
] |
doc_b7f2ac22
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore schema objects in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/troubleshooting)\n\n[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/schema-objects/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/faststore-api-overview)\n\n[Queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-queries)\n\n[Mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-mutations)\n\n[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects)\n\n[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-inputs)\n\n[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-enums)\n\n[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-scalars)\n\n[Configuring GraphQL cache control for GET requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/faststore-api-configuring-graphql-cache-control)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/faststore-api-overview)\n\n[Queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-queries)\n\n[Mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-mutations)\n\n[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects)\n\n[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-inputs)\n\n[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-enums)\n\n[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-scalars)\n\n[Configuring GraphQL cache control for GET requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/faststore-api-configuring-graphql-cache-control)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/faststore-api-overview)\n\nObjects\n\n## Objects\n\n### Address\n\nAddress information.\n\n| Field | Argument | Type | Description |\n| ------------------ | ----------------------------------------------------------------------------------- | ----------------------- | ----------- |\n| **postalCode** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Address postal code. | |\n| **city** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Address city. | |\n| **state** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Address state. | |\n| **country** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Address country. | |\n| **street** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Address street. | |\n| **number** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Address number. | |\n| **neighborhood** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Address neighborhood. | |\n| **complement** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Address complement. | |\n| **reference** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Address reference. | |\n| **geoCoordinates** | \\[[Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)\\] | Address geoCoordinates. | |\n\n### AvailableDeliveryWindows\n\n| Field | Argument | Type | Description |\n| ---------------- | --------------------------------------------------------------------------------- | -------------------------------------------- | ----------- |\n| **startDateUtc** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Available delivery window start date in UTC. | |\n| **endDateUtc** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Available delivery window end date in UTC. | |\n| **price** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int) | Available delivery window price. | |\n| **listPrice** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int) | Available delivery window list price. | |\n| **tax** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int) | Available delivery window tax. | |\n\n### DeliveryIds\n\n| Field | Argument | Type | Description |\n| --------------- | --------------------------------------------------------------------------------- | ------------------------- | ----------- |\n| **courierId** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | DeliveryIds courier id. | |\n| **warehouseId** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | DeliveryIds warehouse id. | |\n| **dockId** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | DeliveryIds dock id. | |\n| **courierName** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | DeliveryIds courier name. | |\n| **quantity** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int) | DeliveryIds quantity. | |\n\n### LogisticsInfo\n\n| Field | Argument | Type | Description |\n| --------------- | ----------------------------------------------------------------------------------------------- | ---------------------------------- | ----------- |\n| **itemIndex** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | LogisticsInfo itemIndex. | |\n| **selectedSla** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | LogisticsInfo selectedSla. | |\n| **slas** | \\[[ShippingSLA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23shippingsla)\\] | List of LogisticsInfo ShippingSLA. | |\n\n### LogisticsItem\n\nShipping Simulation Logistic Item.\n\n| Field | Argument | Type | Description |\n| ------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |\n| **id** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | LogisticsItem ID or SKU. | |\n| **requestIndex** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int) | | |\n| **quantity** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int) | Number of items. | |\n| **seller** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Seller responsible for the ShippingItem. | |\n| **sellerChain** | \\[[String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)\\] | List of Sellers. | |\n| **tax** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int) | LogisticsItem tax. | |\n| **priceValidUntil** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Next date in which price is scheduled to change. If there is no scheduled change, this will be set a year in the future from current time. | |\n| **price** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int) | LogisticsItem price. | |\n| **listPrice** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int) | LogisticsItem listPrice. | |\n| **rewardValue** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int) | LogisticsItem rewardValue. | |\n| **sellingPrice** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int) | LogisticsItem sellingPrice. | |\n| **measurementUnit** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | LogisticsItem measurementUnit. | |\n| **unitMultiplier** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int) | LogisticsItem unitMultiplier. | |\n| **availability** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | LogisticsItem availability. | |\n\n### MessageFields\n\n| Field | Argument | Type | Description |\n| ------------- | --------------------------------------------------------------------------------- | ------------------------- | ----------- |\n| **itemIndex** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | MessageFields item index. | |\n| **ean** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | MessageFields ean. | |\n| **skuName** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | MessageFields sku name. | |\n\n### MessageInfo\n\n| Field | Argument | Type | Description |\n| ---------- | ----------------------------------------------------------------------------------------------- | ------------------- | ----------- |\n| **code** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | MessageInfo code. | |\n| **text** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | MessageInfo text. | |\n| **status** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | MessageInfo status. | |\n| **fields** | [MessageFields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23messagefields) | MessageInfo fields. | |\n\n### PersonNewsletter\n\nNewsletter information.\n\n| Field | Argument | Type | Description |\n| ------ | ---------------------------------------------------------------------------------- | ----------------------------------- | ----------- |\n| **id** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Person's ID in the newsletter list. | |\n\n### PickupAddress\n\n| Field | Argument | Type | Description |\n| ------------------ | ----------------------------------------------------------------------------------- | ------------------------------ | ----------- |\n| **addressType** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | PickupAddress address type. | |\n| **receiverName** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | PickupAddress receiver name. | |\n| **addressId** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | PickupAddress address id. | |\n| **postalCode** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | PickupAddress postal code. | |\n| **city** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | PickupAddress city. | |\n| **state** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | PickupAddress state. | |\n| **country** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | PickupAddress country. | |\n| **street** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | PickupAddress street. | |\n| **number** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | PickupAddress number. | |\n| **neighborhood** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | PickupAddress neighborhood. | |\n| **complement** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | PickupAddress complement. | |\n| **reference** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | PickupAddress reference. | |\n| **geoCoordinates** | \\[[Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)\\] | PickupAddress geo coordinates. | |\n\n### PickupStoreInfo\n\n| Field | Argument | Type | Description |\n| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------- | ----------- |\n| **friendlyName** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | PickupStoreInfo friendly name. | |\n| **address** | [PickupAddress](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23pickupaddress) | PickupStoreInfo address. | |\n| **additionalInfo** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | PickupStoreInfo additional information. | |\n| **dockId** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | PickupStoreInfo dock id. | |\n| **isPickupStore** | [Boolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string%23boolean) | Information if the store has pickup enable. | |\n\n### SearchMetadata\n\nSearch result.\n\n| Field | Argument | Type | Description |\n| -------------------- | ------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | ----------- |\n| **isTermMisspelled** | [Boolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23boolean)! | Indicates if the search term was misspelled. | |\n| **logicalOperator** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Logical operator used to run the search. | |\n| **fuzzy** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Indicates how the search engine corrected the misspelled word by using fuzzy logic. | |\n\n### SellerInfo\n\nInformation of sellers.\n\n| Field | Argument | Type | Description |\n| -------- | --------------------------------------------------------------------------------- | ----------------------------- | ----------- |\n| **id** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Identification of the seller. | |\n| **name** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Name of the seller. | |\n| **logo** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Logo of the seller. | |\n\n### SellersData\n\nRegionalization with sellers information.\n\n| Field | Argument | Type | Description |\n| ----------- | ----------------------------------------------------------------------------------------- | ------------------------- | ----------- |\n| **id** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Identification of region. | |\n| **sellers** | \\[[SellerInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)\\] | List of sellers. | |\n\n### ShippingData\n\nShipping Simulation information.\n\n| Field | Argument | Type | Description |\n| ----------------- | --------------------------------------------------------------------------------------------------- | ---------------------- | ----------- |\n| **items** | \\[[LogisticsItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23logisticsitem)\\] | List of LogisticsItem. | |\n| **logisticsInfo** | \\[[LogisticsInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23logisticsinfo)\\] | List of LogisticsInfo. | |\n| **messages** | \\[[MessageInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23messageinfo)\\] | List of MessageInfo. | |\n| **address** | [Address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23address) | Address information. | |\n\n### ShippingSLA\n\n| Field | Argument | Type | Description |\n| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- | ----------- |\n| **id** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | ShippingSLA id. | |\n| **name** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | ShippingSLA name. | |\n| **price** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float) | ShippingSLA price. | |\n| **shippingEstimate** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | ShippingSLA shipping estimate. | |\n| **localizedEstimates** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | ShippingSLA localized shipping estimate. Note: this will always return a localized string for locale en-US. | |\n| **availableDeliveryWindows** | \\[[AvailableDeliveryWindows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-object%23availabledeliverywindows)\\] | ShippingSLA available delivery windows. | |\n| **shippingEstimateDate** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | ShippingSLA shipping estimate date. | |\n| **deliveryIds** | \\[[DeliveryIds](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23deliveryids)\\] | List of ShippingSLA delivery ids. | |\n| **deliveryChannel** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | ShippingSLA delivery channel. | |\n| **friendlyName** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | ShippingSLA friendly name. | |\n| **carrier** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | ShippingSLA carrier. | |\n| **pickupPointId** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | ShippingSLA pickup point id. | |\n| **pickupStoreInfo** | [PickupStoreInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23pickupstoreinfo) | ShippingSLA pickup store info. | |\n| **pickupDistance** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float) | ShippingSLA pickup distance. | |\n\n### SkuVariants\n\n| Field | Argument | Type | Description |\n| ----------------------- | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **activeVariations** | [ActiveVariations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23activevariations) | SKU property values for the current SKU. | |\n| **allVariantsByName** | [VariantsByName](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23variantsbyname) | All available options for each SKU variant property, indexed by their name. | |\n| **slugsMap** | [SlugsMap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23slugsmap) | Maps property value combinations to their respective SKU's slug. Enables us to retrieve the slug for the SKU that matches the currently selected variations in O(1) time. If dominantVariantName is not present, the first variant will be considered the dominant one. | |\n| dominantVariantName | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | | |\n| **availableVariations** | [FormattedVariants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23formattedvariants) | Available options for each varying SKU property, taking into account thedominantVariantName property. Returns all available options for the dominant property, and only options that can be combined with its current value for other properties. If dominantVariantName is not present, the first variant will be considered the dominant one. | |\n| dominantVariantName | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | | |\n\n### StoreAggregateOffer\n\nAggregate offer information, for a given SKU that is available to be fulfilled by multiple sellers.\n\n| Field | Argument | Type | Description |\n| ----------------- | ----------------------------------------------------------------------------------------------- | --------------------------------------------------- | ----------- |\n| **highPrice** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | Highest price among all sellers. | |\n| **lowPrice** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | Lowest price among all sellers. | |\n| **offerCount** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int)! | Number of sellers selling this SKU. | |\n| **priceCurrency** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | ISO code of the currency used for the offer prices. | |\n| **offers** | \\[[StoreOffer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeoffer)!\\]! | Array with information on each available offer. | |\n\n### StoreAggregateRating\n\nAverage rating, based on multiple ratings or reviews.\n\n| Field | Argument | Type | Description |\n| --------------- | -------------------------------------------------------------------------------- | ------------------------------ | ----------- |\n| **ratingValue** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | Value of the aggregate rating. | |\n| **reviewCount** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int)! | Total number of ratings. | |\n\n### StoreAuthor\n\ninformation about the author of a product review or rating.\n\n| Field | Argument | Type | Description |\n| -------- | ---------------------------------------------------------------------------------- | ------------ | ----------- |\n| **name** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Author name. | |\n\n### StoreBrand\n\nBrand of a given product.\n\n| Field | Argument | Type | Description |\n| -------- | ---------------------------------------------------------------------------------- | ----------- | ----------- |\n| **name** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Brand name. | |\n\n### StoreBreadcrumbList\n\nList of items consisting of chain linked web pages, ending with the current page.\n\n| Field | Argument | Type | Description |\n| ------------------- | ----------------------------------------------------------------------------------------------------- | ---------------------------------- | ----------- |\n| **itemListElement** | \\[[StoreListItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storelistitem)!\\]! | Array with breadcrumb elements. | |\n| **numberOfItems** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int)! | Number of breadcrumbs in the list. | |\n\n### StoreCart\n\nShopping cart information.\n\n| Field | Argument | Type | Description |\n| ------------ | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | ----------- |\n| **order** | [StoreOrder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeorder)! | Order information, including orderNumber and acceptedOffer. | |\n| **messages** | \\[[StoreCartMessage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storecartmessage)!\\]! | List of shopping cart messages. | |\n\n### StoreCartMessage\n\nShopping cart message.\n\n| Field | Argument | Type | Description |\n| ---------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------ | ----------- |\n| **text** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Shopping cart message text. | |\n| **status** | [StoreStatus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums%23storestatus)! | Shopping cart message status, which can be INFO, WARNING or ERROR. | |\n\n### StoreCollection\n\nProduct collection information.\n\n| Field | Argument | Type | Description |\n| ------------------ | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- | ----------- |\n| **seo** | [StoreSeo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeseo)! | Meta tag data. | |\n| **breadcrumbList** | [StoreBreadcrumbList](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storebreadcrumblist)! | List of items consisting of chain linked web pages, ending with the current page. | |\n| **meta** | [StoreCollectionMeta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storecollectionmeta)! | Collection meta information. Used for search. | |\n| **id** | [ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23id)! | Collection ID. | |\n| **slug** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Corresponding collection URL slug, with which to retrieve this entity. | |\n| **type** | [StoreCollectionType](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums%23storecollectiontype)! | Collection type. | |\n\n### StoreCollectionConnection\n\nCollection connections, including pagination information and collections returned by the query.\n\n| Field | Argument | Type | Description |\n| ------------ | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------- |\n| **pageInfo** | [StorePageInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storepageinfo)! | Collection pagination information. | |\n| **edges** | \\[[StoreCollectionEdge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storecollectionedge)!\\]! | Array with collection connection page edges, each containing a collection and a corresponding cursor. | |\n\n### StoreCollectionEdge\n\nEach collection edge contains a `node`, with product collection information, and a `cursor`, that can be used as a reference for pagination.\n\n| Field | Argument | Type | Description |\n| ---------- | ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | ----------- |\n| **node** | [StoreCollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storecollection)! | Each collection node contains the information of a product collection returned by the query. | |\n| **cursor** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Collection cursor. Used as pagination reference. | |\n\n### StoreCollectionFacet\n\nProduct collection facet, used for search.\n\n| Field | Argument | Type | Description |\n| --------- | ---------------------------------------------------------------------------------- | ------------ | ----------- |\n| **key** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Facet key. | |\n| **value** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Facet value. | |\n\n### StoreCollectionMeta\n\nCollection meta information. Used for search.\n\n| Field | Argument | Type | Description |\n| ------------------ | ------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ----------- |\n| **selectedFacets** | \\[[StoreCollectionFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storecollectionfacet)!\\]! | List of selected collection facets. | |\n\n### StoreCurrency\n\nCurrency information.\n\n| Field | Argument | Type | Description |\n| ---------- | ---------------------------------------------------------------------------------- | ------------------------- | ----------- |\n| **code** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Currency code (e.g: USD). | |\n| **symbol** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Currency symbol (e.g: $). | |\n\n### StoreDeliveryMode\n\nDelivery mode information.\n\n| Field | Argument | Type | Description |\n| ------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | ----------- |\n| **deliveryChannel** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | The delivery channel information of the session. | |\n| **deliveryMethod** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | The delivery method information of the session. | |\n| **deliveryWindow** | [StoreDeliveryWindow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storedeliverywindow) | The delivery window information of the session. | |\n\n### StoreDeliveryWindow\n\nDelivery window information.\n\n| Field | Argument | Type | Description |\n| ------------- | ---------------------------------------------------------------------------------- | ------------------------------------------- | ----------- |\n| **startDate** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | The delivery window start date information. | |\n| **endDate** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | The delivery window end date information. | |\n\n### StoreFacet\n\nSearch facet information.\n\n| Field | Argument | Type | Description |\n| ---------- | ---------------------------------------------------------------------------------- | -------------------------------------------------- | ----------- |\n| **key** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Facet key. | |\n| **label** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Facet label. | |\n| **values** | \\[[StoreFacetValue](#storefacetvalue)!\\]! | Array with information on each facet value. | |\n| **type** | [StoreFacetBoolean](#storefacetboolean)! | Facet type. Possible values are BOOLEAN and RANGE. | |\n| **type** | [StoreFacetRange](#storefacetrange)! | Facet type. | |\n\n### StoreFacetBoolean\n\nSearch facet boolean information.\n\n| Field | Argument | Type | Description |\n| ---------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | ----------- |\n| **key** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Facet key. | |\n| **label** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Facet label. | |\n| **values** | \\[[StoreFacetValueBoolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storefacetvalueboolean)!\\]! | Array with information on each facet value. | |\n\n### StoreFacetRange\n\nSearch facet range information.\n\n| Field | Argument | Type | Description |\n| --------- | -------------------------------------------------------------------------------------------------------------- | -------------------------- | ----------- |\n| **key** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Facet key. | |\n| **label** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Facet label. | |\n| **min** | [StoreFacetValueRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storefacetvaluerange)! | Minimum facet range value. | |\n| **max** | [StoreFacetValueRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storefacetvaluerange)! | Maximum facet range value. | |\n\n### StoreFacetValueBoolean\n\nInformation of a specific facet value.\n\n| Field | Argument | Type | Description |\n| ------------ | ------------------------------------------------------------------------------------ | ------------------------------------ | ----------- |\n| **value** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Facet value. | |\n| **label** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Facet value label. | |\n| **selected** | [Boolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23boolean)! | Indicates whether facet is selected. | |\n| **quantity** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int)! | Number of items with this facet. | |\n\n### StoreFacetValueRange\n\nSearch facet range value information. Used for minimum and maximum range values.\n\n| Field | Argument | Type | Description |\n| ------------ | -------------------------------------------------------------------------------- | ---------------------------------- | ----------- |\n| **absolute** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | Search facet range absolute value. | |\n| **selected** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | Search facet range selected value. | |\n\n### StoreGeoCoordinates\n\nGeographic coordinates information.\n\n| Field | Argument | Type | Description |\n| ------------- | -------------------------------------------------------------------------------- | -------------------------------------------- | ----------- |\n| **latitude** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | The latitude of the geographic coordinates. | |\n| **longitude** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | The longitude of the geographic coordinates. | |\n\n### StoreImage\n\nImage.\n\n| Field | Argument | Type | Description |\n| ----------------- | ---------------------------------------------------------------------------------- | -------------------- | ----------- |\n| **url** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Image URL. | |\n| **alternateName** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Alias for the image. | |\n\n### StoreListItem\n\nItem of a list.\n\n| Field | Argument | Type | Description |\n| ------------ | ---------------------------------------------------------------------------------- | --------------------------------- | ----------- |\n| **item** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | List item value. | |\n| **name** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Name of the list item. | |\n| **position** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int)! | Position of the item in the list. | |\n\n### StoreOffer\n\nOffer information.\n\n| Field | Argument | Type | Description |\n| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |\n| **listPrice** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | This is displayed as the \"from\" price in the context of promotions' price comparison. This may change before it reaches the shelf. | |\n| **sellingPrice** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | Computed price before applying coupons, taxes or benefits. This may change before it reaches the shelf. | |\n| **priceCurrency** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | ISO code of the currency used for the offer prices. | |\n| **price** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | Also known as spot price. | |\n| **priceValidUntil** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Next date in which price is scheduled to change. If there is no scheduled change, this will be set a year in the future from current time. | |\n| **itemCondition** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Offer item condition. | |\n| **availability** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Offer item availability. | |\n| **seller** | [StoreOrganization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeorganization)! | Seller responsible for the offer. | |\n| **itemOffered** | [StoreProduct](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeproduct)! | Information on the item being offered. | |\n| **quantity** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int)! | Number of items offered. | |\n\n### StoreOrder\n\nInformation of a specific order.\n\n| Field | Argument | Type | Description |\n| ----------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **orderNumber** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | ID of the order in [VTEX order management](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources-oms--60QcBsvWeum02cFi3GjBzg%23). | |\n| **acceptedOffer** | \\[[StoreOffer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeoffer)!\\]! | Array with information on each accepted offer. | |\n\n### StoreOrganization\n\nOrganization.\n\n| Field | Argument | Type | Description |\n| -------------- | ---------------------------------------------------------------------------------- | ---------------- | ----------- |\n| **identifier** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Organization ID. | |\n\n### StorePageInfo\n\nWhenever you make a query that allows for pagination, such as `allProducts` or `allCollections`, you can check `StorePageInfo` to learn more about the complete set of items and use it to paginate your queries.\n\n| Field | Argument | Type | Description |\n| ------------------- | ------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- | ----------- |\n| **hasNextPage** | [Boolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23boolean)! | Indicates whether there is at least one more page with items after the ones returned in the current query. | |\n| **hasPreviousPage** | [Boolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23boolean)! | Indicates whether there is at least one more page with items before the ones returned in the current query. | |\n| **startCursor** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Cursor corresponding to the first possible item. | |\n| **endCursor** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Cursor corresponding to the last possible item. | |\n| **totalCount** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int)! | Total number of items (products or collections), not pages. | |\n\n### StorePerson\n\nClient profile data.\n\n| Field | Argument | Type | Description |\n| -------------- | ---------------------------------------------------------------------------------- | ------------------ | ----------- |\n| **id** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Client ID. | |\n| **email** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Client email. | |\n| **givenName** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Client first name. | |\n| **familyName** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Client last name. | |\n\n### StoreProduct\n\nProduct information. Products are variants within product groups, equivalent to VTEX [SKUs](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u%23). For example, you may have a **Shirt** product group with associated products such as **Blue shirt size L**, **Green shirt size XL** and so on.\n\n| Field | Argument | Type | Description |\n| ---------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ----------- |\n| **seo** | [StoreSeo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeseo)! | Meta tag data. | |\n| **breadcrumbList** | [StoreBreadcrumbList](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storebreadcrumblist)! | List of items consisting of chain linked web pages, ending with the current page. | |\n| **slug** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Corresponding collection URL slug, with which to retrieve this entity. | |\n| **name** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Product name. | |\n| **productID** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Product ID, such as [ISBN](https://read.calvincode.net/reader?url=https://www.isbn-international.org/content/what-isbn) or similar global IDs. | |\n| **brand** | [StoreBrand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storebrand)! | Product brand. | |\n| **description** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Product description. | |\n| **image** | \\[[StoreImage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeimage)!\\]! | Array of images. | |\n| context | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | | |\n| limit | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int) | | |\n| **offers** | [StoreAggregateOffer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeaggregateoffer)! | Aggregate offer information. | |\n| **sku** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Stock Keeping Unit. Merchant-specific ID for the product. | |\n| **gtin** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Global Trade Item Number. | |\n| **review** | \\[[StoreReview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storereview)!\\]! | Array with review information. | |\n| **aggregateRating** | [StoreAggregateRating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeaggregaterating)! | Aggregate ratings data. | |\n| **isVariantOf** | [StoreProductGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeproductgroup)! | Indicates product group related to this product. | |\n| **additionalProperty** | \\[[StorePropertyValue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storepropertyvalue)!\\]! | Array of additional properties. | |\n| **releaseDate** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | The product's release date. Formatted using [ISO 8601](https://read.calvincode.net/reader?url=https://www.iso.org/iso-8601-date-and-time-format.html). | |\n\n### StoreProductConnection\n\nProduct connections, including pagination information and products returned by the query.\n\n| Field | Argument | Type | Description |\n| ------------ | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |\n| **pageInfo** | [StorePageInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storepageinfo)! | Product pagination information. | |\n| **edges** | \\[[StoreProductEdge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeproductedge)!\\]! | Array with product connection edges, each containing a product and a corresponding cursor. | |\n\n### StoreProductEdge\n\nEach product edge contains a `node`, with product information, and a `cursor`, that can be used as a reference for pagination.\n\n| Field | Argument | Type | Description |\n| ---------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ----------- |\n| **node** | [StoreProduct](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeproduct)! | Each product node contains the information of a product returned by the query. | |\n| **cursor** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Product cursor. Used as pagination reference. | |\n\n### StoreProductGroup\n\nProduct group information. Product groups are catalog entities that may contain variants. They are equivalent to VTEX [Products](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-product--2zrB2gFCHyQokCKKE8kuAw%23), whereas each variant is equivalent to a VTEX [SKU](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u%23). For example, you may have a **Shirt** product group with associated products such as **Blue shirt size L**, **Green shirt size XL** and so on.\n\n| Field | Argument | Type | Description |\n| ---------------------- | --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **hasVariant** | \\[[StoreProduct](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeproduct)!\\]! | Array of variants related to product group. Variants are equivalent to VTEX [SKUs](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u%23). | |\n| **productGroupID** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Product group ID. | |\n| **name** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Product group name. | |\n| **additionalProperty** | \\[[StorePropertyValue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storepropertyvalue)!\\]! | Array of additional properties. | |\n| **skuVariants** | [SkuVariants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23skuvariants) | Object containing data structures to facilitate handling different SKU variant properties. Specially useful for implementing SKU selection components. | |\n\n### StorePropertyValue\n\nProperties that can be associated with products and products groups.\n\n| Field | Argument | Type | Description |\n| ------------------ | -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ----------- |\n| **propertyID** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Property id. This propert changes according to the content of the object. | |\n| **value** | [ObjectOrString](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23objectorstring)! | Property value. May hold a string or the string representation of an object. | |\n| **name** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Property name. | |\n| **valueReference** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Specifies the nature of the value. | |\n\n### StoreRedirect\n\nRedirect informations, including url returned by the query.<https://schema.org/Thing>\n\n| Field | Argument | Type | Description |\n| ------- | --------------------------------------------------------------------------------- | ---------------- | ----------- |\n| **url** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | URL to redirect. | |\n\n### StoreReview\n\nInformation of a given review.\n\n| Field | Argument | Type | Description |\n| ---------------- | -------------------------------------------------------------------------------------------------------- | -------------------------- | ----------- |\n| **reviewRating** | [StoreReviewRating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storereviewrating)! | Review rating information. | |\n| **author** | [StoreAuthor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeauthor)! | Review author. | |\n\n### StoreReviewRating\n\nInformation of a given review rating.\n\n| Field | Argument | Type | Description |\n| --------------- | -------------------------------------------------------------------------------- | ------------------ | ----------- |\n| **ratingValue** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | Rating value. | |\n| **bestRating** | [Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23float)! | Best rating value. | |\n\n### StoreSearchResult\n\nSearch result.\n\n| Field | Argument | Type | Description |\n| --------------- | ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------- | ----------- |\n| **products** | [StoreProductConnection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeproductconnection)! | Search result products. | |\n| **facets** | \\[[StoreFacet](#storefacet)!\\]! | Array of search result facets. | |\n| **suggestions** | [StoreSuggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storesuggestions)! | Search result suggestions. | |\n| **metadata** | [SearchMetadata](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-onbjects%23searchmetadata) | Search result metadata. Additional data can be used to send analytics events. | |\n\n### StoreSeo\n\nSearch Engine Optimization (SEO) tags data.\n\n| Field | Argument | Type | Description |\n| ----------------- | ---------------------------------------------------------------------------------- | ------------------- | ----------- |\n| **title** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Title tag. | |\n| **titleTemplate** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Title template tag. | |\n| **description** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Description tag. | |\n| **canonical** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Canonical tag. | |\n\n### StoreSession\n\nSession information.\n\n| Field | Argument | Type | Description |\n| ------------------ | ----------------------------------------------------------------------------------------------------------- | ----------------------------- | ----------- |\n| **locale** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Session locale. | |\n| **currency** | [StoreCurrency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storecurrency)! | Session currency. | |\n| **country** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Session country. | |\n| **channel** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Session channel. | |\n| **deliveryMode** | [StoreDeliveryMode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storedeliverymode) | Session delivery mode. | |\n| **addressType** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Session address type. | |\n| **postalCode** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Session postal code. | |\n| **geoCoordinates** | [StoreGeoCoordinates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storegeocoordinates) | Session input geoCoordinates. | |\n| **person** | [StorePerson](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeperson) | Session input person. | |\n\n### StoreSuggestionTerm\n\nSuggestion term.\n\n| Field | Argument | Type | Description |\n| --------- | ---------------------------------------------------------------------------------- | ---------------------- | ----------- |\n| **value** | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | The term. | |\n| **count** | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int)! | Its occurrences count. | |\n\n### StoreSuggestions\n\nSuggestions information.\n\n| Field | Argument | Type | Description |\n| ------------ | ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | ----------- |\n| **terms** | \\[[StoreSuggestionTerm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storesuggestionterm)!\\]! | Array with suggestion terms. | |\n| **products** | \\[[StoreProduct](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeproduct)!\\]! | Array with suggestion products' information. | |\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/faststore-api/schema/objects.mdx)\n\n[Mutations« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-mutations)[InputsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-inputs)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23objects)\n\n[Address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23address)[AvailableDeliveryWindows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23availabledeliverywindows)[DeliveryIds](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23deliveryids)[LogisticsInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23logisticsinfo)[LogisticsItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23logisticsitem)[MessageFields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23messagefields)[MessageInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23messageinfo)[PersonNewsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23personnewsletter)[PickupAddress](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23pickupaddress)[PickupStoreInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23pickupstoreinfo)[SearchMetadata](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23searchmetadata)[SellerInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23sellerinfo)[SellersData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23sellersdata)[ShippingData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23shippingdata)[ShippingSLA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23shippingsla)[SkuVariants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23skuvariants)[StoreAggregateOffer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeaggregateoffer)[StoreAggregateRating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeaggregaterating)[StoreAuthor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeauthor)[StoreBrand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storebrand)[StoreBreadcrumbList](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storebreadcrumblist)[StoreCart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storecart)[StoreCartMessage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storecartmessage)[StoreCollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storecollection)[StoreCollectionConnection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storecollectionconnection)[StoreCollectionEdge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storecollectionedge)[StoreCollectionFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storecollectionfacet)[StoreCollectionMeta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storecollectionmeta)[StoreCurrency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storecurrency)[StoreDeliveryMode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storedeliverymode)[StoreDeliveryWindow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storedeliverywindow)[StoreFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storefacet)[StoreFacetBoolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storefacetboolean)[StoreFacetRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storefacetrange)[StoreFacetValueBoolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storefacetvalueboolean)[StoreFacetValueRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storefacetvaluerange)[StoreGeoCoordinates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storegeocoordinates)[StoreImage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeimage)[StoreListItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storelistitem)[StoreOffer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeoffer)[StoreOrder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeorder)[StoreOrganization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeorganization)[StorePageInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storepageinfo)[StorePerson](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeperson)[StoreProduct](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeproduct)[StoreProductConnection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeproductconnection)[StoreProductEdge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeproductedge)[StoreProductGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeproductgroup)[StorePropertyValue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storepropertyvalue)[StoreRedirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeredirect)[StoreReview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storereview)[StoreReviewRating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storereviewrating)[StoreSearchResult](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storesearchresult)[StoreSeo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeseo)[StoreSession](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storesession)[StoreSuggestionTerm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storesuggestionterm)[StoreSuggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storesuggestions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/faststore-api/schema/objects.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23objects)\n\n[Address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23address)[AvailableDeliveryWindows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23availabledeliverywindows)[DeliveryIds](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23deliveryids)[LogisticsInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23logisticsinfo)[LogisticsItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23logisticsitem)[MessageFields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23messagefields)[MessageInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23messageinfo)[PersonNewsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23personnewsletter)[PickupAddress](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23pickupaddress)[PickupStoreInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23pickupstoreinfo)[SearchMetadata](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23searchmetadata)[SellerInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23sellerinfo)[SellersData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23sellersdata)[ShippingData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23shippingdata)[ShippingSLA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23shippingsla)[SkuVariants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23skuvariants)[StoreAggregateOffer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeaggregateoffer)[StoreAggregateRating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeaggregaterating)[StoreAuthor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeauthor)[StoreBrand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storebrand)[StoreBreadcrumbList](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storebreadcrumblist)[StoreCart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storecart)[StoreCartMessage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storecartmessage)[StoreCollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storecollection)[StoreCollectionConnection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storecollectionconnection)[StoreCollectionEdge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storecollectionedge)[StoreCollectionFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storecollectionfacet)[StoreCollectionMeta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storecollectionmeta)[StoreCurrency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storecurrency)[StoreDeliveryMode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storedeliverymode)[StoreDeliveryWindow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storedeliverywindow)[StoreFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storefacet)[StoreFacetBoolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storefacetboolean)[StoreFacetRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storefacetrange)[StoreFacetValueBoolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storefacetvalueboolean)[StoreFacetValueRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storefacetvaluerange)[StoreGeoCoordinates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storegeocoordinates)[StoreImage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeimage)[StoreListItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storelistitem)[StoreOffer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeoffer)[StoreOrder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeorder)[StoreOrganization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeorganization)[StorePageInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storepageinfo)[StorePerson](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeperson)[StoreProduct](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeproduct)[StoreProductConnection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeproductconnection)[StoreProductEdge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeproductedge)[StoreProductGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeproductgroup)[StorePropertyValue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storepropertyvalue)[StoreRedirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeredirect)[StoreReview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storereview)[StoreReviewRating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storereviewrating)[StoreSearchResult](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storesearchresult)[StoreSeo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storeseo)[StoreSession](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storesession)[StoreSuggestionTerm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storesuggestionterm)[StoreSuggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects/docs/guides/faststore/schema-objects%23storesuggestions)\n\nOn this page\n\n[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=)"
}
] |
doc_4f4b04f2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain the VTEX api reference ssl certificates api API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/ssl-certificates-api/)\n\nSSL Certificates\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/ssl-certificates-api/)\n\nSSL Certificates\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[GeGet Segment« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/session-manager-api%23get-/api/segments)[GeList SSL certificatesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api/docs/api-reference/ssl-certificates-api%23get-/api/edge/certificates)\n\n[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=)"
}
] |
doc_0468ffc6
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides api authentication using application keys in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/api-authentication-using-api-keys)\n\n[Rotating VTEX API tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/rotating-vtex-api-tokens)\n\n[App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/app-authentication-using-auth-tokens)\n\n[API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/api-authentication-using-user-tokens)\n\n[Checking which user is currently authenticated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/checking-which-user-is-currently-authenticated)\n\n[Expiring a shopper's password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/expiring-a-shoppers-password)\n\n[Refresh token flow for headless implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/refresh-token-flow-for-headless-implementations)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/api-response-codes)\n\nError handling and best practices\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/api-authentication-using-api-keys)\n\n[Rotating VTEX API tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/rotating-vtex-api-tokens)\n\n[App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/app-authentication-using-auth-tokens)\n\n[API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/api-authentication-using-user-tokens)\n\n[Checking which user is currently authenticated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/checking-which-user-is-currently-authenticated)\n\n[Expiring a shopper's password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/expiring-a-shoppers-password)\n\n[Refresh token flow for headless implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/refresh-token-flow-for-headless-implementations)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/api-response-codes)\n\nError handling and best practices\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides)\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/api-usage)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/api-authentication-using-api-keys)\n\nAPI authentication using API keys\n\nApplication keys (`appKey`) are credentials used to authenticate requests to VTEX APIs. Store administrators can create multiple application keys that may be used, for example, for different integrations. Read [Generating and managing application keys](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/api-keys--4bFEmcHXgpNksoePchZyy6) to learn how to create these credentials.\n\nAn API key includes specific permissions, based on License Manager [roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) and [resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) selected when creating or editing the API key. Read [Managing app key permissions](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/api-keys--4bFEmcHXgpNksoePchZyy6%23managing-app-key-permissions) for more details.\n\nEach `appKey` you create has an associated `appToken`. The appKey-appToken pair can be used in API requests to authorize interactions with VTEX services if they have [roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) with the required [resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3?%26utm%5Fsource=autocomplete).\n\nApplication keys are usually the best way to authenticate API calls in your integrations or in self-hosted backend requests in general. However, frontend requests should be authenticated with [user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens).\n\n> Do not use application keys in your client-side code. This makes your store vulnerable to attacks. Follow the [Best practices for using application keys](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm%23never-use-client-side-code-for-integrations).\n\n## Usage\n\nUse the `appKey` and `appToken` credential pair to authenticate API requests by sending their values in these HTTP headers:\n\n| Header key | Value |\n| ------------------- | ---------- |\n| X-VTEX-API-AppKey | {appKey} |\n| X-VTEX-API-AppToken | {appToken} |\n\nSee an example [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getorder) request:\n\n`1\n\ncurl --location --request GET 'https://apiexamples.vtexcommercebeta.com.br/api/oms/pvt/orders/:orderId' \\ \n\n2\n\n--header 'X-VTEX-API-AppKey: vtexappkey-example-YSWQFZ' \\ \n\n3\n\n--header 'X-VTEX-API-AppToken: eyJhbGciOiJFUzI1NiIsImtpZCI6IjA1MTZFN0IwMDNFODMxRTg0QkFDOTg2NzBCNUM2QTRERTlBN0RFNkUiLCJ0eXAiOiJqd3QifQ.eyJzdWIiOiJwZWRyby5jb3N0YUB2dGV4LmNvbS5iciIsImFjY291bnQiOiJhcHBsaWFuY2V0aGVtZSIsImF1ZGllbmNlIjoiYWRtaW4iLCJzZXNzIjoiZjU3YjMyMGItMWE3YS00YzlkLWJkNDMtZTE4NDdhYmE1MTE1IiwiZXhwIjoxNjE2NzY3Mjc4LCJ1c2VySWQiOiJmYjU0MmU1MS01NDg4LTRjMzQtOGQxNy1lZDhmY2Y1OTdhOTQiLCJpYXQiOjE2MwerY2ODA4NzgsImlzcyI6InRva2VuLWVtaXR0ZXIiLCJqdGkiOiJmYTI0YWJiOC03Y2E5LTQ3NjUtYmYzNC1kMmvU5YTgzYjYxZmUifQ.23rn-2dEdAAYXJX2exrxDEdbieyKWsVKABeSUNeFWyhz7xRd7d5EcxwiMLjM3bRaBOKrAA9Op7ocn89c45qQ' \\ \n\n4\n\n--header 'Accept: application/json' \\ \n\n5\n\n--header 'Content-Type: application/json' \n\n`\n\n> ️ According to the [W3C definition of Message Headers in HTTP requests](https://read.calvincode.net/reader?url=https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html%23sec4.2), header names are case-insensitive. `X-VTEX-API-AppKey`, `x-vtex-api-appkey` or any other variation in the authentication headers will work the same way.\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/authentication/api-authentication-using-api-keys.md)\n\n[Authentication« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys//docs/guides/authentication)[Rotating VTEX API tokensNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys//docs/guides/rotating-vtex-api-tokens)\n\nSee also\n\n[App authentication using auth tokensGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/app-authentication-using-auth-tokens)[API authentication using user tokensGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/api-authentication-using-user-tokens)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/api-authentication-using-api-keys%23usage)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/authentication/api-authentication-using-api-keys.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys/docs/guides/api-authentication-using-api-keys%23usage)\n\nOn this page\n\n[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=)"
}
] |
doc_6a78bdb3
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex broadcaster in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/troubleshooting)\n\n[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-broadcaster/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/updates/release-notes)\n\nBroadcaster Adapter\n\nThe Broadcaster adapter is designed to adapt broadcaster catalog changes to an event in IO's Events system.\n\nWith the catalog changes being broadcasted to IO, you can have apps that listen to the catalog changes and do tasks according to the changes. For example, the [Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-availability-notify) app uses the Broadcaster Adapter to monitor inventory updates. Once the requested SKU gets back in stock, the app will email shoppers who asked to be notified.\n\n\n\nThe broadcaster adapter receives a POST request with the data of the SKU that changed, and then it will push an event to the Event system to broadcast to apps that want to listen to these changes.\n\n> The Broadcaster Adapter app receives catalog changes from the same account where the app is installed and not from sellers.\n\n## SKU Data\n\nWhen the Broadcaster Adapter app sends an event, it contains a payload with the following fields.\n\n| Field Name | Description | Type |\n| --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |\n| IdSku | SKU ID in VTEX | string |\n| ProductId | Product ID in VTEX | long |\n| An | Account Name in VTEX, shown in the store’s VTEX Admin url. | string |\n| IdAffiliate | Affiliate ID generated automatically in the configuration. | string |\n| DateModified | Date when the item was updated. | string |\n| IsActive | Identifies whether the product is active or not. If true the product/SKU is active | boolean |\n| StockModified | Identifies that the inventory level has been altered. If false, the inventory level has not been changed. | boolean |\n| PriceModified | Identifies that the price has been altered. If false, the product/SKU price has not been changed. | boolean |\n| HasStockKeepingUnitModified | Identifies that the product/SKU registration data has changed, such as name, description, weight, etc. If true, the product/SKU registration data changed. | boolean |\n| HasStockKeepingUnitRemovedFromAffiliate | Identifies that the product is no longer associated with the trade policy. If true, the trade policy has changed. | boolean |\n\n## Regarding Franchise Accounts\n\nWhen attempting to listen for catalog change notifications in a **[franchise account](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-franchise-account--kWQC6RkFSCUFGgY5gSjdl)** (sometimes referred to as a **\"subaccount\"**), you will likely find that notifications are not being received by your app. This is because by default, catalog change notifications are only sent to the Broadcaster Adapter in the **main account**.\n\n### \"Notify Subaccounts\" setting\n\nThe app installed in the main account can be configured to push a notification event to all of the associated franchise accounts / subaccounts.\n\nTo access this setting, search for `My Apps` in the VTEX Admin, then search the list of installed apps for `Broadcaster Adapter`. Click on `Settings`. Finally, activate the checkbox for `Notify Subaccounts` and click `Save`.\n\n## Testing the app\n\nBy default, when the Broadcaster Adapter app sends events, these events are only sent in each account's master workspace. If you work in a **[Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-workspace)**, there are two ways to receive events there:\n\n### \"Notify Target Workspace\" setting\n\nThe app installed in the master workspace can be configured to push a notification event to a target workspace of your choice in addition to pushing it in the master workspace.\n\nTo access this setting, search for `My Apps` in the VTEX Admin, then search the list of installed apps for `Broadcaster Adapter`. Click on `Settings`. Finally, input the name of the workspace you wish to notify in the `Notify Target Workspace` field and click `Save`.\n\n### Event simulation via REST API\n\nYou can simulate an event by making a `POST` request to `app.io.vtex.com/vtex.broadcaster/v0/{{account}}/{{workspace}}/notify`with the body:\n\n`1\n\n{ \n\n2\n\n \"HasStockKeepingUnitModified\": true, \n\n3\n\n \"IdSku\": {{SKU id}} \n\n4\n\n} \n\n`\n\nThis endpoint requires a `VtexidClientAutCookie` header for authentication.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/vtex-broadcaster.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[SKU Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/guides/vtex-broadcaster%23sku-data)\n\n[Regarding Franchise Accounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/guides/vtex-broadcaster%23regarding-franchise-accounts)\n\n[\"Notify Subaccounts\" setting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/guides/vtex-broadcaster%23notify-subaccounts-setting)\n\n[Testing the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/guides/vtex-broadcaster%23testing-the-app)\n\n[\"Notify Target Workspace\" setting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/guides/vtex-broadcaster%23notify-target-workspace-setting)[Event simulation via REST API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/guides/vtex-broadcaster%23event-simulation-via-rest-api)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/vtex-broadcaster.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[SKU Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/guides/vtex-broadcaster%23sku-data)\n\n[Regarding Franchise Accounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/guides/vtex-broadcaster%23regarding-franchise-accounts)\n\n[\"Notify Subaccounts\" setting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/guides/vtex-broadcaster%23notify-subaccounts-setting)\n\n[Testing the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/guides/vtex-broadcaster%23testing-the-app)\n\n[\"Notify Target Workspace\" setting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/guides/vtex-broadcaster%23notify-target-workspace-setting)[Event simulation via REST API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster/docs/guides/vtex-broadcaster%23event-simulation-via-rest-api)\n\nOn this page\n\n[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=)"
}
] |
doc_b310a35c
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation 7 structuringthedocumentation in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-7-structuringthedocumentation/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/api-reference)\n\n[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-7-structuringthedocumentation/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/storefront-development)\n\n[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-7-structuringthedocumentation/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/troubleshooting)\n\n[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-7-structuringthedocumentation/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[What is a Pixel app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-pixel-app)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio)\n\n[2\\. Cloning the boilerplate repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository)\n\n[3\\. Configuring your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-4-configuringyourappsettings)\n\n[4\\. Writing the head and body scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-5-writingtheheaderandbodyscripts)\n\n[5\\. Listening to store events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-6-listeningtostoreevents)\n\n[6\\. Structuring the documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-7-structuringthedocumentation)\n\n[7\\. Making your Pixel app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-8-makingyourpixelapppubliclyavailable)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/create-master-data-crud-app)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[What is a Pixel app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-pixel-app)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio)\n\n[2\\. Cloning the boilerplate repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository)\n\n[3\\. Configuring your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-4-configuringyourappsettings)\n\n[4\\. Writing the head and body scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-5-writingtheheaderandbodyscripts)\n\n[5\\. Listening to store events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-6-listeningtostoreevents)\n\n[6\\. Structuring the documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-7-structuringthedocumentation)\n\n[7\\. Making your Pixel app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-8-makingyourpixelapppubliclyavailable)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/create-master-data-crud-app)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/app-development)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-getting-started)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[6\\. Structuring the documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-7-structuringthedocumentation)\n\n6\\. Structuring the documentation\n\nNow that your Pixel app is defined, it is time to create its **documentation**!\n\nCreating a documentation for your app is one of the most essential parts of your development journey, since the documentation will be the one responsible for presenting your app functionality to its future users.\n\nKnowing this, the VTEX IO team provides a documentation **template** to help you in this process:\n\n1. Access your app's `docs` folder.\n2. Access the `README.md` file.\n\nIn the `README.md` file, you will find several recommendations to your documentation. Read them carefully and make the updates according to your scenario.\n\n> Keep in mind that documentation is a ongoing process: update your app's `README.md` file whenever a new release impacts the user experience.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[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-1-developnativeintegrationswithpixelapps/vtex-io-documentation-7-structuringthedocumentation.md)\n\n[5\\. Listening to store events« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation//docs/guides/vtex-io-documentation-6-listeningtostoreevents)[7\\. Making your Pixel app publicly availableNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation//docs/guides/vtex-io-documentation-8-makingyourpixelapppubliclyavailable)\n\nSee also\n\n[7\\. Deploying your Pixel appApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation/docs/guides/vtex-io-documentation-8-makingyourpixelapppubliclyavailable)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\n Send feedback\n\n[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-1-developnativeintegrationswithpixelapps/vtex-io-documentation-7-structuringthedocumentation.md)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[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=)"
}
] |
doc_fd4b0cf2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX product summary 2.91.0 ProductSummaryList app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/vtex-io-apps)\n\nProduct Summary List\n\n[vtex.product-summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary)\n\nVersion: 2.91.0\n\nLatest version: 2.91.0\n\nThe Product Summary List app (`list-context.product-list`) is an instance of the `list-context` interface, which provides predefined interfaces used to create content lists, such as a product list.\n\n\n\nTo create a product list, you must use the `list-context.product-list` and `product-summary.shelf` blocks.\n\n## product-list-block\n\nThis block is used to specify the variation of `product-summary` that should be used to create the product list and the `list-context.product-list` you want, as follows:\n\n`1\n\n \"product-summary.shelf#demo1\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"stack-layout#prodsum\", \n\n4\n\n \"product-summary-name\", \n\n5\n\n \"product-rating-inline\", \n\n6\n\n \"product-summary-space\", \n\n7\n\n \"product-summary-price\", \n\n8\n\n \"product-summary-buy-button\" \n\n9\n\n ] \n\n10\n\n }, \n\n11\n\n \"list-context.product-list#demo1\": { \n\n12\n\n \"blocks\": [\"product-summary.shelf#demo1\"], \n\n13\n\n \"children\": [\"slider-layout#demo-products\"] \n\n14\n\n }, \n\n`\n\n`list-context.product-list` also runs the GraphQL query that fetches the product list, allowing it to receive the following props:\n\n| Prop name | Type | Description | Default value |\n| -------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------ |\n| category | string | Category ID of the listed items. For subcategories, use \"/\" (example: \"1/2/3\"). | \\- |\n| specificationFilters | Array({ id: String, value: String }) | Specification filters of the listed items. | \\[\\] |\n| collection | string | Filter by collection. | \\- |\n| orderBy | enum | Sort type of the items. Possible values are: '', OrderByTopSaleDESC, OrderByReleaseDateDESC, OrderByBestDiscountDESC, OrderByPriceDESC, OrderByPriceASC, OrderByNameASC, OrderByNameDESC. | OrderByTopSaleDESC |\n| hideUnavailableItems | boolean | Hides unavailable items. | false |\n| maxItems | number | Maximum items to be fetched. | 10 |\n| skusFilter | [SkusFilterEnum](#skusfilterenum) | Control SKUs returned for each product in the query. The fewer SKUs that need to be returned, the more efficient your shelf query will be. Possible values are: FIRST\\_AVAILABLE, ALL\\_AVAILABLE, ALL. | \"ALL\\_AVAILABLE\" |\n| installmentCriteria | [InstallmentCriteriaEnum](#installmentcriteriaenum) | Controls the price that will be displayed when the price has different installment options. Possible values are: MAX\\_WITHOUT\\_INTEREST, MAX\\_WITH\\_INTEREST. | \"MAX\\_WITHOUT\\_INTEREST\" |\n| listName | string | Name of the list property in Google Analytics events. | \\- |\n| preferredSKU | [PreferredSKUEnum](#preferredskuenum) | Controls the SKU that will be selected in the summary. Possible values are: FIRST\\_AVAILABLE, LAST\\_AVAILABLE, PRICE\\_ASC, PRICE\\_DESC. | \"FIRST\\_AVAILABLE\" |\n\n### `SkusFilterEnum`:\n\n| Name | Value | Description |\n| --------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| First Available | FIRST\\_AVAILABLE | Best performance, ideal if you don't have a SKU selector on your shelf. It returns only the first available SKU for that product in your shelf query. |\n| All Available | ALL\\_AVAILABLE | Somewhat better performance. It only returns available SKUs, which is ideal if you have a SKU selector but still want better performance. |\n| All | ALL | Returns all SKUs related to the product. This is the least efficient option. |\n\n### `InstallmentCriteriaEnum`:\n\n| Name | Value | Description |\n| ------------------------ | ---------------------- | ----------------------------------------------------------------- |\n| Maximum without interest | MAX\\_WITHOUT\\_INTEREST | Displays the maximum installment option with no interest. |\n| Maximum | MAX\\_WITH\\_INTEREST | Displays the maximum installment option with or without interest. |\n\n### `PreferredSKUEnum`:\n\n| Name | Value | Description |\n| --------------- | ---------------- | -------------------------------------------------- |\n| First Available | FIRST\\_AVAILABLE | Selects the first available SKU it finds. |\n| Last Available | LAST\\_AVAILABLE | Selects the last available SKU it finds. |\n| Cheapest | PRICE\\_ASC | Selects the cheapest SKU in stock it finds. |\n| Most Expensive | PRICE\\_DESC | Selects the most expensive available SKU it finds. |\n\n> To select the SKU that will take precedence over this prop, create a Product (field) specification and assign the value of the desired SKU to be initially set for each product. If the specification doesn't exist or the value is empty, the `preferredSKU` prop will be used as a fallback. For more information, see [Configuring custom images for the SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector).\n\nSee also\n\n[Vtex.product SummaryVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/apps/vtex.product-summary)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[product-list-block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList%23product-list-block)\n\n[SkusFilterEnum:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList%23skusfilterenum)[InstallmentCriteriaEnum:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList%23installmentcriteriaenum)[PreferredSKUEnum:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList%23preferredskuenum)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_55b1848e
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore molecules rating field in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/troubleshooting)\n\n[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/molecules-rating-field/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-overview)\n\nRatingField\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/RatingField)\n\nThe `RatingField` component allows users to submit ratings when submitting product reviews. It wraps the [Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating) component, which displays the rating system, and the associated [Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label) component, which provides a text description for the rating field.\n\nExample\n\nCode\n\nRate the product from 1 to 5 stars\n\nRate the product from 1 to 5 starsThis field is required.\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { RatingField } from \"@faststore/ui\"; \n\n`\n\n### Import styles\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\n@import \"@faststore/ui/src/components/molecules/RatingField/styles.scss\"; \n\n`\n\nFor 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).\n\n---\n\n## Examples\n\n### Variants\n\n#### Error\n\nExample\n\nCode\n\nRate the product from 1 to 5 starsThis field is required.\n\n---\n\n## Design tokens\n\n### Design tokens: Label\n\n| Local token | Default value/Global token linked |\n| ------------------------------------ | --------------------------------- |\n| \\--fs-rating-field-label-color | var(--fs-color-text-light) |\n| \\--fs-rating-field-label-size | var(--fs-text-size-2) |\n| \\--fs-rating-field-label-line-height | var(--fs-text-size-4) |\n\n### Design tokens: Error\n\n| Local token | Default value/Global token linked |\n| -------------------------------------------- | --------------------------------- |\n| \\--fs-rating-field-error-message-size | var(--fs-text-size-legend) |\n| \\--fs-rating-field-error-message-line-height | 1.1 |\n| \\--fs-rating-field-error-message-color | var(--fs-color-danger-text) |\n\n## Data attributes\n\nYou can target and override `RatingField` styles using the following data attributes:\n\n`data-fs-rating-field`\n\n`data-fs-rating-field-label`\n\n`data-fs-rating-field-error-message`\n\n---\n\n## Props\n\n| Name | Type | Description | Default | | | | | | |\n| ------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------ | --------------- | -- | ------------------------ | --------------------------- | ------------------- | ----------- | -------------------------------------------------------------------------------- |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-rating-field | | | | | | |\n| **id** | string | ID to identify input and corresponding label. | | | | | | | |\n| **label\\*** | string | The text displayed to identify the input rating. | | | | | | | |\n| **error** | string | The error message displayed when an error occurs. | | | | | | | |\n| **ratingRef** | MutableRefObject<HTMLUListElement> | Component's ref. | | | | | | | |\n| **length** | number | The length of child elements. | 5 | | | | | | |\n| **value** | number | The current value of the rating, based on the quantity of child elements. | 0 | | | | | | |\n| **icon** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Icon to represent the rating score unit (e.g.: a <Icon name=\"Star\" /> component) |\n| **onChange** | (value: number) => void | Function to be triggered when Rating option change. This should only be used if you and an actionable rating list. | | | | | | | |\n| **disabled** | false \\| true | Specifies that the actionable rating should be disabled. | | | | | | | |\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/rating-field.mdx)\n\n[Rating« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating)[RegionBarNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-region-bar)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23variants)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23design-tokens)\n\n[Design tokens: Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23design-tokens-label)[Design tokens: Error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23design-tokens-error)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23props)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/rating-field.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23variants)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23design-tokens)\n\n[Design tokens: Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23design-tokens-label)[Design tokens: Error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23design-tokens-error)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-rating-field/docs/guides/faststore/molecules-rating-field%23props)\n\nOn this page\n\n[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=)"
}
] |
doc_2eccdcb1
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore routing managing urls with redirects and rewrite paths in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/troubleshooting)\n\n[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/routing-managing-urls-with-redirects-and-rewrite-paths/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore)\n\nManaging URLs with redirects and rewrite paths\n\nLearn how to configure redirects and rewrites in your FastStore project to manage user access to your content.\n\nIn this guide, you will learn how to configure redirects and rewrites in your FastStore project. These tools help you manage user access to your content by automatically directing users from one URL to another or mapping custom URLs to existing page templates.\n\nRedirects automatically take users from one URL to another. They are useful when pages have been moved, renamed, or removed. For example, if a page has been moved or renamed, the redirect ensures the user is taken to the new location.\n\nRewrites allow you to map custom URLs to existing page templates without changing the URL in the browser. This is useful when you want to hide complex or dynamic URL structures from users while maintaining clean and SEO-friendly URLs. For example, you can map a custom URL, such as `/sale`, to an existing Product Listing Page (PLP) template.\n\nIn summary:\n\n* Redirects change both the URL the user sees and the destination.\n* Rewrites keep the URL the same but change the destination internally.\n\nThese two tools enhance content organization, help maintain a good user experience, and ensure search engines continue to index the correct content.\n\n## Redirect behavior and caveats\n\nBefore configuring redirects, it's important to understand how they behave in FastStore and what caveats apply.\n\n### Native routes take precedence\n\nFastStore prioritizes native pages (e.g., product, collection, and brand pages) over redirect rules. If a redirect's source path matches a native page, the redirect will be ignored. For example, if `/fall-sale` is a live native collection page, a redirect rule from `/fall-sale` to `/fall` will not work. The collection page will render instead. To make the redirect work, you must unpublish or disable the native page (`/fall-sale`). To disable a collection page, follow these steps:\n\n1. Access the Admin and go to **Catalog > Collections**.\n2. Click on the collection name you want to disable.\n3. Click `COLLECTION SETTINGS`.\n4. In **Schedule**, change the **End date** to a date before the **Start date**.\n5. Click `Save`. \n> For more information on how to manage a collection, see the [Delete and edit a collection](https://read.calvincode.net/reader?url=https://newhelp.vtex.com/docs/tutorials/creating-collections-beta%23delete-and-edit-a-collection) guide.\n\nIf the source path of this native page is published by the Headless CMS, you must also unpublish it. To unpublish in the Headless CMS, follow these steps:\n\n1. Access the Admin and go to **Storefront > Headless CMS**.\n2. Click on the page name you want to unpublish.\n3. Click `Unpublish` and choose `Unpublish now`. \n> You can also schedule to unpublish the page by clicking `Add to Release`.\n4. Click `Unpublish`.\n5. Click `Save`.\n\n> For more information on how to manage a page in the Headless CMS, see the [Managing pages in the Headless CMS](https://read.calvincode.net/reader?url=https://newhelp.vtex.com/en/docs/tutorials/managing-pages) guides.\n\n### Query strings are not forwarded by default\n\nQuery string parameters (e.g., `?key=value`) are not forwarded in redirects by default. For example, a rule `/from` → `/to` will redirect `/from?key=value` to `/to`, dropping the `?key=value` portion.\n\n## Creating redirects\n\nFastStore allows you to configure redirects through the [discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options) file. This configuration is based on [Next.js redirects](https://read.calvincode.net/reader?url=https://nextjs.org/docs/pages/api-reference/next-config-js/redirects).\n\n> Projects hosted on Vercel have redirect limits, such as a maximum of 1,024 redirects in the array and a maximum string length of 4,096 for `source` and `destination` properties. (For details, see Vercel's [Redirects](https://read.calvincode.net/reader?url=https://vercel.com/docs/edge-network/redirects%23configuration) article.) If you need to configure more than 1,024 redirects, see the [(Beta) Enabling redirects using the enableRedirects flag](#beta-enabling-redirects-using-the-enableredirects-flag) section for an alternative workflow.\n\n1. Open your FastStore project in your preferred code editor and go to the `discovery.config.js` file within your project directory.\n2. Inside `discovery.config.js`, add the `redirects` function. This function will define your redirect rules, for example: \n`1 \naccount: \"{accountName}\", \n2 \n… \n3 \nasync redirects() { \n4 \n const redirects = require('./src/redirects.json'); \n5 \n return redirects; \n6 \n}, \n` \n> The `redirects` function requires the `redirects.json` file, which you will create in the next step. This file contains the redirect definitions.\n3. Go to the `src` folder, create the `redirects.json` file, and add the following: \n`1 \n[ \n2 \n { \n3 \n \"source\": \"/office\", \n4 \n \"destination\": \"/about\", \n5 \n \"permanent\": true \n6 \n } \n7 \n] \n` \n| Property name | Description | \n| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | \n| source | Original URL pattern that triggers the redirect. In this example, any URL starting with /office will be redirected. | \n| destination | New URL to which users are sent. Here, /about is the destination for users coming from /office. | \n| permanent | The type of redirect. Set to true for a permanent (308 status code) redirect, which search engines will cache. Set to false for a temporary (307 status code) redirect. | \n> For more information about each property, refer to the [Next.js](https://read.calvincode.net/reader?url=https://nextjs.org/docs/pages/api-reference/next-config-js/redirects) documentation.\n4. Run `yarn dev` to start your project in development mode.\n5. Open a browser and go to the old URL (e.g., `/office`). If the redirect is set up correctly, you should be automatically redirected to the new URL (e.g., `/about`).\n\n## (Beta) Enabling redirects using the `enableRedirects` flag\n\nFor projects requiring more than 1,024 redirects, you can enable the `enableRedirects` flag in the `discovery.config.js` file. This flag lets you manage redirects through the [Redirects](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/managing-url-redirects) feature in the VTEX Admin.\n\n> This workflow, which uses both a code configuration and the [Redirects](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/managing-url-redirects) interface, is currently in beta.\n\n1. Update your FastStore project to version `3.2.0` or higher. To do this, open your project in a code editor.\n2. Open a terminal and run the following command to update the FastStore packages to the latest version: \n`1 \nyarn upgrade -L --scope @faststore \n`\n3. With your FastStore project open, navigate to the `discovery.config.js` file in the project directory.\n4. Within the `experimental` section, add `enableRedirects: true` to enable the redirects feature in the project, for example: \ndiscovery.config.js \n`1 \n… \n2 \nexperimental: { \n3 \n ... \n4 \n enableRedirects: true, \n5 \n}, \n6 \n… \n`\n5. Run `yarn dev` to check for and address any errors before deploying this change to production.\n6. Create a new branch and open a pull request to deploy the changes made in the `discovery.config.js` file to production.\n\nOnce the change is live, you can manage the store's redirects in VTEX Admin by following the instructions in [Managing URL redirects](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/managing-url-redirects--3UJuFrU8imSVWg134mkvJV).\n\n## Creating rewrites\n\nFastStore leverages [Next.js rewrites](https://read.calvincode.net/reader?url=https://nextjs.org/docs/pages/api-reference/next-config-js/rewrites) to create custom routes while using existing Product Listing Page (PLP) templates. This allows you to map specific URLs to templates defined in Headless CMS, providing flexibility in content organization and URL structure.\n\nFor more information on using rewrites with a PLP template, refer to the [Using rewrites with PLP template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template%23product-listing-page-plp-template-selection-criteria) section in the Multiple Page Templates documentation.\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/routing/managing-urls-with-redirects-and-rewrite-paths.mdx)\n\n[Adding available installment information in PDP« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page)[Managing performanceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/managing-performance-overview)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Redirect behavior and caveats](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths%23redirect-behavior-and-caveats)\n\n[Native routes take precedence](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths%23native-routes-take-precedence)[Query strings are not forwarded by default](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths%23query-strings-are-not-forwarded-by-default)\n\n[Creating redirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths%23creating-redirects)\n\n[(Beta) Enabling redirects using the enableRedirects flag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths%23beta-enabling-redirects-using-the-enableredirects-flag)\n\n[Creating rewrites](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths%23creating-rewrites)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/routing/managing-urls-with-redirects-and-rewrite-paths.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Redirect behavior and caveats](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths%23redirect-behavior-and-caveats)\n\n[Native routes take precedence](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths%23native-routes-take-precedence)[Query strings are not forwarded by default](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths%23query-strings-are-not-forwarded-by-default)\n\n[Creating redirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths%23creating-redirects)\n\n[(Beta) Enabling redirects using the enableRedirects flag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths%23beta-enabling-redirects-using-the-enableredirects-flag)\n\n[Creating rewrites](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths%23creating-rewrites)\n\nOn this page\n\n[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=)"
}
] |
doc_8df8327d
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX store components infocard app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/troubleshooting)\n\n[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.store-components/InfoCard/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/vtex-io-apps)\n\nInfo Card\n\n[vtex.store-components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components)\n\nVersion: 3.178.5\n\nLatest version: 3.178.5\n\nThe `info-card` component groups information on a single topic. It often includes text, an image, and a call-to-action button.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme dependencies in the `manifest.json` file, as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.store-components\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `info-card` block to the desired page template.\n2. Add the `info-card` block to the same template file using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"info-card\": { \n\n2\n\n \"props\": { \n\n3\n\n \"id\": \"info-card-example\", \n\n4\n\n \"isFullModeStyle\": false, \n\n5\n\n \"textPosition\": \"left\", \n\n6\n\n \"imageUrl\": \"https://storecomponents.vteximg.com.br/arquivos/banner-infocard2.png\", \n\n7\n\n \"headline\": \"Clearance Sale\", \n\n8\n\n \"callToActionText\": \"DISCOVER\", \n\n9\n\n \"callToActionUrl\": \"/sale/d\", \n\n10\n\n \"blockClass\": \"info-card-example\", \n\n11\n\n \"textAlignment\": \"center\", \n\n12\n\n \"fetchpriority\": \"auto\", \n\n13\n\n \"preload\": true \n\n14\n\n } \n\n15\n\n }, \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| ---------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| blockClass | String | Extra class name for custom styling. | null |\n| callToActionLinkTarget | LinkTargetEnum | Where to display the call-to-action component's linked URL, as the name for a browsing context (a tab, window, or iframe). | \"\\_self\" |\n| callToActionMode | CallToActionEnum | Mode of the call-to-action component. | \"button\" |\n| callToActionText | string | Text displayed inside the call-to-action component. | \"\" |\n| callToActionUrl | string | URL of the call-to-action component. | \"\" |\n| headline | string | Headline of the Info Card. | null |\n| htmlId | string | ID of the container element. | null |\n| imageUrl | string | Path to the image used on desktop devices. | \"\" |\n| imageActionUrl | string | Redirect URL used when the image component is clicked. | \"\" |\n| isFullModeStyle | boolean | Style of the Info Card component. If true, the image component is used as the background, and text is displayed over it. | false |\n| linkTarget | LinkTargetEnum | Where to display the linked URL when the Info Card component is clicked. | \"\\_self\" |\n| mobileImageUrl | string | Path to the image used on mobile devices. If empty, the desktop image is used. | null |\n| subhead | string | Text to be displayed underneath the headline. If not provided, it will not be rendered. | null |\n| bodyText | string | Text to be displayed underneath the subhead. If not provided, it will not be rendered. | null |\n| textAlignment | TextAlignmentEnum | Text alignment inside the component: left, center or right. This prop is ignored if isFullModeStyle is true. | \"left\" |\n| textMode | TextModeEnum | Text mode used to process the text from headline and subhead props. | \"html\" |\n| textPosition | TextPositionEnum | Position of the text component: left, center or right. | \"left\" |\n| fetchpriority | string | The fetch priority hint ('high', 'low' or 'auto'). | |\n| auto | | | |\n| preload | boolean | Preloads the first image in a list, prioritizing the image display over other assets. | |\n| false | | | |\n\n#### `TextPositionEnum` possible values\n\n| Enum name | Enum value | Description |\n| --------- | ---------- | -------------------------------------------------------------------------------------- |\n| Left | 'left' | Text will be on the left. If isFullModeStyle is false, the image will be on the right. |\n| Center | 'center' | Text will be in the center. Not applicable if isFullModeStyle is false. |\n| Right | 'right' | Text will be on the right. If isFullModeStyle is false, the image will be on the left. |\n\n#### `CallToActionEnum` possible values\n\n| Enum name | Enum value | Description |\n| --------- | ---------- | ---------------------------------------------------------------- |\n| None | none | Does not render any call-to-action components. |\n| Button | button | Renders the call-to-action component as a button. |\n| Link | link | Renders the call-to-action component as a text in a link format. |\n\n#### `LinkTargetEnum` possible values\n\nThese values are the same ones supported by HTML5 anchor tags. For more information, please read the [MDN](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) documentation.\n\n| Enum name | Enum value | Description |\n| -------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Self (default) | \\_self | Opens the link in the current browsing context. |\n| Blank | \\_blank | Opens the link in a new tab, but users can configure browsers to open a new window instead. |\n| Parent | \\_parent | Opens the link in the parent browsing context of the current one. If there is no parent, it behaves as \\_self. |\n| Top | \\_top | Opens the link in the topmost browsing context (the \"highest\" context that is an ancestor of the current one). If there is no ancestor, it behaves as \\_self. |\n\n#### `TextModeEnum` possible values\n\n| Enum name | Enum value | Description |\n| --------- | ---------- | -------------------------------------------------------------------------------------------------------------------- |\n| HTML | html | Uses HTML text for headline and subhead props. |\n| Rich Text | rich-text | Uses markdown text and the [rich-text block](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/rich-text) for headline and subhead props. |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, please see the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| --------------------------- |\n| infoCardCallActionContainer |\n| infoCardCallActionText |\n| infoCardContainer |\n| infoCardHeadline |\n| infoCardImage |\n| infoCardImageContainer |\n| infoCardImageLinkWrapper |\n| infoCardSubhead |\n| infoCardBodyText |\n| infoCardTextContainer |\n\nSee also\n\n[Vtex.store ComponentsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/apps/vtex.store-components)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/apps/vtex.store-components/InfoCard%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/apps/vtex.store-components/InfoCard%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/InfoCard/docs/apps/vtex.store-components/InfoCard%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_3f917892
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex tracking in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/troubleshooting)\n\n[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-tracking/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/vtex-shipping-network)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/vtex-tracking)\n\n[Integrating external orders via API to be used with VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/integrate-external-orders-vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/multilevel-omnichannel-inventory)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/setting-up-white-label-seller-as-pickup-point)\n\n[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/delivery-promise)\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/vtex-shipping-network)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/vtex-tracking)\n\n[Integrating external orders via API to be used with VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/integrate-external-orders-vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/multilevel-omnichannel-inventory)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/setting-up-white-label-seller-as-pickup-point)\n\n[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/delivery-promise)\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides)\n\nLogistics\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking/docs/guides/vtex-tracking)\n\nVTEX Tracking\n\nVTEX Tracking is a VTEX solution focused on last mile delivery tracking.\n\nLearn more about it in our help center [VTEX Tracking overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-tracking-overview--1uDRquVudbPuoK05MtbZGh%23) or check the developer's guide on how to [Integrate external orders via API to be used with VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/integrating-external-orders-via-api-to-be-used-with-vtex-tracking).\n\nContributors\n\n1\n\n[](https://github.com/jumeyermattosarruda)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Fulfillment/vtex-tracking/vtex-tracking.md)\n\n[VTEX Shipping Network Labels Integration« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking//docs/guides/vtex-shipping-network-labels-integration)[Integrating external orders via API to be used with VTEX TrackingNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-tracking//docs/guides/integrate-external-orders-vtex-tracking)\n\nContributors\n\n1\n\n[](https://github.com/jumeyermattosarruda)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Fulfillment/vtex-tracking/vtex-tracking.md)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[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=)"
}
] |
doc_b341df02
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX store drawer app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/troubleshooting)\n\n[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.store-drawer/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.reviews-and-ratings)\n\n[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.reviews-and-ratings)\n\n[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/guides/advanced-components)\n\nDrawer\n\nOfficial extension\n\nVersion: 0.18.3\n\nLatest version: 0.18.3\n\n[](#contributors-)\n\nThe **Drawer** component is a sliding panel that displays additional options and menus when expanded. It is typically used in mobile layouts and responsive web designs where screen space is limited.\n\n\n\nWhen closed, the **Drawer** component is represented by an icon button positioned at the edge of the screen. Upon interaction, the drawer slides into view, revealing its content. Users can interact with the exposed content, perform actions, and navigate menus. To dismiss the drawer, users can either tap outside the drawer or use the close button.\n\n## Configuration\n\n1. Open your store theme in the code editor of your preference.\n2. Open the `manifest.json` file and add the `vtex.store-drawer` app to your store theme dependencies as in the following:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.store-drawer\": \"0.x\" \n\n3\n\n} \n\n`\n\n1. Add the `drawer` block to your app. The following example is from the [Store Theme](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme).\n\n`1\n\n\"drawer\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"menu#drawer\" \n\n4\n\n ] \n\n5\n\n}, \n\n6\n\n \n7\n\n\"menu#drawer\": { \n\n8\n\n \"children\": [ \n\n9\n\n \"menu-item#category-clothing\", \n\n10\n\n \"menu-item#category-decoration\", \n\n11\n\n \"menu-item#custom-sale\" \n\n12\n\n ], \n\n13\n\n \"props\": { \n\n14\n\n \"orientation\": \"vertical\" \n\n15\n\n } \n\n16\n\n}, \n\n`\n\n1. Use the `drawer-trigger` block to customize the icon that triggers the opening of the drawer as follows:\n\n`1\n\n\"drawer\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"menu#drawer\" \n\n4\n\n ], \n\n5\n\n \"blocks\": [\"drawer-trigger\"] \n\n6\n\n}, \n\n7\n\n \n8\n\n\"drawer-trigger\": { \n\n9\n\n \"children\": [\"rich-text#open-drawer\"] \n\n10\n\n}, \n\n11\n\n \n12\n\n\"rich-text#open-drawer\": { \n\n13\n\n \"props\": { \n\n14\n\n \"text\": \"Open drawer\" \n\n15\n\n } \n\n16\n\n} \n\n17\n\n \n18\n\n\"menu#drawer\": { \n\n19\n\n \"children\": [ \n\n20\n\n \"menu-item#category-clothing\", \n\n21\n\n \"menu-item#category-decoration\", \n\n22\n\n \"menu-item#custom-sale\" \n\n23\n\n ], \n\n24\n\n \"props\": { \n\n25\n\n \"orientation\": \"vertical\" \n\n26\n\n } \n\n27\n\n}, \n\n`\n\n1. Use the `drawer-header` block to customize the header containing the button that closes the drawer. For example:\n\n`` 1\n\n// blocks.json \n\n2\n\n{ \n\n3\n\n \"drawer\": { \n\n4\n\n \"blocks\": [\"drawer-header#my-drawer\"] \n\n5\n\n }, \n\n6\n\n \"drawer-header#my-drawer\": { \n\n7\n\n \"children\": [ \n\n8\n\n // you need to include the block `drawer-close-button` somewhere inside here \n\n9\n\n \"flex-layout.row#something\", \n\n10\n\n // ... \n\n11\n\n \"drawer-close-button\" \n\n12\n\n ] \n\n13\n\n } \n\n14\n\n} \n\n ``\n\n### Using the Drawer as a standalone component\n\nIf you are using this component as a standalone module, you will need to import it into the specific component where you want to use it. For example:\n\n`1\n\nimport { Drawer, DrawerHeader, DrawerCloseButton } from \"vtex.store-drawer\"; \n\n2\n\n \n3\n\nconst Menu = () => ( \n\n4\n\n <Drawer \n\n5\n\n header={ \n\n6\n\n <DrawerHeader> \n\n7\n\n <DrawerCloseButton /> \n\n8\n\n </DrawerHeader> \n\n9\n\n } \n\n10\n\n > \n\n11\n\n <ul> \n\n12\n\n <li>Link 1</li> \n\n13\n\n <li>Link 2</li> \n\n14\n\n <li>Link 3</li> \n\n15\n\n <li>Link 4</li> \n\n16\n\n <li>Link 5</li> \n\n17\n\n <li>Link 6</li> \n\n18\n\n </ul> \n\n19\n\n </Drawer> \n\n20\n\n); \n\n`\n\n### Props\n\n#### `drawer`\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| maxWidth | number or string | Defines the maximum width of the open drawer. | 450 |\n| isFullWidth | boolean | Controls whether the open drawer should occupy the full available width. | false |\n| slideDirection | 'horizontal'\\|'vertical'|'rightToLeft'|'leftToRight' | Controls the direction of the opening animation for the drawer. | 'horizontal' |\n| backdropMode | 'default'\\|'none' | Controls whether the backdrop should be displayed when the drawer is open. | |\n| renderingStrategy | 'lazy'\\|'eager' | Controls the rendering strategy for the children of the drawer component. It determines whether the children should be rendered only when the drawer is clicked (lazy) or immediately when the page loads (eager). Enabling the eager strategy may improve SEO performance. However, it may also result in slower page rendering. | 'lazy' |\n| customPixelEventId | string | Defines the store event ID responsible for triggering the drawer to automatically open on the interface. | undefined |\n| customPixelEventName | string | Defines the store event name responsible for triggering the drawer to automatically open on the interface. Some examples are: 'addToCart' and 'removeFromCart' events. Note that if no customPixelEventId is set, using this prop will cause the drawer to open in every event with the specified name. | undefined |\n\n#### `drawer-close-button`\n\n| Prop name | Type | Description | Default value |\n| --------- | ---------------- | ------------------------------------------------------------------------------------- | ------------- |\n| size | number | Defines the size of the icon inside the button. | 30 |\n| type | 'filled'\\|'line' | Defines the type of the icon. | 'line' |\n| text | string | Defines the text inside the button. The icon will not be rendered if text is defined. | undefined |\n\n#### `drawer-trigger`\n\n| Prop name | Type | Description | Default value |\n| ------------------ | ------ | ---------------------------------------------------------------------------------- | ------------- |\n| customPixelEventId | string | Defines the event ID to be sent whenever users interact with the Drawer component. | undefined |\n\n## Customization\n\nIn order to apply CSS customizations to this and other blocks, follow the instructions in [Using CSS handles for store customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS handles |\n| ---------------------- |\n| drawer |\n| opened |\n| overlay |\n| overlay--visible |\n| closed |\n| moving |\n| drawerContent |\n| drawerHeader |\n| drawerTriggerContainer |\n| openIconContainer |\n| closeIconContainer |\n| closeIconButton |\n| childrenContainer |\n\n[Similar Products Variants« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.similar-products-variants)[Store LocatorNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-locator)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-drawer%23configuration)\n\n[Using the Drawer as a standalone component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-drawer%23using-the-drawer-as-a-standalone-component)[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-drawer%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-drawer/docs/apps/vtex.store-drawer%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_56877f90
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation deploying the app stable version in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-deploying-the-app-stable-version/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/api-reference)\n\n[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-deploying-the-app-stable-version/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/storefront-development)\n\n[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-deploying-the-app-stable-version/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/troubleshooting)\n\n[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-deploying-the-app-stable-version/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n[Releasing a new app version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-releasing-a-new-app-version)\n\n[Publishing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-publishing-an-app)\n\n[Deploying the app's stable version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-deploying-the-app-stable-version)\n\n[Promoting a workspace to Master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n[Releasing a new app version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-releasing-a-new-app-version)\n\n[Publishing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-publishing-an-app)\n\n[Deploying the app's stable version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-deploying-the-app-stable-version)\n\n[Promoting a workspace to Master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/app-development)\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n[Deploying the app's stable version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-deploying-the-app-stable-version)\n\nDeploying the app's stable version\n\nThis guide will teach you how to deploy the latest stable version of your app so that all accounts having your app installed can be automatically updated with the new stable version.\n\n## Before you begin\n\nBefore proceeding any further, make sure the app you are about to deploy has already been [published](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-publishing-an-app) and tested. Note that deploying an app is one of the steps to **making your new app version publicly available**. Please refer to [this](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available) guide for more information.\n\nAlso, keep in mind that after publishing your app, you must wait 7 minutes before deploying it. Otherwise, you'll receive the following error: **Invalid state transition**. If you are deploying a **hotfix**, you can use the **`--force`** flag to instantly deploy your new app version. This flag is available only for VTEX IO CLI versions higher than `2.118.0`.\n\n## Instructions\n\nIf you have already published and validated your app, take the steps below to deploy your app's candidate version as a **stable version**.\n\n1. Open the terminal and log in to the account responsible for the app development, i.e., **the account specified as the app's vendor in the [manifest.json](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-manifest) file.**\n2. Deploy your new app version:\n* _Replace the values between the curly brackets according to your scenario._ \n`1 \nvtex deploy {appvendor}.{appname}@{appversion} \n`\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/vtex-io-documentation-making-your-new-app-version-publicly-available/vtex-io-documentation-deploying-the-app-stable-version.md)\n\n[Publishing an app« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version//docs/guides/vtex-io-documentation-publishing-an-app)[Promoting a workspace to MasterNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version//docs/guides/vtex-io-documentation-promoting-a-workspace-to-master)\n\nSee also\n\n[Promoting a workspace to MasterApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-deploying-the-app-stable-version%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-deploying-the-app-stable-version%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/vtex-io-documentation-making-your-new-app-version-publicly-available/vtex-io-documentation-deploying-the-app-stable-version.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-deploying-the-app-stable-version%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version/docs/guides/vtex-io-documentation-deploying-the-app-stable-version%23instructions)\n\nOn this page\n\n[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=)"
}
] |
doc_b0a08489
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation 5 definingstyles in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-5-definingstyles/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/api-reference)\n\n[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-5-definingstyles/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/storefront-development)\n\n[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-5-definingstyles/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/troubleshooting)\n\n[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-5-definingstyles/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/getting-started-3)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-1-basicsetup)\n\n[2\\. Configuring your account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-2-prerequesites)\n\n[3\\. Creating a Store Theme project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-3-settingyourstoretheme)\n\n[4\\. Configuring templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-4-configuringtemplates)\n\n[5\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-5-definingstyles)\n\n[6\\. Building your own store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme)\n\n[7\\. Making your store theme public](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-making-your-theme-content-public)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-glossary)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/getting-started-3)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-1-basicsetup)\n\n[2\\. Configuring your account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-2-prerequesites)\n\n[3\\. Creating a Store Theme project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-3-settingyourstoretheme)\n\n[4\\. Configuring templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-4-configuringtemplates)\n\n[5\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-5-definingstyles)\n\n[6\\. Building your own store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme)\n\n[7\\. Making your store theme public](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-making-your-theme-content-public)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-glossary)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/store-framework)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/getting-started-3)\n\n[5\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-5-definingstyles)\n\n5\\. Defining styles\n\nLearn how to set specific styles for your store components to enhance your store's user experience.\n\nAfter understanding blocks and templates and how they render interface components, this guide will show you how to customize them to match your store identity.\n\nThe Store Theme allows you to:\n\n* [Set a default style for all store components](#setting-a-default-style-for-all-store-components)\n* [Set a specific style for a component type or a single component](#setting-a-specific-style-for-a-component-type-or-a-single-component)\n\n## Setting a default style for all store components\n\nTo set the default style for your store, you can use the `style.json` file in the `style` folder of the Store Theme app. This single file allows you to customize the appearance of your store by modifying the default definitions declared within it. This approach avoids the need to customize individual components on each page.\n\nFor example, you can set the default theme background color to blue by changing the `semanticColors` block's `base` property:\n\n`1\n\n\"semanticColors\": { \n\n2\n\n \"background\": { \n\n3\n\n \"base\": \"#00BFFF\", \n\n4\n\n \"base--inverted\": \"#03044e\", \n\n5\n\n \"action-primary\": \"#0F3E99\", \n\n6\n\n \"action-secondary\": \"#eef3f7\", \n\n7\n\n \"emphasis\": \"#f71963\", \n\n8\n\n \"disabled\": \"#f2f4f5\", \n\n9\n\n \"success\": \"#8bc34a\", \n\n10\n\n \"success--faded\": \"#eafce3\", \n\n11\n\n \"danger\": \"#ff4c4c\", \n\n12\n\n \"danger--faded\": \"#ffe6e6\", \n\n13\n\n \"warning\": \"#ffb100\", \n\n14\n\n \"warning--faded\": \"#fff6e0\", \n\n15\n\n \"muted-1\": \"#727273\", \n\n16\n\n \"muted-2\": \"#979899\", \n\n17\n\n \"muted-3\": \"#cacbcc\", \n\n18\n\n \"muted-4\": \"#e3e4e6\", \n\n19\n\n \"muted-5\": \"#f2f4f5\" \n\n20\n\n }, \n\n21\n\n} \n\n`\n\n> The `styles.json` file only accepts [HEX values](https://read.calvincode.net/reader?url=https://www.w3schools.com/html/html%5Fcolors%5Fhex.asp) to set a color. Using other formats, such as RGB, may break the PWA module.\n\nFor detailed instructions on customizing your theme, see the [VTEX Styleguide](https://read.calvincode.net/reader?url=https://styleguide.vtex.com/%23/Styles), a comprehensive CSS framework with guidelines for defining component styles. It includes a detailed explanation of the `styles.json` file structure to help you in your customizations.\n\n## Setting a specific style for a component type or a single component\n\nThe `style.json` file enables more generic customization of your store visual style and can be useful in most scenarios.\n\nIf you want to create a more distinctive store identity with certain elements featuring unique styles different from the default theme, consider this scenario: Imagine your store primarily uses blue as its main color, but you want the text components (created by `rich-text` blocks) to display in red. To make only one specific text component red while keeping the rest in the default blue color, you can achieve this advanced customization by overriding the default styles defined in `styles.json`. This can be done using CSS handles and the `blockClass` prop.\n\nTo apply advanced customization to your store style, see the guide [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/).\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/getting-started-3/vtex-io-documentation-5-definingstyles.md)\n\n[4\\. Configuring templates« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles//docs/guides/vtex-io-documentation-4-configuringtemplates)[6\\. Building your own store themeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles//docs/guides/vtex-io-documentation-6-buildingyourownstoretheme)\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Setting a default style for all store components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-5-definingstyles%23setting-a-default-style-for-all-store-components)\n\n[Setting a specific style for a component type or a single component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-5-definingstyles%23setting-a-specific-style-for-a-component-type-or-a-single-component)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/getting-started-3/vtex-io-documentation-5-definingstyles.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Setting a default style for all store components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-5-definingstyles%23setting-a-default-style-for-all-store-components)\n\n[Setting a specific style for a component type or a single component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles/docs/guides/vtex-io-documentation-5-definingstyles%23setting-a-specific-style-for-a-component-type-or-a-single-component)\n\nOn this page\n\n[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=)"
}
] |
doc_b0517c58
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain troubleshooting my store is presenting price inconsistencies in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n---\n\nStore performance\n\n[I can't complete a purchase on a FastStore website](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website)\n\n[My store is slow or unavailable](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/my-store-is-slow-or-unavailable)\n\n[Google Analytics 4 is tracking inconsistent data from my store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store)\n\n[UTMs are not being applied to the cart at Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/utms-are-not-being-applied-to-the-cart-at-checkout)\n\n[My routes are not behaving as expected](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/my-routes-are-not-behaving-as-expected)\n\n[My store is presenting price inconsistencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/my-store-is-presenting-price-inconsistencies)\n\n[My store translation is not behaving as expected](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n---\n\nStore performance\n\n[I can't complete a purchase on a FastStore website](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website)\n\n[My store is slow or unavailable](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/my-store-is-slow-or-unavailable)\n\n[Google Analytics 4 is tracking inconsistent data from my store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store)\n\n[UTMs are not being applied to the cart at Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/utms-are-not-being-applied-to-the-cart-at-checkout)\n\n[My routes are not behaving as expected](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/my-routes-are-not-behaving-as-expected)\n\n[My store is presenting price inconsistencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/my-store-is-presenting-price-inconsistencies)\n\n[My store translation is not behaving as expected](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected)\n\n---\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting)\n\nStore performance\n\nMy store is presenting price inconsistencies\n\nProduct price is different on Search Results and Product Detail pages.\n\n**Keywords:** Catalog | Search | Pricing\n\nThe Search Results and Product Details pages have different indexing processes. This can lead to differences in price.\n\nIf your store is presenting inconsistencies, follow the instructions below.\n\n## Reindex Catalog and disable Search Result cache\n\nTo correct the inconsistencies:\n\n1. [Reindex](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/i-cant-index-a-product-in-the-catalog--5ZKLTqnCyGbWEYGPTCBIxI) the products that have inconsistencies in Catalog.\n2. Check the value set for the `simulationBehavior` property of the [Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result) app. If it's set to `skip`, change it to `default`.\n\n> When the `simulationBehavior` is set to `skip`, the Search Results page displays the old price based on the user cache. To fetch and display the latest price in Catalog, change it to `default`.\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/henriquessb)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/store-performance/my-store-is-presenting-price-inconsistencies.md)\n\n[My routes are not behaving as expected« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/my-routes-are-not-behaving-as-expected)[My store translation is not behaving as expectedNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[Reindex Catalog and disable Search Result cache](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/my-store-is-presenting-price-inconsistencies%23reindex-catalog-and-disable-search-result-cache)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/store-performance/my-store-is-presenting-price-inconsistencies.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Reindex Catalog and disable Search Result cache](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-is-presenting-price-inconsistencies/docs/troubleshooting/my-store-is-presenting-price-inconsistencies%23reindex-catalog-and-disable-search-result-cache)\n\nOn this page\n\n[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=)"
}
] |
doc_d8227c68
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore themes overview in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/troubleshooting)\n\n[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/themes-overview/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/themes-overview)\n\n[Soft blue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/themes-soft-blue)\n\n[Midnight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/themes-midnight)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/using-themes-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/themes-overview)\n\n[Soft blue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/themes-soft-blue)\n\n[Midnight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/themes-midnight)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/using-themes-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/styling-overview)\n\nOverview\n\nBy default, every FastStore project comes with the [Brandless theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview%23brandless-and-the-theming-structure). However, you have the option to use one of the [available themes](#available-themes) or [create a custom theme](#creating-a-custom-theme).\n\n> You have the flexibility and freedom to style the theme by overriding it using global or local tokens, or by starting from scratch using your preferred styling tool.\n\n---\n\n## Available Themes\n\n[Midnight](/docs/guides/faststore/themes-midnight)[Soft Blue](/docs/guides/faststore/themes-soft-blue)\n\n---\n\n## Creating a Custom Theme\n\n1. Open your starter project and create a new `.scss` file on `src/themes` (e.g. `my-theme.scss`).\n2. Add the tokens you want to overwrite inside the `.theme` class.\n\n> If you want, you can work on `custom-theme.scss` file that's ready to use. We are using [CSS cascade layers](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Learn/CSS/Building%5Fblocks/Cascade%5Flayers) feature to better deal with styling specificities issues, so keeping the `@layer theme` in the file is recommended.\n\nsrc/themes/my-theme.scss\n\n`1\n\n \n2\n\n@layer theme { \n\n3\n\n .theme { \n\n4\n\n // -------------------------------------------------------- \n\n5\n\n // Colors (Branding Core) \n\n6\n\n // -------------------------------------------------------- \n\n7\n\n \n8\n\n // -------------------------------------------------------- \n\n9\n\n // Typography (Branding Core) \n\n10\n\n // -------------------------------------------------------- \n\n11\n\n \n12\n\n // -------------------------------------------------------- \n\n13\n\n // Spacing (UI Essentials) \n\n14\n\n // -------------------------------------------------------- \n\n15\n\n \n16\n\n // -------------------------------------------------------- \n\n17\n\n // Grid & Layout (UI Essentials) \n\n18\n\n // -------------------------------------------------------- \n\n19\n\n \n20\n\n // -------------------------------------------------------- \n\n21\n\n // Interactive Controls (UI Essentials) \n\n22\n\n // -------------------------------------------------------- \n\n23\n\n \n24\n\n // -------------------------------------------------------- \n\n25\n\n // Refinements \n\n26\n\n // -------------------------------------------------------- \n\n27\n\n \n28\n\n // -------------------------------------------------------- \n\n29\n\n // FS UI Components \n\n30\n\n // -------------------------------------------------------- \n\n31\n\n // Add here the customizations for FastStore UI components. \n\n32\n\n } \n\n33\n\n} \n\n`\n\n1. Go to `discovery.config.js` and change the `theme` from `custom-theme` to your file's name, for example:\n\ndiscovery.config.js\n\n`1\n\ntheme: 'my-theme', \n\n`\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/styling/themes/overview.mdx)\n\n[Styling« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/styling-overview)[Soft blueNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/themes-soft-blue)\n\nSee also\n\n[3\\. Running the project locallyStorefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/getting-started-2-setting-up-the-project)[Global TokensStorefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/global-tokens-overview)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Available Themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/themes-overview%23available-themes)\n\n[Creating a Custom Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/themes-overview%23creating-a-custom-theme)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/styling/themes/overview.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Available Themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/themes-overview%23available-themes)\n\n[Creating a Custom Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview/docs/guides/faststore/themes-overview%23creating-a-custom-theme)\n\nOn this page\n\n[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=)"
}
] |
doc_ee7a1588
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation business guidelines app monetization in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-business-guidelines-app-monetization/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/api-reference)\n\n[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-business-guidelines-app-monetization/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/storefront-development)\n\n[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-business-guidelines-app-monetization/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/troubleshooting)\n\n[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-business-guidelines-app-monetization/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-app-store)\n\n[Becoming a registered VTEX App Store developer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer)\n\n[Developing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-developing-an-app)\n\n[Setting your app's billing model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-setting-your-apps-billing-model)\n\n[Preparing your app for distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-preparing-your-app-distribution)\n\n[Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)\n\n[Using the Docs builder to publish app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/using-the-docs-builder-to-publish-app-documentation)\n\n[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n[App monetization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-app-monetization)\n\n[Marketing guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets)\n\n[User Experience guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-design-guidelines)\n\n[Engineering guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-engineering-guidelines)\n\n[Documentation guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-docs-guidelines)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-app-store)\n\n[Becoming a registered VTEX App Store developer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer)\n\n[Developing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-developing-an-app)\n\n[Setting your app's billing model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-setting-your-apps-billing-model)\n\n[Preparing your app for distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-preparing-your-app-distribution)\n\n[Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)\n\n[Using the Docs builder to publish app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/using-the-docs-builder-to-publish-app-documentation)\n\n[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n[App monetization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-app-monetization)\n\n[Marketing guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets)\n\n[User Experience guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-design-guidelines)\n\n[Engineering guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-engineering-guidelines)\n\n[Documentation guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-docs-guidelines)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/app-development)\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-app-store)\n\n[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n[App monetization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-app-monetization)\n\nApp monetization\n\nApp Store's business models are flexible and, thus, adaptable to different scenarios for marketing your app.\n\nCurrently, there are two models available:\n\n* [Free distribution](#free-distribution)\n* [Paid distribution](#paid-distribution)\n\n> The business model is defined in the `billingOptions` field of the app's `manifest.json` file. Check out our documentation on [Setting your app's billing model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model) to learn how to set up the most suitable billing type.\n\n## Free distribution\n\nEven with different monetization possibilities, you can offer your app for free, without installation costs for users. In this case, the fees for the app distribution through the VTEX App Store are defined in a business partnership with the VTEX team prior to the homologation of the app.\n\n## Paid distribution\n\n### Fixed fee\n\nA simplified billing option, recommended for projects with low infrastructure costs in which you set a single monthly fee to distribute the application. Therefore, all users interested in using your software would pay the same amount, regardless of how long they use it.\n\n### Variable fee\n\nVariable pricing based on metrics predefined in the application code. For example, for an SMS sender app, the billing metric could be the number of messages sent per user.\n\n### Hybrid fee\n\nThis is a more sophisticated billing model, in which fixed and variable prices can be combined into predefined metrics in the application code. Considering the example of the previous topic, in the Hybrid fee model, you would define a variable fee depending on the number of messages sent by users.\n\n## Revenue share\n\nIn all the scenarios presented above, a revenue-sharing fee will be applied to the app's pricing to commercialize it in the VTEX App Store:\n\n| Business model | Amount | Billing |\n| ----------------- | ----------------- | ------------------------------------------------------------------------------ |\n| Free distribution | Negotiable (in %) | Percentage to be defined in the trade agreement with the VTEX partner program. |\n| Paid distribution | 25% | Percentage charged on the total value of approved app orders. |\n\n> Your app's invoices will be available in the Billing module of the VTEX Admin. In this format, you, as the person responsible for the application, must issue an invoice so that VTEX can make the appropriate financial transfers following the split agreed upon in the business model. You can also track the app's sales using our Order Management System (OMS), which is integrated into the admin panel of your VTEX account.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Perks/vtex-io-documentation-homologation-requirements-for-vtex-app-store/vtex-io-documentation-business-guidelines-app-monetization.md)\n\n[App Store Guidelines« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization//docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)[Marketing guidelinesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization//docs/guides/vtex-io-documentation-business-guidelines-marketing-assets)\n\nSee also\n\n[Marketing guidelinesApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Free distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-app-monetization%23free-distribution)\n\n[Paid distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-app-monetization%23paid-distribution)\n\n[Fixed fee](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-app-monetization%23fixed-fee)[Variable fee](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-app-monetization%23variable-fee)[Hybrid fee](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-app-monetization%23hybrid-fee)\n\n[Revenue share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-app-monetization%23revenue-share)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Perks/vtex-io-documentation-homologation-requirements-for-vtex-app-store/vtex-io-documentation-business-guidelines-app-monetization.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Free distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-app-monetization%23free-distribution)\n\n[Paid distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-app-monetization%23paid-distribution)\n\n[Fixed fee](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-app-monetization%23fixed-fee)[Variable fee](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-app-monetization%23variable-fee)[Hybrid fee](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-app-monetization%23hybrid-fee)\n\n[Revenue share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization/docs/guides/vtex-io-documentation-business-guidelines-app-monetization%23revenue-share)\n\nOn this page\n\n[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=)"
}
] |
doc_95c6cd80
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides understanding vtex reference architectures in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/vtex-platform-overview)\n\n[Cloud infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/cloud-infrastructure)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/security)\n\n[Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/data-privacy)\n\n[Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/composability)\n\n[Extensibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/extensibility)\n\n[Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/store-architecture)\n\n[Understanding VTEX reference architectures](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/understanding-vtex-reference-architectures)\n\n[Developer experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/developer-experience)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/vtex-platform-overview)\n\n[Cloud infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/cloud-infrastructure)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/security)\n\n[Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/data-privacy)\n\n[Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/composability)\n\n[Extensibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/extensibility)\n\n[Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/store-architecture)\n\n[Understanding VTEX reference architectures](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/understanding-vtex-reference-architectures)\n\n[Developer experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/developer-experience)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides)\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/vtex-platform-overview)\n\n[Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/store-architecture)\n\n[Understanding VTEX reference architectures](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/understanding-vtex-reference-architectures)\n\nUnderstanding VTEX reference architectures\n\nLearn how each element is represented in VTEX reference architectures.\n\nThe VTEX reference architectures follow a common market methodology that segments the main agents involved in the solution in a simple, orderly, and logical manner. The design structure highlights the systems in blocks, colors, and objective descriptions of connections, facilitating visualization and understanding for all stakeholders.\n\nIn this guide, you will learn how each element is represented in VTEX architectures, considering the [characteristics of the modules](#captions-colors-and-connections):\n\n* [Macroelements: Layers](#macroelements-layers)\n* [Microelements: Components](#microelements-components) \n * [Merchant Channels](#merchant-channels) \n * [VTEX Core Services](#vtex-core-services) \n * [Third-Party](#third-party) \n * [Back Office](#back-office)\n\n## Captions, colors, and connections\n\nDifferent colors are used to identify the characteristics of the modules presented, indicating where they are executed and which involved party provides them.\n\nUnderstand the meaning of each representation below:\n\n\n\n1. **Module code developed exclusively by VTEX with execution in VTEX infrastructure**: Pink background and pink border.\n2. **Module code not developed exclusively by VTEX (customizations) with execution in VTEX infrastructure**: White background and pink border.\n3. **Module code not developed exclusively by VTEX (customizations) with execution outside VTEX infrastructure**: White background and black border.\n4. **Back office services, which are executed outside VTEX infrastructure**: Gray background and black border.\n5. **Optional module (e.g., Integration Layers)**: Dashed border.\n\nThe connection between modules and systems should be represented with arrows, where the arrowheads indicate the direction of the information and its return:\n\n1. **Black arrows**: Used for asynchronous calls, which are not real-time.\n2. **Blue arrows**: Used for synchronous calls, in real-time.\n\n## Macroelements: Layers\n\nThe macroelements represent the entities involved in the project. In general, four major layers are considered: **Merchant Channels**, **VTEX Core Services**, **Third-Party**, and **Back Office**.\n\n\n\nEach of these layers has microelements, which are the components that constitute the project. These components can be modules, apps, integration systems, sellers, sales channels, or any other component relevant to the architecture.\n\n## Microelements: Components\n\nNow that we know about the macro-elements, we can understand the components that constitute the four major layers: [Merchant Channels](#merchant-channels), [VTEX Core Services](#vtex-core-services), [Third-Party](#third-party), and [Back Office](#back-office).\n\n### Merchant Channels\n\nMerchant channels are digital sales channels used by the store, such as the website, PWA, and mobile app.\n\n\n\n### VTEX Core Services\n\nVTEX Core Services are the essential components or frameworks provided by VTEX within the platform. These services include modules, such as [Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview), [Order Management System (OMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-overview), [Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-overview). They constitute the foundation of the VTEX platform, empowering businesses to effectively manage and conduct their ecommerce operation strategies.\n\nIn a [B2C store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-architecture) architecture, the diagram below presents the blocks with a pink background and border, representing the native components of VTEX.\n\n\n\nWithin the main block, there is the **VTEX IO - Apps** block, which contains the custom apps for [frontend](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io), [backend](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io), and [Admin](https://read.calvincode.net/reader?url=https://learn.vtex.com/docs/course-admin-lang-en).\n\n> Although they are executed on VTEX infrastructure, the development and maintenance of custom apps for the frontend, backend, and VTEX Admin must be done by the store development team.\n\nAlso within the VTEX IO - Apps block, you will find the [VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps), which are plug-and-play solutions developed and maintained by VTEX.\n\n### Third-Party\n\nThird-party systems or modules, which are executed and maintained externally to VTEX, include payment providers, data monitoring systems, and customization services. Depending on business needs, third-party systems or modules could replace a native VTEX feature or provide a completely new one.\n\n\n\n### Back Office\n\nAn ecommerce operation may use several external systems to manage its resources and information, such as Enterprise Resource Planning (ERP), Customer Relationship Management (CRM), and Warehouse Management System (WMS).\n\nThese systems belong to the [Merchant Back office](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide) layer, as illustrated in the following diagram:\n\n\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Platform-Overview/store-architecture/understanding-vtex-reference-architectures.md)\n\n[Store architecture« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures//docs/guides/store-architecture)[Developer experienceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures//docs/guides/developer-experience)\n\nSee also\n\n[Store architectureGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/store-architecture)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Captions, colors, and connections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/understanding-vtex-reference-architectures%23captions-colors-and-connections)\n\n[Macroelements: Layers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/understanding-vtex-reference-architectures%23macroelements-layers)\n\n[Microelements: Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/understanding-vtex-reference-architectures%23microelements-components)\n\n[Merchant Channels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/understanding-vtex-reference-architectures%23merchant-channels)[VTEX Core Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/understanding-vtex-reference-architectures%23vtex-core-services)[Third-Party](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/understanding-vtex-reference-architectures%23third-party)[Back Office](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/understanding-vtex-reference-architectures%23back-office)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Platform-Overview/store-architecture/understanding-vtex-reference-architectures.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Captions, colors, and connections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/understanding-vtex-reference-architectures%23captions-colors-and-connections)\n\n[Macroelements: Layers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/understanding-vtex-reference-architectures%23macroelements-layers)\n\n[Microelements: Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/understanding-vtex-reference-architectures%23microelements-components)\n\n[Merchant Channels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/understanding-vtex-reference-architectures%23merchant-channels)[VTEX Core Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/understanding-vtex-reference-architectures%23vtex-core-services)[Third-Party](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/understanding-vtex-reference-architectures%23third-party)[Back Office](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-vtex-reference-architectures/docs/guides/understanding-vtex-reference-architectures%23back-office)\n\nOn this page\n\n[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=)"
}
] |
doc_8c0e87ef
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides store framework glossary in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/getting-started-3)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-1-basicsetup)\n\n[2\\. Configuring your account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-2-prerequesites)\n\n[3\\. Creating a Store Theme project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-3-settingyourstoretheme)\n\n[4\\. Configuring templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-4-configuringtemplates)\n\n[5\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-5-definingstyles)\n\n[6\\. Building your own store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme)\n\n[7\\. Making your store theme public](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-making-your-theme-content-public)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/getting-started-3)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-1-basicsetup)\n\n[2\\. Configuring your account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-2-prerequesites)\n\n[3\\. Creating a Store Theme project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-3-settingyourstoretheme)\n\n[4\\. Configuring templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-4-configuringtemplates)\n\n[5\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-5-definingstyles)\n\n[6\\. Building your own store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme)\n\n[7\\. Making your store theme public](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-making-your-theme-content-public)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/getting-started-3)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary)\n\nGlossary\n\n## A\n\n### Analytics\n\nTools and practices for examining data to gain insights or track performance. In the [Store Framework](#store-framework) context, analytics help store owners understand customer behavior and optimize their operations. Learn more in [Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-analytics).\n\n---\n\n## B\n\n### Bindings\n\nProcess of linking a website, a store name, and a [trade policy](#trade-policy) to create a unique identifier for each store, allowing multiple storefronts to operate within the same VTEX account. Learn more in [What is binding?](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-binding--4NcN3NJd0IeYccgWCI8O2W).\n\n### Blocks\n\nFundamental building units of a storefront’s layout used to structure and customize pages in [Store Framework](#store-framework). They are declared in the `blocks` section of the [Store Theme](#store-theme)’s app JSON files, allowing for a modular and reusable approach to storefront development. Learn more in [Blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition%23blocks).\n\n### Builders\n\nModules defined in the `manifest.json` file that specify the functionality of an app. They categorize the app’s features, such as [store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder) for storefront elements, [react](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder) for UI components, and [node](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder) for backend app development, among others. Learn more in [Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders).\n\n---\n\n## C\n\n### Children\n\nA [composition](#composition) type that allows flexible ordering of child [blocks](#blocks). Child blocks are listed in a `children` array, and their sequence determines their positioning on the page, enabling dynamic layout control for store themes. Learn more in [Children](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition%23children).\n\n### Content Management System (CMS)\n\nA tool that allows you to create, manage, and publish digital content easily, without needing advanced technical skills. In Store Framework, [Site Editor](#site-editor) functions as a Content Management System (CMS), reflecting the blocks defined in the [Store Theme](#store-theme) of the VTEX account. Learn more in [CMS Overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/6OCY6S9tqBXPD5mgpbBInC).\n\n### Components\n\nBuilding [blocks](#blocks) used to create storefronts and admin apps. These blocks accept [properties](#properties-props) and return React elements to define what is displayed in the user interface. They range from basic elements (such as buttons and forms) to complex features (such as product carousels and navigation bars). Learn more in [Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components).\n\n### Composition\n\nA property in the `interfaces.json` file that defines how [React](https://read.calvincode.net/reader?url=https://react.dev/) components are organized and structured within a parent-child hierarchy in a [Store Theme](#store-theme). There are three types of composition: [blocks](#blocks), [children](#children), and [slots](#slots). Learn more in [Composition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition).\n\n### CSS Handles\n\nA CSS class that maps to an HTML element. It serves as a layout-building assistant for your store, allowing you to customize any block by applying CSS classes within the [Store Theme](#store-theme) code. Learn more in [Using CSS handles for store customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n---\n\n## D\n\n### Dependencies\n\nA property (#properties-props) in the `manifest.json` file that specifies other [VTEX IO apps](#vtex-io-apps) that an app requires to function. Dependencies ensure that required apps are automatically installed when your app is installed. Learn more in [Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-dependencies).\n\n---\n\n## I\n\n### Interfaces\n\nRules defined in the `interfaces.json` file that link a [block](#blocks) to a [component](#components), enabling storefront development. These rules define the block's behavior, available [properties](#properties-props), and methods used during rendering. Learn more in [Interfaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface).\n\n---\n\n## J\n\n### JSON Schema\n\nA declarative format for defining the structure, constraints, and default values of JSON data. Used in [Store Framework](#store-framework), it ensures consistency and validation in app configurations, such as [blocks](#blocks) or [components](#components), by specifying data types, required fields, and allowed values. Learn more in [JSON Schema](https://read.calvincode.net/reader?url=https://json-schema.org/).\n\n---\n\n## M\n\n### Manifest\n\nA document containing metadata that defines and shapes the core attributes and features of a [VTEX IO app](#vtex-io-app). Learn more in [Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest).\n\n---\n\n## P\n\n### Peer dependencies\n\nDeclared in the `manifest.json` file under the `peerDependencies` field, these specify other [VTEX IO apps](#vtex-io-apps) required for an app to function. Unlike regular [dependencies](#dependencies), peer dependencies aren’t automatically installed when the app is installed. Instead, users must manually ensure their installation. They are often used in scenarios where an app relies on specific major versions of other apps, or when it depends on paid apps that may not be included by default. Learn more in [Peer dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies).\n\n### Properties (props)\n\nKey-value pairs used to define the behavior and appearance of [components](#components) in the [Store Framework](#store-framework). They provide flexibility and customization, allowing developers to configure various aspects of a component, such as layout, functionality, and styling, within the storefront. Learn more in [Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-properties).\n\n---\n\n## R\n\n### Routes\n\nRoutes are configurations that map URL patterns and HTTP methods to specific actions, determining how an application handles incoming client requests. In the context of [Store Framework](#store-framework), routing is managed by the [Rewriter app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter) and [Store Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder), enabling developers to focus on defining route paths and designing page templates without managing low-level routing logic directly. Learn more in [Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-routing).\n\n---\n\n## S\n\n### Search Engine Optimization (SEO)\n\nPractices and techniques to improve a website’s visibility and ranking on search engines. Learn more in [SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo).\n\n### Site Editor\n\nA [Content Management System (CMS)](#content-management-system-cms) for stores built with [Store Framework](#store-framework). It reflects [blocks](#blocks) defined in the [Store Theme](#store-theme), allowing non-technical users to edit content, modify components, and update storefronts via a user-friendly interface. Learn more in [Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-site-editor).\n\n### Sitemap\n\nFile listing all pages of a website, typically used for [SEO](#search-engine-optimization-seo) purposes, ensuring search engines can index pages effectively.\n\n### Slots\n\nA [composition](#composition) type that allows developers to pass [components](#components) as [props](#properties-props) directly, offering an alternative to [blocks](#blocks) composition in [Store Framework](#store-framework). Learn more in [Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots).\n\n### Store Framework\n\nVTEX framework for creating ecommerce storefronts, leveraging [React](https://read.calvincode.net/reader?url=https://react.dev/) and [VTEX IO](#vtex-io) development platform. It offers native storefront [components](#components) to develop scalable and efficient online stores. Learn more in [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework).\n\n### Store Theme\n\nA [VTEX IO app](#vtex-io-app) that defines a storefront’s appearance and functionality. Learn more in [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme).\n\n---\n\n## T\n\n### Trade policy\n\nA set of configurations on the VTEX platform that define catalog, pricing, promotions, logistics, and payments for specific sales strategies. Trade policies are used to segment sales conditions across different channels (for example, B2B, marketplaces), adapting store navigation and offerings based on the user type. Learn more in [How trade policies work](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV).\n\n---\n\n## V\n\n### VTEX App Store\n\nA marketplace for [VTEX IO](#vtex-io) plug-and-play solutions, where both first-party and third-party apps can be published and downloaded by clients and partners. Learn more in [VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store).\n\n### VTEX IO\n\nA cloud-based development platform designed to enhance the agility and autonomy of creating and managing online stores. It allows for the streamlined and independent development of applications and new software, supporting multiple environments known as [workspaces](#workspaces). Learn more in [What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io).\n\n### VTEX IO apps\n\nModular applications developed to extend or customize the VTEX platform. Developed using VTEX IO's framework, these apps can range from frontend components for Store Framework to backend services, like payment gateways and integrations with third-party tools. VTEX IO apps can also be distributed through the VTEX App Store, offering a straightforward way to install, update, and maintain functionality across VTEX stores. Learn more in [What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app).\n\n### VTEX IO CLI\n\nA command-line interface for developers to interact with the [VTEX IO](#vtex-io) platform. It enables linking local files, managing [workspaces](#workspaces), releasing app versions, and performing essential development tasks. The CLI is central to the VTEX IO development workflow. Learn more in [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).\n\n---\n\n## W\n\n### Workspaces\n\nIsolated environments within a VTEX account that act as separate versions for app development in VTEX IO. Similar to branches in [Git](https://read.calvincode.net/reader?url=https://git-scm.com/), workspaces enable safe testing, development, and deployment of new features and updates. Learn more in [Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace).\n\n---\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework-glossary.md)\n\n[7\\. Making your store theme public« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary//docs/guides/vtex-io-documentation-making-your-theme-content-public)[CompositionNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary//docs/guides/vtex-io-documentation-composition)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[A](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23a)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23analytics)\n\n[B](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23b)\n\n[Bindings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23bindings)[Blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23blocks)[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23builders)\n\n[C](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23c)\n\n[Children](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23children)[Content Management System (CMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23content-management-system-cms)[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23components)[Composition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23composition)[CSS Handles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23css-handles)\n\n[D](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23d)\n\n[Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23dependencies)\n\n[I](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23i)\n\n[Interfaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23interfaces)\n\n[J](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23j)\n\n[JSON Schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23json-schema)\n\n[M](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23m)\n\n[Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23manifest)\n\n[P](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23p)\n\n[Peer dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23peer-dependencies)[Properties (props)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23properties-props)\n\n[R](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23r)\n\n[Routes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23routes)\n\n[S](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23s)\n\n[Search Engine Optimization (SEO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23search-engine-optimization-seo)[Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23site-editor)[Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23sitemap)[Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23slots)[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23store-framework)[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23store-theme)\n\n[T](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23t)\n\n[Trade policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23trade-policy)\n\n[V](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23v)\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23vtex-app-store)[VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23vtex-io)[VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23vtex-io-apps)[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23vtex-io-cli)\n\n[W](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23w)\n\n[Workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23workspaces)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework-glossary.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[A](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23a)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23analytics)\n\n[B](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23b)\n\n[Bindings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23bindings)[Blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23blocks)[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23builders)\n\n[C](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23c)\n\n[Children](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23children)[Content Management System (CMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23content-management-system-cms)[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23components)[Composition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23composition)[CSS Handles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23css-handles)\n\n[D](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23d)\n\n[Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23dependencies)\n\n[I](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23i)\n\n[Interfaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23interfaces)\n\n[J](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23j)\n\n[JSON Schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23json-schema)\n\n[M](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23m)\n\n[Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23manifest)\n\n[P](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23p)\n\n[Peer dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23peer-dependencies)[Properties (props)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23properties-props)\n\n[R](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23r)\n\n[Routes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23routes)\n\n[S](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23s)\n\n[Search Engine Optimization (SEO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23search-engine-optimization-seo)[Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23site-editor)[Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23sitemap)[Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23slots)[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23store-framework)[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23store-theme)\n\n[T](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23t)\n\n[Trade policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23trade-policy)\n\n[V](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23v)\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23vtex-app-store)[VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23vtex-io)[VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23vtex-io-apps)[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23vtex-io-cli)\n\n[W](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23w)\n\n[Workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-glossary/docs/guides/store-framework-glossary%23workspaces)\n\nOn this page\n\n[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=)"
}
] |
doc_469e5c4a
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation frequently asked questions in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-frequently-asked-questions/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/api-reference)\n\n[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-frequently-asked-questions/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/storefront-development)\n\n[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-frequently-asked-questions/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/troubleshooting)\n\n[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-frequently-asked-questions/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/app-development)\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\nFrequently asked questions\n\nThis FAQ provides detailed information on VTEX IO and the VTEX IO Store Framework, covering their usage, access requirements, cost, and support options.\n\n## VTEX IO\n\n### What can I develop with VTEX IO?\n\nVTEX IO enables you to build:\n\n* **Storefront apps:** Design tailored storefront components with React.\n* **Admin apps:** Extend your store's admin capabilities with additional applications.\n* **Backend apps:** Create backend services for integration with Storefront or Admin apps, using Node or .NET Core.\n* **Pixel apps:** Develop pixel apps to gather user data for integration with third-party services.\n\n### Who can use VTEX IO?\n\nVTEX IO access is generally limited to a small group of developers as a closed beta, except for custom storefront apps.\n\n* **Closed beta access:** To join the closed beta for project types like Admin, backend, and pixel, you must meet one of the following criteria: \n * Enterprise VTEX Accounts: Users on an Enterprise plan can verify eligibility based on their contract. \n * Partners: VTEX IO-certified development partners are eligible for closed beta access.\n* **Storefront apps:** All VTEX accounts and partners can develop storefront apps without restrictions. This option allows you to build React-based storefronts to suit your specific business needs, regardless of your VTEX plan or certification status.\n\n### I meet all the necessary prerequisites. What do I need to do to start developing?\n\nIf you meet the prerequisites for closed beta access, complete the [Application form](https://read.calvincode.net/reader?url=https://forms.gle/f7bYdTA7tfdfB5tt7) with your project details. Review the guidelines on [filling out the application form for development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/) to ensure you meet all criteria.\n\n> **Note:** No application is needed to develop storefront apps.\n\n### How much does it cost?\n\nCurrently, developing on VTEX IO does not incur additional fees.\n\n### What type of support is available?\n\nCustom apps are the responsibility of their developers. VTEX does not provide support for custom apps.\n\n## VTEX IO Store Framework\n\n### What are the advantages of building with the Store Framework?\n\nThe Store Framework is designed to reduce time-to-market, lower maintenance costs, and provide extensive customization options for storefront development. It is backed by an active developer community that contributes enhancements to store blocks, fostering scalable and customizable storefronts.\n\n### Can I customize Store Framework blocks?\n\nYes, Store Framework blocks are designed with flexibility in mind. Each block comes with configurable properties and CSS Handles, allowing you to adapt styling and behavior to match your brand and design requirements, making it easier to build a distinct store identity and streamline implementation time.\n\nFor more complex needs, custom apps and components can be created. However, note that VTEX does not provide support for third-party apps; the app vendor is responsible for maintaining and supporting these custom solutions.\n\n### Who can use Store Framework?\n\nAll VTEX accounts can use Store Framework, as it is available in open beta. However, as an open-source project in active development, expect ongoing updates and improvements.\n\n### How much does Store Framework cost?\n\nThe Store Framework is included by default in VTEX contracts, with no additional cost for clients.\n\n### What support is available for Store Framework?\n\nVTEX provides support for all native Store Framework blocks, so any issues related to these blocks can be resolved by opening a [support ticket](https://read.calvincode.net/reader?url=https://help-tickets.vtex.com/smartlink/sso/login/zendesk) with the VTEX Support team.\n\nBeing open-source, the Store Framework also benefits from a community-driven support network. Users can request new features, report bugs, and engage with other developers via the [VTEX Community](https://read.calvincode.net/reader?url=https://community.vtex.com/), and follow updates in our [Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/updates/release-notes).\n\n### How do I get started with Store Framework?\n\nTo start building with Store Framework, check out our [Getting Started guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3).\n\n> Need additional assistance? If you have questions not covered here, feel free to [VTEX support](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM) for further help.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Hello/vtex-io-documentation-frequently-asked-questions.md)\n\n[Seller Portal Edition App« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions//docs/guides/seller-portal-edition-app)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23vtex-io)\n\n[What can I develop with VTEX IO?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23what-can-i-develop-with-vtex-io)[Who can use VTEX IO?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23who-can-use-vtex-io)[I meet all the necessary prerequisites. What do I need to do to start developing?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23i-meet-all-the-necessary-prerequisites-what-do-i-need-to-do-to-start-developing)[How much does it cost?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23how-much-does-it-cost)[What type of support is available?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23what-type-of-support-is-available)\n\n[VTEX IO Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23vtex-io-store-framework)\n\n[What are the advantages of building with the Store Framework?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23what-are-the-advantages-of-building-with-the-store-framework)[Can I customize Store Framework blocks?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23can-i-customize-store-framework-blocks)[Who can use Store Framework?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23who-can-use-store-framework)[How much does Store Framework cost?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23how-much-does-store-framework-cost)[What support is available for Store Framework?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23what-support-is-available-for-store-framework)[How do I get started with Store Framework?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23how-do-i-get-started-with-store-framework)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Hello/vtex-io-documentation-frequently-asked-questions.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23vtex-io)\n\n[What can I develop with VTEX IO?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23what-can-i-develop-with-vtex-io)[Who can use VTEX IO?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23who-can-use-vtex-io)[I meet all the necessary prerequisites. What do I need to do to start developing?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23i-meet-all-the-necessary-prerequisites-what-do-i-need-to-do-to-start-developing)[How much does it cost?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23how-much-does-it-cost)[What type of support is available?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23what-type-of-support-is-available)\n\n[VTEX IO Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23vtex-io-store-framework)\n\n[What are the advantages of building with the Store Framework?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23what-are-the-advantages-of-building-with-the-store-framework)[Can I customize Store Framework blocks?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23can-i-customize-store-framework-blocks)[Who can use Store Framework?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23who-can-use-store-framework)[How much does Store Framework cost?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23how-much-does-store-framework-cost)[What support is available for Store Framework?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23what-support-is-available-for-store-framework)[How do I get started with Store Framework?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23how-do-i-get-started-with-store-framework)\n\nOn this page\n\n[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=)"
}
] |
doc_a7f732c2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX menu app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/troubleshooting)\n\n[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.menu/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/basic-components)\n\nMenu\n\nOfficial extension\n\nVersion: 2.35.3\n\nLatest version: 2.35.3\n\n[](#contributors)\n\nThe Menu component displays a navigation bar with links and dropdown submenus. It can be configured to display internal or external links and supports both category-based and custom menu items.\n\n\n\n## Configuration\n\n1. Add the app to the store theme dependencies in the `manifest.json` file.\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.menu\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `vtex.menu@2.x:menu` block to the [store header](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-header/blob/master/store/interfaces.json) template.\n2. Configure the `menu-item` blocks to build the store menu options. These can be declared in two ways in `vtex.menu@2.x:menu`: as children or as props. The advantage of the second type of `menu-item` configuration is that Site Editor can be used to edit the blocks.\n\n### `menu-item` as children\n\n_Example:_\n\n`1\n\n\"vtex.menu@2.x:menu#websites\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"menu-item#shop\", \n\n4\n\n \"menu-item#about-us\" \n\n5\n\n ] \n\n6\n\n}, \n\n7\n\n\"menu-item#shop\": { \n\n8\n\n \"props\": { \n\n9\n\n \"id\": \"menu-item-shop\", \n\n10\n\n \"type\": \"custom\", \n\n11\n\n \"highlight\": false, \n\n12\n\n \"itemProps\": { \n\n13\n\n \"type\": \"internal\", \n\n14\n\n \"href\": \"#\", \n\n15\n\n \"noFollow\": false, \n\n16\n\n \"tagTitle\": \"Shop\", \n\n17\n\n \"text\": \"Shop\" \n\n18\n\n }, \n\n19\n\n \"iconProps\": { \n\n20\n\n \"id\": \"bnd-logo\", \n\n21\n\n \"size\": 16, \n\n22\n\n \"viewBox\": \"0 0 16 16\", \n\n23\n\n \"activeClassName\": \"rebel-pink\", \n\n24\n\n \"mutedClassName\": \"c-action-primary\" \n\n25\n\n }, \n\n26\n\n \"iconToTheRight\": true \n\n27\n\n } \n\n28\n\n} \n\n`\n\n### `menu-item` as props\n\n_Example:_\n\n`1\n\n\"vtex.menu@2.x:menu#websites\": { \n\n2\n\n \"props\": { \n\n3\n\n \"items\": [ \n\n4\n\n { \n\n5\n\n \"id\": \"menu-item-shop\", \n\n6\n\n \"type\": \"custom\", \n\n7\n\n \"highlight\": false, \n\n8\n\n \"itemProps\": { \n\n9\n\n \"type\": \"internal\", \n\n10\n\n \"href\": \"#\", \n\n11\n\n \"noFollow\": false, \n\n12\n\n \"tagTitle\": \"Shop\", \n\n13\n\n \"text\": \"Shop\" \n\n14\n\n } \n\n15\n\n }, \n\n16\n\n { \n\n17\n\n \"id\": \"menu-item-about-us\", \n\n18\n\n \"type\": \"custom\", \n\n19\n\n \"highlight\": false, \n\n20\n\n \"itemProps\": { \n\n21\n\n \"type\": \"internal\", \n\n22\n\n \"href\": \"/about-us\", \n\n23\n\n \"noFollow\": false, \n\n24\n\n \"tagTitle\": \"about-us\", \n\n25\n\n \"text\": \"About Us\" \n\n26\n\n } \n\n27\n\n } \n\n28\n\n ] \n\n29\n\n } \n\n30\n\n} \n\n`\n\n### Adding a submenu\n\nYou can define a submenu by adding the `submenu` block to a `menu-item`:\n\n`1\n\n\"menu-item#shop\": { \n\n2\n\n \"props\": { \n\n3\n\n \"type\": \"custom\", \n\n4\n\n \"highlight\": false, \n\n5\n\n \"itemProps\": { \n\n6\n\n \"type\": \"internal\", \n\n7\n\n \"href\": \"#\", \n\n8\n\n \"noFollow\": false, \n\n9\n\n \"tagTitle\": \"Shop\", \n\n10\n\n \"text\": \"Shop\" \n\n11\n\n }, \n\n12\n\n }, \n\n13\n\n \"blocks\": [\"vtex.menu@2.x:submenu#shop\"] // Defining a submenu \n\n14\n\n}, \n\n15\n\n\"vtex.menu@2.x:submenu#shop\": { \n\n16\n\n \"children\": [ \n\n17\n\n \"vtex.menu@2.x:menu#submenushop\" \n\n18\n\n ] \n\n19\n\n}, \n\n20\n\n\"vtex.menu@2.x:menu#submenushop\": { \n\n21\n\n \"children\": [ \n\n22\n\n \"menu-item#shop\" \n\n23\n\n ] \n\n24\n\n} \n\n`\n\n> The Menu block doesn't require any specific child blocks to work\n\n## `menu-item` props\n\nThe available `menu-item` block props are:\n\n| Prop name | Type | Description | Default value |\n| --------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| type | string | Menu item type, either category or custom | category |\n| id | string | Menu item ID | undefined |\n| highlight | boolean | Indicates whether the item has a highlight | undefined |\n| iconPosition | string | Icon position relative to the menu item text, either to the left or right | left |\n| iconProps | IconProps | Icon props | undefined |\n| onMountBehavior | enum | Indicates whether the submenu should always be automatically displayed when its parent is hovered/clicked on (open) or (close) | closed |\n| itemProps | CategoryItem or CustomItem | Item props | undefined |\n| blockClass | CustomCSSClasses | Used to override default CSS handles. To learn how this prop works, check this description of [useCustomClasses](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Please note that this is only useful when importing this block as a React component. | undefined |\n\n### Icon props\n\n| Prop name | Type | Description | Default value |\n| --------------- | ------- | ------------------------------------- | ------------- |\n| id | string | Icon ID | N/A |\n| isActive | boolean | Indicates if the item is active | true |\n| size | number | Icon size | 16 |\n| viewBox | string | Icon view box | 0 0 16 16 |\n| activeClassName | string | Icon classname when isActive is true | N/A |\n| mutedClassName | string | Icon classname when isActive is false | N/A |\n\n### Category-specific props\n\n| Prop name | Type | Description | Default value |\n| ---------- | ------ | ---------------- | ------------- |\n| categoryId | number | Item category ID | N/A |\n| text | string | Menu item text | N/A |\n\n### Custom item props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------- | ------------------------------------------- | ------------- |\n| type | string | Menu item type, either internal or external | internal |\n| href | string | Link to the menu item destination | N/A |\n| noFollow | boolean | No follow attribute | N/A |\n| tagTitle | string | Menu item tag | N/A |\n| text | string | Menu item text | N/A |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, please follow the instructions in [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS Handle |\n| ------------------------ |\n| accordionIcon--isClosed |\n| accordionIcon--isOpen |\n| accordionIcon |\n| container |\n| linkLeft |\n| linkMiddle |\n| linkRight |\n| menuContainerNav |\n| menuContainer |\n| menuItemInnerDiv |\n| menuItem |\n| menuItem--isOpen |\n| menuItem--isClosed |\n| menuLinkDivLeft |\n| menuLinkDivMiddle |\n| menuLinkDivRight |\n| menuLinkNav |\n| renderLink |\n| styledLinkContainer |\n| styledLinkContent |\n| styledLinkIcon |\n| styledLink |\n| submenuAccordion |\n| submenuColumn |\n| submenuContainer |\n| submenuWrapper--isClosed |\n| submenuWrapper--isOpen |\n| submenuWrapper |\n| submenu |\n\n[Login« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.login)[MinicartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.minicart)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23configuration)\n\n[menu-item as children](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23menu-item-as-children)[menu-item as props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23menu-item-as-props)[Adding a submenu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23adding-a-submenu)\n\n[menu-item props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23menu-item-props)\n\n[Icon props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23icon-props)[Category-specific props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23category-specific-props)[Custom item props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23custom-item-props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_56f2522c
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain troubleshooting i cant integrate my external search provider in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting)\n\nDevelopment\n\nI can’t integrate my external Search Provider\n\nLearn how to fix \"Unknown errors\" when integrating an external search provider with VTEX.\n\n**Keywords:** Integration | VTEX Protocol | Search Protocol | Search Resolver | External Search Provider\n\nWhen attempting to integrate an external search provider with the VTEX Platform as described in the guide [Implementing a Custom Search Resolver App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe), you may encounter \"Unknown errors\" that prevent successful integration.\n\nThese errors may occur due to outdated dependencies in your app.\n\n## Solution\n\nTo fix any \"Unknown errors\" during search integration, follow these steps:\n\n### Step 1 - Update the `vtex.search-graphql` dependency version\n\nMake sure the `vtex.search-graphql` dependency in your `node/package.json` file is up-to-date with the latest version of the `vtex.search-graphql` app.\n\n1. Open your app directory and go to the `node/package. json` file.\n2. Locate the `vtex.search-graphql` dependency.\n3. Compare the version listed in your `node/package.json` with the [latest version available for the vtex.search-graphql app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/search-graphql/blob/master/manifest.json%23L4).\n4. If your `vtex.search-graphql` dependency is outdated, update it to the latest version. \na. Edit the `node/package. json` file, updating the version number for `vtex.search-graphql`. \nb. Save the changes to the `node/package. json` file.\n\n### Step 2 - Install updated dependencies\n\nAfter updating the `vtex.search-graphql` version, install the update dependencies:\n\n1. Open a terminal and go to your app's `node` folder.\n2. Run the following command to install the updated dependencies: \n`1 \nyarn \n`\n\n### Step 3 - Re-link the app\n\nAfter installing the updated dependencies, re-link the app to apply the changes. Run the following command:\n\n`1\n\nvtex link \n\n`\n\nIf the issue persists, please open a ticket with [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/support).\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/i-cant-integrate-my-external-search-provider.md)\n\n[I can't install VTEX IO CLI« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-install-vtex-io-cli)[My multi-language store is not functioning in the development workspaceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider%23solution)\n\n[Step 1 - Update the vtex.search-graphql dependency version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider%23step-1-update-the-vtexsearch-graphql-dependency-version)[Step 2 - Install updated dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider%23step-2-install-updated-dependencies)[Step 3 - Re-link the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider%23step-3-re-link-the-app)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/i-cant-integrate-my-external-search-provider.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider%23solution)\n\n[Step 1 - Update the vtex.search-graphql dependency version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider%23step-1-update-the-vtexsearch-graphql-dependency-version)[Step 2 - Install updated dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider%23step-2-install-updated-dependencies)[Step 3 - Re-link the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider%23step-3-re-link-the-app)\n\nOn this page\n\n[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=)"
}
] |
doc_60ee7b2d
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain troubleshooting the promotion highlight flag does not appear on the product in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting)\n\nDevelopment\n\nThe promotion highlight flag does not appear on the product\n\nWhen creating a promotion and enabling the highlight option, the product does not display the highlight flag in the store.\n\nIn stores developed with VTEX IO Store Framework, when creating a promotion and [enabling the highlight option](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configurando-promocao-com-destaque-flag--tutorials%5F2295%23configuring-the-promotion), the corresponding flag may not appear on the product.\n\nThis behavior may occur due to the absence of the [product-highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-highlights) component on the corresponding page.\n\n## Solution\n\nTo display the promotion highlight on a product, follow the steps below.\n\n### Check the promotion setup\n\nMake sure your promotion is configured properly and has the highlight option enabled. You can check this directly in the VTEX Admin or using a VTEX API.\n\n#### VTEX Admin\n\n1. In the VTEX Admin, go to **Promotions > Promotions**.\n2. Open the promotion you configured.\n3. Confirm the promotion is highlighted.\n\n\n\n#### VTEX API\n\nUsing the [Get promotion or tax by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api%23get-/api/rnb/pvt/calculatorconfiguration/-idCalculatorConfiguration-) API, check if the `isFeatured` field is set as **true**.\n\n### Check the `product-highlights` component\n\n1. Open the Store Theme app using any code editor, such as Visual Studio Code.\n2. Go to the page template where the product should be displayed with the highlight flag.\n3. Check if the template has a product highlight block declared.\n\n> The Product Highlights blocks require a product context to work properly. Therefore, when declaring these blocks, ensure that they are placed in a theme template or a block where this context is available, such as `store.product` and `product-summary.shelf`.\n\n1. If a product highlight block is not declared, follow the [Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-highlights) documentation to set it up.\n\nIf the problem continues, open a ticket with [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/the-promotion-highlight-flag-does-not-appear-on-the-product.md)\n\n[The Price in the shelf or in the search results is different from the product page« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)[vtex release CLI command returns an EBADF messageNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product%23solution)\n\n[Check the promotion setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product%23check-the-promotion-setup)[Check the product-highlights component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product%23check-the-product-highlights-component)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/the-promotion-highlight-flag-does-not-appear-on-the-product.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product%23solution)\n\n[Check the promotion setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product%23check-the-promotion-setup)[Check the product-highlights component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product%23check-the-product-highlights-component)\n\nOn this page\n\n[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=)"
}
] |
doc_31400767
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides get address by postal code in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[List pickup points by location](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/list-pickup-points-by-location)\n\n[Get address by postal code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/get-address-by-postal-code)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[List pickup points by location](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/list-pickup-points-by-location)\n\n[Get address by postal code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/get-address-by-postal-code)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/checkout-api-overview)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Get address by postal code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/get-address-by-postal-code)\n\nGet address by postal code\n\nTo assist the customer in the process of filling in data at Checkout and also to select the sellers able to deliver the product in a certain area, it is possible to register postal codes and assign them to addresses in the VTEX database. For more information about deliveries, visit [Inventory & shipping - Overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/visao-geral-logistics--tutorials%5F143).\n\nThis guide describes how to obtain the registered address information for a specific postal code and country.\n\n## Getting address by postal code\n\nTo get the registered address information for a postal code, you need to use the [Get address by postal code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/postal-code/-countryCode-/-postalCode-) endpoint. The country and postal code information must be sent through the URL request, as shown by the example below:\n\n`https://{accountname}.{environment.com.br}/api/checkout/pub/postal-code/BRA/22250040`\n\nAfter sending the request, the endpoint will return the response body containing the address information registered, as shown in the example below:\n\n`1\n\n... \n\n2\n\n{ \n\n3\n\n \"postalCode\": \"22250040\", \n\n4\n\n \"city\": \"Rio de Janeiro\", \n\n5\n\n \"state\": \"RJ\", \n\n6\n\n \"country\": \"BRA\", \n\n7\n\n \"street\": \"Praia Botafogo\", \n\n8\n\n \"number\": \"\", \n\n9\n\n \"neighborhood\": \"Botafogo\", \n\n10\n\n \"complement\": \"\", \n\n11\n\n \"reference\": \"\", \n\n12\n\n \"geoCoordinates\": [ \n\n13\n\n -43.182182312011719, \n\n14\n\n -22.94549560546875 \n\n15\n\n ] \n\n16\n\n} \n\n17\n\n... \n\n`\n\n## Error codes\n\nThe following errors may appear as a message in the response body.\n\n### 200 - OK\n\nDespite the code `200` (which indicates the success of the request), if there is no registered address in the VTEX database associated with the entered postal code or country, the response body will not contain any address information.\n\n`1\n\n{ \n\n2\n\n \"postalCode\": \"222500\", \n\n3\n\n \"city\": \"\", \n\n4\n\n \"state\": \"\", \n\n5\n\n \"country\": \"BRA\", \n\n6\n\n \"street\": \"\", \n\n7\n\n \"number\": \"\", \n\n8\n\n \"neighborhood\": \"\", \n\n9\n\n \"complement\": \"\", \n\n10\n\n \"reference\": \"\", \n\n11\n\n \"geoCoordinates\": [] \n\n12\n\n} \n\n`\n\n### 404 - Not Found\n\n* `Message error example: \"The requested URL was not found on the server\"`: check that the URL data is correct.\n\n`1\n\n<body> \n\n2\n\n <h1>404 Not Found</h1> \n\n3\n\n <p>The requested URL was not found on this server.</p> \n\n4\n\n</body> \n\n`\n\n### 500 - Internal Server Error\n\n* `Message error example (code ORD026): \"A communication error with Postal Code Service has occurred\"`: this message will appear when less than three country code digits are entered in the URL request.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"ORD026\", \n\n5\n\n \"message\": \"A communication error with Postal Code Service has occurred\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"9e8e40ad-f98d-4e36-81f3-1937caa83f1c\" \n\n9\n\n} \n\n`\n\nContributors\n\n2\n\n[](https://github.com/karenkrieger)\n\n[](https://github.com/ricardoaerobr)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/fulfillment-checkout-section-api-quick-start-guides/get-address-by-postal-code.md)\n\n[List pickup points by location« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code//docs/guides/list-pickup-points-by-location)[RegionNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code//docs/guides/region-section-api-quick-start-guides)\n\nContributors\n\n2\n\n[](https://github.com/karenkrieger)\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[Getting address by postal code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/get-address-by-postal-code%23getting-address-by-postal-code)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/get-address-by-postal-code%23error-codes)\n\n[200 - OK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/get-address-by-postal-code%23200-ok)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/get-address-by-postal-code%23404-not-found)[500 - Internal Server Error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/get-address-by-postal-code%23500-internal-server-error)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/fulfillment-checkout-section-api-quick-start-guides/get-address-by-postal-code.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Getting address by postal code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/get-address-by-postal-code%23getting-address-by-postal-code)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/get-address-by-postal-code%23error-codes)\n\n[200 - OK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/get-address-by-postal-code%23200-ok)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/get-address-by-postal-code%23404-not-found)[500 - Internal Server Error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code/docs/guides/get-address-by-postal-code%23500-internal-server-error)\n\nOn this page\n\n[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=)"
}
] |
doc_7ba1ef51
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides pricing hub in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides)\n\nIntegration Guides\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/pricing-hub)\n\nPricing Hub\n\nPricing Hub is a system developed for the B2B context that works as an intermediary between VTEX and external pricing systems.\n\n## Learn more\n\n* [Pricing Hub - Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview)\n\nContributors\n\n2\n\n[](https://github.com/geisecosta)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/pricing-hub.md)\n\n[Reference Implementations« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub//docs/guides/tax-services-reference-implementation)[reCAPTCHANext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub//docs/guides/recaptcha)\n\nContributors\n\n2\n\n[](https://github.com/geisecosta)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/pricing-hub%23learn-more)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/pricing-hub.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub/docs/guides/pricing-hub%23learn-more)\n\nOn this page\n\n[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=)"
}
] |
doc_bc0e24ba
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides pricing hub overview in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/updates/release-notes)\n\nPricing Hub - Overview\n\n> This feature is in closed beta, available only for selected customers. If you have any questions, contact our [Support](https://read.calvincode.net/reader?url=https://help.vtex.com/support).\n\nIn the B2B scenario, it is common for stores to have personalized prices per customer and complex pricing systems that require external integrations. Pricing Hub is a system developed for the B2B context that works as an intermediary between VTEX and external pricing systems.\n\nIn VTEX, B2B stores have the option to use our internal pricing system or an external one. If the store chooses to operate with an external pricing system, Pricing Hub will query an external price calculation API. The external API should then respond with the price for all items in the shopping cart according to its predefined tax rules.\n\n\n\n## Implementation\n\nTo connect with external pricing systems using Pricing Hub, it is necessary to build a VTEX IO middleware app. We offer two reference implementation templates to simplify this process:\n\n* [C# template](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/external-prices-app)\n* [Node template](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/external-prices-node)\n\nRead the documentation on each repository to learn more about the required steps to use and customize the app.\n\n## Specifications\n\nSee below all the specifications of the request and the response expected when communicating with Pricing Hub.\n\n### Price calculation request\n\nThe external prices calculation tool must provide an endpoint that will receive a `POST` [Get Prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-hub%23post-/api/pricing-hub/prices) request. This route retrieves and applies prices for the items that are passed in the request. Pricing Hub will select the pricing method that will be used for each item and will fetch their respective price from the selected pricing method.\n\n> Responses from Pricing Hub tend to have a greater delay when compared to other VTEX systems. That is expected, however, due to the complexity of its nested requests. The timeout for this request is 900 milliseconds.\n\nIn this request, Pricing Hub provides a body in a specific format, exemplified below. This means that either the endpoint must be prepared to receive this body format, or the app must contain a parser to adapt it to the correct format.\n\n#### Request body example\n\n`1\n\n{ \n\n2\n\n \"item\": \n\n3\n\n { \n\n4\n\n \"index\": 0, \n\n5\n\n \"skuId\": \"880011\", \n\n6\n\n \"quantity\": 1 \n\n7\n\n }, \n\n8\n\n \"context\":{ \n\n9\n\n \"email\": \"john@email.com\" \n\n10\n\n } \n\n11\n\n} \n\n`\n\nThe request body should have the following properties:\n\n| **Attribute** | **Type** | **Description** |\n| ------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| item | object | The item whose price is supposed to be fetched by Pricing Hub. |\n| ↪ index | integer | This is the index of the item at Checkout's cart. It has to be unique in the items array. |\n| ↪ skuId | string | This is the SKU ID of the item that will be priced. |\n| ↪ quantity | integer | This is the amount of items that will be priced. It is possible to have a volume discount for many repeated items. Hence, the price may not be the quantity of the item multiplied by the unitary price. |\n| context | object | The object that contains the context to inform the query. |\n| ↪ email | string | The customer's email address. If there is no value, use an empty string. |\n\n### External prices provider response\n\nIn response to the request sent by Pricing Hub, we expect an outcome in the following format:\n\n`1\n\n{ \n\n2\n\n \"item\": { \n\n3\n\n \"price\": 54035, \n\n4\n\n \"priceTables\": \"special\", \n\n5\n\n \"index\": 0, \n\n6\n\n \"skuId\": \"880011\", \n\n7\n\n \"listPrice\": 54035, \n\n8\n\n \"costPrice\": 50000, \n\n9\n\n \"sellingPrice\": 54035, \n\n10\n\n \"priceValidUntil\": \"2023-01-27T20:29:57Z\", \n\n11\n\n \"tradePolicyId\": \"special\" \n\n12\n\n } \n\n13\n\n} \n\n`\n\nThe response should have the following properties:\n\n| **Attribute** | **Type** | **Description** |\n| ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| item | object | The object that contains the price data. |\n| ↪ price | integer | The price returned by the pricing API that was used by Pricing-Hub. It is measured in cents, so 5000 means 50,00 in local currency. |\n| ↪ priceTables | string | The price table that was used to price the item. |\n| ↪ index | integer | The same index referring to Checkout's cart that was passed to the API. |\n| ↪ skuId | string | The same SKU ID that was passed to the API. |\n| ↪ listPrice | integer | The list price returned by the pricing API that was used by Pricing Hub. It is measured in cents, so 5000 means 50,00 in local currency. |\n| ↪ costPrice | integer | The cost price returned by the pricing API that was used by Pricing-Hub. It is measured in cents, so 5000 means 50,00 in local currency. |\n| ↪ sellingPrice | integer | The computed price before applying coupons, taxes or promotions. |\n| ↪ priceValidUntil | string | The moment up until the price is valid. After that moment, it will be necessary to call the pricing API again. The format of the string is in RFC3339. |\n| ↪ tradePolicyId | string | Trade Policy ID. |\n\n## Index - Pricing Hub API\n\n`POST` [Get Prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-hub%23post-/api/pricing-hub/prices) `PUT` [Configure External Price Source](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-hub%23put-/api/pricing-hub/prices/config)\n\nContributors\n\n3\n\n[](https://github.com/geisecosta)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Pricing-Hub/pricing-hub-overview.md)\n\nContributors\n\n3\n\n[](https://github.com/geisecosta)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/guides/pricing-hub-overview%23implementation)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/guides/pricing-hub-overview%23specifications)\n\n[Price calculation request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/guides/pricing-hub-overview%23price-calculation-request)[External prices provider response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/guides/pricing-hub-overview%23external-prices-provider-response)\n\n[Index - Pricing Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/guides/pricing-hub-overview%23index-pricing-hub-api)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Pricing-Hub/pricing-hub-overview.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/guides/pricing-hub-overview%23implementation)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/guides/pricing-hub-overview%23specifications)\n\n[Price calculation request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/guides/pricing-hub-overview%23price-calculation-request)[External prices provider response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/guides/pricing-hub-overview%23external-prices-provider-response)\n\n[Index - Pricing Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-hub-overview/docs/guides/pricing-hub-overview%23index-pricing-hub-api)\n\nOn this page\n\n[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=)"
}
] |
doc_4ee5e5a7
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX store form app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/troubleshooting)\n\n[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.store-form/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.reviews-and-ratings)\n\n[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.reviews-and-ratings)\n\n[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/guides/advanced-components)\n\nStore Form\n\nOfficial extension\n\nVersion: 0.10.2\n\nLatest version: 0.10.2\n\n[](#contributors-)\n\nThe Store Form app provides blocks responsible for displaying a user form connected to [**Master Data**](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/what-is-master-data--4otjBnR27u4WUIciQsmkAw?locale=en) through a [JSON schema](https://read.calvincode.net/reader?url=https://json-schema.org/understanding-json-schema/index.html).\n\n\n\n## Configuration\n\n> Before configuring the Store Form block in your theme, make sure you have already configured a **JSON schema in Master Data**. Otherwise, the customer form will not be saved appropriately. To learn more, please refer to [Creating forms for your store users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users).\n\n1. Add the `store-form` app to your theme dependencies in the `manifest.json`. For example: \n`1 \n\"dependencies\": { \n2 \n \"vtex.store-form\": \"0.x\" \n3 \n} \n`\n\nNow, you can use all blocks exported by the `store-form` app. See the full list below:\n\n| Block name | Description |\n| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| form |  Top-level block, in which you will specify which entity and schema from Master Data will be used for building the form. It provides context to its 8 children blocks (listed below). |\n| form-input.checkbox | Renders a checkbox field in the form. |\n| form-input.dropdown | Renders a dropdown field in the form. |\n| form-input.radiogroup | Renders a radio button field in the form. |\n| form-input.textarea | Renders a big text field in the form. |\n| form-input.text | Renders a small text field in the form with few available characters. |\n| form-field-group | Renders different form blocks (such as form-input.radiogroup and form-input.text) based on the schema's sub-property type. |\n| form-input.upload | Renders an Upload field in the form. |\n| form-submit | Renders a button to submit the user form content. |\n| form-success | Accepts an array of blocks rendered when the form is successfully submitted. Any children block is valid. |\n\n1. In any desired store template, such as the `store.product`, add the `form` block. In the example below, the form block is contained in a Flex Layout row: \n`1 \n{ \n2 \n \"store.product\": { \n3 \n \"children\": [ \n4 \n \"flex-layout.row#product-breadcrumb\", \n5 \n \"flex-layout.row#product-main\" \n6 \n \"flex-layout.row#form\", \n7 \n \"shelf.relatedProducts\", \n8 \n \"product-reviews\", \n9 \n \"product-questions-and-answers\" \n10 \n ] \n11 \n }, \n12 \n ... \n13 \n} \n`\n2. Then, declare the `form` block. Remember to specify which `entity` and `schema` from Master Data should be fetched to build the block.\n\n`1\n\n{ \n\n2\n\n \"flex-layout.row#form\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"flex-layout.col#form\" \n\n5\n\n ] \n\n6\n\n }, \n\n7\n\n \"flex-layout.col#form\": { \n\n8\n\n \"children\": [ \n\n9\n\n \"form\" \n\n10\n\n ] \n\n11\n\n }, \n\n12\n\n \"form\": { \n\n13\n\n \"props\": { \n\n14\n\n \"entity\": \"clients\", \n\n15\n\n \"schema\": \"person\" \n\n16\n\n } \n\n17\n\n } \n\n18\n\n} \n\n`\n\n> If the `form` block does not have any children configured, **a default form will be rendered** automatically based on the JSON schema in Master Data. This reading and interpretation of JSON schemas is facilitated by the [Reacht Hook Form JSON Schema](https://read.calvincode.net/reader?url=https://github.com/vtex/react-hook-form-jsonschema) library, which supports the Store Form blocks logic behind the scenes.\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| entity | string |  The [entity](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/creating-data-entity--tutorials%5F1265) in Master Data where the document will be saved. | undefined |\n| schema | string |  The JSON schema name will be used. The schema name is set in the API request to create it in Master Data. | undefined |\n\n1. If desired, complete the `form` block by adding and configuring an array of children blocks. You can use the blocks listed in the first table stated above. For example:\n\n`1\n\n \"form\": { \n\n2\n\n \"props\": { \n\n3\n\n \"entity\": \"clients\", \n\n4\n\n \"schema\": \"person\" \n\n5\n\n }, \n\n6\n\n \"children\": [ \n\n7\n\n \"rich-text#formTitle\", \n\n8\n\n \"form-input.text#firstName\", \n\n9\n\n \"form-input.text#lastName\", \n\n10\n\n \"form-field-group#address\", \n\n11\n\n \"form-input.checkbox#agreement\", \n\n12\n\n \"form-submit\" \n\n13\n\n ], \n\n14\n\n \"blocks\": [\"form-success\"] \n\n15\n\n }, \n\n16\n\n \"form-success\": { \n\n17\n\n \"children\": [ \n\n18\n\n \"rich-text#successSubmit\" \n\n19\n\n ] \n\n20\n\n }, \n\n21\n\n \"rich-text#successSubmit\": { \n\n22\n\n \"props\": { \n\n23\n\n \"text\": \"Succesfully submitted the data!\", \n\n24\n\n \"textAlignment\": \"CENTER\", \n\n25\n\n \"textPosition\": \"CENTER\" \n\n26\n\n } \n\n27\n\n }, \n\n28\n\n \"form-input.text#firstName\": { \n\n29\n\n \"props\": { \n\n30\n\n \"pointer\": \"#/properties/firstName\" \n\n31\n\n } \n\n32\n\n }, \n\n33\n\n \"form-input.text#lastName\": { \n\n34\n\n \"props\": { \n\n35\n\n \"pointer\": \"#/properties/lastName\" \n\n36\n\n } \n\n37\n\n }, \n\n38\n\n \"form-input.checkbox#agreement\": { \n\n39\n\n \"props\": { \n\n40\n\n \"pointer\": \"#/properties/agreement\", \n\n41\n\n \"label\": \"Do you agree that this is the best form component in the whole wide world?\" \n\n42\n\n } \n\n43\n\n }, \n\n44\n\n \"form-field-group#address\": { \n\n45\n\n \"props\": { \n\n46\n\n \"pointer\": \"#/properties/address\" \n\n47\n\n } \n\n48\n\n }, \n\n49\n\n \"form-submit\": { \n\n50\n\n \"props\": { \n\n51\n\n \"label\": \"Submit\" \n\n52\n\n } \n\n53\n\n } \n\n`\n\n### `form-input.radiogroup`, `form-input.dropdown`, `form-input.textarea` and `form-input.checkbox` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |\n| pointer | string |  JSON schema pointer, i.e., the JSON schema path (for example: #/properties/firstName) in which the form block inputs should be validated against. | undefined |\n| label | string |  Field name when rendered. | Property title |\n\n### `form-input.textarea` props\n\n| Prop name | Type | Description | Default value |\n| ----------- | ------ | ------------------------------------ | ------------- |\n| placeholder | string | Placeholder for the text area input. | undefined |\n\n### `form-input.text` props\n\n| Prop name | Type | Description | Default Value |\n| ---------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |\n| pointer | string |  JSON schema path (e.g., #/properties/firstName) for validating form block inputs. | undefined |\n| inputType | enum | Defines the type of the text field. Possible values are: input \\- renders a regular text field; hidden \\- renders a hidden text field used for pre-defining an editable value to be submitted to the form; password \\- renders a password text field. | input |\n| value (optional) | string | Displays a pre-defined text to be submitted when the inputType is set as hidden. | undefined |\n| label | string |  Label of the input field. | Property's title |\n| placeholder | string | Placeholder for the text input. | undefined |\n\n### `form-field-group` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| pointer | string |  JSON schema pointer, i.e., the JSON schema path (for example: #/properties/address) in which the form block inputs should be validated against. Note that since you are configuring a form-field-group block, the path must not include a schema sub-property, only a schema property. | undefined |\n| uiSchema | object | Redefines how the form-field-groups block should render each sub-property declared in the JSON schema path defined in pointer. As previously mentioned, the form-field-groups already handle this functionality on their own. However, you have the option to override the sub-property types using a schema and redefine how each form block will be rendered. | undefined |\n\n### `form-input.upload` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| pointer | string |  JSON schema pointer, i.e., the JSON schema path (for example: #/properties/address) in which the form block inputs should be validated against. Note that since you are configuring a form-field-group block, the path must not include a schema's sub-property, only a schema's property. | undefined |\n| accept | string |  By default, the upload input only supports image and PDF format files. If you want to customize it, you can use the format type you want by following this pattern: \\*.TYPEFILE. Learn more [about the accept field](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file%23accept). | |\n\n* **`uiSchema` object:**\n\n`1\n\nconst UISchema = { \n\n2\n\n type: UIType, \n\n3\n\n properties: { \n\n4\n\n // Note that the definition is recursive \n\n5\n\n childName: { UISchema }, \n\n6\n\n childName: { UISchema }, \n\n7\n\n // ... \n\n8\n\n childName: { UISchema }, \n\n9\n\n }, \n\n10\n\n}; \n\n`\n\nWhere `childName` should be replaced for the desired sub-property name and the `UIType` should be replaced for one of the following values:\n\n* `default`: Will consider the `form-field-group` own logic (e.g. using the [React Hook Form JSON Schema](https://read.calvincode.net/reader?url=https://github.com/vtex/react-hook-form-jsonschema) library) for block rendering;\n* `radio`: The sub-property will be rendered as a `form-input.radiogroup` block.\n* `select`: The sub-property will be rendered as a `form-input.dropdown` block.\n* `input`: The sub-property will be rendered as a `form-input.text` block with `inputType` set to `input`.\n* `hidden`: The sub-property will be rendered as a `form-input.text` block with `inputType` set to `hidden`.\n* `password`: The sub-property will be rendered as a `form-input.text` block with `inputType` set to `password`.\n* `textArea`: The sub-property will be rendered as a `form-input.textarea` block.\n* `checkbox`: The sub-property will be rendered as a `form-input.checkbox` block.\n* `upload`: The sub-property will be rendered as a `form-input.upload` block.\n\n## App Behavior\n\nThe JSON schema created in Master Data is responsible for informing the form blocks about the data they should receive. It specifies the type of input expected for each form field from users.\n\nWhen the user clicks the `Submit` button, the form blocks retrieve all input data and send it to the Schema validation. This process, which involves understanding the expected input and sending it to Master Data, is facilitated by the [React Hook Form JSON schema](https://read.calvincode.net/reader?url=https://github.com/vtex/react-hook-form-jsonschema) library working behind the scenes.\n\nIf any unexpected answer is detected, and the form blocks does not match the Schema, Master Data will be unable to create a user form, and an error message will be returned to the user.\n\n## Customization\n\nIn order to apply CSS customizations to this and other blocks, follow the instructions in [Using CSS handles for store customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS handles |\n| ------------------- |\n| form |\n| formLoading |\n| formErrorLoading |\n| formSubmitContainer |\n| formSubmitButton |\n| formErrorServer |\n| formErrorUserInput |\n\n[Store Locator« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-locator)[Store LinkNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-link)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-form%23configuration)\n\n[form-input.radiogroup, form-input.dropdown, form-input.textarea and form-input.checkbox props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-form%23form-inputradiogroup-form-inputdropdown-form-inputtextarea-and-form-inputcheckbox-props)[form-input.textarea props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-form%23form-inputtextarea-props)[form-input.text props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-form%23form-inputtext-props)[form-field-group props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-form%23form-field-group-props)[form-input.upload props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-form%23form-inputupload-props)\n\n[App Behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-form%23app-behavior)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-form/docs/apps/vtex.store-form%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_7bdf36dd
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX responsive layout app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/troubleshooting)\n\n[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.responsive-layout/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.tab-layout)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.tab-layout)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/vtex-io-apps)\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/guides/layout-apps)\n\nResponsive Layout\n\nOfficial extension\n\nVersion: 0.1.4\n\nLatest version: 0.1.4\n\n[](#contributors-)\n\nResponsive Layout allows you to declare layout structures that will only be rendered in a specific screen-size breakpoint.\n\n\n\nThis app defines and exports four blocks:\n\n* `responsive-layout.desktop`\n* `responsive-layout.mobile`\n* `responsive-layout.tablet`\n* `responsive-layout.phone`\n\nEach block has `composition: children`, which means that it expects to receive an array of `children` blocks for rendering if the current screen-size is right for its breakpoint.\n\n## Configuration\n\n1. Import the Responsive Layout app to your theme dependencies in the `manifest.json`. For example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.responsive-layout\": \"0.x\" \n\n3\n\n } \n\n`\n\n1. Add the `responsive-layout` block to your theme. For example:\n\n`1\n\n \"store.custom#about-us\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"responsive-layout.desktop\", \n\n4\n\n \"responsive-layout.tablet\", \n\n5\n\n \"responsive-layout.phone\" \n\n6\n\n ] \n\n7\n\n }, \n\n8\n\n \n9\n\n \"responsive-layout.desktop\": { \n\n10\n\n \"children\": [\"rich-text#desktop\"] \n\n11\n\n }, \n\n12\n\n \"responsive-layout.tablet\": { \n\n13\n\n \"children\": [\"rich-text#tablet\"] \n\n14\n\n }, \n\n15\n\n \"responsive-layout.phone\": { \n\n16\n\n \"children\": [\"rich-text#phone\"] \n\n17\n\n }, \n\n18\n\n \n19\n\n \"rich-text#desktop\": { \n\n20\n\n \"props\": { \n\n21\n\n \"text\": \"# This will only show up on desktop.\", \n\n22\n\n \"blockClass\": \"title\" \n\n23\n\n } \n\n24\n\n }, \n\n25\n\n \"rich-text#tablet\": { \n\n26\n\n \"props\": { \n\n27\n\n \"text\": \"# This will only show up on tablet.\", \n\n28\n\n \"blockClass\": \"title\" \n\n29\n\n } \n\n30\n\n }, \n\n31\n\n \"rich-text#phone\": { \n\n32\n\n \"props\": { \n\n33\n\n \"text\": \"# This will only show up on phone.\", \n\n34\n\n \"blockClass\": \"title\" \n\n35\n\n } \n\n36\n\n }, \n\n`\n\nNote that you could use _any_ array of blocks as `children`, given that they are allowed by the `block` that is directly above `responsive-layout`.\n\n[Overlay Layout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.overlay-layout)[Slider LayoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.slider-layout)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-layout/docs/apps/vtex.responsive-layout%23configuration)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_1bc9b33f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX search Autocomplete app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/troubleshooting)\n\n[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.search/Autocomplete/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/guides/basic-components)\n\nAutocomplete\n\n[vtex.search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search)\n\nVersion: 2.18.7\n\nLatest version: 2.18.7\n\nAutocomplete is the [Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb) feature that displays previous search results based on current and previous searches. These results are presented in four different lists, which can be together or separated, depending on the customer's interaction. It includes:\n\n* Top Searches.\n* Search History.\n* Search Suggestions.\n* Product Suggestions.\n\nDuring the interaction with the search bar, Intelligent Search immediately displays the set of Top Searches and Search History (if the customer has done searches before).\n\nWhen the user starts typing, the system displays the Search suggestions and the Product suggestions and removes the previous lists.\n\nYou can read a detailed explanation of Autocomplete and its features in the [Autocomplete](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4gXFsEWjF7QF7UtI2GAvhL) user guide.\n\n## Before you begin\n\nMake sure you have added the `search` app to your theme dependencies in the `manifest.json` as shown below:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.search\": \"2.x\" \n\n3\n\n } \n\n`\n\nCheck the [Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search) app documentation for more details on this step.\n\n## Usage\n\nAdd `autocomplete-result-list.v2` into the blocks of a `search-bar`. We also recommend to set `openAutocompleteOnFocus` as shown.\n\n`1\n\n{ \n\n2\n\n \"autocomplete-result-list.v2\": { \n\n3\n\n \"blocks\": [\"product-summary\"] \n\n4\n\n }, \n\n5\n\n \"search-bar\": { \n\n6\n\n \"blocks\": [\"autocomplete-result-list.v2\"], \n\n7\n\n \"props\": { \n\n8\n\n \"openAutocompleteOnFocus\": true \n\n9\n\n } \n\n10\n\n } \n\n11\n\n} \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| maxTopSearches | Number | Maximum number of terms in the top searches list. | 10 |\n| maxHistory | Number | Maximum number of terms in the search history list. | 5 |\n| maxSuggestedProducts | Number | Maximum number of suggested products. | 3 |\n| maxSuggestedTerms | Number | Maximum number of suggested terms. | 3 |\n| autocompleteWidth | Number | Autocomplete width. Number between 0 and 100. | \\- |\n| productLayout | [ProductLayoutEnum](#productlayoutenum) | Defines the product layout in the suggested products list. | \\- |\n| hideTitles | Boolean | If true, all the titles will be hidden. | false |\n| historyFirst | Boolean | If true, the Search History list will be prioritized. | false |\n| customBreakpoints | [CustomBreakpointsProp](#custombreakpointsprop) | Defines a maximum number of suggested products by breakpoints. | \\- |\n| simulationBehavior | \"skip\" or \"default\" | If you want faster searches and do not care about most up to date prices and promotions, use \"skip\" value. | default |\n| customPage | string | Defines a custom page to the autocomplete links. Example: store.search.custom. | store.search |\n| orderBy | enum | Determines which order products must follow when displayed. The possible values are named after the order type: OrderByTopSaleDESC, OrderByReleaseDateDESC, OrderByBestDiscountDESC, OrderByPriceDESC, OrderByPriceASC, OrderByNameASC, or OrderByNameDESC. ASC and DESC stand for ascending order and descending order, respectively, based on the position of each value's corresponding code in the [ASCII table](https://read.calvincode.net/reader?url=http://www.asciitable.com/). If not set to any of the mentioned values, the fallback behavior is sorting by [relevance settings](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/1qlObWIib6KqgrfX1FCOXS). OrderByScoreDESC is **not** a valid value for this prop. | \"\" |\n\n#### ProductLayoutEnum\n\n| Enum name | Enum value |\n| ---------- | ---------- |\n| Horizontal | HORIZONTAL |\n| Vertical | VERTICAL |\n\n#### CustomBreakpointsProp\n\n| Prop name | Type | Description | Default value |\n| --------- | --------------------------------- | ------------------------------------------- | ------------- |\n| md | [BreakpointProp](#breakpointprop) | Defines the options for the md breakpoint. | \\- |\n| lg | [BreakpointProp](#breakpointprop) | Defines the options for the lg breakpoint. | \\- |\n| xlg | [BreakpointProp](#breakpointprop) | Defines the options for the xlg breakpoint. | \\- |\n\n#### BreakpointProp\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ------ | -------------------------------------------------------- | ------------- |\n| width | Number | Minimum width for the breakpoint. | \\- |\n| maxSuggestedProducts | Number | Maximum number of suggested products for the breakpoint. | \\- |\n\n[Add To Cart Button« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.add-to-cart-button)[BannerNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.search/banner)\n\nSee also\n\n[Vtex.searchVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.search)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.search/Autocomplete%23before-you-begin)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.search/Autocomplete%23usage)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/Autocomplete/docs/apps/vtex.search/Autocomplete%23props)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_6b9a1573
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore delivery promise implementation in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/troubleshooting)\n\n[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/delivery-promise-implementation/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation)\n\n[Understanding Delivery Promise operation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-overview)\n\n[Working with Delivery Promise components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-components)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation)\n\n[Understanding Delivery Promise operation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-overview)\n\n[Working with Delivery Promise components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-components)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-overview)\n\nImplementing Delivery Promise\n\n> This feature is in closed beta, which means that only selected customers have access to it. If you're interested in implementing it in the future, please contact our [Support](https://read.calvincode.net/reader?url=https://support.vtex.com/hc/en-us) team.\n\n**Delivery Promise** is a feature that provides accurate and reliable delivery estimates for available products based on the customer's location. It ensures that customers only see products that are in stock and can be delivered to their address or picked up at a nearby location.\n\nThis solution continuously updates product availability throughout the buying journey by responding to changes in catalog, pricing, inventory, or shipping settings. These updates are then sent to [Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview) and [Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search), ensuring customers see up-to-date options based on their region.\n\nIn this guide, you'll learn how to configure Delivery Promise in your FastStore project.\n\n> To understand how Delivery Promise operates, see the [Understanding Delivery Promise operation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview) guide. For more information about Delivery Promise components, see the [Working with Delivery Promise components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-components) guide.\n\n## Default settings\n\nDelivery Promise is defined in the `deliveryPromise` section of the [discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options) file.\n\nThe default settings are:\n\ndiscovery.config.js\n\n`1\n\ndeliveryPromise: { \n\n2\n\n enabled: true, \n\n3\n\n mandatory: false \n\n4\n\n }, \n\n`\n\n* `enabled`: When set to **true**, Delivery Promise activates, allowing the store to provide delivery estimates based on the user's location.\n* `mandatory`: When set to **true**, users must provide a postal code. By default, this is **false**, allowing users to browse and add items to the cart without entering their postal code. However, without a postal code, the accuracy of delivery information may be limited.\n\n## Before you begin\n\n### Get the `search-session` app\n\nCheck if you have version `0.5.0` or later of the [search-session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-session) app installed.\n\n1. In your terminal, run the `vtex list` command.\n2. In the returned results, search for the app.\n3. If you don't have this app installed, run the command `vtex install vtex.search-session`.\n\n### Enable the VTEX Intelligent Search app\n\nTo enable the Intelligent Search app, check the version of your [Edition Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) account.\n\nIn your terminal, log in to your account by running `vtex login {accountName}` and run `vtex edition get` to see the Edition app version installed. _Remember to replace the values between curly braces with your account name_.\n\nAccounts with `vtex.edition-store@5.x`\n\nIf your account is using the `vtex.edition-store@5.x` major version, the VTEX Intelligent Search app is already included, and you need to integrate it via VTEX Admin.\n\nTo integrate VTEX Intelligent Search, access **Store Settings > Intelligent Search > Integrations** in the VTEX Admin, and click `START INTEGRATION`.\n\nAccounts with an edition version older than `5.x`\n1. In the VTEX IO CLI, log in to your VTEX account by running `vtex login {accountName}`. _Remember to replace the values between curly braces with your account name._\n2. If the VTEX Intelligent Search app isn't installed in your account, run the following command: \n`1 \nvtex install vtex.search-resolver@1.x vtex.admin-search@1.x \n`\n\nAfter installing the app, integrate it by going to **Store Settings > Intelligent Search > Integrations** in the VTEX Admin, and clicking `START INTEGRATION`.\n\nAccounts that want to migrate to version `5.x`\n\nIf you're using a different major version and want to migrate, please [open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support) and request the installation of Edition app `vtex.edition-store@5.x`.\n\n### Update the `@faststore/cli` package\n\nRun the `yarn upgrade @faststore/cli` command to update the `@faststore/cli` package to the latest version.\n\n### Open a ticket with VTEX Support\n\nOpen a ticket with [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support) and request the activation of Delivery Promise in your account.\n\n## Instructions\n\n### Step 1 - Enabling `deliveryPromise`\n\n1. Open your FastStore project using the code editor of your choice.\n2. Open the [discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options) file.\n3. Under the [deliveryPromise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options%23deliverypromise) section, set the `enabled` value to `true`. Set the `mandatory` value based on your business needs. Learn more in the [Default settings](#default-settings) section. \ndiscovery.config.js \n`1 \ndeliveryPromise: { \n2 \n enabled: true, \n3 \n mandatory: false, \n4 \n} \n`\n\n### Step 2 - Syncing your FastStore project with Headless CMS\n\nRun the `faststore cms-sync` command to sync the `cms` folder of your FastStore project with [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview).\n\nThe expected response is the message `CMS synced successfully...`. The native regionalization components and sections will be automatically updated. You can check them in the VTEX Admin:\n\n* **Regionalization component:** Go to **Storefronts > Headless CMS > Global Sections > NavBar > Navigation > Regionalization**.\n* **Region Bar section:** Go to **Storefronts > Headless CMS > Global Sections > Region Bar**.\n* **Region Modal section:** Go to **Storefronts > Headless CMS > Global Sections > Region Modal**.\n\nYou only need to [add a new section](#step-3-adding-region-popover-section): `Region Popover`.\n\n### Step 3 - Adding the `Region Popover` section\n\n`RegionPopover` is a section that manages user location inputs. It's used when location data is missing or the store default postal code is applied. `RegionPopover` is available in [@faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson) and uses the [Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-popover) component as its UI base.\n\n\n\n`RegionPopover` code\n\npackages/core/src/components/region/RegionPopover/RegionPopover.tsx\n\n`` 1\n\nimport type { PopoverProps as UIPopoverProps } from '@faststore/ui' \n\n2\n\nimport { \n\n3\n\n Icon as UIIcon, \n\n4\n\n InputField as UIInputField, \n\n5\n\n Link as UILink, \n\n6\n\n Popover as UIPopover, \n\n7\n\n useUI, \n\n8\n\n} from '@faststore/ui' \n\n9\n\nimport { useRef, useState } from 'react' \n\n10\n\n \n11\n\nimport useRegion from '../RegionModal/useRegion' \n\n12\n\n \n13\n\nimport { sessionStore, useSession } from 'src/sdk/session' \n\n14\n\nimport { textToTitleCase } from 'src/utils/utilities' \n\n15\n\nimport styles from './section.module.scss' \n\n16\n\n \n17\n\ninterface RegionPopoverProps { \n\n18\n\n title?: UIPopoverProps['title'] \n\n19\n\n closeButtonAriaLabel?: UIPopoverProps['closeButtonAriaLabel'] \n\n20\n\n inputField?: { \n\n21\n\n label?: string \n\n22\n\n errorMessage?: string \n\n23\n\n noProductsAvailableErrorMessage?: string \n\n24\n\n buttonActionText?: string \n\n25\n\n } \n\n26\n\n idkPostalCodeLink?: { \n\n27\n\n text?: string \n\n28\n\n to?: string \n\n29\n\n icon?: { \n\n30\n\n icon?: string \n\n31\n\n alt?: string \n\n32\n\n } \n\n33\n\n } \n\n34\n\n textBeforeLocation?: string \n\n35\n\n textAfterLocation?: string \n\n36\n\n description?: string \n\n37\n\n triggerRef?: UIPopoverProps['triggerRef'] \n\n38\n\n onDismiss: UIPopoverProps['onDismiss'] \n\n39\n\n offsetTop?: UIPopoverProps['offsetTop'] \n\n40\n\n offsetLeft?: UIPopoverProps['offsetLeft'] \n\n41\n\n placement?: UIPopoverProps['placement'] \n\n42\n\n} \n\n43\n\n \n44\n\nfunction RegionPopover({ \n\n45\n\n title = 'Set your location', \n\n46\n\n closeButtonAriaLabel, \n\n47\n\n inputField: { \n\n48\n\n label: inputFieldLabel, \n\n49\n\n errorMessage: inputFieldErrorMessage, \n\n50\n\n noProductsAvailableErrorMessage: inputFieldNoProductsAvailableErrorMessage, \n\n51\n\n buttonActionText: inputButtonActionText, \n\n52\n\n }, \n\n53\n\n idkPostalCodeLink: { \n\n54\n\n text: idkPostalCodeLinkText, \n\n55\n\n to: idkPostalCodeLinkTo, \n\n56\n\n icon: { icon: idkPostalCodeLinkIcon, alt: idkPostalCodeLinkIconAlt }, \n\n57\n\n }, \n\n58\n\n textBeforeLocation = 'Your current location is:', \n\n59\n\n textAfterLocation = 'Use the field below to change it.', \n\n60\n\n description = 'Offers and availability vary by location.', \n\n61\n\n triggerRef, \n\n62\n\n offsetTop = 6, \n\n63\n\n offsetLeft, \n\n64\n\n placement = 'bottom-start', \n\n65\n\n}: RegionPopoverProps) { \n\n66\n\n const inputRef = useRef<HTMLInputElement>(null) \n\n67\n\n const { isValidating, ...session } = useSession() \n\n68\n\n const { popover: displayPopover, closePopover } = useUI() \n\n69\n\n const { city, postalCode } = sessionStore.read() \n\n70\n\n const location = city ? `${textToTitleCase(city)}, ${postalCode}` : postalCode \n\n71\n\n \n72\n\n const [input, setInput] = useState<string>('') \n\n73\n\n \n74\n\n const { loading, setRegion, regionError, setRegionError } = useRegion() \n\n75\n\n \n76\n\n const handleSubmit = async () => { \n\n77\n\n if (isValidating) { \n\n78\n\n return \n\n79\n\n } \n\n80\n\n \n81\n\n await setRegion({ \n\n82\n\n session, \n\n83\n\n onSuccess: () => { \n\n84\n\n setInput('') \n\n85\n\n closePopover() \n\n86\n\n }, \n\n87\n\n postalCode: input, \n\n88\n\n errorMessage: inputFieldErrorMessage, \n\n89\n\n noProductsAvailableErrorMessage: \n\n90\n\n inputFieldNoProductsAvailableErrorMessage, \n\n91\n\n }) \n\n92\n\n } \n\n93\n\n \n94\n\n const idkPostalCodeLinkProps = { \n\n95\n\n href: idkPostalCodeLinkTo, \n\n96\n\n children: ( \n\n97\n\n <> \n\n98\n\n {idkPostalCodeLinkText} \n\n99\n\n {!!idkPostalCodeLinkIcon && ( \n\n100\n\n <UIIcon \n\n101\n\n name={idkPostalCodeLinkIcon} \n\n102\n\n aria-label={idkPostalCodeLinkIconAlt} \n\n103\n\n width={20} \n\n104\n\n height={20} \n\n105\n\n /> \n\n106\n\n )} \n\n107\n\n </> \n\n108\n\n ), \n\n109\n\n } \n\n110\n\n \n111\n\n const RegionPopoverContent = ( \n\n112\n\n <> \n\n113\n\n <span data-fs-region-popover-description> \n\n114\n\n {postalCode ? ( \n\n115\n\n <> \n\n116\n\n {textBeforeLocation} <span>{location}</span>. {textAfterLocation} \n\n117\n\n </> \n\n118\n\n ) : ( \n\n119\n\n <>{description}</> \n\n120\n\n )} \n\n121\n\n </span> \n\n122\n\n <UIInputField \n\n123\n\n data-fs-region-popover-input \n\n124\n\n id=\"region-popover-input-postal-code\" \n\n125\n\n inputRef={inputRef} \n\n126\n\n label={inputFieldLabel} \n\n127\n\n actionable \n\n128\n\n value={input} \n\n129\n\n onInput={(e) => { \n\n130\n\n regionError !== '' && setRegionError('') \n\n131\n\n setInput(e.currentTarget.value) \n\n132\n\n }} \n\n133\n\n onSubmit={handleSubmit} \n\n134\n\n onClear={() => { \n\n135\n\n setInput('') \n\n136\n\n setRegionError('') \n\n137\n\n }} \n\n138\n\n buttonActionText={loading ? '...' : inputButtonActionText} \n\n139\n\n error={regionError} \n\n140\n\n /> \n\n141\n\n {idkPostalCodeLinkTo && ( \n\n142\n\n <UILink data-fs-region-popover-link {...idkPostalCodeLinkProps} /> \n\n143\n\n )} \n\n144\n\n </> \n\n145\n\n ) \n\n146\n\n \n147\n\n return ( \n\n148\n\n <> \n\n149\n\n {displayPopover.isOpen && ( \n\n150\n\n <div className={`${styles.section} section-region-popover`}> \n\n151\n\n <UIPopover \n\n152\n\n data-fs-region-popover \n\n153\n\n title={title} \n\n154\n\n isOpen={displayPopover.isOpen} \n\n155\n\n content={RegionPopoverContent} \n\n156\n\n placement={placement} \n\n157\n\n dismissible \n\n158\n\n triggerRef={triggerRef} \n\n159\n\n offsetTop={offsetTop} \n\n160\n\n offsetLeft={offsetLeft} \n\n161\n\n closeButtonAriaLabel={closeButtonAriaLabel} \n\n162\n\n onEntered={() => { \n\n163\n\n if (!postalCode && inputRef.current) { \n\n164\n\n inputRef.current.focus() \n\n165\n\n } \n\n166\n\n }} \n\n167\n\n /> \n\n168\n\n </div> \n\n169\n\n )} \n\n170\n\n </> \n\n171\n\n ) \n\n172\n\n} \n\n173\n\n \n174\n\nexport default RegionPopover \n\n ``\n\nFollow the steps below to add the `RegionPopover` section to Headless CMS.\n\n1. In the VTEX Admin, go to **Storefront > Headless CMS > Global Sections**.\n2. In the Sections tab, click `+` to open a modal with a list of section options.\n3. Search for the **Region Popover** section and click it to add it.\n4. Set the `Title` and `Close popover aria-label` fields with your values.\n5. Click `Save` to save your changes.\n6. Click `Publish` to open a dropdown list with the options `Add to Release` (to schedule the update) and `Publish now` (to publish immediately).\n\nLearn more in [Adding sections to Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-3-adding-content-types-and-sections%23step-3-adding-sections-to-the-headless-cms)\n\n### Step 4 - (Optional) Defining a default postal code\n\nThe default postal code is a fallback mechanism when users don't provide a location, aren't logged in, or have no saved address.\n\nTo set a default postal code for your store, follow the steps below:\n\n1. Open your FastStore project using the code editor of your choice.\n2. Open the [discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options) file.\n3. In the [session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options%23session) object, set your default `postalCode`. See the example below: \ndiscovery.config.js \n`1 \n session: { \n2 \n currency: { \n3 \n code: \"USD\", \n4 \n symbol: \"$\", \n5 \n }, \n6 \n locale: \"en-US\", \n7 \n channel: '{\"salesChannel\":\"1\",\"regionId\":\"\"}', \n8 \n country: \"USA\", \n9 \n deliveryMode: null, \n10 \n addressType: null, \n11 \n city: null, \n12 \n postalCode: 10021, \n13 \n geoCoordinates: null, \n14 \n person: null, \n15 \n }, \n`\n\n## Managing Delivery Promise filters and labels\n\nDelivery Promise [filters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview%23filter-options) help shoppers narrow products by delivery/pickup availability for their location, while [badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-components) visually indicate shipping/pickup availability for the shopper's location when Delivery Promise data exists.\n\nBy default, filters and badges are active once Delivery Promise is enabled and implemented in the store. However, you can deactivate them (Global Filter by Pickup Point, [Delivery Option](https://read.calvincode.net/reader?url=https://newhelp.vtex.com/docs/tutorials/delivery-options-beta), and [Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview%23badges) and edit their labels in the Headless CMS. To do this, follow these steps.\n\n> For more details on filters and badges, see the [Working with Delivery Promise components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-components) guide.\n\n1. Access the VTEX Admin and go to **Storefront > Headless CMS**.\n2. Click the **Global Sections** Content Type.\n3. Click the **Settings** tab.\n4. Go to the **Delivery Promise** section and change the labels and settings to suit your scenario.\n\n\n\n## Enabling the Availability (In-stock) filter\n\nBy default, the [Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview%23plp-or-search-page-filters) filter is disabled in the Headless CMS. To enable this feature, follow these steps:\n\n### Setting up `hideUnavailableItems`\n\n1. Open your FastStore project in the code editor of your choice.\n2. Open the `discovery.config.js` file.\n3. In the `hideUnavailableItems` property, change the value to `false`. \n`1 \n... \n2 \napi: { \n3 \n storeId: \"newstore\", \n4 \n workspace: \"master\", \n5 \n environment: \"vtexcommercestable\", \n6 \n hideUnavailableItems: false, \n7 \n incrementAddress: false, \n8 \n}, \n9 \n... \n`\n4. Create a new branch and open a pull request to deploy the change made in the `discovery.config.js` file to production.\n\n### Enabling the filter in the Headless CMS\n\nAfter changing the `hideUnavailableItems` value to `false`, you can enable this filter in the Headless CMS.\n\n1. Access VTEX Admin and go to **Storefront > Headless CMS**.\n2. Click the **Global Sections** Content Type.\n3. Click the **Settings** tab.\n4. Go to the **Delivery Promise** section and check the field **Should display In Stock filter?**\n\n\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/features/delivery-promise/implementation.mdx)\n\n[Managing product images in specific contexts« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)[Understanding Delivery Promise operationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-overview)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Default settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23default-settings)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23before-you-begin)\n\n[Get the search-session app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23get-the-search-session-app)[Enable the VTEX Intelligent Search app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23enable-the-vtex-intelligent-search-app)[Update the @faststore/cli package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23update-the-faststorecli-package)[Open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23open-a-ticket-with-vtex-support)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23instructions)\n\n[Step 1 - Enabling deliveryPromise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23step-1-enabling-deliverypromise)[Step 2 - Syncing your FastStore project with Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23step-2-syncing-your-faststore-project-with-headless-cms)[Step 3 - Adding the Region Popover section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23step-3-adding-the-region-popover-section)[Step 4 - (Optional) Defining a default postal code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23step-4-optional-defining-a-default-postal-code)\n\n[Managing Delivery Promise filters and labels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23managing-delivery-promise-filters-and-labels)\n\n[Enabling the Availability (In-stock) filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23enabling-the-availability-in-stock-filter)\n\n[Setting up hideUnavailableItems](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23setting-up-hideunavailableitems)[Enabling the filter in the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23enabling-the-filter-in-the-headless-cms)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/features/delivery-promise/implementation.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Default settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23default-settings)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23before-you-begin)\n\n[Get the search-session app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23get-the-search-session-app)[Enable the VTEX Intelligent Search app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23enable-the-vtex-intelligent-search-app)[Update the @faststore/cli package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23update-the-faststorecli-package)[Open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23open-a-ticket-with-vtex-support)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23instructions)\n\n[Step 1 - Enabling deliveryPromise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23step-1-enabling-deliverypromise)[Step 2 - Syncing your FastStore project with Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23step-2-syncing-your-faststore-project-with-headless-cms)[Step 3 - Adding the Region Popover section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23step-3-adding-the-region-popover-section)[Step 4 - (Optional) Defining a default postal code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23step-4-optional-defining-a-default-postal-code)\n\n[Managing Delivery Promise filters and labels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23managing-delivery-promise-filters-and-labels)\n\n[Enabling the Availability (In-stock) filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23enabling-the-availability-in-stock-filter)\n\n[Setting up hideUnavailableItems](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23setting-up-hideunavailableitems)[Enabling the filter in the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation/docs/guides/faststore/delivery-promise-implementation%23enabling-the-filter-in-the-headless-cms)\n\nOn this page\n\n[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=)"
}
] |
doc_96201e27
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX store icons app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/troubleshooting)\n\n[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.store-icons/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/guides/functional-apps)\n\nStore Icons\n\nOfficial extension\n\nVersion: 0.18.0\n\nLatest version: 0.18.0\n\n[](https://travis-ci.org/vtex-apps/store-icons)\n\nAll Store icons components.\n\n## Table of Contents\n\n* [Store Icons](#store-icons) \n * [Description](#description) \n * [Release schedule](#release-schedule) \n * [Table of Contents](#table-of-contents) \n * [Concept](#concept) \n * [Usage](#usage) \n * [Dedicated Icon](#dedicated-icon) \n * [Generic Icon](#generic-icon) \n * [Icons](#icons) \n * [Props](#props) \n * [Icons List](#icons-list) \n * [Brand](#brand) \n * [High Priority Actions](#high-priority-actions) \n * [Middle Priority Actions](#middle-priority-actions) \n * [Informational](#informational) \n * [Navigation](#navigation) \n * [Status Indicators](#status-indicators) \n * [Customize](#customize) \n * [Overwriting the default IconPack](#overwriting-the-default-iconpack) \n * [Nomenclature](#nomenclature) \n * [Icon Intention](#icon-intention) \n * [Troubleshooting](#troubleshooting) \n * [Contributing](#contributing) \n * [Tests](#tests)\n\n## Concept\n\nThis project is based on [SVG fragment identifiers](https://read.calvincode.net/reader?url=https://css-tricks.com/svg-fragment-identifiers-work/). All store icons are served by Render SDK, and with HTML tag `<use>` we can render a fragment from our icon pack. If you want to know the complete list of fragment SVG's, [see here](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/docs/ICONPACK.md)\n\n## Usage\n\nFirst of all, add into the dependencies of your `manifest.json` and use it as an npm module:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.store-icons\": \"0.x\" \n\n3\n\n} \n\n`\n\nThere are two different ways to use the icons available here. If you're developing a store's theme, you should use the `icon` block for the icon you want to render, which behaves just like any other block and expects to receive the props exposed by its [API](#props). But if you're developing custom components and want to use icons defined here, just follow the instructions below.\n\n### Dedicated Icon\n\nImport the desired icon and use it into your code, for example:\n\n`1\n\nimport { IconMenu } from 'vtex.store-icons' \n\n2\n\n \n3\n\nconst YourComponent = (props) => <IconMenu /> \n\n`\n\nYou can see [here](#icon-list) a list of every available icon.\n\n### Generic Icon\n\nThe API provides a generic icon, The `Icon` component. You can choose from any other icon passing only the `id` from the respective one you want to add.\n\nFor example:\n\n`1\n\nimport { Icon } from 'vtex.store-icons' \n\n2\n\n \n3\n\nconst YourComponent = (props) => <Icon id=\"hpa-cart\" /> \n\n`\n\n⚠️ This component is meant to be used on icons there aren't common throughout the store. Choose [dedicated](#dedicated-icon) components whenever possible.\n\n## Icons\n\n### Props\n\nAny icon can receive the following props:\n\n| Property | Description | Type | Default value |\n| --------------- | ------------------------------------------ | ------- | ------------- |\n| id | The ID for the desired icon | String | '' |\n| size | Desired size | Number | 16 |\n| isActive | desc | Boolean | true |\n| activeClassName | The className it should have if active | String | 🚫 |\n| mutedClassName | The className it should have if not active | String | 🚫 |\n\nObs: **...props**: It is important to notice that any other `<svg>` prop passed will work with an icon as well.\n\n#### Enhanced Props\n\nSome components support modifiers. These are props that define the icon type, orientation, state or shape.\n\n| Modifier | Possible values |\n| ----------- | --------------------- |\n| type | filled line outline |\n| orientation | up down left right |\n| state | on off |\n| shape | square rounded circle |\n\n### Icon List\n\n#### Brand\n\n| Component | id | Type | Orientation | State | Shape | |\n| -------------------------------------------------------------------------------------------- | ------ | ---- | ----------- | ----- | ----------------- | ------ |\n| [IconSocial](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconSocial.js) | social | 🚫 | 🚫 | 🚫 | square \\| rounded | circle |\n\n#### High Priority Actions\n\n| Component | id | Type | Orientation | State | Shape |\n| ------------------------------------------------------------------------------------------------------------ | --------------- | ---- | ----------- | ----- | ----- |\n| [IconArrowBack](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconArrowBack.js) | arrow-back | 🚫 | 🚫 | 🚫 | 🚫 |\n| [IconAssistantSales](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconAssistantSales.js) | assistant-sales | 🚫 | 🚫 | 🚫 | 🚫 |\n| [IconProfile](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconProfile.js) | profile | 🚫 | 🚫 | 🚫 | 🚫 |\n| [IconCart](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconCart.js) | cart | 🚫 | 🚫 | 🚫 | 🚫 |\n| [IconSearch](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconSearch.js) | search | 🚫 | 🚫 | 🚫 | 🚫 |\n| [IconDelete](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconDelete.js) | delete | 🚫 | 🚫 | 🚫 | 🚫 |\n| [IconMenu](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconMenu.js) | menu | 🚫 | 🚫 | 🚫 | 🚫 |\n| [IconLocationMarker](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconLocationMarker.js) | location-marker | 🚫 | 🚫 | 🚫 | 🚫 |\n\n#### Medium Priority Actions\n\n| Component | id | Type | Orientation | State | Shape | |\n| ---------------------------------------------------------------------------------------------------- | ----------- | ----------------- | ----------- | --------- | --------- | -- |\n| [IconEyesight](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconEyesight.js) | eyesight | filled \\| outline | 🚫 | on \\| off | 🚫 | |\n| [IconMinus](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconMinus.js) | minus | filled \\| outline | line | 🚫 | 🚫 brands | |\n| [IconPlus](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blobrandseact/IconPlus.js) | plus | filled \\| outline | line | 🚫 | 🚫 | 🚫 |\n| [IconSingleItem](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconSingleItem.js) | single-item | 🚫 | 🚫 | 🚫 | 🚫 | |\n| [IconList](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconList.js) | list | 🚫 | 🚫 | 🚫 | 🚫 | |\n| [IconGallery](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconGallery.js) | gallery | 🚫 | 🚫 | 🚫 | 🚫 | |\n| [IconRemove](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconRemove.js) | remove | 🚫 | 🚫 | 🚫 | 🚫 | |\n| [IconSwap](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconSwap.js) | swap | 🚫 | 🚫 | 🚫 | 🚫 | |\n| [IconHeart](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconHeart.js) | heart | 🚫 | 🚫 | 🚫 | 🚫 | |\n| [IconGlobe](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconGlobe.js) | globe | 🚫 | 🚫 | 🚫 | 🚫 | |\n| [IconBookmark](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconBookmark.js) | bookmark | filled \\| outline | 🚫 | 🚫 | 🚫 | |\n| [IconPlay](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconPlay.js) | play | filled \\| outline | 🚫 | 🚫 | 🚫 | |\n| [IconPause](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconPause.js) | pause | filled \\| outline | 🚫 | 🚫 | 🚫 | |\n\n#### Navigation\n\n| Component | id | Type | Orientation | State | Shape | | |\n| ------------------------------------------------------------------------------------------ | ----- | ---- | ----------- | ----- | ----- | -- | -- |\n| [IconCaret](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconCaret.js) | caret | 🚫 | up \\| down | left | right | 🚫 | 🚫 |\n\n#### Status Indicators\n\n| Component | id | Type | Orientation | State | Shape | |\n| -------------------------------------------------------------------------------------------------- | ---------- | ----------------- | ----------- | ----- | ----- | -- |\n| [IconClose](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconClose.js) | close | filled \\| outline | 🚫 | 🚫 | 🚫 | |\n| [IconCheck](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconCheck.js) | check | filled \\| outline | line | 🚫 | 🚫 | 🚫 |\n| [IconVolumeOn](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconVolumeOn.js) | volume-on | filled \\| outline | line | 🚫 | 🚫 | 🚫 |\n| [IconVolumeOff](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/feature/docs/react/IconVolumeOff.js) | volume-off | filled \\| outline | line | 🚫 | 🚫 | 🚫 |\n\n## Customize\n\nIn the [usage](#usage) section, we discuss two ways of using icons. These ways extend to customization, so, prefer to change an existing Icon so that you can use the [dedicated](#dedicated-icon) version. You can check how to override and name icons below.\n\n### Overwriting the default IconPack\n\nAs mentioned before, all icon IDs are stored at the [iconpack.svg](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/docs/ICONPACK.md) file. You can overwrite the default one by:\n\n1. On your [store-theme](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme/tree/master/styles) create a new folder called `iconpacks`\n2. Create a file called `iconpack.svg`\n3. Declare your icon IDs (use the default `iconpack` as an example in how to do that properly).\n\n### Nomenclature\n\nThe naming convention is: [intention](#icon-intention)\\-[id](#icon-list)\\--[?modifiers](#enhanced-props)\n\nWhere the `modifiers` follows the rule:`?type`\\--`?orientation`\\--`?state`\\--`?shape`\n\n**🤓 ? stands for optional inputs**\n\n#### Icon Intention\n\n`bnd` **Brand** \\- Display logos, brands or advertisements.\n\n`hpa` **High priority actions** \\- Actions that are important to the global context.\n\n`mpa` **Mild priority actions** \\- Actions that are important only to the current component context.\n\n`inf` **Informational** \\- Represents information display or actions that, when triggered, reveal further details about the current context.\n\n`nav` **Navigation** \\- Actions that triggers navigation.\n\n`sti` **Status indicators** \\- Indicates the current item/component semantic status.\n\n## CSS Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles |\n| -------------------- |\n| 'arrowBackIcon' |\n| 'assistantSalesIcon' |\n| 'caretIcon' |\n| 'cartIcon' |\n| 'checkIcon' |\n| 'closeIcon' |\n| 'deleteIcon' |\n| 'equalsIcon' |\n| 'eyeSightIcon' |\n| 'filterIcon' |\n| 'globeIcon' |\n| 'gridIcon' |\n| 'heartIcon' |\n| 'homeIcon' |\n| 'inlineGridIcon' |\n| 'locationInputIcon' |\n| 'locationMarkerIcon' |\n| 'menuIcon' |\n| 'minusIcon' |\n| 'plusIcon' |\n| 'profileIcon' |\n| 'removeIcon' |\n| 'searchIcon' |\n| 'singleGridIcon' |\n| 'socialIcon' |\n| 'starIcon' |\n| 'swapIcon' |\n| 'playIcon' |\n| 'pauseIcon' |\n| 'fullscreenIcon' |\n| 'volumeOnIcon' |\n| 'volumeOffIcon' |\n\n[Session Client GraphQL API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.session-client/session-client-graphql-api)[Store SitemapNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-sitemap)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)[ICONPACKVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-icons@0.18.0/ICONPACK)[BaselineVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-icons@0.18.0/script/baseline)\n\nON THIS PAGE\n\n[Table of Contents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-icons%23table-of-contents)\n\n[Concept](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-icons%23concept)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-icons%23usage)\n\n[Dedicated Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-icons%23dedicated-icon)[Generic Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-icons%23generic-icon)\n\n[Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-icons%23icons)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-icons%23props)[Icon List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-icons%23icon-list)\n\n[Customize](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-icons%23customize)\n\n[Overwriting the default IconPack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-icons%23overwriting-the-default-iconpack)[Nomenclature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-icons%23nomenclature)\n\n[CSS Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons/docs/apps/vtex.store-icons%23css-customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_f64ef96e
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides session manager in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/session-manager)\n\n[Session data aggregation: create and transform calls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/session-data-aggregation-create-and-transform-calls)\n\n[Session data available from VTEX apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/session-data-available-from-vtex-apps)\n\n[Adding telesales impersonated email using the Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/adding-telesales-impersonated-email-using-the-session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/session-manager)\n\n[Session data aggregation: create and transform calls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/session-data-aggregation-create-and-transform-calls)\n\n[Session data available from VTEX apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/session-data-available-from-vtex-apps)\n\n[Adding telesales impersonated email using the Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/adding-telesales-impersonated-email-using-the-session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides)\n\nIntegration Guides\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/session-manager)\n\nSession Manager\n\nSession Manager is a module that tracks the current browsing session of all clients on the VTEX platform. Important session information is automatically captured and stored in a secure and easily accessible location. This includes data such as relevant cookies, query strings, authentication credentials, current profile and pricing information, if applicable.\n\nThis article aims to describe Session Manager from a system design perspective. For further details on how to interact with the Session Manager API, check the [API reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/session-manager-api%23overview).\n\n## Getting and storing session information\n\nWhenever a new device comes in contact with the VTEX infrastructure, Session Manager receives a request for a new session. Events that would trigger this request include visiting a store page, opening the VTEX Admin panel and loading the inStore vendor interface, to name a few. After a new session is created, Session Manager will start receiving all the important information associated to navigation from that specific device.\n\nUsing the [Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/session-manager-api%23overview), you can make a request to receive the session data you need for your application. This includes important inferences made by VTEX modules. See [Data available from VTEX apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps) for more information.\n\nFor instance, a user with a specific campaign referral link might have a promotional price table set on his session, which will cause them to see updated prices when navigating the store that created that campaign.\n\nBesides getting session information for a device navigating in the VTEX infrastructure, Session Manager allows you to store your own custom data in that session. This information is easily recoverable and eliminates the need for other user tracking methods like cookies.\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/session-manager.md)\n\n[Reference Implementations« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager//docs/guides/external-search-provider-reference)[Session data aggregation: create and transform callsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager//docs/guides/session-data-aggregation-create-and-transform-calls)\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Getting and storing session information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/session-manager%23getting-and-storing-session-information)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/session-manager.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Getting and storing session information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-manager/docs/guides/session-manager%23getting-and-storing-session-information)\n\nOn this page\n\n[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=)"
}
] |
doc_bfc42a70
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX search 1.0.8 Autocomplete app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/troubleshooting)\n\n[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.search@1.0.8/Autocomplete/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/guides/basic-components)\n\nAutocomplete\n\n[vtex.search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search)\n\nVersion: 1.0.8\n\nLatest version: 2.18.8\n\n> This page is about version **1.0.8** of the app, which is not the most recent version. The latest stable version is **2.18.8**.\n\n## Description\n\n`Autocomplete` is an alternative for the default VTEX autocomplete. It includes:\n\n* Top Searches.\n* Search History.\n* Product Suggestions.\n* Term Suggestions.\n\nYou can read a detailed explanation of Autocomplete and it's features [here](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4gXFsEWjF7QF7UtI2GAvhL).\n\n## Usage\n\nAdd `autocomplete-result-list.v2` into the blocks of a `search-bar`. We also recommend to set `openAutocompleteOnFocus` as shown.\n\n`1\n\n{ \n\n2\n\n \"autocomplete-result-list.v2\": { \n\n3\n\n \"blocks\": [\"product-summary\"] \n\n4\n\n }, \n\n5\n\n \"search-bar\": { \n\n6\n\n \"blocks\": [\"autocomplete-result-list.v2\"], \n\n7\n\n \"props\": { \n\n8\n\n \"openAutocompleteOnFocus\": true \n\n9\n\n } \n\n10\n\n } \n\n11\n\n} \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ----------------------------------------------- | ------------------------------------------------------------- | ------------- |\n| maxTopSearches | Number | Maximum number of terms in the top searches list | 10 |\n| maxHistory | Number | Maximum number of terms in the search history list | 5 |\n| maxSuggestedProducts | Number | Maximum number of suggested products | 3 |\n| maxSuggestedTerms | Number | Maximum number of suggested terms | 3 |\n| autocompleteWidth | Number | Autocomplete width. Number between 0 and 100 | \\- |\n| productLayout | [ProductLayoutEnum](#productlayoutenum) | Defines the product layout in the suggested products list | \\- |\n| hideTitles | Boolean | If true, all the titles will be hidden | false |\n| historyFirst | Boolean | If true, the history list will be prioritized | false |\n| customBreakpoints | [CustomBreakpointsProp](#custombreakpointsprop) | Defines a maximum number of suggested products by breakpoints | \\- |\n\n#### ProductLayoutEnum\n\n| Enum name | Enum value |\n| ---------- | ---------- |\n| Horizontal | HORIZONTAL |\n| Vertical | VERTICAL |\n\n#### CustomBreakpointsProp\n\n| Prop name | Type | Description | Default value |\n| --------- | --------------------------------- | ------------------------------------------ | ------------- |\n| md | [BreakpointProp](#breakpointprop) | Defines the options for the md breakpoint | \\- |\n| lg | [BreakpointProp](#breakpointprop) | Defines the options for the lg breakpoint | \\- |\n| xlg | [BreakpointProp](#breakpointprop) | Defines the options for the xlg breakpoint | \\- |\n\n#### BreakpointProp\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ------ | ------------------------------------------------------- | ------------- |\n| width | Number | Minimum width for the breakpoint | \\- |\n| maxSuggestedProducts | Number | Maximum number of suggested products for the breakpoint | \\- |\n\n[Add To Cart Button« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.add-to-cart-button)[BannerNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.search/banner)\n\nSee also\n\n[Vtex.searchVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.search)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.search@1.0.8/Autocomplete%23description)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.search@1.0.8/Autocomplete%23usage)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Autocomplete/docs/apps/vtex.search@1.0.8/Autocomplete%23props)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_28eb3b2f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore project structure updating the core package version in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/troubleshooting)\n\n[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/project-structure-updating-the-core-package-version/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/developer-tools-overview)\n\n[Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/developer-tools-config-options)\n\n[Custom Cypress integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/developer-tools-custom-cypress)\n\n[FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/developer-tools-faststore-cli)\n\n[Updating the @fastore/cli package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/developer-tools-updating-the-cli-package-version)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/developer-tools-overview)\n\n[Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/developer-tools-config-options)\n\n[Custom Cypress integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/developer-tools-custom-cypress)\n\n[FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/developer-tools-faststore-cli)\n\n[Updating the @fastore/cli package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/developer-tools-updating-the-cli-package-version)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/developer-tools-overview)\n\nUpdating the '@faststore/cli' package version\n\nIf you need to update the [@faststore/cli](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson) package, follow these instructions.\n\n> Since the publication of [this release note](https://read.calvincode.net/reader?url=https://developers.vtex.com/updates/release-notes/2024-09-11-faststore-cli-dependency), the `@faststore/core` package now depends on the `@faststore/cli` package. Before updating the `@faststore/cli` package, make sure to check if this package is already listed in your dependencies. If not, check out the [release note](https://read.calvincode.net/reader?url=https://developers.vtex.com/updates/release-notes/2024-09-11-faststore-cli-dependency) related to this change.\n\n1. Open your FastStore codebase in the code editor of your preference.\n2. Open the terminal and run the following: \n`1 \nyarn add @faststore/cli@latest \n`\n3. Run `yarn dev` to sync the changes to your project.\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developer-tools/updating-the-cli-package-version.mdx)\n\n[FastStore CLI« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/developer-tools-faststore-cli)[StylingNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version/docs/guides/faststore/styling-overview)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developer-tools/updating-the-cli-package-version.mdx)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[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=)"
}
] |
doc_ee4e0402
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation site editor in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-site-editor/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/api-reference)\n\n[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-site-editor/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/storefront-development)\n\n[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-site-editor/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/troubleshooting)\n\n[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-site-editor/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-working-with-site-editor)\n\n[Integrating a frontend app with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor)\n\n[Making a custom component available in Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor)\n\n[Site Editor schema examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/vtex-io-documentation-site-editor-schema-examples)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-working-with-site-editor)\n\n[Integrating a frontend app with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor)\n\n[Making a custom component available in Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor)\n\n[Site Editor schema examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/vtex-io-documentation-site-editor-schema-examples)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-working-with-site-editor)\n\nWorking with Site Editor\n\nDiscover how Site Editor simplifies the customization of your Store Framework storefront.\n\n[Site Editor](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/site-editor-overview) works as a Content Management System (CMS) designed for stores developed with [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework), reflecting the blocks defined in the [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme) of the VTEX account.\n\nBased on the source code, the Site Editor displays an editable version of the website's storefront, enabling non-technical users to manage content as desired and modify components and their behavior through a friendly interface.\n\nIn your VTEX Admin, go to **Storefront > Site Editor** to see the main available tools.\n\n\n\nChanges made in Site Editor are immediately reflected in the store, and every storefront block can have its properties changed there. For example, you can change the content of a rich text block and shelf properties, such as which collection is being shown, among other changes.\n\n> Developers are responsible for creating components, defining the structure of the [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme), and ensuring seamless integration with Site Editor. This integration allows non-technical users to manage and update components easily, empowering store administrators to make changes to their storefronts without modifying the codebase.\n\nLearn more in [Site Editor - Overview](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/site-editor-overview--299Dbeb9mFczUTyNQ9xPe1).\n\n## Before you begin\n\n### Develop your Store Theme\n\nMake sure your store has a [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme) developed following the [Storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3) guide.\n\n### Check the builders\n\nCheck if the builders are properly installed in your Store Theme. To use builders, you must have at least the `vtex.builder-hub@0.293.4` version installed in your account. Also, you need to specify them in the app’s `manifest.json` file. Learn more at [Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders).\n\nYou must have at least the following builders configured:\n\n* [store builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder): Enables the development of Store Framework storefronts.\n* [react builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder): Used to develop apps with [React](https://read.calvincode.net/reader?url=https://react.dev/) when your project requires customized frontend solutions.\n\n### Create the store pages\n\nDevelop your store pages following the [Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages) guides.\n\n### Configure your components\n\nSet up your components following the [Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components) guides.\n\n## Essential concepts\n\nIt is important to understand the concept of a Content Management System (CMS) to learn how to work with Site Editor.\n\nA Content Management System (CMS) is a tool for creating, managing, and modifying website content. VTEX offers different CMS options based on the storefront technology used to develop your site. Store Framework uses Site Editor, Legacy CMS Portal uses [Layout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj), and FastStore leverages [VTEX Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview).\n\nOn VTEX, these tools allow you to manage the pages that make up your store website with the autonomy to create, organize, edit, and define the entire structure of folders, files, and components to create the storefront you want.\n\nTo learn more, see [CMS - Overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/6OCY6S9tqBXPD5mgpbBInC).\n\n## Guides in this section\n\nIn this section, you will find the following guides.\n\n[Integrating a frontend app with Site EditorDiscover how to integrate a frontend app with Site Editor.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor)[Making a custom component available in Site EditorAllow component customization directly in Site Editor.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor)[Site Editor schema examplesExplore practical schema examples for configuring custom components in Site Editor.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework-working-with-site-editor.md)\n\n[Using Flex Layout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor//docs/guides/vtex-io-documentation-using-flex-layout)[Integrating a frontend app with Site EditorNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor//docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-working-with-site-editor%23before-you-begin)\n\n[Develop your Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-working-with-site-editor%23develop-your-store-theme)[Check the builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-working-with-site-editor%23check-the-builders)[Create the store pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-working-with-site-editor%23create-the-store-pages)[Configure your components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-working-with-site-editor%23configure-your-components)\n\n[Essential concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-working-with-site-editor%23essential-concepts)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-working-with-site-editor%23guides-in-this-section)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework-working-with-site-editor.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-working-with-site-editor%23before-you-begin)\n\n[Develop your Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-working-with-site-editor%23develop-your-store-theme)[Check the builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-working-with-site-editor%23check-the-builders)[Create the store pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-working-with-site-editor%23create-the-store-pages)[Configure your components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-working-with-site-editor%23configure-your-components)\n\n[Essential concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-working-with-site-editor%23essential-concepts)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor/docs/guides/store-framework-working-with-site-editor%23guides-in-this-section)\n\nOn this page\n\n[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=)"
}
] |
doc_db40bc91
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides how to connect with vtex core commerce apis using vtex io in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-clients)\n\n[Developing custom Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients)\n\n[Connecting to VTEX Core Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io)\n\n[Using Clients in Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/using-node-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-clients)\n\n[Developing custom Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients)\n\n[Connecting to VTEX Core Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io)\n\n[Using Clients in Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/using-node-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/app-development-guides)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/vtex-io-documentation-clients)\n\n[Connecting to VTEX Core Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io)\n\nConnecting to VTEX Core Commerce APIs\n\nLearn how to enable seamless HTTP communication with VTEX Core Commerce APIs within your VTEX IO app.\n\nVTEX IO apps are designed to seamlessly interface with [VTEX Core Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference). These APIs provide a set of functionalities and data access points for managing and interacting with the VTEX ecommerce platform, enabling developers to perform various operations, such as managing orders, products, and customer data.\n\nIn this guide, you will learn how to create a custom client that can handle HTTP requests to these VTEX Core Commerce APIs, allowing your application to retrieve and manipulate data within the VTEX ecosystem.\n\n## Before you begin\n\nEnsure a smooth development process by having the following prerequisites in place:\n\n* **VTEX IO Development Workspace:** Set up your VTEX IO environment by following the steps outlined in [Creating a Development Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace).\n* **TypeScript Familiarity:** Acquire a basic understanding of TypeScript, as we'll be using the `node` [Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders) for TypeScript development. For details, refer to [Typescript's Official Documentation](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/docs/).\n* **Understanding of Clients:** Clients play a crucial role in facilitating interactions between your application and both external and internal services. Learn more about [Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients).\n\n## Instructions\n\n### Step 1 - Setting up your VTEX IO app\n\n1. Start a new VTEX IO app using the `node` builder and open the project using your preferred code editor.\n2. Install the `@vtex/api` package by running the following command: \n`1 \nyarn add @vtex/api \n`\n3. Update the app's `manifest.json` to include the appropriate `outbound-access` policy for the requested URL. Here's a hypothetical example: \nmanifest.json \n`1 \n{ \n2 \n \"name\": \"your-app\", \n3 \n \"version\": \"1.0.0\", \n4 \n \"scripts\": { \n5 \n // ... \n6 \n }, \n7 \n \"dependencies\": { \n8 \n // ... \n9 \n }, \n10 \n \"builders\": { \n11 \n // ... \n12 \n }, \n13 \n \"policies\": [ \n14 \n { \n15 \n \"name\": \"outbound-access\", \n16 \n \"attrs\": { \n17 \n \"host\": \"{{account}}.vtexcommercestable.com.br\", \n18 \n \"path\": \"/api/checkout/pub/orderForm/*\" \n19 \n } \n20 \n } \n21 \n ] \n22 \n} \n`\n\n### Step 2 - Creating a Client for connecting to VTEX Core Commerce APIs\n\n1. Create a TypeScript file for your Client in the `node/clients` directory. Choose a name that easily identifies your Client (e.g., `myClient.ts`).\n2. Create a client that represents the module you want to access. It will be a class that extends `JanusClient`. \n./node/clients/myClient.ts \n`1 \nimport type { InstanceOptions, IOContext } from '@vtex/api' \n2 \nimport { JanusClient } from '@vtex/api' \n3 \n \n4 \nexport default class MyClient extends JanusClient { \n5 \n constructor(context: IOContext, options?: InstanceOptions) { \n6 \n super(context, { …options }) \n7 \n } \n8 \n} \n`\n3. In the constructor, set the `VtexIdclientAutCookie` header with the required token for authorization. Use `ctx.authToken` for the app's token, or `ctx.vtex.storeUserAuthToken` or `ctx.vtex.adminUserAuthToken` for requests from VTEX Admin or VTEX Storefront, respectively. Refer to [App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens) for more information. \n./node/clients/myClient.ts \n`1 \nimport type { InstanceOptions, IOContext } from '@vtex/api' \n2 \nimport { JanusClient } from '@vtex/api' \n3 \n \n4 \nexport default class MyClient extends JanusClient { \n5 \n constructor(context: IOContext, options?: InstanceOptions) { \n6 \n super(ctx, { \n7 \n ...options, \n8 \n headers: { \n9 \n Accept: 'application/json', \n10 \n VtexIdclientAutCookie: ctx.storeUserAuthToken, \n11 \n 'x-vtex-user-agent': ctx.userAgent, \n12 \n ...options?.headers, \n13 \n }, \n14 \n }) \n15 \n } \n16 \n} \n` \n> Ensure to export the Client from its module using either [default or named export](https://read.calvincode.net/reader?url=https://medium.com/@etherealm/named-export-vs-default-export-in-es6-affb483a0910).\n\n### Step 3 - Implementing the Client methods\n\nIn your Client TypeScript file, implement the desired methods using the [HttpClient](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23httpclient-methods) for targeted HTTP calls.\n\n./node/clients/myClient.ts\n\n`` 1\n\nimport type { InstanceOptions, IOContext } from '@vtex/api' \n\n2\n\nimport { JanusClient } from '@vtex/api' \n\n3\n\n \n4\n\nexport default class MyClient extends JanusClient { \n\n5\n\n constructor(context: IOContext, options?: InstanceOptions) { \n\n6\n\n super(ctx, { \n\n7\n\n ...options, \n\n8\n\n headers: { \n\n9\n\n Accept: 'application/json', \n\n10\n\n VtexIdclientAutCookie: ctx.storeUserAuthToken, \n\n11\n\n 'x-vtex-user-agent': ctx.userAgent, \n\n12\n\n ...options?.headers, \n\n13\n\n }, \n\n14\n\n }) \n\n15\n\n } \n\n16\n\n \n17\n\n public newOrderForm = (orderFormId?: string) => { \n\n18\n\n return this.http \n\n19\n\n .postRaw<OrderForm>(this.routes.orderForm(orderFormId), undefined, { \n\n20\n\n metric: 'checkout-newOrderForm', \n\n21\n\n }) \n\n22\n\n .catch(statusToError) as Promise<IOResponse<OrderForm>> \n\n23\n\n } \n\n24\n\n \n25\n\n private get routes() { \n\n26\n\n const base = '/api/checkout/pub' \n\n27\n\n \n28\n\n return { \n\n29\n\n orderForm: (orderFormId?: string) => \n\n30\n\n `$\\{base\\}/orderForm/$\\{orderFormId ?? ''\\}` \n\n31\n\n } \n\n32\n\n } \n\n33\n\n \n34\n\n} \n\n ``\n\nIn the provided example, the `newOrderForm` method is implemented to make HTTP requests using `this.http`. It facilitates the creation of a new order form by sending a POST request (`postRaw`) to the specified endpoint. The method includes additional configurations, such as defining the metric for tracking and handling potential errors in the response.\n\n### Step 4 - Exporting custom clients\n\nNow that you've created your custom Client, organize and export it for use in your VTEX IO service. Follow these steps:\n\n1. Create an `index.ts` file in the `node/clients` folder.\n2. Inside the `index.ts` file, import the custom client you created in the previous step. For example: \n`1 \nimport MyClient from \"./myClient.ts\"; \n`\n3. Define a class called `Clients` that extends `IOClients`. This class is used to organize and configure your custom Clients. Within the Clients class, declare a `get` property for each of your custom Clients. This property allows you to access a specific Client by name. In our example, we've created a client named `myClient` that uses the `MyClient` class. \n`1 \nimport { IOClients } from \"@vtex/api\"; \n2 \nimport MyClient from \"./myClient.ts\"; \n3 \n \n4 \nexport class Clients extends IOClients { \n5 \n public get status() { \n6 \n return this.getOrSet(\"myClient\", MyClient); \n7 \n } \n8 \n} \n`\n\nNow that you have developed and exported your custom Client to communicate with the desired service, your Clients can be accessed and used within your VTEX IO service to perform various tasks. Learn how to use clients effectively in the [Using Node Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients) guide.\n\n## Key considerations\n\n* **GraphQL apps:** Some Core Commerce modules already feature a GraphQL app that abstracts their endpoints. Check if the desired data is available via one of our GraphQL apps. Utilize the [GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide) app on the Admin for exploration.\n* **Authentication:** IO apps do not require an appKey/appToken pair to make requests to VTEX Core Commerce APIs. Every app has its own rotating token that can be used on the app's code. In scenarios where using the app's token is not ideal (e.g., authorization depends on the calling user), opt to use the user's token instead, using `ctx.vtex.storeUserAuthToken` or `ctx.vtex.adminUserAuthToken`. Refer to [Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication) for more information.\n\n## Example\n\n* [CheckoutClient](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-graphql/blob/master/node/clients/checkout.ts)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/back-end-development-guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io.md)\n\n[Developing custom Clients« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io//docs/guides/vtex-io-documentation-how-to-create-and-use-clients)[Using Clients in Node appsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io//docs/guides/using-node-clients)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23instructions)\n\n[Step 1 - Setting up your VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23step-1-setting-up-your-vtex-io-app)[Step 2 - Creating a Client for connecting to VTEX Core Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23step-2-creating-a-client-for-connecting-to-vtex-core-commerce-apis)[Step 3 - Implementing the Client methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23step-3-implementing-the-client-methods)[Step 4 - Exporting custom clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23step-4-exporting-custom-clients)\n\n[Key considerations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23key-considerations)\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23example)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/back-end-development-guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23instructions)\n\n[Step 1 - Setting up your VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23step-1-setting-up-your-vtex-io-app)[Step 2 - Creating a Client for connecting to VTEX Core Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23step-2-creating-a-client-for-connecting-to-vtex-core-commerce-apis)[Step 3 - Implementing the Client methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23step-3-implementing-the-client-methods)[Step 4 - Exporting custom clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23step-4-exporting-custom-clients)\n\n[Key considerations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23key-considerations)\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23example)\n\nOn this page\n\n[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=)"
}
] |
doc_5c668f69
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore molecules quantity selector in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/troubleshooting)\n\n[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/molecules-quantity-selector/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-overview)\n\nQuantitySelector\n\nAllow shoppers to choose the quantity of a product to buy.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/QuantitySelector)\n\nThe `QuantitySelector` component allows customers to select the quantity of a given product to purchase.\n\nExample\n\nCode\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { QuantitySelector } from \"@faststore/ui\"; \n\n`\n\n### Import styles\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\nimport \"@faststore/ui/src/components/molecules/QuantitySelector/styles.scss\"; \n\n`\n\n---\n\n## Examples\n\n### Disabled\n\nExample\n\nCode\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| ------------------------------------- | ----------------------------------------------------------------------------- |\n| \\--fs-qty-selector-width | calc(var(--fs-control-tap-size) \\* 2.7) |\n| \\--fs-qty-selector-height | calc(var(--fs-control-tap-size) + (var(--fs-qty-selector-border-width) \\* 2)) |\n| \\--fs-qty-selector-shadow | none |\n| \\--fs-qty-selector-shadow-hover | 0 0 0 var(--fs-border-width) var(--fs-border-color-active) |\n| \\--fs-qty-selector-bkg-color | var(--fs-color-body-bkg) |\n| \\--fs-qty-selector-bkg-color-hover | var(--fs-qty-selector-bkg-color) |\n| \\--fs-qty-selector-border-radius | var(--fs-border-radius) |\n| \\--fs-qty-selector-border-width | var(--fs-border-width) |\n| \\--fs-qty-selector-border-width-hover | var(--fs-border-width) |\n| \\--fs-qty-selector-border-color | var(--fs-border-color) |\n| \\--fs-qty-selector-border-color-hover | var(--fs-border-color-active) |\n| \\--fs-qty-selector-text-size | var(--fs-text-size-base) |\n| \\--fs-qty-selector-text-color | var(--fs-color-text) |\n| \\--fs-qty-selector-text-color-hover | var(--fs-qty-selector-text-color) |\n\n### Design tokens: Button\n\n| Local token | Default value/Global token linked |\n| --------------------------------------- | ------------------------------------ |\n| \\--fs-qty-selector-button-bkg-color | transparent |\n| \\--fs-qty-selector-button-border-radius | var(--fs-qty-selector-border-radius) |\n\n### Design tokens: Disabled\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------- | ----------------------------------------- |\n| \\--fs-qty-selector-disabled-bkg-color | var(--fs-color-disabled-bkg) |\n| \\--fs-qty-selector-disabled-text-color | var(--fs-color-disabled-text) |\n| \\--fs-qty-selector-disabled-border-color | var(--fs-qty-selector-disabled-bkg-color) |\n\n---\n\n## Data attributes\n\nYou can target and override `QuantitySelector` styles using the following data attributes:\n\n`data-fs-quantity-selector`\n\n`data-fs-quantity-selector=[\"disabled\"]`\n\n`data-quantity-selector-button=\"left\" | \"right\"`\n\n`data-quantity-selector-input`\n\n---\n\n## Props\n\n| Name | Type | Description | Default |\n| --------------------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------- |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-quantity-selector |\n| **max** | number | The maximum value the quantity selector can receive | |\n| **min** | number | The minimum value the quantity selector can receive | 1 |\n| **initial** | number | The initial value for quantity selector | |\n| **unitMultiplier** | number | Controls by how many units the value advances | 1 |\n| **useUnitMultiplier** | false \\| true | Controls wheter you use or not the unitMultiplier | |\n| **disabled** | false \\| true | Specifies that the whole quantity selector component should be disabled. | false |\n| **onChange** | (value: number) => void | Event emitted when value is changed | |\n| **onValidateBlur** | (min: number, maxValue: number, quantity: number) => void | Event emitted when value is out of the min and max bounds | |\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/quantity-selector.mdx)\n\n[ProductTitle« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-product-title)[RadioFieldNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-radio-field)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/aliceoq)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23examples)\n\n[Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23disabled)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23design-tokens)\n\n[Design tokens: Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23design-tokens-button)[Design tokens: Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23design-tokens-disabled)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23props)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/quantity-selector.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23examples)\n\n[Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23disabled)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23design-tokens)\n\n[Design tokens: Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23design-tokens-button)[Design tokens: Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23design-tokens-disabled)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector/docs/guides/faststore/molecules-quantity-selector%23props)\n\nOn this page\n\n[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=)"
}
] |
doc_272ba7fe
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX admin customers app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/troubleshooting)\n\n[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.admin-customers/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/vtex-io-apps)\n\nAdmin Customers\n\nOfficial extension\n\nVersion: 2.18.2\n\nLatest version: 2.18.2\n\n> This app is no longer maintained by VTEX. This means support and maintenance are no longer provided.\n\n> To continue using the B2B Suite, it is important to install the [VTEX B2B Admin Customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers).\n\n# Customers Admin\n\nA VTEX admin app that helps manage your customer data. This application allows users to create, edit, and search for customers. It's an alternative to MasterData when it comes to managing the documents from the CL entity.\n\nThe [vtex.admin-customers-graphql](https://read.calvincode.net/reader?url=https://github.com/vtex/admin-customers-graphql) depends on this application. Its responsibility is to group all the GraphQL queries and mutations needed to manage MasterData data.\n\n## 🚀 Installation\n\nUsing the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/vtex-io-cli-installation-and-command-reference/%23command-reference), log into the VTEX account you are working on and install the latest version:\n\n`1\n\nvtex install vtex.admin-customers \n\n`\n\nAfter installing the app, you can find it in the Admin at **Customers > Customers**.\n\n## ✅ Features\n\nThe list below presents every feature of this application, where the checked ones have already been implemented. The features that are yet to come are unchecked.\n\n> Please, whenever a new feature from the list below is implemented, mind-marking the checkbox and create a feature demo.\n\n* [Listing](#listing)\n* [Memorize visibility fields](#memorize-visibility-fields)\n* [Search](#search)\n* [Filters](#filters)\n* [Creation](#creation)\n* [Details view](#details-view)\n* [Edition](#edition)\n* Deletion of profile (GDPR/LGPD)\n* Address association listing\n* Schema viewing with user-level configuration\n* Counters\n\n## 🎥 Demonstration\n\n**Listing** \n\n\n\n**Memorize visibility fields** \n\nThe visibility fields is a feature to toggle visibility of table columns.\n\nHere we have an additional feature that saves the preferred column visibility configuration of the end user, maintaining your configurations even after a page refresh and future visits to this page.\n\n\n\n**Search** \n\nThe search input uses the fields: **E-mail**, **First Name** or **Last Name** to filter the results that matches the terms searched while also displaying the results on the table.\n\n\n\n**Filters** \n\nWith these filters, it is possible to refine your search. You can filter by: **E-mail**, **First Name**, **Last Name**, **Document ID**, **Document** or **Receive Newsletter**.\n\nEvery filter has conditionals for you to choose from; it could be **equal**, **not equal**, or **contains**.\n\n **Creation** \n\n\n\n**Details view**  **Edition** \n\n\n\n## ☕ Developing\n\n1. Clone this repo `git clone https://github.com/vtex/admin-customers`\n2. `yarn --cwd react/` for code completion\n3. `vtex link`\n4. Navigate to `workspace--account.myvtex.com/admin/app/example`\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Customers Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/apps/vtex.admin-customers%23customers-admin)\n\n[🚀 Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/apps/vtex.admin-customers%23-installation)\n\n[✅ Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/apps/vtex.admin-customers%23-features)\n\n[🎥 Demonstration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/apps/vtex.admin-customers%23-demonstration)\n\n[☕ Developing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers/docs/apps/vtex.admin-customers%23-developing)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_8e780aa2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore managing performance testing server side rendering in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/troubleshooting)\n\n[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/managing-performance-testing-server-side-rendering/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-overview)\n\n[Testing server-side rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-testing-server-side-rendering)\n\n[Improving store performance with Preact](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-improving-store-performance-with-preact)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-overview)\n\n[Testing server-side rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-testing-server-side-rendering)\n\n[Improving store performance with Preact](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-improving-store-performance-with-preact)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-overview)\n\nTesting server-side rendering\n\nJavaScript handles data fetching, templating, and routing on the client-side rather than on the server-side. However, the amount of JavaScript shipped to the browser tends to increase as the complexity of an application grows. As a result, JavaScript code competes for processing power and delays the rendering task because it keeps trying to be processed before the browser finishes rendering the page content.\n\nTo ensure your server-side rendering (SSR) HTML is functional and free of bugs, it is important to check how your web page looks and behaves when JavaScript is disabled.\n\n## Instructions\n\n1. Check the documentation of your web browser and search for how to disable JavaScript. For example, if you are using Google Chrome, check Google's documentation on [Disabling JavaScript](https://read.calvincode.net/reader?url=https://developers.google.com/web/tools/chrome-devtools/javascript/disable).\n2. Access your store website and check if its [core features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started%23vtex-core-services), such as product searching, shopping cart, and checkout process are working as expected. Your store will not function exactly as planned, but check below which are the expected and undesired behaviors when disabling JavaScript: \n * **Undesired behaviors** \n * The page does not render anything. \n * Instead of updating only the different content, the page is fully refreshed when navigating to another page. \n * Misplaced layout. \n * **Expected behaviors** \n * Simpler design, displaying basic layout similar to a static webpage. \n * Animations and interactive menus do not work. \n * The below-the-fold content does not render.\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/managing-performance/testing-server-side-rendering.md)\n\n[Managing performance« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-overview)[Improving store performance with PreactNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-improving-store-performance-with-preact)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-testing-server-side-rendering%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/managing-performance/testing-server-side-rendering.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-testing-server-side-rendering/docs/guides/faststore/managing-performance-testing-server-side-rendering%23instructions)\n\nOn this page\n\n[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=)"
}
] |
doc_b4eae9c7
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides checkout api overview in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview)\n\nCheckout API - Overview\n\n> ️ Check the new [Checkout onboarding guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/checkout-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about the Checkout and is organized by focusing on the developer's journey.\n\nThe Checkout API allows you to obtain and configure information about the shopping cart and its attachments, personalization of custom fields, orderForm structure, fulfillment data, order management, and identification of the sellers delivery region.\n\n**Important**: Data modification operations (`POST`, `PATCH`, `PUT` or `DELETE` endpoints) shall not be performed in parallel in the Checkout APIs. They need to be enqueued by the client/requester. Otherwise, old values can be overwritten incorrectly or competition errors may occur.\"\n\n## Shopping cart\n\nAllows merchants to simulate, configure and customize shopping cart information.\n\n* [POST - Cart Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/cartsimulation)\n* [GET - Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/orderForm)\n* [GET - Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getcartinformationbyid)\n* [POST - Remove all items](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/removeallitems)\n* [GET - Remove all personal data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/removeallpersonaldata)\n* [POST - Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/itemsupdate)\n* [POST - Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/items)\n* [PUT - Change price](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/pricechange)\n* [PATCH - Ignore profile data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/ignoreprofiledata)\n* [GET - Cart installments](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getcartinstallments)\n* [POST - Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addcoupons)\n\n## Cart attachments\n\nAllows merchants to obtain client profiles and add information to a given shopping cart.\n\n* [GET - Get client profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getclientprofilebyemail)\n* [POST - Add client profile](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addclientprofile)\n* [POST - Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addshippingaddress)\n* [POST - Add client preferences](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addclientpreferences)\n* [POST - Add marketing data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addmarketingdata)\n* [POST - Add payment data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addpaymentdata)\n* [POST - Add merchant context data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addmerchantcontextdata)\n\n## Custom data\n\nAllows merchants to manage custom fields that were created by an app in their account.\n\n* [PUT - Set multiple custom field values](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/setmultiplecustomfieldvalues)\n* [PUT - Set single custom field value](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/setsinglecustomfieldvalue)\n* [DELETE - Remove single custom field value](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/removesinglecustomfieldvalue)\n\n## Configuration\n\nAllows merchants to configure orderForm in the account and seller exchange on a given order.\n\n* [GET - Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getorderformconfiguration)\n* [POST - Update orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/updateorderformconfiguration)\n* [GET - Get window to change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getwindowtochangeseller)\n* [POST - Update window to change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/updatewindowtochangeseller)\n* [POST - Clear orderForm messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/clearorderformmessages)\n\n## Fulfillment\n\nAllows merchants to obtain pickup points and address information.\n\n* [GET - List pickup points by location](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/listpickupppointsbylocation)\n* [GET - Get address by postal code](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getaddressbypostalcode)\n\n## Order placement\n\nAllows merchants to place and process orders by creating a new cart or using an existing cart.\n\n* [POST - Place order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/placeorderfromexistingorderform)\n* [PUT - Place order](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/placeorder)\n* [POST - Process order](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/processorder)\n\n## Region\n\nAllows merchants to obtain a list of sellers serving a specific delivery region.\n\n* [GET - Get sellers by region or address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/regions/-regionId-)\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/checkout-api-overview.md)\n\n[How to implement product color variation« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview//docs/guides/how-to-implement-product-color-variation)[Custom DataNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview//docs/guides/custom-data-1)\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23shopping-cart)\n\n[Cart attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23cart-attachments)\n\n[Custom data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23custom-data)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23configuration)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23fulfillment)\n\n[Order placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23order-placement)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23region)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/checkout-api-overview.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23shopping-cart)\n\n[Cart attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23cart-attachments)\n\n[Custom data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23custom-data)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23configuration)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23fulfillment)\n\n[Order placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23order-placement)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview/docs/guides/checkout-api-overview%23region)\n\nOn this page\n\n[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=)"
}
] |
doc_23e79450
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore dynamic content step 2 handling the dynamic content in custom sections in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/troubleshooting)\n\n[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/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-overview)\n\n[Managing content with 'scopes' and 'requiredScopes'](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)\n\n[Multiple page templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-multiple-page-template)\n\n[Previewing Headless CMS in development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)\n\n[Widgets for Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-widgets)\n\n[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-overview)\n\n[Step 1 - Setting up the store code for Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content)\n\n[Step 2 - Handling Dynamic Content in custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-overview)\n\n[Managing content with 'scopes' and 'requiredScopes'](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)\n\n[Multiple page templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-multiple-page-template)\n\n[Previewing Headless CMS in development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)\n\n[Widgets for Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-widgets)\n\n[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-overview)\n\n[Step 1 - Setting up the store code for Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content)\n\n[Step 2 - Handling Dynamic Content in custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/headless-cms-overview)\n\n[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-overview)\n\nStep 2 - Handling Dynamic Content in custom sections\n\nAfter [mapping pages and data-fetching functions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%23step-1-mapping-pages-and-data-fetching-functions) and choosing one of the methods for [creating Dynamic Content via API fetching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%23step-2-creating-dynamic-content-via-api-fetching), use the data to render it in a store section. In this step, we will create a new Hero section, placed on a landing page, to render the image from the data.\n\n| _Before_: Using [Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero) native section with an image uploaded from the Headless CMS. | _After:_ Using a custom Hero section fetching the image content from an API. |\n| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n|  |  |\n\n## Before you begin\n\n* Complete the [Step 1 - Setting up your store code for Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content) to set up your store code.\n* Make sure your store's Headless CMS includes the following sections in addition to your existing store page sections: \n * **Global**: Includes the global header and footer sections, which are required for all page types. \n * **Children**: Acts as the placeholder for the unique content of each page (including Landing Pages), and it is a mandatory section. Your local build will fail if this section is missing.\n\nFor more information, refer to [Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview%23sections).\n\n## Instructions\n\n### 1\\. Creating the section\n\nCreate and display a [section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section) for the Dynamic Content. For this tutorial, we’ll create a [Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero).\n\n1. Open your Faststore project.\n2. Inside `src`, create the folder `components`.\n3. Inside `components`, create a subfolder named `sections`.\n4. Inside `sections` create a file called `ProductHero.tsx`, and paste the following code: \nsrc/components/sections/ProductHero.tsx \n`1 \nimport { \n2 \n HeroSection, \n3 \n getOverriddenSection, \n4 \n useDynamicContent, \n5 \n} from \"@faststore/core\"; \n6 \nimport { ServerDynamicContentQuery } from \"@faststore/core/api\"; \n7 \n \n8 \nconst OverridenHero = getOverriddenSection({ \n9 \n Section: HeroSection, \n10 \n components: { \n11 \n HeroImage: { \n12 \n Component: CustomHeroImage, \n13 \n }, \n14 \n }, \n15 \n}); \n16 \n \n17 \nfunction CustomHeroImage() { \n18 \n const context = useDynamicContent<ServerDynamicContentQuery>(); \n19 \n \n20 \n return ( \n21 \n <img \n22 \n src={ \n23 \n context.data?.extraData?.customFieldFromRoot ?? \n24 \n \"https://via.placeholder.com/350\" \n25 \n } \n26 \n width={400} \n27 \n alt={context.data?.extraData?.customField ?? \"Hero section image\"} \n28 \n /> \n29 \n ); \n30 \n} \n31 \n \n32 \nexport default function ProductHero( \n33 \n props: React.ComponentProps<typeof OverridenHero> \n34 \n) { \n35 \n const context = useDynamicContent<ServerDynamicContentQuery>(); \n36 \n return ( \n37 \n <OverridenHero \n38 \n {...props} \n39 \n image={{ src: \"noop\", alt: \"noop\" }} \n40 \n title={ \n41 \n context.data?.extraData?.customField ?? \n42 \n \"Add the Hero section title here\" \n43 \n } \n44 \n /> \n45 \n ); \n46 \n} \n` \n * The `useDynamicContent` hook brings the data from the [@faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson) package. \n * The `ServerDynamicContentQuery` specifies the type of data that we will get from the FastStore API package. \n * Since we are working with Hero, we import the Hero component and its styles. \n * The `useDynamicContent` hook holds the information in the `data` variable. \n * In return, we validate the data and display the image in the Hero and the product's name using some HTML elements.\n5. Create an `index.tsx` file inside the components folder and paste the following code: \n`1 \nimport ProductHero from “./sections/ProductHero” \n2 \n \n3 \nexport default { ProductHero }; \n`\n\nThis file helps import and export our new component. Now that the component is ready, let’s create its section schema for the Headless CMS.\n\n### 2\\. Synchronizing the component with Headless CMS\n\nTo define a schema for the `ProductHero` component within the Headless CMS, follow the steps below:\n\n1. Create the folders `cms/faststore` inside your project directory.\n2. Inside `faststore`, create the `sections.json` file.\n3. Paste the following code: \n`1 \n[ \n2 \n { \n3 \n \"name\": \"ProductHero\", \n4 \n \"schema\": { \n5 \n \"title\": \"Hero with a Fixed Image\", \n6 \n \"description\": \"Add a quick promotion with an image/action pair\", \n7 \n \"type\": \"object\", \n8 \n \"required\": [\"title\"], \n9 \n \"properties\": { \n10 \n \"title\": { \n11 \n \"title\": \"Title\", \n12 \n \"type\": \"string\" \n13 \n }, \n14 \n \"subtitle\": { \n15 \n \"title\": \"Subtitle\", \n16 \n \"type\": \"string\" \n17 \n }, \n18 \n \"link\": { \n19 \n \"title\": \"Call to Action\", \n20 \n \"type\": \"object\", \n21 \n \"properties\": { \n22 \n \"text\": { \n23 \n \"type\": \"string\", \n24 \n \"title\": \"Text\" \n25 \n }, \n26 \n \"url\": { \n27 \n \"type\": \"string\", \n28 \n \"title\": \"URL\" \n29 \n }, \n30 \n \"linkTargetBlank\": { \n31 \n \"type\": \"boolean\", \n32 \n \"title\": \"Open link in new window?\", \n33 \n \"default\": false \n34 \n } \n35 \n } \n36 \n }, \n37 \n \"colorVariant\": { \n38 \n \"type\": \"string\", \n39 \n \"title\": \"Color variant\", \n40 \n \"enumNames\": [\"Main\", \"Light\", \"Accent\"], \n41 \n \"enum\": [\"main\", \"light\", \"accent\"] \n42 \n }, \n43 \n \"variant\": { \n44 \n \"type\": \"string\", \n45 \n \"title\": \"Variant\", \n46 \n \"enumNames\": [\"Primary\", \"Secondary\"], \n47 \n \"enum\": [\"primary\", \"secondary\"] \n48 \n } \n49 \n } \n50 \n } \n51 \n } \n52 \n] \n`\n4. Run `yarn cms-sync` to synchronize the changes.\n5. Go to the VTEX Admin, and access **Storefront > Headless CMS**.\n6. Click `Create document` and choose `Landing Page` to create a new landing page.\n7. Add the new section.\n8. Open the **Settings** tab, and in the SEO path, add the slug for the new landing page, for example, `my-landing-page`. This step is essential because this slug is being consumed in the `index.tsx` file from the `dynamicContent` folder and this slug identifies in the code which content we want to bring to the page.\n9. Click `Save`.\n10. Open your terminal and run `yarn dev`. \n> Make sure you are logged in to your store account. If not run `vtex login {accountname}`.\n11. Open the localhost indicated in the terminal and add the `/my-landing-page` to the slug, e.g., `https://localhots:3000/my-landing-page`.\n12. Go to the localhost available and refresh the page. You will have the section similar to the following:\n\n\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/headless-cms/dynamic-content/step-2-handling-the-dynamic-content-in-custom-sections.mdx)\n\n[Step 1 - Setting up the store code for Dynamic Content« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content)[Developer tools and referencesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/developer-tools-overview)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%23instructions)\n\n[1\\. Creating the section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%231-creating-the-section)[2\\. Synchronizing the component with Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%232-synchronizing-the-component-with-headless-cms)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/headless-cms/dynamic-content/step-2-handling-the-dynamic-content-in-custom-sections.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%23instructions)\n\n[1\\. Creating the section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%231-creating-the-section)[2\\. Synchronizing the component with Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections%232-synchronizing-the-component-with-headless-cms)\n\nOn this page\n\n[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=)"
}
] |
doc_67cf0842
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation 2 basic development setup in vtex io in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-2-basic-development-setup-in-vtex-io/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/api-reference)\n\n[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-2-basic-development-setup-in-vtex-io/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/storefront-development)\n\n[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-2-basic-development-setup-in-vtex-io/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/troubleshooting)\n\n[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-2-basic-development-setup-in-vtex-io/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io)\n\n[2\\. Creating the new app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-3-creating-the-new-app)\n\n[3\\. Declaring a theme block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-4-declaring-a-theme-block)\n\n[4\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-5-defining-styles)\n\n[5\\. Structuring documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-6-structuring-documentation)\n\n[6\\. Consuming data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-7-consuming-data)\n\n[7\\. Translating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-8-translating-the-component)\n\n[8\\. Improving performance with caching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-9-improving-performance-with-caching)\n\n[9\\. Making your app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-developing-custom-storefront-components)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/create-master-data-crud-app)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io)\n\n[2\\. Creating the new app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-3-creating-the-new-app)\n\n[3\\. Declaring a theme block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-4-declaring-a-theme-block)\n\n[4\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-5-defining-styles)\n\n[5\\. Structuring documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-6-structuring-documentation)\n\n[6\\. Consuming data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-7-consuming-data)\n\n[7\\. Translating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-8-translating-the-component)\n\n[8\\. Improving performance with caching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-9-improving-performance-with-caching)\n\n[9\\. Making your app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-developing-custom-storefront-components)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/create-master-data-crud-app)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/app-development)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io)\n\nSetting up your development environment\n\nLearn how to set up your development environment to build storefront components with React and VTEX IO.\n\nAny development on VTEX IO begins and ends with [**VTEX IO CLI**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference). VTEX IO CLI works as a communication gateway between your VTEX account and the VTEX IO development platform.\n\nWith VTEX IO CLI, you can log in to your VTEX account, manage workspaces, develop apps, and install new ones.\n\n## Before you begin\n\n* Make sure you are familiar with the core concepts of Store Framework, including blocks, store themes, and templates. If you need to refresh your knowledge or get acquainted with these concepts, you can refer to the getting started tutorial on [building storefronts with Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3).\n* Check our recommended practices for tooling, features, flexibility, scalability, performance, accessibility, internationalization, and styling. For more information, please refer to [Best practices for developing custom storefront components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-custom-storefront-components).\n\n## Instructions\n\n### Step 1 - Getting started with VTEX IO CLI\n\n1. [Install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install).\n2. Once the installation is finished, open the terminal and log in to your VTEX account by running following command:\n\n> Replace `{accountName}` with the name of your VTEX account.\n\n`1\n\nvtex login {accountName} \n\n`\n\nThis will open a browser window prompting you to enter your credentials.\n\n1. Enter your credential in the browser window and return to the terminal.\n2. Run the `vtex whoami` command to show which `account` and `workspace` are being used by VTEX IO CLI.\n\n\n\nBy logging in to your VTEX account with VTEX IO CLI, you will have access to various development tools and be able to manage your workspaces.\n\n### Step 2 - Creating a workspace\n\nTo get started with development in VTEX IO, it is important to understand the concept of [workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/). Workspaces are isolated environments in which development occurs, and are similar to branches in a GitHub repository. This means that workspaces allow you to develop and test your changes without the risk of impacting live apps or conflicting with the work of other developers.\n\nBy default, when you first log in to VTEX IO, you are automatically placed in the in the `master` workspace, which represents the current live version of your store. Making changes in this workspace can potentially affect the user experience. To avoid this, you must create a separate [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/) and switch to it before beginning any development work.\n\nTo switch to a development workspace, run the `vtex use` command in your terminal as shown below:\n\n`1\n\nvtex use {workspaceName} \n\n`\n\n> Replace `{workspaceName}` with the name of your development workspace.\n\nThis command will create a new workspace named `workspaceName` if it does not already exist and switch to it. If the workspace already exists, it will simply switch to it.\n\n\n\nOnce you have logged into your account and created your own development workspace, you are ready to start developing your React app. In the next step of this tutorial, you will learn how to start your app's project.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[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-1-developing-storefront-apps-using-react-and-vtex-io/vtex-io-documentation-2-basic-development-setup-in-vtex-io.md)\n\n[Storefront apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io//docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)[2\\. Creating the new appNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io//docs/guides/vtex-io-documentation-3-creating-the-new-app)\n\nSee also\n\n[VTEX IO CLIGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)[Creating a Development workspaceGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-creating-a-development-workspace)[WorkspaceApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-workspace)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io%23instructions)\n\n[Step 1 - Getting started with VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io%23step-1-getting-started-with-vtex-io-cli)[Step 2 - Creating a workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io%23step-2-creating-a-workspace)\n\nWas this helpful?\n\n Send feedback\n\n[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-1-developing-storefront-apps-using-react-and-vtex-io/vtex-io-documentation-2-basic-development-setup-in-vtex-io.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io%23instructions)\n\n[Step 1 - Getting started with VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io%23step-1-getting-started-with-vtex-io-cli)[Step 2 - Creating a workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io%23step-2-creating-a-workspace)\n\nOn this page\n\n[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=)"
}
] |
doc_e65f7d90
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore project structure handling third party scripts in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/troubleshooting)\n\n[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/project-structure-handling-third-party-scripts/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-overview)\n\nAdding third-party scripts\n\nIn this guide, learn how to add third-party scripts to FastStore projects.\n\nThird-party scripts are elements embedded in a webpage but served from a different domain than the one the user visits. Examples of these scripts include social media buttons, video players, ads, analytics tools, and other elements contributing to a more dynamic and interactive web experience.\n\n> There is an ongoing issue where FastStore stores are not receiving Google Tag Manager (GTM) events due to an integration conflict between FastStore and [Partytown](https://read.calvincode.net/reader?url=https://partytown.builder.io/). The team is actively working on a fix.\n> \n> In the meantime, please follow the workaround outlined in this [Known Issue article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/known-issues/gtm-scripts-are-not-loading-on-the-native-thirdparty-scripts--4hTYThw8092OCHhUIvpCAa).\n\n## Before you begin\n\n### Choose essential third-party scripts\n\nTo maintain your website's performance without compromising the functionality offered by third-party scripts, consider incorporating only those third-party scripts that enhance the value of your website.\n\n### Update the `@faststore/core` version\n\nEnsure your project uses `@faststore/core` version `2.1.82` or above. If not, follow these steps:\n\n1. Open the FastStore code project.\n2. Navigate to the `package.json` file.\n3. Find the `@faststore/core` package and change its version to `2.1.82`.\n4. In your terminal, run `yarn install` to update the package in the project.\n\n### Verify compatibility with Partytown\n\nFastStore uses [Partytown](https://read.calvincode.net/reader?url=https://partytown.builder.io/) for script execution. Not all third-party scripts may be compatible with Partytown, so we strongly recommend testing third-party scripts with Partytown before implementing them. If any issues occur, avoid using those particular scripts.\n\n---\n\n## Instructions\n\n1. In your FastStore project, navigate to the `src` folder and create a folder named `scripts`.\n2. Within the `src/scripts` folder, create the `ThirdPartyScripts.tsx` file.\n3. In the `ThirdPartyScripts.tsx` file, add your script as the example below: \nsrc/scripts/ThirdPartyScripts.tsx \n`1 \nconst ThirdPartyScripts = () => { \n2 \n return ( \n3 \n <script \n4 \n type=\"text/partytown\" \n5 \n dangerouslySetInnerHTML={{ \n6 \n // Add your script here and remove the console.log example \n7 \n __html: \"console.log('🚀 Hello from a third-party script!')\", \n8 \n }} \n9 \n /> \n10 \n ) \n11 \n} \n12 \n \n13 \nexport default ThirdPartyScripts \n`\n4. Run `yarn dev` in the terminal to start the development server and execute the script you have added.\n5. Access the provided localhost URL in your browser, open the Developer Tools, and go to the `Console` tab. You should be able to see the message: `🚀Hello from a third-party script!`: \n\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/handling-third-party-scripts.mdx)\n\n[Implementing storefront features« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-overview)[Building navigation menusNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-building-navigation-menus)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23before-you-begin)\n\n[Choose essential third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23choose-essential-third-party-scripts)[Update the @faststore/core version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23update-the-faststorecore-version)[Verify compatibility with Partytown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23verify-compatibility-with-partytown)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/handling-third-party-scripts.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23before-you-begin)\n\n[Choose essential third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23choose-essential-third-party-scripts)[Update the @faststore/core version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23update-the-faststorecore-version)[Verify compatibility with Partytown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23verify-compatibility-with-partytown)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23instructions)\n\nOn this page\n\n[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=)"
}
] |
doc_cc1d34d3
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides including order variables in the transactional email template in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n[Setting up DKIM for transactional emails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/setting-up-dkim-for-transactional-emails)\n\n[Setting up the SPF](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/setting-up-the-spf)\n\n[How to set up functions in the Message Center templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/how-to-set-up-functions-in-the-message-center-templates)\n\n[Including order variables in the transactional email template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/including-order-variables-in-the-transactional-email-template)\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n[Setting up DKIM for transactional emails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/setting-up-dkim-for-transactional-emails)\n\n[Setting up the SPF](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/setting-up-the-spf)\n\n[How to set up functions in the Message Center templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/how-to-set-up-functions-in-the-message-center-templates)\n\n[Including order variables in the transactional email template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/including-order-variables-in-the-transactional-email-template)\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides)\n\nMessage Center\n\n[Including order variables in the transactional email template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/including-order-variables-in-the-transactional-email-template)\n\nIncluding order variables in the transactional email template\n\nLearn how to use variables and create custom Message Center templates.\n\nIn the **Message Center**, under the **Templates** tab, you will find the transactional email templates sent to your clients.\n\nSome of them are fired when the status of an order changes. For example:\n\n* **Order Confirmation**: email sent when the order was made successfully.\n* **Billed Order**: email sent when the order is billed.\n* **Delivery canceled**: email sent when the order is canceled.\n\nYou can customize all of the Message Center templates, and you have a series of variables at your disposal that allow you to add data to the email dynamically.\n\nThese variables are JSON properties in the **JSON Data** field and can be used in the email's HTML. Insert them into double keys using the following format: `{{variable}}`\n\n## Example\n\n> Examples of JSON Data will only appear in the templates when you develop the desired action in your store. If you have not transacted an order, a recurrence, or any other action, JSON Data will be blank.\n\nLet's say you want to enter the carrier's name in the \"product sent\" email.\n\nTo do this, enter the \"product sent\" template and search for the' courier' property in the **JSON Data** field.\n\n\n\nThe filled-in value for this property is just an example, but you can use it in the **HTML** field so that when the email is sent, the customer sees the carrier that is actually responsible for the order delivery. \n\nNote that the `courier` property is inside the `package` object. Therefore, you need to enter it as follows:\n\n`{{package.courier}}`\n\n\n\nAs you see, the sample value (\"Transportadora Teste Courier S.A.\") was inserted in the preview screen, below the **HTML** and **JSON Data** fields.\n\n## Other order email variables\n\nAmong the properties of order JSONs that can be used as variables in transactional email templates are:\n\n`` 1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"h-0\": \"Properties\", \n\n4\n\n \"h-1\": \"Definition\", \n\n5\n\n \"0-0\": \"`courier`\", \n\n6\n\n \"0-1\": \"Courier\", \n\n7\n\n \"1-0\": \"`invoiceNumber`\", \n\n8\n\n \"1-1\": \"Invoice number\", \n\n9\n\n \"2-0\": \"`invoiceValue`\", \n\n10\n\n \"2-1\": \"Invoice value\", \n\n11\n\n \"3-0\": \"`invoiceUrl`\", \n\n12\n\n \"3-1\": \"Invoice URL\", \n\n13\n\n \"4-0\": \"`issuanceDate`\", \n\n14\n\n \"4-1\": \"Date of issue\", \n\n15\n\n \"5-0\": \"`trackingNumber`\", \n\n16\n\n \"5-1\": \"Order tracking number\", \n\n17\n\n \"6-0\": \"`invoiceKey`\", \n\n18\n\n \"6-1\": \"Invoice access key\", \n\n19\n\n \"7-0\": \"`trackingUrl`\", \n\n20\n\n \"7-1\": \"Order tracking URL (informed by the carrier)\" \n\n21\n\n }, \n\n22\n\n \"cols\": 2, \n\n23\n\n \"rows\": 8 \n\n24\n\n} \n\n ``\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Message-Center/templates/including-order-variables-in-the-transactional-email-template.md)\n\n[How to set up functions in the Message Center templates« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template//docs/guides/how-to-set-up-functions-in-the-message-center-templates)[Scheduling prices for a range of hoursNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template//docs/guides/scheduling-prices-for-a-range-of-hours)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/including-order-variables-in-the-transactional-email-template%23example)\n\n[Other order email variables](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/including-order-variables-in-the-transactional-email-template%23other-order-email-variables)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Message-Center/templates/including-order-variables-in-the-transactional-email-template.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/including-order-variables-in-the-transactional-email-template%23example)\n\n[Other order email variables](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/including-order-variables-in-the-transactional-email-template/docs/guides/including-order-variables-in-the-transactional-email-template%23other-order-email-variables)\n\nOn this page\n\n[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=)"
}
] |
doc_699102cc
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation 7 consuming data in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-7-consuming-data/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/api-reference)\n\n[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-7-consuming-data/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/storefront-development)\n\n[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-7-consuming-data/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/troubleshooting)\n\n[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-7-consuming-data/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io)\n\n[2\\. Creating the new app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-3-creating-the-new-app)\n\n[3\\. Declaring a theme block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-4-declaring-a-theme-block)\n\n[4\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-5-defining-styles)\n\n[5\\. Structuring documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-6-structuring-documentation)\n\n[6\\. Consuming data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-7-consuming-data)\n\n[7\\. Translating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-8-translating-the-component)\n\n[8\\. Improving performance with caching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-9-improving-performance-with-caching)\n\n[9\\. Making your app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-developing-custom-storefront-components)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/create-master-data-crud-app)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io)\n\n[2\\. Creating the new app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-3-creating-the-new-app)\n\n[3\\. Declaring a theme block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-4-declaring-a-theme-block)\n\n[4\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-5-defining-styles)\n\n[5\\. Structuring documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-6-structuring-documentation)\n\n[6\\. Consuming data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-7-consuming-data)\n\n[7\\. Translating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-8-translating-the-component)\n\n[8\\. Improving performance with caching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-9-improving-performance-with-caching)\n\n[9\\. Making your app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-developing-custom-storefront-components)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/create-master-data-crud-app)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/app-development)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[6\\. Consuming data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-7-consuming-data)\n\n6\\. Consuming data\n\nLearn how to communicate with the backend system in VTEX IO using GraphQL APIs.\n\nNow you need to learn how this new component will talk with the _backend_ system, in other words, how it is going to **consume and insert data in the platform**.\n\nCommunication between storefront apps and VTEX IO is done through **GraphQL APIs**.\n\n## Understanding GraphQL\n\nGraphQL is a language for APIs whose main advantage is **to request specific data through a single endpoint**, avoiding _overfetching_ and _underfetching_.\n\nTo manage the data consumed in GraphQL, we will use a library called [**React Apollo**](https://read.calvincode.net/reader?url=https://www.npmjs.com/package/react-apollo) that provides native components to perform data searches.\n\nThe main components in this library are:\n\n| Name | Description |\n| ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [useQuery](https://read.calvincode.net/reader?url=https://www.apollographql.com/docs/react/data/queries/) | _React hook_ which, when executed, queries the server using the _GraphQL API_ and returns what was requested in the _query_ variables. |\n| [useMutation](https://read.calvincode.net/reader?url=https://www.apollographql.com/docs/react/data/mutations/) | _React hook_, which returns a function that, when executed, communicates with the server from the _GraphQL API_ to send _updates_ and overwrite data. |\n\nThe `useQuery` _React hook_ returns an object with the following properties:\n\n* `loading` (`boolean`) - Returns `true` if the _GraphQL API_ is still being executed. Otherwise, it returns `false`.\n* `error` (`any`) - Only assumes a value when an error occurs when communicating with the server.\n* `data` (`any`) - Contains the object returned from the _query_ execution.\n\nThe `useMutation` _React hook_ returns an _array_ containing:\n\n* A function that can be called at any time to communicate with the server.\n* An object that represents the current state of _mutation_ that has the properties `loading`, `error`, and `data`.\n\nKeeping in mind the objects received by the `useQuery` and `useMutation` _React hooks_, you can define what you want to render in _React_ for the specific `loading` and `error` conditions, in addition to managing the content returned by queries made in the API (stored in `data`).\n\n> To better understand the detailed instructions below, we recommended having a basic knowledge of the GraphQL language. If you are not familiar with this solution, we recommended checking the [documentation](https://read.calvincode.net/reader?url=https://graphql.org/learn/) and reading it carefully before proceeding to the next steps.\n\n## Installing the React Apollo library\n\nUsing your terminal, access your app's directory and run the command shown below to install the `npm` _React Apollo_ library:\n\n`1\n\nyarn add react-apollo \n\n`\n\n## Making queries in GraphQL\n\nFor your component to render the information provided by the VTEX IO platform, you have to query the data stored on the server using _GraphQL APIs_.\n\n\n\nWe will use the `useQuery` _React hook_ to do this:\n\n1. Open your app's code in the code editor of your choice.\n2. In the `react` folder, access the`HelloData.tsx` file or create it if it does not already exist.\n3. In this file, copy and paste the basic model below to build your _GraphQL query_:\n\n`` 1\n\nimport { useQuery } from 'react-apollo' \n\n2\n\nimport QUERY_VALUE from './helloData.gql' \n\n3\n\n \n4\n\nconst HelloData = () => { \n\n5\n\n const { loading, error, data } = useQuery(QUERY_VALUE) \n\n6\n\n \n7\n\n if (loading) { \n\n8\n\n return 'Loading…' \n\n9\n\n } \n\n10\n\n if (error) { \n\n11\n\n return `Error $\\{error\\}` \n\n12\n\n } \n\n13\n\n \n14\n\n return `Done fetching $\\{data\\}` \n\n15\n\n} \n\n16\n\n \n17\n\nexport default HelloData \n\n ``\n\nNote that the `QUERY_VALUE` property is being imported from another file called `helloData.gql`. The `.gql` extension hints that it is a file written in _GraphQL_. The content of this file varies depending on the _query_ that the app will send as a request.\n\nA simple example for `helloData.gql` would be:\n\n`1\n\nquery hello { \n\n2\n\n hero { \n\n3\n\n name \n\n4\n\n height \n\n5\n\n } \n\n6\n\n} \n\n`\n\nThe response, depending on the database, could be something like:\n\n`1\n\n{ \n\n2\n\n \"hero\": { \n\n3\n\n \"name\": \"Luke Skywalker\", \n\n4\n\n \"height\": 1.72, \n\n5\n\n } \n\n6\n\n} \n\n`\n\nNote how the `useQuery` React hook returns an object with `loading`, `error`, and `data` as parameters, which are completed from the query done on the server. By holding the values of these parameters, you can **condition what is rendered in the interface**.\n\nAccording to the example above, if `loading` returns `true`, the message `Loading...` will be rendered. If an error occurs, the message `Error {error description}` will be rendered instead. Finally, if the `data` parameter receives the values of the executed _query_ correctly, the message `Done fetching {data obtained from the query}` will be rendered.\n\n> Check [this](https://read.calvincode.net/reader?url=https://www.apollographql.com/docs/react/data/queries/) practical example of a GraphQL query.\n\n## Mutating in GraphQL\n\nIn addition to _queries_, _mutations_ are another type of operation available for GraphQL APIs.\n\n_Mutations_ are used to insert or modify data that already exists on the platform. They are used for sending _updates_ to the server.\n\n\n\n1. Open your app's code in the code editor of your choice.\n2. In the `react` folder, access the `HelloMutation.tsx` file or create it if it does not already exist.\n3. In this file, copy and paste the basic model below to run a _mutation_ `gql` using the _React_ component:\n\n`1\n\nimport { useMutation } from 'react-apollo' \n\n2\n\nimport MUTATION_VALUE from './helloMutation.gql' \n\n3\n\n \n4\n\nconst HelloMutation = () => { \n\n5\n\n const [doSomething] = useMutation(MUTATION_VALUE) \n\n6\n\n \n7\n\n return <button onClick={() => { doSomething() }}>Click me</button> \n\n8\n\n} \n\n9\n\n \n10\n\nexport default HelloMutation \n\n`\n\nIn this case, unlike the `useQuery` _hook_ where the _query_ is executed immediately, the call to the server will only be made after calling the function returned by the `useMutation` _hook_ (`doSomething` in this example).\n\nYou can add _mutation_ parameters as `doSomething` function variables.\n\nSuppose that one of the _mutation_ variables you are running is the name of a city (`cityName`). One way to pass this variable would be:\n\n`1\n\n- return <button onClick={() => { doSomething() }}>Click me</button> \n\n2\n\n+ return <button onClick={() => { doSomething({ variables: { cityName: 'Rio' ) }}>Click me</button> \n\n`\n\n> Check [this](https://read.calvincode.net/reader?url=https://www.apollographql.com/docs/react/data/mutations/) practical example of a GraphQL mutation.\n\n## Debugging queries and mutations in GraphQL\n\nTo test GraphQL _queries_ and _mutations_, we will use the GraphQL IDE app.\n\nTo install this app on your VTEX account, run the following command on your terminal:\n\n`1\n\nvtex install vtex.admin-graphql-ide \n\n`\n\nOnce the app is installed, follow the steps below:\n\n1. Access the Admin.\n2. In the sidebar, go to **Apps**.\n3. Look for GraphQL IDE in the installed apps list.\n4. In the `Choose your app from the list below` field, select the app you want to debug/test. In this case, you need to choose the name of the app you are developing.\n\n> Remember that, until now, the front app you have been developing has been living in your local files, connected to the VTEX platform only by the `link`. To find the name of your app in this list and be able to debug, it needs to be available (published) and properly installed in the account's master workspace. The necessary settings to make your app publicly available are described in the last section of this walkthrough.\n\n1. On the left side of the text editor, enter the _query_ or _mutation_ that you want to run for testing purposes.\n2. Then, click the _play_ button, and the API query response will appear in the text editor to the right.\n\nIf you need help, there is a `docs` tab on the right corner of your screen that describes the queries and mutations available for the selected app.\n\n\n\nThe example above shows how to use the GraphQL IDE Admin to query an internal route in the `vtex.rewriter` app.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[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-1-developing-storefront-apps-using-react-and-vtex-io/vtex-io-documentation-7-consuming-data.md)\n\n[5\\. Structuring documentation« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data//docs/guides/vtex-io-documentation-6-structuring-documentation)[7\\. Translating the componentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data//docs/guides/vtex-io-documentation-8-translating-the-component)\n\nSee also\n\n[7\\. Translating the componentApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-8-translating-the-component)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Understanding GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-7-consuming-data%23understanding-graphql)\n\n[Installing the React Apollo library](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-7-consuming-data%23installing-the-react-apollo-library)\n\n[Making queries in GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-7-consuming-data%23making-queries-in-graphql)\n\n[Mutating in GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-7-consuming-data%23mutating-in-graphql)\n\n[Debugging queries and mutations in GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-7-consuming-data%23debugging-queries-and-mutations-in-graphql)\n\nWas this helpful?\n\n Send feedback\n\n[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-1-developing-storefront-apps-using-react-and-vtex-io/vtex-io-documentation-7-consuming-data.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Understanding GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-7-consuming-data%23understanding-graphql)\n\n[Installing the React Apollo library](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-7-consuming-data%23installing-the-react-apollo-library)\n\n[Making queries in GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-7-consuming-data%23making-queries-in-graphql)\n\n[Mutating in GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-7-consuming-data%23mutating-in-graphql)\n\n[Debugging queries and mutations in GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-consuming-data/docs/guides/vtex-io-documentation-7-consuming-data%23debugging-queries-and-mutations-in-graphql)\n\nOn this page\n\n[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=)"
}
] |
doc_d4d936d3
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtexarg speech to text in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/updates/release-notes)\n\nSpeech to Text Search\n\nThe `speech-to-text` app uses Google Chrome language processing to listen to the user's microphone and convert speech-to-text. The recognized text is then used to redirect the user to the corresponding search page.\n\n\n\n## Configuration\n\n1. Add the `vtexarg.speech-to-text` app to your theme's **peer dependency** in the `manifest.json` file.\n2. Add the `text-speech` block to the desired theme template or inside another block. For example:\n\n`1\n\n \"flex-layout.col#text-speech\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"speech-to-text\" \n\n4\n\n ] \n\n5\n\n }, \n\n`\n\n1. Then, declare the `speech-to-text` block using the props stated in the [Props](#props) table. For example\n\n`1\n\n \"speech-to-text\": { \n\n2\n\n \"props\": { \n\n3\n\n \"lang\": \"es-ES\", \n\n4\n\n \"iconHeight\": \"20px\", \n\n5\n\n \"iconWidth\": \"20px\", \n\n6\n\n \"imgSrc\": \"https://upload.wikimedia.org/wikipedia/commons/a/a7/Font_Awesome_5_solid_microphone.svg\" \n\n7\n\n } \n\n8\n\n } \n\n`\n\n## Props\n\n| Prop name | Type | Description | Default value |\n| ---------- | ------ | ------------------------------------------- | ------------- |\n| lang | enum | Language used by the Google Chrome NLP API. | en-EN |\n| iconHeight | string | Icon height in px. | 20px |\n| iconWidth | string | Icon width in px. | 20px |\n| imgSrc | string | URL of the source image. | none |\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| ---------------------------- |\n| audioSearchContainer |\n| audioSearchImg |\n| audioSearchImgRecordingState |\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/pixel-apps/vtexarg-speech-to-text.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/guides/vtexarg-speech-to-text%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/guides/vtexarg-speech-to-text%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/guides/vtexarg-speech-to-text%23customization)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/pixel-apps/vtexarg-speech-to-text.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/guides/vtexarg-speech-to-text%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/guides/vtexarg-speech-to-text%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text/docs/guides/vtexarg-speech-to-text%23customization)\n\nOn this page\n\n[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=)"
}
] |
doc_bd255d72
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore project structure config options in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/troubleshooting)\n\n[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/project-structure-config-options/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-overview)\n\n[Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options)\n\n[Custom Cypress integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-custom-cypress)\n\n[FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-faststore-cli)\n\n[Updating the @fastore/cli package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-updating-the-cli-package-version)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-overview)\n\n[Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options)\n\n[Custom Cypress integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-custom-cypress)\n\n[FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-faststore-cli)\n\n[Updating the @fastore/cli package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-updating-the-cli-package-version)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-overview)\n\nConfiguration options for discovery.config.js\n\nThe `discovery.config.js` is a configuration file for managing settings that control store behavior, appearance, and functionality. This file serves as a central hub for configuring key aspects of your FastStore website, including SEO, API connections, session management, analytics, and more.\n\nThis guide outlines the configuration options for tailoring your FastStore website using the `discovery.config.js` file.\n\n## Example file\n\n`1\n\nmodule.exports = { \n\n2\n\n seo: { \n\n3\n\n title: \"FastStore Starter\", \n\n4\n\n description: \"Fast Demo Store\", \n\n5\n\n titleTemplate: \"%s | FastStore\", \n\n6\n\n author: \"FastStore\", \n\n7\n\n }, \n\n8\n\n theme: \"custom-theme\", \n\n9\n\n platform: \"vtex\", \n\n10\n\n api: { \n\n11\n\n storeId: \"storeframework\", \n\n12\n\n workspace: \"master\", \n\n13\n\n environment: \"vtexcommercestable\", \n\n14\n\n hideUnavailableItems: false, \n\n15\n\n incrementAddress: false, \n\n16\n\n }, \n\n17\n\n}; \n\n`\n\nCheck the full file example at [discovery.config.js sample code](https://read.calvincode.net/reader?url=https://github.com/vtex-sites/starter.store/blob/main/discovery.config.js).\n\n> As of December 16, 2024, `discovery.config.js` is the new filename for the legacy `faststore.config.js` file. If you're still using the legacy name, see [this release note](https://read.calvincode.net/reader?url=https://developers.vtex.com/updates/release-notes/2024-12-16-discovery-config-file) to update it.\n\n## Configuration options\n\nBelow is a description of each setting you can configure in the `discovery.config.js` file:\n\n### `seo`\n\nSets default metadata related to Search Engine Optimization (SEO), influencing how your store appears in search results. Learn more in [SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview).\n\n| Property | Type | Description | Example |\n| ------------- | ------ | ----------------------------------------------------------------------- | ---------------------- |\n| title | string | Store headline displayed in search results (60 characters recommended). | \"FastStore Starter\" |\n| description | string | Brief description of the store (150-160 characters optimal). | \"FastStore Demo Store\" |\n| titleTemplate | string | Dynamic page title pattern. Use %s as a placeholder. | \"%s \\| FastStore\" |\n| author | string | Content author/owner for attribution. | \"FastStore\" |\n\n---\n\n### `theme`\n\nDefines the visual identity of your FastStore project, including color schemes, typography, and layout presets. This field is a `string` that specifies the name of the theme being used.\n\nEvery FastStore project starts with the [Brandless theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview%23brandless-and-the-theming-structure) by default. However, you can choose from available themes or develop a custom theme. Learn more in [Themes - Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview).\n\n---\n\n### `platform`\n\nDefines the ecommerce platform being used. You must set `vtex` as a value to enable VTEX-specific features.\n\n> Only `vtex` is a valid value. Any other value will cause errors.\n\n---\n\n### `api`\n\nContains settings related to the store's APIs, which link your FastStore storefront to backend services and manage environment-specific behavior.\n\n| Property | Type | Description | Example |\n| -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |\n| storeId | string | VTEX account being used. | \"mystore\" |\n| workspace | string | Workspace being used. Use master for the production environment, and other names for staging. | \"master\" |\n| environment | string | API environment. | \"vtexcommercestable\" |\n| hideUnavailableItems | boolean | Controls product display. When true, hides out-of-stock products. Default value is false. | false |\n| incrementAddress | boolean | Enables automatic completion of address details during checkout using [VTEX’s address API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code). When true, missing address fields (such as city, state, street, etc.) are automatically filled based on the provided postal code. Default value is false. | false |\n\n---\n\n### `session`\n\nSets up user session defaults, controlling language, currency, location, and shopper attributes.\n\n| Property | Type | Description | Example |\n| --------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |\n| currency | object | Store’s transactional currency for prices, payment, and checkout. | |\n| ├─ code | string | ISO currency code | \"USD\" |\n| └─ symbol | string | Currency symbol | \"$\" |\n| locale | string | Language or locale setting for all store text, dates, and numbers. Use standard locale format like en-US for English (US), pt-BR for Brazilian Portuguese, etc. | \"en-US\" |\n| channel | object | Identifies the commercial and regional context for handling catalog, pricing, and logistics. | |\n| ├─ salesChannel | string | Trade policy that handles catalog, prices, and fulfillment options (example: different regions or seller-specific rules). | \"1\" |\n| └─ regionId | string | Internal identifier used to define regional segmentation based on the user’s location for services such as catalog, shipping, pickup, and other logistics-related processes. | |\n| country | string | ISO country code for the current shopper’s session. This field informs VTEX services which country’s regulations, delivery logistics, and tax rules must be applied. | \"US\" |\n| deliveryMode | string | Order fulfillment method, including delivery channel, selected courier or method, delivery window (start and end times), or pickup point. | \"delivery\" |\n| addressType | string | Address format for fulfillment | \"residential\" |\n| postalCode | string | User’s postal code | \"10001\" |\n| geoCoordinates | float\\[\\] | User’s location as \\[latitude, longitude\\] | \\[40.7128, -74.0060\\] |\n| person | object | Shopper identity attributes. | |\n| ├─ id | string | Unique VTEX customer ID. VTEX Identity service may auto-populate these fields after sign-in. | \"12345\" |\n| ├─ email | string | Customer’s email address | \"user@email.com\" |\n| ├─ firstName | string | Customer’s first name. | \"Alex\" |\n| └─ lastName | string | Customer’s last name. | \"Smith\" |\n\n---\n\n### `cart`\n\nContains the settings to manage the shopping cart’s contents and behavior.\n\n| Property | Type | Description | Example |\n| --------------- | ---------- | ------------------------------------------------------------------------------------------------------- | ---------------------------------- |\n| id | string | Unique identifier of the cart. | \"cart-abc-123\" |\n| items | array | Products added to the cart. | \\[{\"sku\": \"5678\", \"quantity\": 2}\\] |\n| messages | string\\[\\] | System messages associated with the cart, such as shipping changes or other relevant information. | \\[\"Shipping updated\"\\] |\n| shouldSplitItem | boolean | If true, allows cart items from multiple sellers or differing stock locations to be shipped separately. | true |\n\n---\n\n### `storeUrl`\n\nDefines the primary store domain as a string. Example: `https://www.mystore.com`.\n\n### `secureSubdomain`\n\nDefines the HTTPS-enabled subdomain, if used, as a string. Example: `https://secure.mystore.com`.\n\n### `checkoutUrl`\n\nDefines the URL for the checkout process as a string. Example: `https://www.mystore.com/checkout`.\n\n### `loginUrl`\n\nDefines the URL for the login process as a string. Example: `https://www.mystore.com/login`.\n\n### `accountUrl`\n\nDefines the URL for the customer's account management page as a string. Example: `https://www.mystore.com/account`.\n\nLearn more about store domains in [Associating your custom domain with your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns%23step-4-associating-your-custom-domain-with-your-faststore-project).\n\n---\n\n### `previewRedirects`\n\nMaps redirect URLs for the following page types in preview mode.\n\n| Property | Type | Description | Example |\n| -------- | ------ | --------------------------------------------- | -------------------------------------- |\n| home | string | Redirect URL for the homepage. | \"https://preview.mystore.com\" |\n| plp | string | Redirect URL for product listing pages (PLP). | \"https://preview.mystore.com/category\" |\n| search | string | Redirect URL for search results pages. | \"https://preview.mystore.com/search\" |\n| pdp | string | Redirect URL for product detail pages (PDP). | \"https://preview.mystore.com/product\" |\n\nLearn more in [Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths).\n\n---\n\n### `lighthouse`\n\nIncludes settings for [Lighthouse](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/overview), a tool for auditing and improving the quality of web pages.\n\n| Property | Type | Description | Example |\n| ------------- | ------ | -------------------------------------------------- | ------------------------------------------------------ |\n| server | string | The server URL for running Lighthouse audits. | process.env.BASE\\_SITE\\_URL \\| 'http://localhost:3000' |\n| pages | object | Maps the URL of pages to be audited by Lighthouse. | |\n| ├─ home | string | URL of the homepage. | '/' |\n| ├─ pdp | string | URL of a product detail page. | \"/headphone-white-10000006/p\" |\n| └─ collection | string | URL of a collection page. | \"/headphones\" |\n\nLearn more in [Lighthouse Scores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard%23lighthouse-scores).\n\n---\n\n### `cypress`\n\nDefines which pages [Cypress](https://read.calvincode.net/reader?url=https://docs.cypress.io/app/get-started/why-cypress) should visit in end-to-end tests, ensuring predictable routes for the CI pipeline. Prefer relative URLs (for example, `\"/\"`, `/headphones`) and deterministic scenarios with consistent data across runs.\n\n| Property | Type | Description | Example |\n| ----------------------- | ------ | ------------------------------------------------------------------------------------------------ | -------------------------------- |\n| pages | object | Maps the URLs of pages for end-to-end testing with Cypress, with each field defined as a string. | |\n| ├─ home | string | URL of the homepage. | \"/\" |\n| ├─ pdp | string | URL of the product detail page. | \"/headphone-white-10000006/p\" |\n| ├─ collection | string | URL of a collection page. | \"/headphones\" |\n| ├─ collection\\_2 | string | URL of a secondary collection page. | \"/audio\" |\n| ├─ collection\\_filtered | string | URL of a filtered collection page. | \"/headphones?priceRange=100-200\" |\n| └─ search | string | URL of a search results page. | \"/s?q=headphone\" |\n\nLearn more in [enableCypressExtension](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress).\n\n---\n\n### `analytics`\n\nDefines the [Google Tag Manager ID](https://read.calvincode.net/reader?url=https://support.google.com/tagmanager/answer/12326985?hl=en%26ref%5Ftopic=14595647%26sjid=12859079805529639111-SA) used by the site to collect events and trigger tags, allowing you to measure interactions, funnels, and conversions.\n\n| Property | Type | Description | Example |\n| -------------- | ------ | ------------------------------------ | ------------- |\n| gtmContainerId | string | The Google Tag Manager container ID. | \"GTM-1234567\" |\n\nLearn more in [Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview).\n\n---\n\n### `experimental`\n\nContains settings for experimental features.\n\n| Property | Type | Description | Example |\n| ----------------------- | ------ | -------------------------------------------------------------------------------- | ------- |\n| nodeVersion | string | The Node.js version. | \"20\" |\n| cypressVersion | string | The Cypress version. | \"13\" |\n| graphqlCacheControl | object | Settings for GraphQL responses. | |\n| ├─ maxAge | number | Maximum time (in seconds) that the response can be cached. | 300 |\n| └─ staleWhileRevalidate | number | Time (in seconds) during which stale responses can be served while revalidating. | 60 |\n\n---\n\n### `account`\n\nSpecifies the VTEX account name used by the project as a string. Example: `mystore`.\n\n---\n\n### `vtexHeadlessCms`\n\nConfigures webhook endpoints for [VTEX Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview) to trigger publishing, cache invalidation, or content preview whenever changes occur in the CMS.\n\n| Property | Type | Description | Example |\n| ----------- | ---------------- | ----------------------------------------------------------------------------------------- | -------------------------------------------------------------- |\n| webhookUrls | array of strings | An array of strings that defines the webhook URLs used to interact with the Headless CMS. | \\[\"https://mystore.myvtex.com/cms-releases/webhook-releases\"\\] |\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developer-tools/config-options.mdx)\n\n[Developer tools and references« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-overview)[Custom Cypress integrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-custom-cypress)\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Example file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23example-file)\n\n[Configuration options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23configuration-options)\n\n[seo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23seo)[theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23theme)[platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23platform)[api](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23api)[session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23session)[cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23cart)[storeUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23storeurl)[secureSubdomain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23securesubdomain)[checkoutUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23checkouturl)[loginUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23loginurl)[accountUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23accounturl)[previewRedirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23previewredirects)[lighthouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23lighthouse)[cypress](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23cypress)[analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23analytics)[experimental](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23experimental)[account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23account)[vtexHeadlessCms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23vtexheadlesscms)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developer-tools/config-options.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Example file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23example-file)\n\n[Configuration options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23configuration-options)\n\n[seo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23seo)[theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23theme)[platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23platform)[api](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23api)[session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23session)[cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23cart)[storeUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23storeurl)[secureSubdomain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23securesubdomain)[checkoutUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23checkouturl)[loginUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23loginurl)[accountUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23accounturl)[previewRedirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23previewredirects)[lighthouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23lighthouse)[cypress](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23cypress)[analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23analytics)[experimental](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23experimental)[account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23account)[vtexHeadlessCms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options/docs/guides/faststore/developer-tools-config-options%23vtexheadlesscms)\n\nOn this page\n\n[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=)"
}
] |
doc_75d8fb91
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides external marketplace integration logs in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides)\n\nIntegration Guides\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-guide)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-logs)\n\nCatalog logs\n\n| Status | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Success | Occurs when the exchange of messages between VTEX, connector and marketplace flow successfully. |\n| Error | Occurs when the exchange of messages between VTEX, connector and marketplace present errors due to communication (500) or business errors (400). Recommendations: for 500 errors, it is highly recommended to use the contingency flow through the reprocessing queue with at least 10 attempts. After the attempt number is exceeded, we recommend using a DEADLETTER queue for infinite retrials. |\n| Alert | Occurs when the exchange of messages between VTEX, connector and marketplace are able to process, but with a needed action from one of the systems involved. |\n| Pending | Occurs when the exchange of messages between VTEX, connector and marketplace are in progress. Ex. SKUs are still in the connector’s processing queue, or waiting an async response from the marketplace. |\n\n## Log endpoints\n\nConnectors must offer an endpoint that allows the integration app to collect and present logs in the standard report screen. The endpoint should follow the format:\n\n`{urlBase}/{vtexaccount}/logs/`\n\nFor this endpoint the parameters `date` and `status` should be included, following the status described in the [Log messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs%23log-messages) table:\n\n`1\n\nhttps://{urlBase}/logs/?DateAt=aaaa-mm-dd&status=all https://{urlBase}/logs/?DateAt=aaaa-mm-dd&status=sucess,error \n\n`\n\nThe endpoint should return the payload described below, so the list of error messages can be assembled:\n\n`1\n\n{ \n\n2\n\n\"Messages\":[ \n\n3\n\n { \n\n4\n\n\"id\": \"13\", \n\n5\n\n\"Operation\": \"\", \n\n6\n\n\"Direction\": \"\", \n\n7\n\n\"ContentSource\": \"\", \n\n8\n\n\"ContentTransalted\": \"\", \n\n9\n\n\"ContentDestination\": \"\", \n\n10\n\n\"BusinessMessage\": \"\", \n\n11\n\n\"Status\": \"\", \n\n12\n\n } \n\n13\n\n ] \n\n14\n\n } \n\n`\n\n## Content of the messages\n\nThe messages contained in logs should follow the standard defined below, allowing the user who operates VTEX platform and catalog to understand the situation:\n\n1. **Operation ID (id)**: allows to identify the unique log in any sort of operation.\n2. **Operation**: identifies if an operation is a Catalog change, Offer creation, Price update, Inventory update, Order status update, Invoice sending, Tracking code sending.\n3. **Direction**: allows to identify the origin and destination of the information. Ex. VTEX to Marketplace.\n4. **Content Source**: payload sent by the origin solution. Ex. Order’s json, connected from the marketplace, allowing to identify the original message sent by the origin app.\n5. **Content Translated**: message generated by the connector with transformations, filers and enrichments needed, allowing sellers to understand the actions executed.\n6. **Content destination**: original payload sent by the destination software after processing trial.\n7. **Business message**: in case of errors, message explaining the error under the business contexto, with guidance on how to solve the problem.\n8. **Status**: should include the statuses of success, error, warning and pending.\n\n## Log messages\n\nEach step of the catalog integration requires a specific set of Log messages. The list below points out which messages to use for each step, and the table describes all messages.\n\n* [Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-load): S1, A1, A2, A3, E1, E2, E3, E4, E5\n* [How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-new-products): S1, A1, A2, A3, E1, E2, E3, E4, E5\n* [How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates): S1, A1, A2, A3, E1, E2, E3, E4, E5\n* [How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update): S1, A1, A2, E1, E2, E3\n* [How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-stock-update): S1, A1, A2, A3, E1, E2, E3, E4, E5\n\n| Code | Event | User message | Error status | Response |\n| ---- | ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -------- |\n| S1 | When sending the SKU registration to the marketplace | The SKU (VTEXId + name) was created in the marketplace with the code (marketplace ID). Link for the SKU within the marketplace. | Success | 201 |\n| A1 | When using the shopping cart simulation through the fulfillment API, the SKU is not retrieved in the items object | Oops, we couldn’t obtain the SKU price of (SKU\\_Id). Please check if the items below are configured correctly in the VTEX platform. On product registration, check if it is associated with the trade policy.On inventory simulation, check if the carrier attending the SKU exists. On price configuration, check if there’s a price associated with the trade policy. | Warning | 400 |\n| A2 | When checking if the SKU is inactive | Oops, the SKU is inactive in VTEX. We recommend that you check:In Catalog, identify the SKU and check if the field “Activate SKU” is checked.In Catalog, check if the image is uploaded. In inventory simulation, check if the carrier attending the SKU exists.On price configuration, check if there’s a price associated with the trade policy. | Warning | 400 |\n| A3 | When transforming the SKU’s registration data AND having to insert a standard value since VTEX doesn’t possess it. | Oops, we couldn’t find the values needed for product registration, with standard values accepted by the marketplace. {list containing FIELD and VALUE attributed} | Warning | 200 |\n| E1 | When transforming SKU registration data to the format demanded by the marketplace. | Oops, we couldn't prepare the SKU registration in the marketplace due to {list all errors occurred during data transformation, and in case any data infringes marketplace rules}. (Connectors should list all errors at once, so the user knows all actions needed to send the SKU). | Error | 400 |\n| E2 | When trying to communicate with the marketplace API used to register the product | Oops, the product registration in the {name} marketplace is unavailable right now. Don’t worry - we’ll try again in a few minutes. In case the problem persists, get in touch with the marketplace. | Error | 500 |\n| E3 | When sending the product registration to the marketplace, and obtaining failure for sending incorrect data. | Oops, we couldn't prepare the SKU registration in the marketplace due to {list all errors occurred during data transformation, and in case any data infringes marketplace rules}. (Connectors should list all errors at once, so the user knows all actions needed to send the SKU). | Error | 400 |\n| E4 | When trying to collect the category or attribute mapping from the mapper. | Oops, we couldn’t find the category {name of the category} mapping of the {SKU name + ID} SKU in the marketplace. Please access the link below to perform this mapping. {Link indicating the store’s mapper}. | Error | 400 |\n| E5 | When trying to communicate with the mapping API from the mapper. | OOps, the VTEX category mapping is unavailable right now. Don’t worry - we’ll try again in a few minutes. In case the problem persists, get in touch with the marketplace. | Error | 500 |\n\n> The table above should be a part of the connector’s documentation. During the development and testing of the integration, if any other error scenarios are identified, and are not already mapped in this table, connectors should add it in their own documentation.\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-logs.md)\n\n[Catalog Integration« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs//docs/guides/external-marketplace-integration-catalog)[Get product list for an initial loadNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs//docs/guides/external-marketplace-integration-product-load)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Log endpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-logs%23log-endpoints)\n\n[Content of the messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-logs%23content-of-the-messages)\n\n[Log messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-logs%23log-messages)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-logs.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Log endpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-logs%23log-endpoints)\n\n[Content of the messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-logs%23content-of-the-messages)\n\n[Log messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs/docs/guides/external-marketplace-integration-logs%23log-messages)\n\nOn this page\n\n[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=)"
}
] |
doc_1d01d250
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation creating robots files for cross border stores in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Checking your store's binding ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/checking-your-stores-binding-id)\n\n[Creating robots files for cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores)\n\n[Cross-border store content internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/cross-border-custom-urls-1)\n\n[Managing landing pages in cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-managing-landing-pages-in-cross-border-stores)\n\n[Indicating alternate versions of localized pages in cross border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Checking your store's binding ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/checking-your-stores-binding-id)\n\n[Creating robots files for cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores)\n\n[Cross-border store content internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/cross-border-custom-urls-1)\n\n[Managing landing pages in cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-managing-landing-pages-in-cross-border-stores)\n\n[Indicating alternate versions of localized pages in cross border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Creating robots files for cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores)\n\nCreating robots files for cross-border stores\n\nThis guide explains how to develop and release a Robots app to manage ´robots.txt´ files for cross-border stores using Store Framework.\n\nA `robots.txt` file controls which folders or files search engines can crawl on a website. Given its impact on store SEO, the following steps explain how to create `robots.txt` files for cross-border stores.\n\n> This guide only applies to cross-border stores. If your store isn't cross-border, see [this guide](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/google-search-console-tracking-robots-txt--tutorials%5F574?locale=en).\n\n## `robots.txt` file structure\n\nBelow is the basic structure of a `robots.txt` file:\n\n* `User-agent`: Specifies the search engine robot to which the following rules apply. To apply the same rules to all robots, use `*`.\n* `Disallow`: Defines the paths (relative to the root directory) of files or folders that the search engine specified in `User-agent` must not index.\n* `Allow`: Specifies the paths of files within a `Disallowed` folder that can be crawled and indexed.\n\nYou must adjust these directives based on your scenario.\n\n## Before you begin\n\nThis feature is available for stores using the `vtex.edition-store@3.x` [Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/) or newer. To check which Edition app is installed on your account, run `vtex edition get`. If your store is using an older Edition, [open a ticket](https://read.calvincode.net/reader?url=https://help-tickets.vtex.com/smartlink/sso/login/zendesk) with VTEX Support requesting the installation of `vtex.edition-store@5.x`.\n\n## Instructions\n\nFollow the steps below to develop your Robots app:\n\n1. Use the command below to clone the `store-theme-robots` app boilerplate repository. \n`1 \ngit clone https://github.com/vtex-apps/store-theme-robots \n`\n2. Once successfully cloned, open the local app directory in your code editor.\n3. Open the `manifest.json` file and edit the `vendor` field with the name of the developing account. \n`1 \n{ \n2 \n \"vendor\": \"myaccount\", \n3 \n \"name\": \"robots\", \n4 \n \"version\": \"0.0.1\", \n5 \n \"builders\": { \n6 \n \"sitemap\": \"0.x\" \n7 \n }, \n8 \n ... \n9 \n} \n`\n4. Inside the `sitemap/robots` folder, create a `.txt` robots file for each supported locale binding. The name of each file must be the `id` value of its respective `binding`. \n> Follow [this tutorial](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-your-stores-binding-id) to check the store binding `id`s. \nYour app folder should have a structure similar to the following: \n`1 \nstore-theme-robots \n2 \n├── manifest.json \n3 \n├── README.md \n4 \n└─┬ sitemap \n5 \n └─┬ robots \n6 \n ├── 706e9126-d0fc-47de-9o2d-5f9649e61877.txt \n7 \n └── 748aafcf-1674-456d-9ffc-7ddb3f26e43f.txt \n`\n5. Edit each file in the `sitemap/robots` folder with the content you want for your `robots.txt` files.\n6. Once everything is set up, use the terminal and [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/) to log in to the VTEX account you're currently working in.\n7. Run `vtex use {workspace}` to select a developer environment. \n> Replace the values between curly brackets based on your scenario.\n8. Run `cd store-theme-robots` to go to the local app directory.\n9. Run `vtex link` to [link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/) your new app to your development workspace.\n10. Check the `robots` file generated for each store by accessing `https://{workspace}--{account}.myvtex.com/{locale}/robots.txt` on your browser.\n11. Follow the guide [Deploying a new app version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available) to test your Robots app in a [production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace) and, once you're satisfied with the result, promote it to master. \n> The Robots app must be tested in a [production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace).\n\nNow you're ready to check your store's `robots.txt` files by accessing `https://{account}.myvtex.com/{locale}/robots.txt` in your browser, replacing the values between the curly brackets based on your scenario.\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/vtex-io-cross-border-stores/vtex-io-documentation-creating-robots-files-for-cross-border-stores.md)\n\n[Checking your store's binding ID« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores//docs/guides/checking-your-stores-binding-id)[Cross-border store content internationalizationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores//docs/guides/cross-border-custom-urls-1)\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[robots.txt file structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores%23robotstxt-file-structure)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/vtex-io-cross-border-stores/vtex-io-documentation-creating-robots-files-for-cross-border-stores.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[robots.txt file structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores%23robotstxt-file-structure)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores%23instructions)\n\nOn this page\n\n[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=)"
}
] |
doc_289c88c8
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides sku specifications in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/alternative-api-requests)\n\n[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/how-to-implement-product-color-variation)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/alternative-api-requests)\n\n[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/how-to-implement-product-color-variation)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/catalog-integration)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/sku-specifications)\n\nSKU specifications\n\nSKU specifications are necessary to be able to choose the SKU, that is, the variation of the product. Example: Color, Size, Voltage. The SKU Selector can be found in the search result or on the product page.\n\n> If you wish to implement color variation in your products, we recommend you do not use SKU specifications. Instead, see this tutorial about [How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-implement-product-color-variation).\n\n> VTEX Admin says that if a new SKU Specification field is created, all the SKUs associated will be deactivated. However, if created, products will keep activated.\n\n## Data Model\n\n| **Field** | **Description** | **Required** | **Type** | **Default** |\n| ------------ | ----------------------------------------------------------------------- | ------------ | -------- | ------------- |\n| Id | ID of Specification. This ID is used to delete/update the specification | No | Integer | AutoIncrement |\n| SkuId | ID of SKU | Yes | Integer | \\- |\n| FieldId | Field ID | Yes | Integer | \\- |\n| FieldValueId | ID of FieldValue. Required only for FieldTypeId 5,6 | Yes | Integer | null |\n| Text | Value of specification. Only for FieldTypeId different from 5,6,7 | No | String | null |\n\n## Implementation\n\n### Create SKU Specification\n\nTo create a SKU specification, simply use the API below. Remember that you must have saved the ID of the field for which you want to create, and the `FieldId` of the value created for the field.\n\nPOST\n\n`1\n\nhttps://{{accountName}}.vtexcommercestable.com.br/api/catalog/pvt/stockkeepingunit/{{skuId}}/specification/ \n\n`\n\nBody:\n\n`1\n\n{ \n\n2\n\n \"FieldId\": 13, \n\n3\n\n \"FieldValueId\": 101 \n\n4\n\n} \n\n`\n\nHeader:\n\n`1\n\nAccept: application/json \n\n2\n\nContent-Type: application/json \n\n3\n\nX-VTEX-API-AppToken: {{X-VTEX-API-AppToken}} \n\n4\n\nX-VTEX-API-AppKey: {{X-VTEX-API-AppKey}} \n\n`\n\nResponse:\n\n`1\n\nStatus: 200 OK \n\n`\n\n`1\n\n{ \n\n2\n\n \"Id\": 1505, \n\n3\n\n \"SkuId\": 1234568387, \n\n4\n\n \"FieldId\": 193, \n\n5\n\n \"FieldValueId\": 360, \n\n6\n\n \"Text\": \"Size 10\" \n\n7\n\n} \n\n`\n\n### Remove an SKU Specification\n\nTo remove a specification from an SKU, use the [Delete SKU specification API endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/stockkeepingunit/-skuId-/specification/-specificationId-).\n\n### Remove all specifications of specific SKU\n\nTo remove all specifications of one SKU, use the [Delete all SKU specifications endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/stockkeepingunit/-skuId-/specification)\n\nContributors\n\n3\n\n[](https://github.com/ancrln)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/catalog-integration/sku-specifications.md)\n\n[Product specifications« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications//docs/guides/product-specifications)[Updating SKU Specifications with Catalog APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications//docs/guides/updating-sku-specifications-with-catalog-api)\n\nContributors\n\n3\n\n[](https://github.com/ancrln)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Data Model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/sku-specifications%23data-model)\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/sku-specifications%23implementation)\n\n[Create SKU Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/sku-specifications%23create-sku-specification)[Remove an SKU Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/sku-specifications%23remove-an-sku-specification)[Remove all specifications of specific SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/sku-specifications%23remove-all-specifications-of-specific-sku)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/catalog-integration/sku-specifications.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Data Model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/sku-specifications%23data-model)\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/sku-specifications%23implementation)\n\n[Create SKU Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/sku-specifications%23create-sku-specification)[Remove an SKU Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/sku-specifications%23remove-an-sku-specification)[Remove all specifications of specific SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications/docs/guides/sku-specifications%23remove-all-specifications-of-specific-sku)\n\nOn this page\n\n[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=)"
}
] |
doc_347899d1
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain the VTEX api reference pick and pack api API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/pick-and-pack-api/)\n\nAuthentication\n\nOrders\n\nWorksheets\n\nFacilities\n\nShipments\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/pick-and-pack-api/)\n\nAuthentication\n\nOrders\n\nWorksheets\n\nFacilities\n\nShipments\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PoSend payment notification with payment ID, date, and value paid« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/payments-gateway-api%23post-/api/payments/pvt/payments/-paymentId-/payment-notification)[PoGenerate JWT tokenNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-api/docs/api-reference/pick-and-pack-api%23post-/token)\n\n[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=)"
}
] |
doc_50de88da
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation site editor schema examples in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-site-editor-schema-examples/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/api-reference)\n\n[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-site-editor-schema-examples/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/storefront-development)\n\n[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-site-editor-schema-examples/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/troubleshooting)\n\n[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-site-editor-schema-examples/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-working-with-site-editor)\n\n[Integrating a frontend app with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor)\n\n[Making a custom component available in Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor)\n\n[Site Editor schema examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-working-with-site-editor)\n\n[Integrating a frontend app with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor)\n\n[Making a custom component available in Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor)\n\n[Site Editor schema examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/store-framework-working-with-site-editor)\n\n[Site Editor schema examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples)\n\nSite Editor schema examples\n\nExplore practical schema examples for configuring custom components in Site Editor.\n\nWhen configuring a custom component, you need to define a schema within it to make it editable by user administrators directly in Site Editor. Learn how to configure the schema definitions in the [Making a custom component available in Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-editable-in-the-site-editor) guide.\n\nTo create your schemas, use the [JSON Schema](https://read.calvincode.net/reader?url=https://json-schema.org/) format, a declarative language that provides a standardized way to describe and validate JSON data.\n\nYou can use the following data types to configure your schemas:\n\n* [String](#string)\n* [Boolean](#boolean)\n* [Object](#object)\n* [Array](#array)\n\nIn this guide, you will learn how to use each data type effectively.\n\n## String\n\nAlongside, you can see the `HeaderComponentProps` interface, which specifies the types of the `title` and `subtitle` props. This interface is used to type-check the props passed to the `HeaderComponent`.\n\nThe `HeaderComponent` is a functional component that accepts `title` and `subtitle` as props, which are destructured from the props object defined by the interface.\n\n> Below are additional examples of content schemas using String for image and date fields.\n\n### Images\n\nConsider a component that displays different images based on device type (desktop or mobile) (e.g., `ImageComponent.tsx`).\n\nTo enable users to select an image from their computer or paste an image URL link, provide options for both methods in your component’s `schema` object.\n\nIn Site Editor, this custom component will look like this:\n\n\n\n### Dates\n\nConsider a component that allows users to input a start and end date (e.g., `DateComponentProps.tsx`).\n\nIn the `schema`, the `initialDate` and `finalDate` props define the configuration for date input fields.\n\nThe `initialDate` prop has an empty string as its default value and a description indicating the expected date format `'{year}/{month}/{day}'`. The `finalDate` prop has the default value set to the current date and time in [ISO 8601](https://read.calvincode.net/reader?url=https://www.iso.org/iso-8601-date-and-time-format.html) format. It includes a custom UI widget for a date-time picker, streamlining the selection of both date and time.\n\nIn Site Editor, this component will look like this:\n\n\n\n## Boolean\n\nConsider a component that allows users to toggle its active or inactive state. To allow users to activate or deactivate the component, define the `schema` as follows.\n\nThe `active` prop is a boolean, meaning it can be either `true` or `false`. The default value set as `true` ensures that the component starts in an active state unless specified otherwise.\n\nIn Site Editor, this custom component will look like this:\n\n\n\n## Object\n\nConsider a component that renders an image, taking an `image` prop, which includes the URL, alt text, and title.\n\nThe `schema` below defines the structure of the component, specifying that it expects an `image` prop, which is an object containing `url`, `alt`, and `title` props.\n\nIn Site Editor, this component will look like this:\n\n\n\n## Array\n\nConsider a component where the displayed images adapt to the screen size.\n\nThe component checks if the viewport width is less than 768 pixels to determine if it is a mobile view and selects the appropriate image source. It then renders the images inside a `div`, with each `img` element receiving the correct source and `alt` text based on the viewport size, ensuring each image has a unique key.\n\nIn the `schema`, the `images` prop is specified as an array of objects, ensuring it will hold multiple items. Each item within the `images` array is defined as an object with three specific props, `src`, `alt`, and `mobileSrc`.\n\nIn Site Editor, this component will look like this:\n\n\n\n### Making the item name editable\n\nIf you want to allow users to change the name of each item in the `images` array within Site Editor, add the `__editorItemTitle` prop to the item configuration.\n\nIn Site Editor, this component will look like this:\n\n\n\n## `enum` and `enumNames` props\n\nSome props are used to define a set of allowed values for a particular prop, such as [enum](#enum-example) and [enumNames](#enumnames-example).\n\nWhen using `enum`, the prop's value must be one of the values in the array.\n\nThe `enumNames` prop is used in conjunction with `enum` to provide a set of human-readable names for the values specified in the `enum` array. This is particularly useful in UI components, such as dropdowns and radio buttons, where you want to display a user-friendly name instead of the actual value.\n\n### **`enum` example**\n\nImagine you have a schema with `colors` as a prop, and the possible values are `red`, `blue`, or `black`.\n\nIn Site Editor, you will see the component like this:\n\n\n\n### **`enumNames` example**\n\nImagine you have a schema with `colors` as a prop, and the possible values are `#0ff102`, `#1038c9`, or `#000000`. However, for the user, you need to show the names `green`, `blue`, or `black`, respectively.\n\nIn Site Editor, you will see this component like this:\n\n\n\nIf the user selects the value `green`, for example, the prop returns `#0ff102`.\n\nHeaderComponent.tsx\n\n`1\n\nimport React from 'react'; \n\n2\n\n \n3\n\ninterface HeaderComponentProps { \n\n4\n\n title: string; \n\n5\n\n subtitle: string; \n\n6\n\n} \n\n7\n\n \n8\n\nconst HeaderComponent = ({ title, subtitle }: HeaderComponentProps) => { \n\n9\n\n return ( \n\n10\n\n <> \n\n11\n\n <p>{title}</p> \n\n12\n\n <p>{subtitle}</p> \n\n13\n\n </> \n\n14\n\n ); \n\n15\n\n}; \n\n16\n\n \n17\n\nHeaderComponent.defaultProps = { \n\n18\n\n title: \"VTEX\", \n\n19\n\n subtitle: \"The Composable and Complete Commerce Platform.\", \n\n20\n\n}; \n\n21\n\n \n22\n\nHeaderComponent.schema = { \n\n23\n\n title: 'Custom Component', \n\n24\n\n type: 'object', \n\n25\n\n properties: { \n\n26\n\n title: { \n\n27\n\n type: 'string', \n\n28\n\n title: 'Título', \n\n29\n\n }, \n\n30\n\n subtitle: { \n\n31\n\n type: 'string', \n\n32\n\n title: 'Subtítulo', \n\n33\n\n }, \n\n34\n\n }, \n\n35\n\n}; \n\n36\n\n \n37\n\nexport default CustomComponent; \n\n`\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-site-editor-schema-examples.mdx)\n\n[Making a custom component available in Site Editor« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples//docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor)[StylingNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples//docs/guides/store-framework-styling)\n\nSee also\n\n[Making a custom component available in Site EditorGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23string)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23images)[Dates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23dates)\n\n[Boolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23boolean)\n\n[Object](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23object)\n\n[Array](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23array)\n\n[Making the item name editable](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23making-the-item-name-editable)\n\n[enum and enumNames props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23enum-and-enumnames-props)\n\n[enum example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23enum-example)[enumNames example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23enumnames-example)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-site-editor-schema-examples.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23string)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23images)[Dates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23dates)\n\n[Boolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23boolean)\n\n[Object](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23object)\n\n[Array](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23array)\n\n[Making the item name editable](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23making-the-item-name-editable)\n\n[enum and enumNames props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23enum-and-enumnames-props)\n\n[enum example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23enum-example)[enumNames example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples/docs/guides/vtex-io-documentation-site-editor-schema-examples%23enumnames-example)\n\nOn this page\n\n[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=)"
}
] |
doc_37b86029
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides calling commerce apis 1 getting the service app boilerplate in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[1\\. Getting the Service app boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate)\n\n[2\\. Discovering VTEX Commerce APIs and authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)\n\n[3\\. Using VTEX IO clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-3-using-vtex-io-clients)\n\n[Calling Commerce APIs - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-conclusion)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[1\\. Getting the Service app boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate)\n\n[2\\. Discovering VTEX Commerce APIs and authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)\n\n[3\\. Using VTEX IO clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-3-using-vtex-io-clients)\n\n[Calling Commerce APIs - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-conclusion)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/app-development-guides)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[1\\. Getting the Service app boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate)\n\nGetting the Service app boilerplate\n\nTo kickstart your journey in this course, your initial step is to clone the [vtex.service-example](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/service-example) boilerplate app. This repository serves as a template with all the essential files you need to get started in this course.\n\n## Cloning the boilerplate repository\n\nClone the `vtex-apps/service-example` boilerplate by running the command presented on the right panel. This will create a local copy of the project, equipping you with the necessary files to start the course.\n\n## Understanding the project structure\n\nOpen the [service-example](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/service-example) project in the code editor of your preference. Note that the project contains the `/node` and `/docs` directories, the `manifest.json` file, and the `package.json` file.\n\n### `manifest.json` file\n\nAt the heart of this structure lies the [manifest.json](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest) file, a crucial document encapsulating metadata about the app. This file not only contains fundamental details such as the app's `name`, `version`, and `title` but also outlines the `builders`, `policies`, and `dependencies` necessary for the app functionality. Let's delve deeper into some of these concepts:\n\n| Field | Type | Description |\n| -------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| builders | object | Specifies the [builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders) required by the app. Note that the app uses the node builder, responsible for interpreting [Node.js](https://read.calvincode.net/reader?url=https://nodejs.org/en) code. For each declared builder, there will be a dedicated folder specifically designed to be interpreted by that particular builder. |\n| policies | array | Declares [policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies) for accessing external services or specific resources needed for the app functioning. |\n\n## `node` folder\n\nThe `/node` folder contains the backend logic of the app, written in [Node.js](https://read.calvincode.net/reader?url=https://nodejs.org/en/). Here, Node packages and native libraries, such as [@vtex/clients](https://read.calvincode.net/reader?url=https://github.com/vtex/io-clients), can be employed to enhance code development.\n\nWithin the `node` folder, you will also find the following folders and files:\n\n| Folder or file | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| /middlewares | Folder containing middleware functions. |\n| /middlewares/validate.ts | Middleware that validates if the request has a valid HTTP status code. It will also be used to access the app authentication token. |\n| /middlewares/status.ts | Middleware to call the VTEX Commerce API and fetch SKU details from the Catalog API. |\n| /clients | Folder where the Clients of the app are defined, used to access external resources and services. |\n| /clients/index.ts | Definition of the Clients class. Here we will import the Client Catalog and define a getter/setter function for Catalog items. |\n| index.ts | Initial declarations for the app's functionality, including mapping routes and middlewares. |\n| package.json | Metadata about the node app, including its name, version, description, dependencies, and scripts. |\n| service.json | Configuration file that specifies the the app's infrastructure attributes. It includes details such as memory allocation, timeout duration, minimum and maximum replicas, and routes. |\n| tsconfig.json | Configuration file for TypeScript, specifying how the TypeScript compiler should compile the project. It may include options such as the target JavaScript version, module system, and other compiler settings. |\n\n### `node/service.json` file\n\nLocated within the `/node` folder, the [service.json](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service) file configures the app's infrastructure attributes. Key details are summarized in the following table:\n\n| Field | Type | Description |\n| ----------- | ------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| memory | integer | Memory size allocated to the app, in megabytes. This value is subjective to automatic adjustments if excessive usage is detected. |\n| timeout | integer | Maximum duration for fulfilling a request, in seconds. Requests exceeding this timeout are aborted. |\n| minReplicas | integer | Minimum number of replicas available when the app is operational. |\n| maxReplicas | integer | Maximum numbers of replicas available for the app. |\n| routes | object | Describes the app's REST routes. Note that a public route named status with the path /\\_v/status/:code is already defined. |\n\n### `node/index.ts` file\n\nThe `node/index.ts` file associates routes with middlewares. Note that the `routes` section associates the `status` route with the GET method and the `validate` and `status` middleware functions.\n\nThis means that when a GET request is made to the `status` route, the app will trigger the `validate` and `status` middleware functions in the specified order.\n\n> Check the `middlewares/status.ts` and `middlewares/validate.ts` files to better understand the functions exposed by this service.\n\n## Testing the `/status` route\n\nChange to the app directory and link it to a development workspace. This action will prompt the availability of the `/status` route. To verify its functionality, make a request to `https://{workspace}--{accountName}.myvtex.com/_v/status/200`, replacing `{workspace}` and `{accountName}` according to your scenario.\n\n`git clone https://github.com/vtex-apps/service-example \n\n1\n\nroot \n\n2\n\n ┣ 📂 node \n\n3\n\n ┣ 📂 docs \n\n4\n\n ┣ 📄 README.md \n\n5\n\n ┣ 📄 manifest.json \n\n6\n\n ┗ 📄 package.json \n\n`\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Calling Commerce APIs/calling-commerce-apis-1-getting-the-service-app-boilerplate.mdx)\n\n[Calling commerce APIs on VTEX IO« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate//docs/guides/calling-commerce-apis-on-vtex-io)[2\\. Discovering VTEX Commerce APIs and authenticationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate//docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Cloning the boilerplate repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate%23cloning-the-boilerplate-repository)\n\n[Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate%23understanding-the-project-structure)\n\n[manifest.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate%23manifestjson-file)\n\n[node folder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate%23node-folder)\n\n[node/service.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate%23nodeservicejson-file)[node/index.ts file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate%23nodeindexts-file)\n\n[Testing the /status route](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate%23testing-the-status-route)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Calling Commerce APIs/calling-commerce-apis-1-getting-the-service-app-boilerplate.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Cloning the boilerplate repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate%23cloning-the-boilerplate-repository)\n\n[Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate%23understanding-the-project-structure)\n\n[manifest.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate%23manifestjson-file)\n\n[node folder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate%23node-folder)\n\n[node/service.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate%23nodeservicejson-file)[node/index.ts file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate%23nodeindexts-file)\n\n[Testing the /status route](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate%23testing-the-status-route)\n\nOn this page\n\n[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=)"
}
] |
doc_57d0ce6e
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain the VTEX api reference license manager api API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/license-manager-api/)\n\nUser\n\nRoles\n\nAPI Keys\n\nStore\n\nAccount\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/license-manager-api/)\n\nUser\n\nRoles\n\nAPI Keys\n\nStore\n\nAccount\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PoSave Events« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/intelligent-search-events-api-headless%23post-/event)[GeGet user information by user IDNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api/docs/api-reference/license-manager-api%23get-/api/license-manager/users/-userId-)\n\n[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=)"
}
] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.