id
stringlengths 12
53
| messages
listlengths 3
3
|
|---|---|
doc_98bda1af
|
[
{
"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 b2b organizations 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.b2b-organizations/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/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.b2b-organizations/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.b2b-organizations/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.b2b-organizations/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.b2b-organizations/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.b2b-organizations/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-checkout-settings)\n\n[B2B Orders History](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-orders-history)\n\n[B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-quotes)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/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.b2b-organizations/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.b2b-organizations/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-checkout-settings)\n\n[B2B Orders History](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-orders-history)\n\n[B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-quotes)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/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.b2b-organizations/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.b2b-organizations/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.b2b-organizations/docs/vtex-io-apps)\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-suite)\n\nB2B Organizations\n\nOfficial extension\n\nVersion: 3.1.2\n\nLatest version: 3.1.2\n\n[](#contributors-)\n\n> 9 The **B2B Organizations** app is part of VTEX\u0019s [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-suite) solution: 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\nIn the B2B model, sales goals go beyond a high order conversion rate. They include simplifying the relationship between companies, reducing costs, and increasing performance by providing the customer with the best possible shopping experience.\n\nB2B commerce relations are usually complex and often require a customized service. Therefore, grouping different users from the same company under an organization, and defining custom payment methods, product selections, and prices for each customer are common tasks in this scenario.\n\nThe **B2B Organizations** app enables you to group B2B users into organizations. You can assign specific payment methods, price tables, and product collections to each organization, allowing all of the organization\u0019s users to share the same commercial conditions. Each organization is further segmented into one or more cost centers, with its own shipping addresses.\n\n## Before you start\n\nFirst, make sure you have the [VTEX IO CLI (Command Line Interface)](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-install) installed in your machine.\n\nNote that installing B2B Organizations will also result in [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions) being installed as a dependency app \u0013 it allows you to grant specific storefront roles for B2B users in an organization. This is especially useful for organizations with multiple users who have different responsibilities, such as placing orders, approving orders or managing the organization users. See the [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions) app documentation for information on the available roles and how to customize their permissions.\n\nIf you want to be able to manage roles and permissions on the VTEX Admin, you must install [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions-ui) as well.\n\n## Installation\n\nYou can install the **B2B Organizations** app by running `vtex install vtex.b2b-organizations` in your terminal, using the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).\n\n## User widget configuration\n\nTo enable the [user widget](#user-widget) in your storefront, this app provides a `b2b-user-widget` block that you can add to the account's store theme. We recommend that you add it to the store header, as shown below.\n\n\n\nFollow the instructions below to display the user widget.\n\n1. Open your store theme app\u0019s repository in your local files.\n2. In the `manifest.json` file, under `dependencies`, add `\"vtex.b2b-organizations\": \"1.x\"`, like so: \n`1 \n\"dependencies\": { \n2 \n \"vtex.b2b-organizations\": \"1.x\" \n3 \n }, \n`\n3. Within your store theme's `store` \\> `blocks` \\> `header` folder, edit the `header.jsonc` file, placing the `b2b-user-widget` block in the desired location, as exemplified below. \nWe recommend placing it on the top row of the store header. The `b2b-user-widget` block accepts no props. \n`1 \n\"header-layout.desktop\": { \n2 \n \"children\": [ \n3 \n \"flex-layout.row#0-desktop\", \n4 \n \"flex-layout.row#1-desktop\", \n5 \n \"flex-layout.row#2-desktop\", \n6 \n \"flex-layout.row#3-desktop\", \n7 \n \"sticky-layout#4-desktop\" \n8 \n ] \n9 \n }, \n10 \n \n11 \n \"flex-layout.row#0-desktop\": { \n12 \n \"children\": [\"b2b-user-widget\"], \n13 \n \"props\": { \n14 \n \"fullWidth\": true \n15 \n } \n16 \n }, \n`\n4. Publish and install the modified store theme. You can follow our documentation on [Making your theme content public](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-making-your-theme-content-public) to do so.\n\n## Seller Wrapper configuration\n\nTo complete the Seller experience, follow the instructions:\n\n1. Check if the `\"vtex.b2b-organizations\": \"1.x\"` is a dependency on `manifest.json` file\n2. Within your store theme's `store` \\> `blocks` \\> `product` \\> `box.jsonc` and `store` \\> `blocks` \\> `product.jsonc` you must wrap the target content to the block `b2b-seller-wrapper`.\n\n_**box.jsonc**_\n\n`1\n\n \"flex-layout.row#box\": { \n\n2\n\n \"children\": [\"flex-layout.col#box\"], \n\n3\n\n \"props\": { \n\n4\n\n \"blockClass\": [\"b2b-seller-wrapper#product\"], \n\n5\n\n } \n\n6\n\n }, \n\n7\n\n \"b2b-seller-wrapper#product\": { \n\n8\n\n \"children\": [\"flex-layout.col#box\"] \n\n9\n\n }, \n\n`\n\n_**product.jsonc**_\n\n`1\n\n \"flex-layout.row#product\": { \n\n2\n\n \"children\": [\"b2b-seller-wrapper#pdp\"] \n\n3\n\n }, \n\n4\n\n \"b2b-seller-wrapper#pdp\": { \n\n5\n\n \"children\": [\"flex-layout.col#product\"] \n\n6\n\n }, \n\n`\n\n1. Publish and install the modified store theme. You can follow our documentation on [Making your theme content public](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-making-your-theme-content-public) to do so.\n\n## Configuration\n\nif we have only one associated organization:\n\n\n\nif we have more than one associated organization:\n\n\n\n### `b2b-user-widget`\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | ------------- |\n| showDropdown | Boolean | controls whether we are viewing the dropdown if we have more than one organization associated with the same email. | true |\n| showLoadingIndicator | Boolean | controls whether a loading indicator will be displayed while widget data is loading. | false |\n\n## Customization\n\nIn order to apply CSS customizations in this and other apps, follow the instructions 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\nCSS handles are available for the **Organization Request Form** component and the **User Widget** component.\n\n| **CSS Handles** |\n| ------------------------------- |\n| newOrganizationContainer |\n| newOrganizationInput |\n| newOrganizationAddressForm |\n| newOrganizationButtonsContainer |\n| newOrganizationButtonSubmit |\n| userWidgetContainer |\n| userWidgetLoading |\n| userWidgetRow |\n| userWidgetItem |\n| userWidgetButton |\n| userWidgetImpersonationItem |\n| userWidgetImpersonationButton |\n| userWidgetImpersonationError |\n\n## How the app works\n\nThe **B2B Organizations** app adds the following functionalities and components to your VTEX store, divided into VTEX Admin, Master Data v2, and Storefront capabilities:\n\n| Public | Availability | Location | Feature |\n| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------- | ---------------------------------------------------------------------------------------------------------------- |\n| B2B store administrator | [VTEX Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-organizations%23vtex-admin) | Organization Requests page | Review Organization Requests |\n| Organizations page | Manage Organizations | | |\n| Organization Details page | Manage Cost Centers associated with organizations | | |\n| Manage Collections associated with organizations | | | |\n| Manage Payment Terms associated with organizations | | | |\n| Manage Price Tables associated with organizations | | | |\n| Manage organization Users | | | |\n| Message Center Templates page | Manage email templates related to the B2B Organizations app | | |\n| B2B store administrator or developers | [Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-organizations%23master-data-v2) | Master Data API v2 | Retrieve and edit information on organization requests, organizations, and cost centers stored in Master Data v2 |\n| B2B customer (organization user) with required permissions | [Storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-organizations%23storefront) | Storefront form | Request New Organization |\n| My Organization | Manage Organization | | |\n| Manage Cost Centers | | | |\n| Manage Users | | | |\n| Impersonate Users | | | |\n| Storefront navigation | User Widget | | |\n\n> This app can also be used together with [B2B Quotes](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-orderquote), allowing order quotes to be managed at the organization level. Please read our B2B Quotes documentation for more details.\n\n### VTEX Admin\n\nAfter installing and setting up the **B2B Organizations** app, its VTEX Admin capabilities can be found by accessing **Account Settings > B2B Organizations & Cost Centers**.\n\n#### Organization Requests\n\nTo request the creation of an organization, B2B customers can use the page available at `/organization-request`. This page allows customers to request an organization creation and its cost center. Add `/organization-request` to your store’s domain to access it.\n\nOnce this step is done by the customer, B2B store administrators may review the organization request by going to **VTEX Admin** \\> **Account Settings** \\> **B2B Organizations & Cost Centers** \\> **Organization Requests** (or at `/admin/b2b-organizations/requests`).\n\nIn this page, they can view a list of all the organization requests placed in their store.\n\n\n\nEach organization can have a status of **pending**, **approved** or **declined**. Pending requests are the ones that still need review.\n\nTo review a request, you must:\n\n1. Click on a request from the table \u0013 or click on  \\> `View`.\n2. Write a comment on the **Add note** field, if necessary.\n3. Click on `Approve` or `Decline`.\n\n\n\nUpon approval, the request status will change to **Approved** and the organization will be created. The [Organization Admin and the Sales Admins](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions%23available-storefront-roles) will be notified about this via email. You can learn more about this notification in the [Email templates](#email-templates) section. In addition, the user designated as the Organization Admin will be granted access to the [My Organization](#my-organization) tab on the **My Account** page of your storefront.\n\nIf the organization request is declined, the request status will be changed to **Declined** and the organization will not be created. The user designated as the Organization Admin is notified via email of this result. Read more about this notification in the [Email templates](#email-templates) section.\n\n#### Organizations\n\nThe **Organizations** page includes a list of all the organizations created in your store and their respective status, and also allows store administrators to:\n\n* [Add organizations](#add-organization).\n* Access the [Organization details](#organization-details) page, which includes organization data, cost centers, collections, payment terms, price tables and users.\n\nTo access the page, go to **Account Settings** \\> **B2B Organizations & Cost Centers** \\> **Organizations** in the VTEX Admin (or at `/admin/b2b-organizations/organizations`).\n\n\n\nYou can click `Refetch` to refresh the organizations list on this page, fetching information about recently created organizations.\n\nIt is possible to use the search bar to find an organization by name or filter the organizations by status.\n\nEach organization can have one of the following statuses:\n\n* **Active**: the organization has been approved by the store administrators and it is currently active.\n* **On hold**: the organization is currently paused, which means its users are not allowed to complete purchases at the moment.\n* **Inactive**: the organization has been deactivated by the store administrators, so its users will not be able to login.\n\n##### Add organization\n\nYou can manually create a new organization on the **Organizations** page. Follow these steps to do so:\n\n1. Click on the `New` button.\n2. Fill in the required information about the new organization, as illustrated in the image below. \n * **Name of organization:** name of the organization you want to create. \n * **Name of cost center:** name of the initial cost center associated with the organization. \n * **Country:** country where the cost center is located. \n * **ZIP:** postal code of the cost center address. \n * **Address Line 1:** primary address information, including street number and street name where the cost center is located. \n * **Address Line 2:** optional field for additional address information. \n * **City:** city where the cost center is located. This is filled in automatically based on the ZIP code informed. \n * **State:** state where the cost center is located. This is filled in automatically based on the ZIP code informed. \n * **Receiver:** name of the person that will receive orders in the informed address.\n3. Click on `Add`.\n\n\n\n> Additional cost centers and addresses may be added after creating the organization, as explained in the next section of this documentation.\n\n#### Organization Details\n\nIn the **Organizations Details** page, you can see and edit the information of an existing organization:\n\n* [Organization Name and Status](#organization-name-and-status)\n* [Cost Centers](#cost-centers)\n* [Collections](#collections)\n* [Payment Terms](#payment-terms)\n* [Price Tables](#price-tables)\n* [Users ](#users)\n\nYou can access this page by going to **Account Settings** \\> **B2B Organizations & Cost Centers** \\> **Organizations** in the VTEX Admin and clicking on the organization whose details you want to view, or on  \\> `View`.\n\n> Note that assigning collections, payment terms, and price tables to an organization is optional. If these are not assigned, users of the organization will see the store\u0019s default catalog, have access to all payment methods, and see the store's default pricing.\n\n##### Organization Name and Status\n\nIn the top section of the page, you can view the following information:\n\n* **Organization Name:** name of the organization. This information can be edited.\n* **Status:** status of the organization. You can set it to **Active**, **On Hold** or **Inactive** by selecting from a list.\n* **Created:** date when the organization was created.\n\n\n\n##### Cost Centers\n\nIn the **Cost Centers** section, you can view all the cost centers associated with the organization. VTEX Admin users can view and manage cost centers for any organization.\n\n\n\n> Each organization must have at least one cost center.\n\nBy default, each cost center will allow all of the [payment terms](#payment-terms) that have been assigned to the parent organization. However, **Organization Admin** users have the ability to enable or disable individual payment terms at the cost center level \u0013 see [Manage Cost Centers](#manage-cost-centers) for more information on this.\n\nTo create a new cost center, follow the steps below.\n\n1. Click on the `New` button.\n2. Fill in the required information about the new cost center, as illustrated in the image below. \n * **Name:** name of the cost center. \n * **Country:** country where the cost center is located. \n * **ZIP:** postal code of the cost center address. \n * **Address Line 1:** primary address information, including street number and street name where the cost center is located. \n * **Address Line 2:** optional field for additional address information. \n * **City:** city where the cost center is located. This is filled in automatically based on the ZIP code informed. \n * **State:** state where the cost center is located. This is filled in automatically based on the ZIP code informed. \n * **Receiver:** name of the person that will receive orders in the informed address.\n3. Click on `Add`.\n\n\n\n##### Cost Center Details\n\nYou can view or edit the details of an existing cost center by clicking on it in the **Organization Details** page.\n\nThis will lead you to the **Cost Center Details** page, where you can:\n\n* View or edit the cost center\u0019s **Name** and **Addresses**.\n* View or edit the cost center's **Business Document**.\n* Add a new shipping address associated with the cost center.\n* Delete the cost center\n\n\n\nThe optional **Business Document** field may be used to store a Tax ID, VAT ID, CNPJ, or similar business identifier. If a Business Document is present in a user's cost center, it will be applied as the `corporateDocument` in the user's profile and therefore attached to any orders placed by the user.\n\n> The shipping addresses assigned to a cost center will be available to that cost center's users at checkout if you install [B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-checkout-settings). No other addresses will be available. Therefore, each cost center must have at least one shipping address.\n\nTo edit or delete an existing address, click  next to it and select **Edit** or **Delete**.\n\nIf you would like to add a new shipping address related to that cost center, follow these instructions:\n\n1. Click on `Add new address`.\n2. Fill in the required information about the new address. \n * **Country:** country where the cost center is located. \n * **ZIP:** postal code of the cost center address. \n * **Address Line 1:** primary address information, including street number and street name where the cost center is located. \n * **Address Line 2:** optional field for additional address information. \n * **City:** city where the cost center is located. This is filled in automatically based on the ZIP code informed. \n * **State:** state where the cost center is located. This is filled in automatically based on the ZIP code informed. \n * **Receiver:** name of the person that will receive orders in the informed address.\n3. Click on `Add`.\n\nMake sure to click `Save` in the top right of the **Cost Center Details** page after any changes.\n\nIf you want to delete the cost center, click on `Delete` instead.\n\n##### Collections\n\n> You must use the **Collections Beta** solution to be able to associate collections to organizations using **B2B Organizations**. Read our article on [Creating Collections Beta](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/creating-collections-beta--yJBHqNMViOAnnnq4fyOye) for more information.\n\nThis section allows you to manage the [product collections](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/creating-collections-beta--yJBHqNMViOAnnnq4fyOye) assigned to the organization. Your selections define the assortment of products the organization users will see in the storefront.\n\nTo add a collection, select the collection you want to add from the **Available** list and click `Add to org`.\n\nTo remove a collection, select the collection you want to remove from the **Assigned to organization** list and click `Remove from org`.\n\n\n\n##### Payment Terms\n\nIn this section, you can choose which [payment conditions](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-configure-payment-conditions--tutorials%5F455?%26utm%5Fsource=autocomplete) are assigned to the organization. Your selections determine which payment options are available to organization users during checkout.\n\nNote that the available payment options can be further customized per cost center by the **Organization Admin**. Check the [Manage Cost Centers](#manage-cost-centers) section for more information on this.\n\nTo add a payment term, select the option you want to add from the **Available** list and click `Add to org`.\n\nTo remove a payment term, select the option you want to remove from the **Assigned to organization** list and click `Remove from org`.\n\n\n\n> To customize the checkout according to each organization user\u0019s role, you need to install and configure [B2B Checkout Settings](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/b2b-checkout-settings).\n\n##### Price Tables\n\nThis section allows you to choose which [price tables](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-price-tables--58YmY2Iwggyw4WeSCGg24S) are assigned to the organization. The price tables you select determine the prices the organization users will see in the storefront.\n\nPrice tables associated with an organization override the base price only when fulfillment is performed by the main account. When franchises perform the fulfillment, the price table is not applied, resulting in incorrect price displays. To ensure correct operation, configure both the logistics and the price tables directly in the main account, avoiding the use of franchises that inherit price settings.\n\nTo add a price table, select the option you want to add from the **Available** list and click `Add to org`.\n\nTo remove a price table, select the option you want to remove from the **Assigned to organization** list and click `Remove from org`.\n\n\n\n##### Users\n\nThis section presents a list of users associated with the organization, showing their **emails**, their **roles** within the organization, and the **cost center** to which they are associated. It is worth noting that the same email can be associated with up to 949 different organizations or cost centers.\n\n\n\nTo add a new user to the organization, follow these steps:\n\n1. In the **Users** list, click on the `New` button.\n2. Fill in the user\u0019s information, as illustrated below. \n * **Name:** full name of the user. \n * **Email:** email of the user. \n * **Cost Center:** cost center the user will be associated with. \n * **Role:** role the user will have in the storefront. See more details on the available roles in the [Storefront Permissions documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions%23available-storefront-roles).\n3. Click on `Add`.\n\n\n\nOnce you add a new user to the organization, if a customer account did not already exist in your store for the provided email address, it will be created.\n\nTo edit or remove an existing user, follow these steps:\n\n1. Click on the user you want to edit or delete in the **Users** list.\n2. Edit the desired information. \nYou can change the user\u0019s **Cost Center** and their **Role**. \nIf you want to remove the user from the organization, click `Remove user` instead and skip the next step.\n3. To apply your changes, click `Save`.\n\n\n\nIf a user is removed from an organization, their account will continue to exist in the store, but they will no longer be assigned to an organization, a cost center, and a B2B role. Thus, they will no longer have access to details of their organization in the **My Organization** page. Instead, they will have the ability to [request the creation of a new organization](#request-new-organization), if necessary.\n\n> As an optional feature, you can install the [Admin Customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.admin-customers) app for additional customer management capabilities on the VTEX Admin.\n\n#### Email templates\n\nThe **B2B Organizations** app provides a set of four email templates to be sent to B2B organization users, triggered automatically based on specific changes:\n\n| **Template name** | **Recipient** | **Trigger** |\n| ------------------------------- | -------------------------------------- | ------------------------------------------- |\n| **Organization Approved** | User with the Organization Admin role | The organization request has been approved. |\n| **Organization Created** | Users with a Sales Admin role | The organization has been created. |\n| **Organization Declined** | User with the Organization Admin role | The organization request has been declined. |\n| **Organization Status Changed** | Users with the Organization Admin role | The organization status has changed. |\n\nIf you want to view or edit any of these templates, follow the steps below.\n\n1. In the VTEX Admin, go to **Customer > Message center > Templates**.\n2. In the search bar, type `organization`.\n3. Click on the template you want to view or edit.\n4. Make the desired changes in the template. You can learn more about editing **Message Center** templates by reading our documentation on [How to create and edit transactional email templates](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/transactional-emails--6IkJwttMw5T84mlY9RifRP/335JZKUYgvYlGOJgvJYxRO).\n5. Click on `Save`.\n\n\n\n### Master Data v2\n\nThe **B2B Organizations** app stores information about organization requests, organizations, and cost centers in [Master Data v2](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/master-data-v2--3JJ1mlzuo88w22gO0gy0QS).\n\nThis means that it is possible for store administrators or developers to fetch this information using the [Master Data API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/master-data-api-v2-overview), by using their **data entity name** as the value for the `data_entity_name` parameter.\n\nYou can see the data entity names in the table below.\n\n| **Data entity names** |\n| ---------------------- |\n| organization\\_requests |\n| organizations |\n| cost\\_centers |\n\n### Storefront\n\nStorefront capabilities, in turn, are accessible to B2B customers who visit a supplier\u0019s store, provided that they are logged in and have the required permissions.\n\nThe following sections describe what your customer can do in your storefront, after you've finished setting up the B2B Organizations app.\n\n#### Request New Organization\n\nA B2B user who is not already part of an organization can request the creation of a new buyer organization in your store by filling in the **Request New Organization** form. They can follow the steps below to do so.\n\n1. Access the store website.\n2. Click on **My Account** \\> **My Organization**.\n3. Provide the required information, as shown in the image below. \n * **Organization Name:** name of the organization. \n * **User to become Organization Admin:** section where you must provide information about the first user of the organization, who will be assigned as the Organization Admin. \n * **First Name:** first name of the Organization Admin user. \n * **Last Name:** last name of the Organization Admin user. \n * **Email Address:** email address of the Organization Admin user. \n * **Default Cost Center:** section where you must provide information about the first cost center associated with the organization. \n * **Cost Center Name:** name of the cost center. \n * **Business Document:** optional field for a business document such as a Tax ID, CNPJ, etc. \n * **Country:** country where the cost center is located. \n * **ZIP:** postal code of the cost center address. \n * **Address Line 1:** primary address information, including street number and street name where the cost center is located. \n * **Address Line 2:** optional field for additional address information. \n * **City:** city where the cost center is located. This is filled in automatically based on the ZIP code informed. \n * **State:** state where the cost center is located. This is filled in automatically based on the ZIP code informed. \n * **Receiver:** name of the person that will receive orders in the informed address.\n4. Click `Submit`.\n\n\n\nAfter submitting the form, the request will be sent to a queue for review by the B2B store administrator \u0013 for more details on this, refer to the [Organization Requests](#organization-requests) section.\n\nThe user designated as the **Organization Admin** for the new organization will receive an email notification when the request has either been approved or declined by the store administrator. You can learn more about this notification in the [Email templates](#email-templates) section.\n\n#### My Organization\n\nUsers who are designated as the **Organization Admin** or **Sales Admin** can manage the details of their organization in the storefront, on the **My Organization** page.\n\nUsers with the **Organization Buyer** or **Organization Approver** roles can also view a read-only version of this page.\n\nTo access **My Organization**, follow the instructions below.\n\n1. Access the storefront and log in.\n2. Click `Hello, {name}`.\n3. Click on **My Account**.\n4. Go to **My Organization** on the sidebar. You will see the page below.\n\n\n\nOn this page, the user with the **Organization Admin** or **Sales Admin** roles may do the following:\n\n* [Manage Cost Centers](#manage-cost-centers)\n* [Manage Users](#manage-users)\n\n##### Manage Cost Centers\n\n**Organization Admin** or **Sales Admin** storefront users can find the cost centers associated with their organization in the **Cost Centers** section of the **My Organization** page.\n\nTo add a new cost center, they should go to **My Account > My Organization**, where they have access to the same options described in [Cost Centers](#cost-centers). It is possible to view or edit the details of an existing cost center by clicking on it, the same way as described in [Cost Center Details](#cost-center-details).\n\n**Organization Admins** may also view and/or edit the **Business Document** assigned to each cost center, as described in [Cost Center Details](#cost-center-details).\n\nIn addition, **Organization Admins** can enable specific payment terms for a cost center, by using the toggle button to activate or deactivate the payment terms assigned to the organization, as shown below.\n\n> This section will only be available on the **My Organization** page if [payment terms](#payment-terms) have previously been assigned to the organization by the VTEX Admin users.\n\n\n\n##### Manage Users\n\n**Organization Admin** or **Sales Admin** storefront users can also see and manage the users of their organization in the **Users** section in **My Organization**. To do this, they should go to **My Account > My Organization**, where they have access to the same options described in the [Users](#users) section of this documentation.\n\nUsers with the **Organization Admin** role may add, edit, or remove users with any of the following roles: **Organization Admin**, **Organization Approver**, and **Organization Buyer**.\n\nUsers with the **Sales Admin** role may add, edit, or remove users with any of the following roles: **Sales Admin**, **Sales Manager**, and **Sales Representative**.\n\n###### Impersonate Users\n\nIn telesales, assisted sales, or customer support scenarios where the B2B customer needs help from a salesperson to navigate the store or place orders, it is common to make use of impersonation.\n\nIn the **B2B Organizations** app, only users with **Sales** roles or the **Organization Admin** role may impersonate another user.\n\nThis action will temporarily apply the impersonated user's email, organization, and cost center to their storefront session. It allows the impersonating users to do the following:\n\n* Browse the store and see the prices, products, shipping addresses and payment methods that would be seen by the impersonated user.\n* Take actions on behalf of the impersonated user, such as placing orders.\n* Use their regular permissions.\n\nTo use impersonation, users with **Sales** roles or the **Organization Admin** role must follow the steps below.\n\n1. In the **Users** section of [My Organization](#my-organization), click on  in the row of the user they want to impersonate.\n2. Click on **Impersonate User**.\n\n\n\n#### User widget\n\nTo give storefront users visibility into their currently assigned organization, cost center, and role, this app provides a user widget which can be added to the account's store theme:\n\n\n\n> To display the user widget, it is necessary to follow the instructions in the [User widget configuration](#user-widget-configuration) section.\n\nIf users click `Manage organization`, they can access the **My Organization** page directly.\n\nIn case impersonation is currently active, this block will also show the email of the user being impersonated, as well as a `Stop impersonation` button:\n\n\n\n#### Seller Wrapper Block\n\n> 10 This topic is related to the Seller functionality.\n\nTo persist the Organization seller throughout the PDP and shelves, it must have the \"seller-wrapper\" block in the store theme configuration.\n\nPlease check [Seller wrapper configuration](#seller-wrapper)\n\n[Storefront Permissions UI« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.storefront-permissions-ui)[B2B Checkout SettingsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-checkout-settings)\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[Before you start](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-organizations%23before-you-start)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-organizations%23installation)\n\n[User widget configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-organizations%23user-widget-configuration)\n\n[Seller Wrapper configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-organizations%23seller-wrapper-configuration)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-organizations%23configuration)\n\n[b2b-user-widget](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-organizations%23b2b-user-widget)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-organizations%23customization)\n\n[How the app works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-organizations%23how-the-app-works)\n\n[VTEX Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-organizations%23vtex-admin)[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-organizations%23master-data-v2)[Storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations/docs/apps/vtex.b2b-organizations%23storefront)\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_2117c4d0
|
[
{
"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 developing a graphql api in service 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/developing-a-graphql-api-in-service-apps/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-apps/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-apps/docs/guides/graphql-ide)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-apps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-apps/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-apps/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-apps/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-apps/docs/guides/graphql-ide)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-apps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-apps/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-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/developing-a-graphql-api-in-service-apps/docs/app-development)\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/graphql-in-vtex-io)\n\n[Developing a GraphQL API in service apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps)\n\nDeveloping a GraphQL API in service apps\n\nLearn how to create a GraphQL API with Node-based VTEX IO service apps.\n\nWhen developing a [service app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service), you may need to expose an API so that other systems, such as other VTEX IO apps or external integrations, can interact with it. There are two options for developing APIs: [REST](https://read.calvincode.net/reader?url=https://restfulapi.net/) and [GraphQL](https://read.calvincode.net/reader?url=https://graphql.org/). REST is commonly used for interacting with other services and external integrations, while GraphQL is usually recommended for interactions with frontend apps and systems.\n\nThis guide will show you how to create an API using GraphQL and VTEX IO.\n\n> For details about REST API development, see [Developing services in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io).\n\n## Before you begin\n\nMake sure to check 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* Knowledge of GraphQL and related 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## App behavior\n\nThe basic behavior of a service app with a GraphQL API works as follows:\n\n1. A requester (store user, another app, external service, etc.) makes a GraphQL request to an app instantiated in a VTEX store.\n2. Upon receiving the request, the app executes it through a resolver function.\n3. The resolver uses a [VTEX client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients) to call the desired resource ([VTEX API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis), another app, external service, etc.).\n4. The app receives the response from the resource and continues executing the resolver.\n5. The resolver generates the response body of the request based on the received data.\n6. The app returns the GraphQL request to the requester with the response body.\n\nRequesterAppResourceGraphQL requestClient requestResponseResponseRequesterAppResource\n\n## Implementation\n\nThe next sections explain how to implement a GraphQL API in a service app. This example shows how to display mocked data about live users accessing product pages. The implementation includes creating the GraphQL schema, a [custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-how-to-create-and-use-clients), and a resolver function.\n\n### 1\\. Start with a template\n\nWe recommend downloading a VTEX IO app template to your computer if you are developing an app from scratch. There are two main options for app templates in this case:\n\n* [graphql-example](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/graphql-example): Service template with basic implementation of GraphQL and Node.\n* [service-example](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/service-example): Service template with basic implementation of Node, without GraphQL.\n\nThe next steps of this guide will use the service-example template to demonstrate how to implement a GraphQL API from scratch.\n\nYou can 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\\. Add the GraphQL builder\n\nOpen the `manifest.json` file in your app's root and add the [GraphQL builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-graphql-builder). The builder interprets the GraphQL schema defined in your TypeScript code in the `node` folder.\n\n> Your app may already have the GraphQL builder configured. If that's the case, you only need to check if it uses the latest builder version (1.x).\n\n`1\n\n\"builders\": { \n\n2\n\n \"node\": \"7.x\", \n\n3\n\n \"graphql\": \"1.x\" \n\n4\n\n} \n\n`\n\n### 3\\. Define the GraphQL schema\n\nIn the `graphql` folder, add the `.graphql` files to define the GraphQL schema. You can add the entire schema in a single file or use multiple files, including subfolders. To better organize your project, we recommend using the following structure:\n\n* Add your endpoints (queries, mutations, or subscriptions) in the `schema.graphql` file.\n* Add the directives in the `directives.graphql` file.\n* Create a `types` subfolder and add one `.graphql` file for each type to be defined in the schema.\n\n`1\n\ngraphql \n\n2\n\n┣ 📂 types \n\n3\n\n ┣ 📄 a_type.graphql \n\n4\n\n ┗ 📄 b_type.graphql \n\n5\n\n┣ 📄 directives.graphql \n\n6\n\n┗ 📄 schema.graphql \n\n`\n\n#### Type example\n\ngraphql/types/ProductView.graphql\n\n`1\n\ntype ProductView { \n\n2\n\n slug: String \n\n3\n\n liveUsers: Int \n\n4\n\n} \n\n`\n\n#### Query schema example\n\ngraphql/schema.graphql\n\n`1\n\ntype Query { \n\n2\n\n getSku(topN: Int): String \n\n3\n\n} \n\n`\n\n> GraphQL has many more functionalities you can add to the schema, such as mutations, subscriptions, and directives. See the [official GraphQL documentation](https://read.calvincode.net/reader?url=https://graphql.org/learn/) for details.\n\n### 4\\. Declare the list of clients\n\nYour app will likely access an external resource such as [VTEX APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis), an endpoint from another app, or a service external to VTEX. Within VTEX services, these interactions are handled through [clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients).\n\nInstead of calling endpoints directly in your resolver functions, you should define and use clients to encapsulate your HTTP logic and keep your resolvers clean and focused.\n\n#### Using VTEX native clients\n\nVTEX provides built-in clients for commonly used services, such as Catalog, OMS, and Checkout.\n\nHere's an example of how to add the Catalog client to your app:\n\n1. Open the terminal.\n2. Install the `@vtex/clients` package in the `node` folder of your app: \n`1 \ncd node \n2 \nyarn add @vtex/clients \n`\n3. Open `node/clients/index.ts` and extend the `IOClients` class to register the `catalog` client: \nnode/clients/index.ts \n`1 \nimport { IOClients } from '@vtex/api' \n2 \nimport { Catalog } from '@vtex/clients' \n3 \n \n4 \n// Extend the default IOClients implementation with our own custom clients. \n5 \nexport class Clients extends IOClients { \n6 \n public get catalog() { \n7 \n return this.getOrSet('catalog', Catalog) \n8 \n } \n9 \n} \n`\n\nThis setup allows you to access the `catalog` client in your resolvers through the app's context.\n\n#### Using external resources\n\nTo access routes and resources not available through the native clients, you need to [develop your custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-how-to-create-and-use-clients). Similar to native clients, you must register each custom client in the `Clients` class located in `node/clients/index.ts` so it can be accessed across your app.\n\n### 5\\. Define the resolvers\n\nResolvers are the functions that are executed when a GraphQL endpoint is called. A resolver function must have the same name as its corresponding endpoint. Follow the steps below to define your resolvers:\n\n1. In the `node` folder, create another folder called `resolvers`.\n2. In the new folder, add the TypeScript files that will contain resolver code. We recommend creating a `.ts` file for each resolver.\n3. In the created files, add the resolver code. The following example shows a resolver that you can use as a reference:\n\nnode/resolvers/products.ts\n\n`1\n\nexport const getSku = async ( \n\n2\n\n _: any, \n\n3\n\n { code }: { code: number }, \n\n4\n\n { clients: { catalog } }: Context \n\n5\n\n) => \n\n6\n\n catalog \n\n7\n\n .getSkuById(code.toString()) \n\n8\n\n .then((data) => data.Name) \n\n`\n\n### 6\\. Instantiate the resolvers\n\nAfter defining your resolver functions, add them to the `Service` class of the `node/index.ts` file. You should add a `graphql` field that contains the resolvers for each implemented endpoint.\n\nnode/index.ts\n\n`1\n\nimport type { ClientsConfig, ServiceContext, RecorderState } from '@vtex/api' \n\n2\n\nimport { LRUCache, method, Service } from '@vtex/api' \n\n3\n\nimport { productList } from './resolvers/products' \n\n4\n\n \n5\n\n... \n\n6\n\n \n7\n\nexport default new Service({ \n\n8\n\n clients, \n\n9\n\n graphql:{ \n\n10\n\n resolvers: { \n\n11\n\n Query: { \n\n12\n\n getSku, \n\n13\n\n }, \n\n14\n\n }, \n\n15\n\n }, \n\n16\n\n}) \n\n`\n\n### 7\\. Add the policies\n\nIf your app accesses external endpoints and resources, add the required policies to your `manifest.json`:\n\nmanifest.json\n\n`1\n\n\"policies\": [ \n\n2\n\n { \n\n3\n\n \"name\": \"outbound-access\", \n\n4\n\n \"attrs\": { \n\n5\n\n \"host\": \"portal.vtexcommercestable.com.br\", \n\n6\n\n \"path\": \"/api/catalog/*\" \n\n7\n\n } \n\n8\n\n } \n\n9\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 so it can 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`1\n\nvtex link \n\n`\n\n### 9\\. Test your endpoints\n\nWith your app running, you can test the implemented endpoints by making requests. One way to do this is using the VTEX [GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide) in the Admin panel:\n\n1. Install the GraphQL IDE app by running `vtex install vtex.admin-graphql-ide` in your terminal.\n2. Open the VTEX Admin in the workspace to which your app was linked. In your browser, go to `https://{workspace}--{account}.myvtex.com/admin`.\n3. Go to **Store Settings** \\> **Storefront** and click **GraphQL IDE**.\n4. Select the linked VTEX IO app.\n5. Write the query to test your endpoint. Here is an example: \n`1 \n{ \n2 \n getSku(code: 1) \n3 \n} \n`\n6. Run the query by clicking the `Play` ▶️ button in the top-left corner. You should see the result of your query on the right side of the window. Here is an example: \n`1 \n{ \n2 \n \"data\": { \n3 \n \"getSku\": \"50 ml\" \n4 \n } \n5 \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/developing-a-graphql-api-in-service-apps.mdx)\n\n[List of GraphQL APIs« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps//docs/guides/vtex-io-graphql-api-list)[GraphQL authorization in IO appsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps//docs/guides/graphql-authorization-in-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/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%23before-you-begin)\n\n[App behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%23app-behavior)\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%23implementation)\n\n[1\\. Start with a template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%231-start-with-a-template)[2\\. Add the GraphQL builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%232-add-the-graphql-builder)[3\\. Define the GraphQL schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%233-define-the-graphql-schema)[4\\. Declare the list of clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%234-declare-the-list-of-clients)[5\\. Define the resolvers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%235-define-the-resolvers)[6\\. Instantiate the resolvers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%236-instantiate-the-resolvers)[7\\. Add the policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%237-add-the-policies)[8\\. Link your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%238-link-your-app)[9\\. Test your endpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%239-test-your-endpoints)\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/developing-a-graphql-api-in-service-apps.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/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%23before-you-begin)\n\n[App behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%23app-behavior)\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%23implementation)\n\n[1\\. Start with a template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%231-start-with-a-template)[2\\. Add the GraphQL builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%232-add-the-graphql-builder)[3\\. Define the GraphQL schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%233-define-the-graphql-schema)[4\\. Declare the list of clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%234-declare-the-list-of-clients)[5\\. Define the resolvers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%235-define-the-resolvers)[6\\. Instantiate the resolvers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%236-instantiate-the-resolvers)[7\\. Add the policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%237-add-the-policies)[8\\. Link your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%238-link-your-app)[9\\. Test your endpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-a-graphql-api-in-service-apps/docs/guides/developing-a-graphql-api-in-service-apps%239-test-your-endpoints)\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_319912b1
|
[
{
"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 using the markers prop to customize a blocks message 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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/store-framework-styling)\n\n[Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization)\n\n[Contributing with new CSS Handles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/vtex-io-documentation-contributing-with-new-css-handles)\n\n[Customizing your store's icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/vtex-io-documentation-customizing-your-stores-icons)\n\n[Customizing your store’s typography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/vtex-io-documentation-customizing-your-stores-typography)\n\n[Interactively inspecting storefront blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store)\n\n[Using the Markers prop to customize a block's message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/store-framework-styling)\n\n[Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization)\n\n[Contributing with new CSS Handles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/vtex-io-documentation-contributing-with-new-css-handles)\n\n[Customizing your store's icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/vtex-io-documentation-customizing-your-stores-icons)\n\n[Customizing your store’s typography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/vtex-io-documentation-customizing-your-stores-typography)\n\n[Interactively inspecting storefront blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store)\n\n[Using the Markers prop to customize a block's message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/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-using-the-markers-prop-to-customize-a-blocks-message/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/store-framework)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/store-framework-styling)\n\n[Using the Markers prop to customize a block's message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message)\n\nUsing the Markers prop to customize a block's message\n\nWhen styling storefront components, CSS Handles and Block Classes are helpful for general styles. However, to customize specific text messages within blocks, you can use the `markers` prop. This prop lets you add unique identifiers to parts of a block’s message, making it easier to apply targeted styles.\n\nFollow the steps below to use the `markers` prop for customizing block messages.\n\n## Before you begin\n\nCheck if the block you want to customize supports the `markers` prop. This information can usually be found in the block’s documentation.\n\n## Instructions\n\n1. Open the terminal and 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/) to log in to your VTEX account.\n2. Change to a [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/).\n3. Open your Store Theme using your preferred code editor and locate the block where you want to use the `markers` prop.\n4. In the block's configuration, add the `markers` prop with a unique value (e.g., `discount`). For example: \n`1 \n\"product-price-savings#summary\": { \n2 \n \"props\": { \n3 \n \"markers\": [ \n4 \n \"discount\" \n5 \n ], \n6 \n } \n7 \n}, \n`\n5. Save your changes and [link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/) the app to your workspace.\n6. Open the Admin of your workspace at (`{workspaceName}--{accountName}.myvtex.com/admin`).\n7. Go to the Site Editor and select the block to which you addeed the `markers` prop.\n8. In the Site Editor, wrap the message variable you want to customize with the `markers` value. For example, to style the discount percentage in a product price block, you can wrap it with the markers tag like this: `<discount>-{savingsPercentage}</discount>`. This allows you to target and style just the portion of text inside the discount tag with CSS. \n \n> To find out which message parts you can customize, refer to the block’s documentation. It lists all message variables, like `{savingsPercentage}` in this example. You can use these variables to identify and wrap the specific text you want to style.\n9. Save the changes. This assigns a unique identifier to the wrapped text, allowing you to later customize its style with CSS.\n10. Access your site in the development workspace at `{workspaceName}--{accountName}.myvtex.com` and inspect the HTML element associated with the edited block’s message. \n \nIn this example, note the message's HTML element is wrapped in a new `span` with a unique selector: `<span class=\"vtex-product-price-1-x-savings-discount\">`.\n11. [Use CSS Handles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization) to apply your styles to the new class.\n12. Once you are satisfied with the changes to your Store Theme, [make 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/).\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/styling-your-store/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message.md)\n\n[Interactively inspecting storefront blocks« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message//docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store)[Dealing with eventsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message//docs/guides/store-framework-dealing-with-events)\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-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message%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/styling-your-store/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message.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-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message%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_ad38467e
|
[
{
"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 clicks 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/clicks/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/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/clicks/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/clicks/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/clicks/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/clicks/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/clicks/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/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/clicks/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/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/clicks/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/getting-started-with-vtex-ads-api)\n\n[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/synchronizing-the-catalog-with-vtex-ads)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/retrieving-ads)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/ads-events)\n\n[Understanding ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/understanding-ads-events)\n\n[Ads events notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/ads-events-notification)\n\n[Impressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/impressions)\n\n[Views](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/views)\n\n[Clicks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/clicks)\n\n[Conversion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/conversion)\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/clicks/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/clicks/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/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/clicks/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/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/clicks/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/getting-started-with-vtex-ads-api)\n\n[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/synchronizing-the-catalog-with-vtex-ads)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/retrieving-ads)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/ads-events)\n\n[Understanding ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/understanding-ads-events)\n\n[Ads events notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/ads-events-notification)\n\n[Impressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/impressions)\n\n[Views](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/views)\n\n[Clicks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/clicks)\n\n[Conversion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/conversion)\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/clicks/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/clicks/docs/guides)\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/getting-started-with-vtex-ads-api)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/ads-events)\n\n[Clicks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/clicks)\n\nClicks\n\nTrack ad clicks.\n\nClick tracking is essential for measuring ad performance in VTEX Ads. This guide explains how to properly send click events when users interact with your advertisements.\n\n## Click event rules\n\n* Click events should be sent immediately when a user clicks on an ad.\n* Each click is deduplicated within a 1-hour window per user, per device, per ad.\n* Click events require both `user_id` and `session_id` for proper attribution.\n* Click URLs are unique to each ad and should be obtained from the [Get ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api%23post-/v1/rma/-publisher%5Fid-) response.\n\n> 🚧 Don't construct event URLs manually. Always use the URL provided from the `POST` [Get ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api%23post-/v1/rma/-publisher%5Fid-) request.\n> \n> This is extremely important to ensure long-term stability of the integration, because the parameters of the event URL may change over time, but the integration itself does not.\n\n## Sending a click event\n\nUse the `POST` [Track ad clicks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api%23post-/v1/beacon/click/-ad%5Fid-) endpoint to send click events. Check the endpoint documentation for detailed information about all available fields.\n\nRequest example:\n\n`1\n\nPOST https://events.newtail-media.newtail.com.br/v1/beacon/click/4a94bc6e-7db1-425f-8430-cb4d17488b3b?pos=1 HTTP/1.1 \n\n2\n\naccept: application/json \n\n3\n\ncontent-type: application/json \n\n4\n\n \n5\n\n{ \n\n6\n\n \"user_id\": \"6f92d1e9-00b6-4f8b-9645-faeab321e1cc\", \n\n7\n\n \"session_id\": \"5898b8d1-c250-4bb5-931b-8b9d0ee7b499\" \n\n8\n\n} \n\n`\n\nSucessful response example:\n\n> A successful response will have HTTP code 202.\n\n`1\n\n{ \n\n2\n\n \"messages\": [ \n\n3\n\n \"click will be processed soon\" \n\n4\n\n ] \n\n5\n\n} \n\n`\n\nFailed response example:\n\n> A failed response will have HTTP code 422\\. The error message follows the [RFC 8927](https://read.calvincode.net/reader?url=https://datatracker.ietf.org/doc/rfc8927/) format.\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"instancePath\": \"\", \n\n4\n\n \"keyword\": \"required\", \n\n5\n\n \"message\": \"must have required property 'user_id'\", \n\n6\n\n \"params\": { \"missingProperty\": \"user_id\" }, \n\n7\n\n \"schemaPath\": \"#/anyOf/0/required\" \n\n8\n\n }, \n\n9\n\n { \n\n10\n\n \"instancePath\": \"\", \n\n11\n\n \"keyword\": \"required\", \n\n12\n\n \"message\": \"must have required property 'session_id'\", \n\n13\n\n \"params\": { \"missingProperty\": \"session_id\" }, \n\n14\n\n \"schemaPath\": \"#/anyOf/1/required\" \n\n15\n\n }, \n\n16\n\n { \n\n17\n\n \"instancePath\": \"\", \n\n18\n\n \"keyword\": \"anyOf\", \n\n19\n\n \"message\": \"must match a schema in anyOf\", \n\n20\n\n \"params\": {}, \n\n21\n\n \"schemaPath\": \"#/anyOf\" \n\n22\n\n } \n\n23\n\n] \n\n`\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/VTEX Ads/getting-started-with-vtex-ads-api/ads-events/clicks.md)\n\n[Views« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks//docs/guides/views)[ConversionNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks//docs/guides/conversion)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Click event rules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/clicks%23click-event-rules)\n\n[Sending a click event](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/clicks%23sending-a-click-event)\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 Ads/getting-started-with-vtex-ads-api/ads-events/clicks.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Click event rules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/clicks%23click-event-rules)\n\n[Sending a click event](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clicks/docs/guides/clicks%23sending-a-click-event)\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_7d104a22
|
[
{
"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 global tokens typography 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/global-tokens-typography/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/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/global-tokens-typography/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/global-tokens-typography/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/global-tokens-typography/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/global-tokens-typography/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/global-tokens-typography/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/global-tokens-typography/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/global-tokens-typography/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/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/global-tokens-typography/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/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/global-tokens-typography/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-overview)\n\n[Colors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-colors)\n\n[Grid and Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-grid-and-layout)\n\n[Interactive controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-interactive-controls)\n\n[Refinements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-refinements)\n\n[Spacing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-spacing)\n\n[Typography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/using-themes-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/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/global-tokens-typography/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/global-tokens-typography/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/global-tokens-typography/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/global-tokens-typography/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/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/global-tokens-typography/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/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/global-tokens-typography/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/global-tokens-typography/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/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/global-tokens-typography/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/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/global-tokens-typography/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-overview)\n\n[Colors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-colors)\n\n[Grid and Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-grid-and-layout)\n\n[Interactive controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-interactive-controls)\n\n[Refinements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-refinements)\n\n[Spacing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-spacing)\n\n[Typography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/using-themes-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/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/global-tokens-typography/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/global-tokens-typography/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/global-tokens-typography/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/global-tokens-typography/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/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/global-tokens-typography/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/styling-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-overview)\n\nTypography\n\nA standard scale and basic definitions for your text: `font family`,`weight` and `sizes`.\n\nA standard scale and basic definitions for your text: `font family`,`weight` and `sizes`.\n\n## Font Family\n\n| Global Token | Value |\n| --------------------- | --------------------------------------------------------- |\n| \\--fs-text-face-body | \\-apple-system, system-ui, BlinkMacSystemFont, sans-serif |\n| \\--fs-text-face-title | var(--fs-text-face-body) |\n\n## Weights\n\n| Global Token | Value |\n| -------------------------- | ----- |\n| \\--fs-text-weight-light | 300 |\n| \\--fs-text-weight-regular | 400 |\n| \\--fs-text-weight-medium | 500 |\n| \\--fs-text-weight-semibold | 600 |\n| \\--fs-text-weight-bold | 700 |\n| \\--fs-text-weight-black | 900 |\n\n## Typography Scale\n\nUse a type scale to add rhythm to your typography and ensure consistency throughout the project.\n\nAccess [Typescale](https://read.calvincode.net/reader?url=https://type-scale.com) and choose a scale that suits the store's branding.\n\n### Mobile Scale\n\n* 12 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n* 14 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n* 16 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n* 18 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n* 20 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n* 23 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n* 26 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n* 29 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n* 33 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n\n### Desktop Scale\n\n* 12 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n* 14 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n* 16 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n* 20 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n* 25 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n* 31 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n* 39 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n* 48 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n* 61 \nLorem ipsum dolor sit amet, consectetur adipiscing elit.\n\n| Global Token | Value |\n| ------------------------ | ---------------------------------------------------- |\n| \\--fs-text-size-base | 16px |\n| \\--fs-text-scale-desktop | 4px |\n| \\--fs-text-scale-mobile | 2px |\n| \\--fs-text-size-0 | 12px |\n| \\--fs-text-size-1 | 14px |\n| \\--fs-text-size-2 | var(--fs-text-size-base) |\n| \\--fs-text-size-3 | calc(var(--fs-text-size-2) + var(--fs-scale)) |\n| \\--fs-text-size-4 | calc(var(--fs-text-size-3) + var(--fs-scale)) |\n| \\--fs-text-size-5 | calc(var(--fs-text-size-4) + var(--fs-scale)) |\n| \\--fs-text-size-6 | calc(var(--fs-text-size-5) + var(--fs-scale)) |\n| \\--fs-text-size-7 | calc(var(--fs-text-size-6) + (var(--fs-scale) \\* 2)) |\n| \\--fs-text-size-8 | calc(var(--fs-text-size-7) + (var(--fs-scale) \\* 2)) |\n| \\--fs-text-size-9 | calc(var(--fs-text-size-8) + (var(--fs-scale) \\* 2)) |\n\n---\n\n## Semantical tokens\n\n### Sizes\n\n| Global Token | Value |\n| -------------------------------- | ------------------------ |\n| \\--fs-text-size-title-huge | var(--fs-text-size-8) |\n| \\--fs-text-size-title-page | var(--fs-text-size-7) |\n| \\--fs-text-size-title-product | var(--fs-text-size-4) |\n| \\--fs-text-size-title-section | var(--fs-text-size-4) |\n| \\--fs-text-size-title-subsection | var(--fs-text-size-4) |\n| \\--fs-text-size-title-mini | var(--fs-text-size-4) |\n| \\--fs-text-size-lead | var(--fs-text-size-3) |\n| \\--fs-text-size-menu | var(--fs-text-size-base) |\n| \\--fs-text-size-body | var(--fs-text-size-base) |\n| \\--fs-text-size-legend | var(--fs-text-size-1) |\n| \\--fs-text-size-tiny | var(--fs-text-size-0) |\n\n### Max Lines\n\n| Global Token | Value |\n| -------------------- | ----- |\n| \\--fs-text-max-lines | 2 |\n\n---\n\n## Adding a custom font\n\nUsing a custom font helps to keep a cohesive brand across your store. To maintain readability in your store, choose an easily readable font and the appropriate color and text size. Follow the steps below to add a custom font to your store.\n\n1. Go to the `src` folder and create the `fonts` folder.\n2. Inside the `src/fonts` folder, create a new `WebFonts.tsx` file and add a `<link>` tag for your `font-family` of choice as in the example below.\n\n`1\n\n/* eslint-disable @next/next/no-page-custom-font */ \n\n2\n\n \n3\n\nfunction WebFonts() { \n\n4\n\n return ( \n\n5\n\n <> \n\n6\n\n {/* Add a <link> tag for your font-family of choice */} \n\n7\n\n <link \n\n8\n\n rel=\"stylesheet\" \n\n9\n\n href=\"https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700;900&display=swap\" \n\n10\n\n /> \n\n11\n\n </> \n\n12\n\n ); \n\n13\n\n} \n\n14\n\n \n15\n\nexport default WebFonts; \n\n`\n\n1. In your custom theme file, usually `src/themes/custom-theme.scss`, use the `--fs-text-face-body` token with the `font-family` you chose.\n\n> We recommend using [fallback fonts](https://read.calvincode.net/reader?url=https://developer.chrome.com/blog/font-fallbacks/%23background) as system fonts to ensure quick rendering, consistent and readable content.\n\n`1\n\n@layer theme { \n\n2\n\n .theme { \n\n3\n\n // -------------------------------------------------------- \n\n4\n\n // Typography (Branding Core) \n\n5\n\n // -------------------------------------------------------- \n\n6\n\n --fs-text-face-body: 'Inter', -apple-system, system-ui, BlinkMacSystemFont, sans-serif; \n\n7\n\n } \n\n8\n\n} \n\n`\n\n1. Run `yarn dev` and check the browser to see the new `font-family` applied.\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/global-tokens/typography.mdx)\n\n[Spacing« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-spacing)[IconographyNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/styling-icons)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Font Family](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23font-family)\n\n[Weights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23weights)\n\n[Typography Scale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23typography-scale)\n\n[Mobile Scale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23mobile-scale)[Desktop Scale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23desktop-scale)\n\n[Semantical tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23semantical-tokens)\n\n[Sizes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23sizes)[Max Lines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23max-lines)\n\n[Adding a custom font](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23adding-a-custom-font)\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/global-tokens/typography.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Font Family](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23font-family)\n\n[Weights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23weights)\n\n[Typography Scale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23typography-scale)\n\n[Mobile Scale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23mobile-scale)[Desktop Scale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23desktop-scale)\n\n[Semantical tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23semantical-tokens)\n\n[Sizes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23sizes)[Max Lines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23max-lines)\n\n[Adding a custom font](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-typography/docs/guides/faststore/global-tokens-typography%23adding-a-custom-font)\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_4c6f8e63
|
[
{
"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 catalog 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/catalog-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-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/catalog-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/catalog-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/catalog-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/catalog-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/catalog-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/getting-started)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview)\n\n[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/marketplace-overview)\n\n[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/orders-overview)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/checkout-overview)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/payments-overview)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/fulfillment)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/search-overview)\n\n[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/pricing-overview)\n\n[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/promotions-overview)\n\n[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-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/catalog-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-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/catalog-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-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/catalog-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/catalog-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/getting-started)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview)\n\n[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/marketplace-overview)\n\n[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/orders-overview)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/checkout-overview)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/payments-overview)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/fulfillment)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/search-overview)\n\n[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/pricing-overview)\n\n[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/promotions-overview)\n\n[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-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/catalog-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-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/catalog-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-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/catalog-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/catalog-overview/docs/guides)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/getting-started)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview)\n\nCatalog\n\n> **Help us improve our documentation!** Tell us about your experience with this article by filling out [this form](https://read.calvincode.net/reader?url=https://forms.gle/fQoELRA1yfKDqmAb8).\n\nCatalog is your store's administration module for configuring the features related to your ecommerce products to make them available for customers on your website. This overview article goes over what you can accomplish with the VTEX Catalog, including relevant links to our developer documentation about this topic.\n\n## Understanding Catalog architecture\n\nOn VTEX, [Categories](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2gkZDjXRqfsq62TlAkj4uf) are the way products are organized, generically dividing items available in your store. Usually, they have three levels: department, category, and subcategory.\n\nEach [product](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/1wmX3QvQVxbKVmalhIE5Ru) is associated with a category and a [brand](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/7i3sB8fgkqUp5NoH5yJtfh), and has at least one [Stock Keeping Unit (SKU)](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/3mJbIqMlz6oKDmyZ2bKJoA), which corresponds to each product variation – each physical unit in stock.\n\nCategories are associated with [specification](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2NQoBv8m4Yz3oQaLgDRagP) groups, which group the product and SKU specifications that will be applied to all items associated with the category. All specifications must be completed for items to be active in your store.\n\n\n\n## Setting up your catalog\n\nOne of the first steps for new stores is to upload products to VTEX, whether from your ERP, back-office system, or other sources. See the links below for an overview of the integration flow and detailed guides about each step of the process.\n\n### Integration flow\n\nThese links provide a general overview of the steps in the integration flow between a back office system and a VTEX store catalog.\n\n1. [Back office (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide)\n2. [Setting up the catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog)\n3. [Importing products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products)\n4. [Updating / deleting information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information)\n5. [Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration)\n6. [Catalog API - Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23overview)\n\n> Looking for storefront Catalog content? Read our [Customizing your storefront](#customizing-your-storefront) guides.\n\n### Configuring initial settings (MANDATORY)\n\nAccess the following links to see details about each step and API call while uploading products to your VTEX Catalog. All these steps are **required** and must be completed in the order below, regardless of whether you are connecting to VTEX through an external system.\n\n#### 1\\. Categories\n\nCategories arrange your product assortment in hierarchical levels of product classification. The category system makes a customer search for a product easier and keeps your catalog organized. The three main category levels are called department, category, and subcategory.\n\n* [Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories)\n* [Catalog API - Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pub/category/tree/-categoryLevels-)\n\n#### 2\\. Brands\n\nA brand is an attribute that helps your end customers identify a product and the company behind it.\n\n* [Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands)\n* [Catalog API - Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/brand/list)\n\n#### 3\\. Specifications\n\nSpecifications are additional properties that can be added to your store products or SKUs. On VTEX, you must first create a specification group linked to a category and then include the desired specification fields that will be replicated in all products or SKUs in the category.\n\nWhen a group is created in a department or a category, it will be replicated in all the sublevels of that department or category, following an \"inheritance\" logic. Therefore, to create a specification group applicable to one category only, you must create it at that category level.\n\n* [Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications)\n* [Catalog API - Specification group](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/specification/groupbycategory/-categoryId-)\n* [Catalog API - Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/specification/-specificationId-)\n* [Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications)\n* [Catalog API - Product specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/products/-productId-/specification)\n* [SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications)\n* [Catalog API - SKU specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-/specification)\n\n#### 4\\. Products\n\nA product is a generic definition of an item available in your store, such as a shirt.\n\n* [Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/products)\n* [Catalog API - Product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/products/GetProductAndSkuIds)\n* [Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests)\n* [Implementing product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-implement-product-color-variation)\n\n#### 5\\. SKUs\n\nA SKU, short for \"stock keeping unit\", represents a physical unit or variation of a product, such as a medium blue shirt. SKUs are the items that stores keep in stock and that end customers actually buy.\n\n* [SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus)\n* [Catalog API - SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/sku/stockkeepingunitids)\n\n### Enriching your catalog (MANDATORY)\n\nAfter the initial product upload, you must enrich them with the required information before selling them. The steps below are **required** for any product to be available in your store. See the following points for more details.\n\n#### 6\\. Completing specifications\n\nYou need to complete the specifications of each product and SKU based on the fields and values you have created.\n\n* [Updating SKU specifications with the Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api)\n* [Catalog API - Specification value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/specificationvalue/-specificationValueId-)\n\n#### 7\\. Adding images to SKUs\n\nEvery SKU needs at least one image to be active in your store.\n\n* [Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images)\n* [Catalog API - SKU file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-/file)\n\n#### 8\\. Activating SKUs\n\nRead the following guide to understand how to activate SKUs and make them available in your store.\n\n* [How to activate a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus%23activating-an-sku)\n\n### Adding optional settings\n\nOnce you have all the required information, there are optional settings you can configure to enhance your catalog. See the following links for more information.\n\n#### Attachments\n\nAn attachment is an optional and free product customization. It is used to add information to a SKU.\n\n* [Catalog API - Attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/attachment/-attachmentid-)\n* [Catalog API - SKU attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/skuattachment)\n\n#### Assembly options\n\nAn assembly option is an attachment for complex cases, such as product customization, where you need to manage different product combinations, quantity, additional items, costs, and product inventory and display these options on the product page.\n\n* [Assembly options](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH)\n* [Assembly Options app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/assembly-options-app)\n\n#### Services\n\nA service is an extra that may come with a product, optionally and at a cost. It is used to assign an additional service to a SKU, such as gift packaging, customization, or special warranty deals.\n\n* [Catalog API - SKU service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/skuservice/-skuServiceId-)\n* [Catalog API - SKU service attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/skuservicetypeattachment)\n* [Catalog API - SKU service type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/skuservicetype)\n* [Catalog API - SKU service value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/skuservicevalue)\n\n#### Kits\n\nA kit is a set of SKUs that are sold together, a SKU composed of one or more SKUs.\n\n* [Catalog API - SKU kit](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-sku-kit)\n\n#### Collections\n\nA collection is a group of two or more SKUs that may or may not have common features to be displayed on your store product pages. You can create collections using grouping criteria such as special dates, launches, or best-selling products. You can create collections using either Legacy CMS Portal or Collections beta.\n\n**Legacy CMS Portal**\n\n* [Catalog API - Collection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/collection/-collectionId-)\n* [Catalog API - Subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/collection/-collectionId-/subcollection)\n* [Catalog API - Category subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/subcollection/-subCollectionId-/category)\n* [Catalog API - Brand subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/subcollection/-subCollectionId-/brand)\n* [Catalog API - SKU subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/subcollection/-subCollectionId-/stockkeepingunit)\n\n**Collections Beta**\n\n* [Catalog API - Collections beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api/%23get-/api/catalog%5Fsystem/pvt/collection/search)\n\n#### Trade policies (sales channels)\n\nWhen operating with multiple trade policies, you can define which products will be available on each trade policy.\n\n* [How trade policies work](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)\n* [Catalog API - Trade policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/product/-productId-/salespolicy)\n\n## Customizing your storefront\n\nTo understand how to build your storefront and display your product assortment, read the articles in this section. The rest of this guide focuses on Admin related settings and actions.\n\n### VTEX IO\n\nLearn how to build Catalog related pages in your storefront using VTEX IO.\n\n* [Building a horizontal product summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary)\n* [Building a product details page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page)\n* [Building a shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-shelf)\n* [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* [Creating a product availability form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form)\n* [Rendering a badge on top of a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-rendering-a-badge)\n* [Translating Catalog content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-internationalization)\n\nFind more information in our [Storefront implementation guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation).\n\n## Integrating with external marketplaces or sellers\n\nLearn more about integrating with non-VTEX marketplaces or sellers through the following documentation.\n\n### External Marketplace\n\nIf you are an external marketplace that wishes to integrate with VTEX sellers, you can see the links below to learn how to develop a custom connector to connect with VTEX's architecture and sellers' catalogs.\n\n* [External Marketplace Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide)\n* [Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-catalog)\n* [Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs)\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)\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)\n* [How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates)\n* [Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-catalog-mapping)\n\n### External Seller\n\nSee the documentation below to understand how to integrate an external seller’s offers into your catalog if you act as a VTEX marketplace.\n\n* [External Seller Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide)\n* [Catalog management for VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation)\n\nContributors\n\n5\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/jumeyermattosarruda)\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/catalog-overview.md)\n\n[Getting started« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview//docs/guides/getting-started)[MarketplaceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview//docs/guides/marketplace-overview)\n\nContributors\n\n5\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/jumeyermattosarruda)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Understanding Catalog architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23understanding-catalog-architecture)\n\n[Setting up your catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23setting-up-your-catalog)\n\n[Integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23integration-flow)[Configuring initial settings (MANDATORY)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23configuring-initial-settings-mandatory)[Enriching your catalog (MANDATORY)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23enriching-your-catalog-mandatory)[Adding optional settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23adding-optional-settings)\n\n[Customizing your storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23customizing-your-storefront)\n\n[VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23vtex-io)\n\n[Integrating with external marketplaces or sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23integrating-with-external-marketplaces-or-sellers)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23external-marketplace)[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23external-seller)\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/catalog-overview.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Understanding Catalog architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23understanding-catalog-architecture)\n\n[Setting up your catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23setting-up-your-catalog)\n\n[Integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23integration-flow)[Configuring initial settings (MANDATORY)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23configuring-initial-settings-mandatory)[Enriching your catalog (MANDATORY)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23enriching-your-catalog-mandatory)[Adding optional settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23adding-optional-settings)\n\n[Customizing your storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23customizing-your-storefront)\n\n[VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23vtex-io)\n\n[Integrating with external marketplaces or sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23integrating-with-external-marketplaces-or-sellers)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23external-marketplace)[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview/docs/guides/catalog-overview%23external-seller)\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_0e2748e4
|
[
{
"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 api extensions best practices 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/api-extensions-best-practices/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/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/api-extensions-best-practices/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/api-extensions-best-practices/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/api-extensions-best-practices/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/api-extensions-best-practices/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/api-extensions-best-practices/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/api-extensions-best-practices/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/api-extensions-best-practices/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/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/api-extensions-best-practices/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/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/api-extensions-best-practices/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/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/api-extensions-best-practices/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/api-extensions-best-practices/docs/guides/faststore/api-extensions-overview)\n\n[Extending API schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-extending-api-schema)\n\n[Extending queries using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-extending-queries-using-fragments)\n\n[Consuming FastStore API extension with custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-consuming-api-extensions)\n\n[Best practices for using API extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices)\n\n[API extensions - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-use-cases-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/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/api-extensions-best-practices/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/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/api-extensions-best-practices/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/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/api-extensions-best-practices/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/api-extensions-best-practices/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/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/api-extensions-best-practices/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/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/api-extensions-best-practices/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/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/api-extensions-best-practices/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/api-extensions-best-practices/docs/guides/faststore/api-extensions-overview)\n\n[Extending API schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-extending-api-schema)\n\n[Extending queries using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-extending-queries-using-fragments)\n\n[Consuming FastStore API extension with custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-consuming-api-extensions)\n\n[Best practices for using API extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices)\n\n[API extensions - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-use-cases-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/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/api-extensions-best-practices/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/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/api-extensions-best-practices/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-overview)\n\nBest practices for using API extensions\n\nThe[ @faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson) package version 3.x introduces enhancements to API extension with a more efficient GraphQL query handling and security measures enhancements.\n\nIn this guide, learn to configure API extensions, ensuring the following:\n\n* Use the `gql` helper usage for smoother and more efficient GraphQL query handling.\n* Implement a more secure method for invoking queries and mutations to safeguard your store's data.\n* Optimize call processes for queries or mutations defined within `@faststore/core`.\n\n## Before you begin\n\nMake sure your store version is updated to v3.0.0 or above. If it’s not updated, refer to the [Updating your @faststore/core package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version) section.\n\n## Updating the `gql` helper usage\n\nThe `gql` helper serves as a function to define GraphQL operations such as queries, mutations, or fragments within the store code. See the example below:\n\n/fragments/ClientProduct.tsx\n\n`` 1\n\nimport { gql } from '@faststore/graphql-utils' \n\n2\n\n \n3\n\nexport const fragment = gql` \n\n4\n\n fragment ClientProduct on Query { \n\n5\n\n product(locator: $locator) { \n\n6\n\n id: productID \n\n7\n\n breadcrumbList { \n\n8\n\n itemListElement { \n\n9\n\n item \n\n10\n\n name \n\n11\n\n position \n\n12\n\n } \n\n13\n\n } \n\n14\n\n } \n\n15\n\n} \n\n16\n\n` \n\n ``\n\nImport the `gql` helper from `@faststore/core/api`and call it as a function - with the argument between parenthesis. This also applies to query and mutation definitions inside the components. For example:\n\nfragments/ClientProduct.tsx\n\n`` 1\n\nimport { gql } from '@faststore/core/api' \n\n2\n\n \n3\n\nexport const fragment = gql(` \n\n4\n\n fragment ClientProduct on Query { \n\n5\n\n product(locator: $locator) { \n\n6\n\n id: productID \n\n7\n\n breadcrumbList { \n\n8\n\n itemListElement { \n\n9\n\n item \n\n10\n\n name \n\n11\n\n position \n\n12\n\n } \n\n13\n\n } \n\n14\n\n } \n\n15\n\n } \n\n16\n\n`) \n\n ``\n\n## Using `useQuery` hook to call queries and mutations\n\nQueries, and mutations are must be invoked using secure hashes, which are randomly generated. To that, pass the query or mutation object - the result of the `gql` call - to `useQuery` directly. For example:\n\n`` 1\n\nimport { gql } from '@faststore/core/api' \n\n2\n\nimport { useQuery_unstable as useQuery } from '@faststore/core/src/experimental' \n\n3\n\n \n4\n\nconst query = gql(` \n\n5\n\nquery MyCustomQuery { \n\n6\n\n customQuery() { \n\n7\n\n data \n\n8\n\n } \n\n9\n\n} \n\n10\n\n`) \n\n11\n\n \n12\n\n// useQuery appropriately calls MyCustomQuery \n\n13\n\nfunction CustomComponent() { \n\n14\n\n // ... \n\n15\n\n const result = useQuery(query, variables) \n\n16\n\n // ... \n\n17\n\n} \n\n ``\n\n## Calling queries or mutations defined by `@faststore/core`\n\nA custom component can call a query or mutation defined by `@faststore/core`, such as `ClientManyProductsQuery`. In these cases, replace the `useQuery` hook call with a call to the specific hook for that query.\n\n`1\n\nimport { useClientManyProducts_unstable as useClientManyProducts } from '@faststore/core/src/experimental' \n\n2\n\n \n3\n\n// ClientManyProductsQuery will be called with the variables passed by CustomComponent \n\n4\n\nfunction CustomComponent() { \n\n5\n\n // ... \n\n6\n\n const result = useClientManyProducts(variables) \n\n7\n\n // ... \n\n8\n\n} \n\n`\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/hellofanny)\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/api-extensions/best-practices.mdx)\n\n[Consuming FastStore API extension with custom components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-consuming-api-extensions)[API extensions - Use casesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-use-cases-overview)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/hellofanny)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices%23before-you-begin)\n\n[Updating the gql helper usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices%23updating-the-gql-helper-usage)\n\n[Using useQuery hook to call queries and mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices%23using-usequery-hook-to-call-queries-and-mutations)\n\n[Calling queries or mutations defined by @faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices%23calling-queries-or-mutations-defined-by-faststorecore)\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/api-extensions/best-practices.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/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices%23before-you-begin)\n\n[Updating the gql helper usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices%23updating-the-gql-helper-usage)\n\n[Using useQuery hook to call queries and mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices%23using-usequery-hook-to-call-queries-and-mutations)\n\n[Calling queries or mutations defined by @faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-best-practices/docs/guides/faststore/api-extensions-best-practices%23calling-queries-or-mutations-defined-by-faststorecore)\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_e8d2c0d2
|
[
{
"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 activate an 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/guides/how-to-activate-an-sku/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-activate-an-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/guides/how-to-activate-an-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/guides/how-to-activate-an-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/guides/how-to-activate-an-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/guides/how-to-activate-an-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/guides/how-to-activate-an-sku/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/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/how-to-activate-an-sku/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/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/how-to-activate-an-sku/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/how-to-activate-an-sku/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/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/how-to-activate-an-sku/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/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/how-to-activate-an-sku/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/how-to-activate-an-sku/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/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/how-to-activate-an-sku/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/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/how-to-activate-an-sku/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/how-to-activate-an-sku/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/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/how-to-activate-an-sku/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/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/how-to-activate-an-sku/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/how-to-activate-an-sku/docs/guides)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/catalog-integration)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus)\n\nSKUs\n\nA [Stock Keeping Unit (SKU)](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/3mJbIqMlz6oKDmyZ2bKJoA%23) corresponds to the actual item in the inventory that customers can purchase, which means it is equivalent to a product variation at VTEX, such as a _long sleeve gray size S shirt_.\n\nOnce you have created a product, it is time to submit its respective SKUs.\n\n> Try the interactive version of this article by accessing this [link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus). Code will be highlighted and focused for your convenience.\n\n## Creating an SKU\n\nTo create a new SKU, use the [Create SKU endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit).\n\nFollow these instructions when creating the request body:\n\n* During SKU creation, do not set `IsActive` as `true`. If you send the request to activate the SKU when creating it, you will receive a `400 Bad Request` error. The value to `IsActive` must always be `false` when sending that request for activation to occur afterward, as explained in [Activating an SKU](#activating-an-sku).\n* We suggest you set `ActivateIfPossible` as `true,` unless you plan to have an internal workflow to [manually activate SKUs](#manual-activation).\n* If there is a need to create a new SKU with a specific custom ID, specify the `Id` (integer) in the request. Otherwise, VTEX will generate the ID automatically.\n* Besides the main ID, you must provide at least one of the following alternate IDs in the request body: `RefId` or `EAN`. It is possible to provide both as well.\n\n#### **Request body example (custom ID)**\n\n`1\n\n{ \n\n2\n\n \"Id\": 1, \n\n3\n\n \"ProductId\": 310117069, \n\n4\n\n \"IsActive\": false, \n\n5\n\n \"ActivateIfPossible\": true, \n\n6\n\n \"Name\": \"sku test\", \n\n7\n\n \"RefId\": \"125478\", \n\n8\n\n \"Ean\": \"8949461894984\", \n\n9\n\n \"PackagedHeight\": 10, \n\n10\n\n \"PackagedLength\": 10, \n\n11\n\n \"PackagedWidth\": 10, \n\n12\n\n \"PackagedWeightKg\": 10, \n\n13\n\n \"Height\": null, \n\n14\n\n \"Length\": null, \n\n15\n\n \"Width\": null, \n\n16\n\n \"WeightKg\": null, \n\n17\n\n \"CubicWeight\": 0.1667, \n\n18\n\n \"IsKit\": false, \n\n19\n\n \"CreationDate\": null, \n\n20\n\n \"RewardValue\": null, \n\n21\n\n \"EstimatedDateArrival\": null, \n\n22\n\n \"ManufacturerCode\": \"123\", \n\n23\n\n \"CommercialConditionId\": 1, \n\n24\n\n \"MeasurementUnit\": \"un\", \n\n25\n\n \"UnitMultiplier\": 2.0000, \n\n26\n\n \"ModalType\": null, \n\n27\n\n \"KitItensSellApart\": false, \n\n28\n\n \"Videos\": [ \"https://www.youtube.com/\" ] \n\n29\n\n} \n\n`\n\n#### **Request body example (automatically generated ID)**\n\n`1\n\n{ \n\n2\n\n \"ProductId\": 310117069, \n\n3\n\n \"IsActive\": false, \n\n4\n\n \"ActivateIfPossible\": true, \n\n5\n\n \"Name\": \"sku test\", \n\n6\n\n \"RefId\": \"125478\", \n\n7\n\n \"Ean\": \"8949461894984\", \n\n8\n\n \"PackagedHeight\": 10, \n\n9\n\n \"PackagedLength\": 10, \n\n10\n\n \"PackagedWidth\": 10, \n\n11\n\n \"PackagedWeightKg\": 10, \n\n12\n\n \"Height\": null, \n\n13\n\n \"Length\": null, \n\n14\n\n \"Width\": null, \n\n15\n\n \"WeightKg\": null, \n\n16\n\n \"CubicWeight\": 0.1667, \n\n17\n\n \"IsKit\": false, \n\n18\n\n \"CreationDate\": null, \n\n19\n\n \"RewardValue\": null, \n\n20\n\n \"EstimatedDateArrival\": null, \n\n21\n\n \"ManufacturerCode\": \"123\", \n\n22\n\n \"CommercialConditionId\": 1, \n\n23\n\n \"MeasurementUnit\": \"un\", \n\n24\n\n \"UnitMultiplier\": 2.0000, \n\n25\n\n \"ModalType\": null, \n\n26\n\n \"KitItensSellApart\": false, \n\n27\n\n \"Videos\": [ \"https://www.youtube.com/\" ] \n\n28\n\n} \n\n`\n\n#### **Response body example**\n\n`1\n\n{ \n\n2\n\n \"Id\":1, \n\n3\n\n \"ProductId\": 310117069, \n\n4\n\n \"IsActive\": false, \n\n5\n\n \"ActivateIfPossible\": true, \n\n6\n\n \"Name\": \"sku test\", \n\n7\n\n \"RefId\": \"125478\", \n\n8\n\n \"Ean\": \"8949461894984\", \n\n9\n\n \"PackagedHeight\": 10, \n\n10\n\n \"PackagedLength\": 10, \n\n11\n\n \"PackagedWidth\": 10, \n\n12\n\n \"PackagedWeightKg\": 10, \n\n13\n\n \"Height\": null, \n\n14\n\n \"Length\": null, \n\n15\n\n \"Width\": null, \n\n16\n\n \"WeightKg\": null, \n\n17\n\n \"CubicWeight\": 0.1667, \n\n18\n\n \"IsKit\": false, \n\n19\n\n \"CreationDate\": null, \n\n20\n\n \"RewardValue\": null, \n\n21\n\n \"EstimatedDateArrival\": null, \n\n22\n\n \"ManufacturerCode\": \"123\", \n\n23\n\n \"CommercialConditionId\": 1, \n\n24\n\n \"MeasurementUnit\": \"un\", \n\n25\n\n \"UnitMultiplier\": 2.0000, \n\n26\n\n \"ModalType\": null, \n\n27\n\n \"KitItensSellApart\": false, \n\n28\n\n \"Videos\": [ \"https://www.youtube.com/\" ] \n\n29\n\n} \n\n`\n\n## Updating an SKU\n\nAfter an SKU has been successfully created, if any changes are needed or if it's necessary to [activate it manually](#manual-activation), use the [Update SKU endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/stockkeepingunit/-skuId-).\n\n#### **Request body example**\n\n`1\n\n{ \n\n2\n\n \"Id\": 70, \n\n3\n\n \"ProductId\": 42, \n\n4\n\n \"IsActive\": true, \n\n5\n\n \"Name\": \"Size 10\", \n\n6\n\n \"RefId\": \"B096QW8Y8Z\", \n\n7\n\n \"PackagedHeight\": 15.0, \n\n8\n\n \"PackagedLength\": 15.0, \n\n9\n\n \"PackagedWidth\": 15.0, \n\n10\n\n \"PackagedWeightKg\": 15.0, \n\n11\n\n \"Height\": null, \n\n12\n\n \"Length\": null, \n\n13\n\n \"Width\": null, \n\n14\n\n \"WeightKg\": null, \n\n15\n\n \"CubicWeight\": 0.0, \n\n16\n\n \"IsKit\": false, \n\n17\n\n \"CreationDate\": \"2020-01-25T15:51:00\", \n\n18\n\n \"RewardValue\": null, \n\n19\n\n \"EstimatedDateArrival\": null, \n\n20\n\n \"ManufacturerCode\": null, \n\n21\n\n \"CommercialConditionId\": 1, \n\n22\n\n \"MeasurementUnit\": \"un\", \n\n23\n\n \"UnitMultiplier\": 1.0, \n\n24\n\n \"ModalType\": null, \n\n25\n\n \"KitItensSellApart\": false, \n\n26\n\n \"Videos\": [] \n\n27\n\n} \n\n`\n\n#### **Response body example**\n\n`1\n\n{ \n\n2\n\n \"Id\": 70, \n\n3\n\n \"ProductId\": 42, \n\n4\n\n \"IsActive\": true, \n\n5\n\n \"Name\": \"Size 10\", \n\n6\n\n \"RefId\": \"B096QW8Y8Z\", \n\n7\n\n \"PackagedHeight\": 15.0, \n\n8\n\n \"PackagedLength\": 15.0, \n\n9\n\n \"PackagedWidth\": 15.0, \n\n10\n\n \"PackagedWeightKg\": 15.0, \n\n11\n\n \"Height\": null, \n\n12\n\n \"Length\": null, \n\n13\n\n \"Width\": null, \n\n14\n\n \"WeightKg\": null, \n\n15\n\n \"CubicWeight\": 0.0, \n\n16\n\n \"IsKit\": false, \n\n17\n\n \"CreationDate\": \"2020-01-25T15:51:00\", \n\n18\n\n \"RewardValue\": null, \n\n19\n\n \"EstimatedDateArrival\": null, \n\n20\n\n \"ManufacturerCode\": null, \n\n21\n\n \"CommercialConditionId\": 1, \n\n22\n\n \"MeasurementUnit\": \"un\", \n\n23\n\n \"UnitMultiplier\": 1.0, \n\n24\n\n \"ModalType\": null, \n\n25\n\n \"KitItensSellApart\": false, \n\n26\n\n \"Videos\": [] \n\n27\n\n} \n\n`\n\n## Activating an SKU\n\nBefore you can activate an SKU, it must meet the following requirements:\n\n* The SKU must have at least one of the following alternate IDs configured: `RefId` or `EAN`.\n* The SKU must have at least one image associated. To associate an image to an SKU, use the [Create SKU file endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/file).\n* If the SKU has [specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications), they must be filled in.\n* If the field `ActivateIfPossible` is `false`, the SKU must be activated manually. For more information, check the [Manual activation](#manual-activation) section.\n* If the SKU is a [kit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunitkit), it must have at least one component active.\n* The SKU must be associated with an active product, which, in turn, must be associated with an active Brand and an active Category.\n\nOnce the SKU complies with all the aspects listed above, there are two ways that you can activate your SKU - [manually](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku%23manual-activation) or [automatically](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku%23automatic-activation). Read the following sections for more details.\n\n> Note that additional configurations are necessary for a product and its SKUs to become visible in a store:\n> \n> * Having registered a price for the SKU in the associated trade policy (also known as sales channel). Read the Pricing onboarding guide for more information on this process.\n> * Having at least one unit in stock. Read the Fulfillment onboarding guide for more information on managing inventory.\n> * Configuring your storefront's CMS to display products correctly, as described in this Frequently Asked Question.\n\n### Manual activation\n\nTo manually activate your SKU, follow these steps:\n\n1. [Create the SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit), setting `IsActive` as `false` and `ActivateIfPossible` as `false`.\n2. If the SKU is a kit, [create and associate SKU components](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-post-sku-kit).\n3. [Create and associate SKU files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/file).\n4. [Update the SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/stockkeepingunit/-skuId-) as active, setting `IsActive` as `true`.\n\nNow the SKU should be active in your store.\n\n### Automatic activation\n\nThis configuration will automatically update the SKU as active once it is associated with an image or an active component. You do not need to update the SKU as in the previous steps.\n\nTo automatically activate your SKU, follow these steps:\n\n1. [Create the SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit), setting `IsActive` as `false` and `ActivateIfPossible` as `true`.\n2. If the SKU is a kit, [create and associate SKU components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunitkit).\n3. [Create and associate SKU files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/file).\n\nNow the SKU should be active in your store.\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\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/catalog-integration/skus.md)\n\n[Updating SKU Specifications with Catalog API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku//docs/guides/updating-sku-specifications-with-catalog-api)[ImagesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku//docs/guides/images)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Creating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23creating-an-sku)\n\n[Updating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23updating-an-sku)\n\n[Activating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23activating-an-sku)\n\n[Manual activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23manual-activation)[Automatic activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23automatic-activation)\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/skus.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Creating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23creating-an-sku)\n\n[Updating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23updating-an-sku)\n\n[Activating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23activating-an-sku)\n\n[Manual activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23manual-activation)[Automatic activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku/docs/guides/skus%23automatic-activation)\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_088cf84b
|
[
{
"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 integrate external orders 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/integrate-external-orders-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/integrate-external-orders-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/integrate-external-orders-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/integrate-external-orders-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/integrate-external-orders-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/integrate-external-orders-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/integrate-external-orders-vtex-tracking/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-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/integrate-external-orders-vtex-tracking/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-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/integrate-external-orders-vtex-tracking/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-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/integrate-external-orders-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/integrate-external-orders-vtex-tracking/docs/guides/vtex-shipping-network)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-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/integrate-external-orders-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/integrate-external-orders-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/integrate-external-orders-vtex-tracking/docs/guides/multilevel-omnichannel-inventory)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-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/integrate-external-orders-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/integrate-external-orders-vtex-tracking/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-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/integrate-external-orders-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/integrate-external-orders-vtex-tracking/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-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/integrate-external-orders-vtex-tracking/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-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/integrate-external-orders-vtex-tracking/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-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/integrate-external-orders-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/integrate-external-orders-vtex-tracking/docs/guides/vtex-shipping-network)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-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/integrate-external-orders-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/integrate-external-orders-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/integrate-external-orders-vtex-tracking/docs/guides/multilevel-omnichannel-inventory)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-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/integrate-external-orders-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/integrate-external-orders-vtex-tracking/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-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/integrate-external-orders-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/integrate-external-orders-vtex-tracking/docs/guides)\n\nLogistics\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-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/integrate-external-orders-vtex-tracking/docs/guides/integrate-external-orders-vtex-tracking)\n\nIntegrating external orders via API to be used with VTEX Tracking\n\nThe [VTEX Tracking app](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-tracking-overview--1uDRquVudbPuoK05MtbZGh) automatically gets invoiced orders’ information from VTEX’s Order Management System (OMS) so as to create delivery routes. However, it is possible to import external orders by using our APIs.\n\nSince the actual fulfillment and tracking only happen for invoiced orders, external order integrations must accomplish four steps to create and move the imported orders along the [OMS’s workflow](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/fluxo-de-pedido--tutorials%5F196%23) to the `invoiced` status. The steps are:\n\n1. Place order\n2. Authorize dispatch\n3. Start handling\n4. Send invoice\n\n> Because this type of integration assumes payment is already taken care of when orders are imported, we can use the fulfillment order workflow. This is the same workflow used by sellers integrating with marketplaces, for example.\n\n> Make sure you have [API authentication credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication) to use the APIs listed below.\n\n## 1\\. Place order\n\nThis step actually creates the order in the [OMS](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/lista-de-pedidos--tutorials%5F200%23).\n\nTo do this, use the [Place fulfillment order API request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/fulfillment/pvt/orders).\n\n> To successfully place an order on the platform, you must have products already registered in your VTEX [catalog](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ%23) and make sure they are available in the platform's [inventory](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/inventory-management--tutorials%5F139). For this purpose, it may be a good idea to [set unlimited inventory](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/inventory-management--tutorials%5F139).\n\n> The field `marketplaceServicesEndpoint` is required, but not necessarily applicable in the context of integrating orders to VTEX Tracking. Because of this, you may send it with a mock value not corresponding with a real working endpoint, such as `https://exampleseller.marketplaceservices.com`.\n\n### Affiliate ID\n\nBecause we are using endpoints typically used by sellers connecting to external marketplaces, steps 1 and 2 will require you to send the `affiliateId` field.\n\nThis field is meant to be a three-letter code identifying the marketplace that made the sale to be fulfilled. In the case of importing external orders to VTEX Tracking, you may send any arbitrary three-letter code and the requests should work as expected.\n\n> For a given order you should use the same `affiliateId`, `orderId` and `marketplaceOrderId` in steps 2, 3 and 4, as used in this first step when required in the API requests. The `orderId` will be in the response of the [Place fulfillment order request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/fulfillment/pvt/orders) and it is composed of the `affiliateId` and `marketplaceOrderId` joined by a `-`.\n\n> Do not use an affiliate that is configured to use the seller's payment methods, or else this request will return a `status 500`. In this case, create a new affiliate without this configuration or use an arbitrary `affiliateId`.\n\n## 2\\. Authorize dispatch\n\nTo move the created order to the next status, use the [Authorize dispatch for fulfillment orders request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/fulfillment/pvt/orders/-orderId-/fulfill).\n\n## 3\\. Start handling\n\nAfter dispatch is authorized, the order goes automatically into the grace period also known as the cancellation window. This is a period of time in which the store waits to see if the customer wants to cancel the purchase before it actually starts handling the order. This window is set to 30 minutes by default, but can be changed in the Order Management settings. Learn how to [set the grace period for order cancelation](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-the-grace-period-for-order-cancellation--jYFdnPDtNm4WCEkYWqqC%23).\n\nAfter the grace period, the order status will be `ready-for-handling`. To move it to the next status, use the [Start handling order API request](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/starthandling).\n\n## 4\\. Send invoice\n\nUse the [Order invoice notification request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/invoice) to send invoice information to VTEX.\n\n> Note that this step can occur in parallel to steps 2 and 3\\. Once an order has been created, the platform can receive its invoice information.\n\nYou can use the [Order invoice notification request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/invoice) to send all invoice information at once, or you can send part of the information and update the invoice with the rest of the information later by using the [Update order's partial invoice request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-).\n\nAn example of the latter is when you need to include a tracking number to an invoice that is already registered to the platform.\n\n> This request can be used to send the link to the XML of the invoice, which can be relevant to some VTEX Tracking integrations. Find if that is your case and learn more in this article on [how to install and configure the VTEX Tracking app](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/how-to-install-and-setup-the-vtex-tracking-app-on-your-vtex-admin--3ejuFsJ1m0r08cT6afpIPf%23).\n\n## Checking an integrated order's information\n\nDuring integration or after you are done integrating a given order with these steps, you can check the order's information and progress in the [Order Management](https://read.calvincode.net/reader?url=https://help.vtex.com/en/category/orders-management--2663q96EyQuYc20y0yYAEE%23) section on VTEX Admin or with the [Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api).\n\nFor order information related to VTEX Tracking, see the [VTEX Tracking API documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/tracking).\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/Isabella-Veloso)\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/Fulfillment/vtex-tracking/integrate-external-orders-vtex-tracking.md)\n\n[VTEX Tracking« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking//docs/guides/vtex-tracking)[VTEX Pick and PackNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking//docs/guides/vtex-pick-and-pack)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/Isabella-Veloso)\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[1\\. Place order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/docs/guides/integrate-external-orders-vtex-tracking%231-place-order)\n\n[Affiliate ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/docs/guides/integrate-external-orders-vtex-tracking%23affiliate-id)\n\n[2\\. Authorize dispatch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/docs/guides/integrate-external-orders-vtex-tracking%232-authorize-dispatch)\n\n[3\\. Start handling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/docs/guides/integrate-external-orders-vtex-tracking%233-start-handling)\n\n[4\\. Send invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/docs/guides/integrate-external-orders-vtex-tracking%234-send-invoice)\n\n[Checking an integrated order's information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/docs/guides/integrate-external-orders-vtex-tracking%23checking-an-integrated-orders-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/Fulfillment/vtex-tracking/integrate-external-orders-vtex-tracking.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[1\\. Place order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/docs/guides/integrate-external-orders-vtex-tracking%231-place-order)\n\n[Affiliate ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/docs/guides/integrate-external-orders-vtex-tracking%23affiliate-id)\n\n[2\\. Authorize dispatch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/docs/guides/integrate-external-orders-vtex-tracking%232-authorize-dispatch)\n\n[3\\. Start handling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/docs/guides/integrate-external-orders-vtex-tracking%233-start-handling)\n\n[4\\. Send invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/docs/guides/integrate-external-orders-vtex-tracking%234-send-invoice)\n\n[Checking an integrated order's information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrate-external-orders-vtex-tracking/docs/guides/integrate-external-orders-vtex-tracking%23checking-an-integrated-orders-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_43b0faae
|
[
{
"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 orderquote 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-orderquote/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-orderquote/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-orderquote/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-orderquote/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-orderquote/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-orderquote/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-orderquote/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-orderquote/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-orderquote/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-orderquote/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-orderquote/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-orderquote/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-orderquote/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-orderquote/updates/release-notes)\n\nOrder Quote\n\nThe Order Quote app provides B2B capabilities to save a shopping cart, storing its items, product quantities and prices for further use.\n\n> The Order Quote app is not compatible with the [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite) solution. Therefore, these instructions do not apply to stores using the B2B Suite. If you are using the B2B Suite, refer to the [B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-quotes) documentation instead.\n\nThe user can also print the quotation information containing the cart information along with expiration date which is defined at **Admin > Apps**.\n\n\n\n## Configuration\n\n1. Using [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), install the Order Quote app by running `vtex install vtex.orderquote@1.x`.\n2. Head over to your VTEX account's admin and access the **Apps** section.\n3. Select the **Order Quote** app and click on **Settings**.\n4. Fill out the **Lifespan** and **Store logo URL** fields.\n5. Click on **Save**.\n6. Add the Order Quote app as a `peerDependency` in your `store-theme`'s `manifest.json` file:\n\n`1\n\n \"peerDependencies\": { \n\n2\n\n+ \"vtex.orderquote\": \"1.x\" \n\n3\n\n } \n\n`\n\nOnce declared as a [Peer Dependency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies), the app will generate a few routes under the `/orderquote` path in order to create the Order Quote custom page. Namely, they are:\n\n| Route | Description |\n| -------------------- | --------------------------------------------------------------------------------------------- |\n| /orderquote | Lists all saved cart quotations. |\n| /orderquote/create | Retrieves the current cart information, allowing you to create cart quotations as you desire. |\n| /orderquote/view/:ID | Details page, displayed when you click on a quote from the listing page (/orderquote). |\n\nThe new routes already contain a default template with all blocks automatically exported by the `orderquote` app, meaning that the Order Quote pages are ready to be rendered and no further actions are required from you.\n\n## 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://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS Handles |\n| ----------------------- |\n| buttonDelete |\n| buttonPrint |\n| buttonSave |\n| buttonsContainer |\n| buttonUse |\n| checkboxClear |\n| containerCreate |\n| containerFields |\n| containerList |\n| containerView |\n| refreshButton |\n| refreshLoading |\n| field |\n| inputCreate |\n| inputCreate |\n| listContainer |\n| logo |\n| notAuthenticatedMessage |\n| printingArea |\n| totalizerContainer |\n| itemNameContainer |\n| itemName |\n| itemSkuName |\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/b2b-components/vtex-orderquote.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/vtex-orderquote/docs/guides/vtex-orderquote%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-orderquote/docs/guides/vtex-orderquote%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/b2b-components/vtex-orderquote.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/vtex-orderquote/docs/guides/vtex-orderquote%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-orderquote/docs/guides/vtex-orderquote%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_8d3eded7
|
[
{
"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 logrocket 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.logrocket/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/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.logrocket/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.logrocket/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.logrocket/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.logrocket/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.logrocket/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/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.logrocket/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/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.logrocket/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.logrocket/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/guides/pixel-apps)\n\nLogRocket\n\nOfficial extension\n\nVersion: 1.0.1\n\nLatest version: 1.0.1\n\nVTEX LogRocket first-party app\n\n## How to install\n\nOpen a terminal and type:\n\n`1\n\nvtex install vtex.logrocket@1.x \n\n`\n\nOpen your admin in the Apps section:\n\n<https://YOURSTORENAME.myvtex.com/admin/apps/vtex.logrocket@1.0.0/setup>\n\nFill in your LogRocket's Account ID and click save.\n\n### Setup in Cart and Checkout page\n\n**This step will not be needed in a couple of months!**\n\nOpen your admin in the Checkout section in the `checkout6-custom.js`:\n\n<https://ACCOUNT.myvtexdev.com/admin/portal/#/sites/default/code/files/checkout6-custom.js>\n\nAdd the following snippet in the file:\n\n`1\n\n// LogRocket \n\n2\n\n(function() { \n\n3\n\n var accountId = 'YOURACCOUNTID'; \n\n4\n\n var b=document.createElement(\"script\");b.onload=function(){window.LogRocket && window.LogRocket.init(accountId);};b.type=\"text/javascript\";b.crossOrigin=\"anonymous\";b.src=\"https://cdn.lr-ingest.io/LogRocket.min.js\";a=document.getElementsByTagName(\"script\")[0];a.parentNode.insertBefore(b,a); \n\n5\n\n})(); \n\n`\n\nClick Save.\n\n[Kelkoo app« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.kelkoo)[Lucky OrangeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.lucky-orange)\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[How to install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.logrocket%23how-to-install)\n\n[Setup in Cart and Checkout page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.logrocket/docs/apps/vtex.logrocket%23setup-in-cart-and-checkout-page)\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_37c40d59
|
[
{
"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 3 cloningtheboilerplaterepository 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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/docs/app-development)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository/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-3-cloningtheboilerplaterepository/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[2\\. Cloning the boilerplate repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository)\n\n2\\. Cloning the boilerplate repository\n\nIn this part of this tutorial, you'll clone our **Pixel app boilerplate** into your local files. This boilerplate comes with all the needed settings for you to start developing your new Pixel app.\n\n## Instructions\n\n1. Using the terminal, clone the [**Pixel app boilerplate repository**](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/pixel-app-template/) to your local files by running the following command:\n\n`1\n\ngit clone https://github.com/vtex-apps/pixel-app-template/ \n\n`\n\n1. Open the `pixel-app-template` folder in any code editor of your preference.\n\nIn the following, you'll learn how to customize this Pixel app to make it your own.\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-3-cloningtheboilerplaterepository.md)\n\n[1\\. Setting up your development environment« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository//docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio)[3\\. Configuring your app settingsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository//docs/guides/vtex-io-documentation-4-configuringyourappsettings)\n\nSee also\n\n[3\\. Configuring your app settingsApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository/docs/guides/vtex-io-documentation-4-configuringyourappsettings)\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-3-cloningtheboilerplaterepository/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository%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/Getting-Started/vtex-io-documentation-1-developnativeintegrationswithpixelapps/vtex-io-documentation-3-cloningtheboilerplaterepository.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-3-cloningtheboilerplaterepository/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository%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_c1386ee7
|
[
{
"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 soft blue 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-soft-blue/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-soft-blue/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-soft-blue/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-soft-blue/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-soft-blue/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-soft-blue/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-soft-blue/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-soft-blue/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-soft-blue/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/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-soft-blue/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/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-soft-blue/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/themes-overview)\n\n[Soft blue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/themes-soft-blue)\n\n[Midnight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/themes-midnight)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/using-themes-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/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-soft-blue/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-soft-blue/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-soft-blue/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-soft-blue/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/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-soft-blue/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-soft-blue/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/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-soft-blue/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-soft-blue/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/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-soft-blue/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/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-soft-blue/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/themes-overview)\n\n[Soft blue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/themes-soft-blue)\n\n[Midnight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/themes-midnight)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/using-themes-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/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-soft-blue/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-soft-blue/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-soft-blue/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-soft-blue/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/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-soft-blue/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-soft-blue/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-soft-blue/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/themes-overview)\n\nSoft Blue\n\nA basic theme for your storefront.\n\n\n\n## Use `soft-blue` as your theme\n\n1. In your [starter project](https://read.calvincode.net/reader?url=https://github.com/vtex-sites/starter.store), create a new file named `soft-blue.scss` in `src/themes`.\n2. Add the following styles to `src/themes/soft-blue.scss`:\n\nsrc/themes/soft-blue.scss\n\n`1\n\n// ---------------------------------------------------------- \n\n2\n\n// GLOBAL TOKENS \n\n3\n\n// Theme Soft Blue \n\n4\n\n// ---------------------------------------------------------- \n\n5\n\n \n6\n\n@layer theme { \n\n7\n\n .theme { \n\n8\n\n // -------------------------------------------------------- \n\n9\n\n // Colors (Branding Core) \n\n10\n\n // -------------------------------------------------------- \n\n11\n\n \n12\n\n // PALETTE \n\n13\n\n --fs-color-main-0: #ecf0ff; \n\n14\n\n --fs-color-main-1: #d8e2ff; \n\n15\n\n --fs-color-main-2: #00419e; \n\n16\n\n --fs-color-main-3: #002c71; \n\n17\n\n --fs-color-main-4: #001947; \n\n18\n\n \n19\n\n --fs-color-accent-0: #ebdcff; \n\n20\n\n --fs-color-accent-1: #8d50fd; \n\n21\n\n --fs-color-accent-2: #732fe2; \n\n22\n\n --fs-color-accent-3: #5900c8; \n\n23\n\n --fs-color-accent-4: #4700a0; \n\n24\n\n \n25\n\n // HIERARCHY \n\n26\n\n --fs-color-primary-bkg: var(--fs-color-main-4); \n\n27\n\n --fs-color-primary-bkg-active: var(--fs-color-main-2); \n\n28\n\n --fs-color-primary-bkg-light: var(--fs-color-main-0); \n\n29\n\n --fs-color-primary-bkg-light-active: var(--fs-color-main-1); \n\n30\n\n \n31\n\n // SITUATIONS \n\n32\n\n --fs-color-success-bkg: #cee8de; \n\n33\n\n --fs-color-warning-bkg: #f6e0ba; \n\n34\n\n \n35\n\n // COMPONENTS & STATES \n\n36\n\n --fs-color-text-display: var(--fs-color-main-4); \n\n37\n\n \n38\n\n --fs-color-action-bkg: var(--fs-color-accent-3); \n\n39\n\n --fs-color-action-bkg-hover: var(--fs-color-accent-2); \n\n40\n\n --fs-color-action-bkg-active: var(--fs-color-accent-1); \n\n41\n\n \n42\n\n // -------------------------------------------------------- \n\n43\n\n // Typography (Branding Core) \n\n44\n\n // -------------------------------------------------------- \n\n45\n\n \n46\n\n // FACE \n\n47\n\n --fs-text-face-body: 'Lato', -apple-system, system-ui, BlinkMacSystemFont, sans-serif; \n\n48\n\n \n49\n\n // -------------------------------------------------------- \n\n50\n\n // Refinements \n\n51\n\n // -------------------------------------------------------- \n\n52\n\n \n53\n\n // BORDERS \n\n54\n\n --fs-border-radius: 0.25rem; \n\n55\n\n \n56\n\n // SHADOW \n\n57\n\n --fs-shadow: none; \n\n58\n\n --fs-shadow-darker: 0 0 10px rgb(0 0 0 / 20%); \n\n59\n\n --fs-shadow-hover: 0 1px 4px rgb(0 0 0 / 10%), 0 6px 8px rgb(0 0 0 / 10%); \n\n60\n\n \n61\n\n // -------------------------------------------------------- \n\n62\n\n // FS UI Components \n\n63\n\n // -------------------------------------------------------- \n\n64\n\n // Add here the customizations for FastStore UI components. \n\n65\n\n \n66\n\n --fs-logo-width: 8rem; \n\n67\n\n \n68\n\n [data-fs-product-card] { \n\n69\n\n --fs-product-card-border-color: transparent; \n\n70\n\n --fs-product-card-border-color-hover: var(--fs-border-color-light); \n\n71\n\n \n72\n\n &[data-fs-product-card-bordered='true'] { \n\n73\n\n --fs-product-card-border-color: var(--fs-border-color-light); \n\n74\n\n } \n\n75\n\n \n76\n\n } \n\n77\n\n } \n\n78\n\n} \n\n`\n\n1. Go to `discovery.config.js` and change the `theme` to `soft-blue`:\n\n`1\n\ntheme: 'soft-blue', \n\n`\n\n1. To preview how the new theme looks in your store, open the terminal, run `yarn dev`, and access the local server.\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/soft-blue.mdx)\n\n[Themes reference« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/themes-overview)[MidnightNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/themes-midnight)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Use soft-blue as your theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/themes-soft-blue%23use-soft-blue-as-your-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/soft-blue.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Use soft-blue as your theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue/docs/guides/faststore/themes-soft-blue%23use-soft-blue-as-your-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_2e7a8e9d
|
[
{
"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 service integration guide 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-service-integration-guide/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/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-service-integration-guide/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-service-integration-guide/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-service-integration-guide/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-service-integration-guide/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-service-integration-guide/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/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-service-integration-guide/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-service-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-services-overview)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-services-specification)\n\n[Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-services-recipe)\n\n[Tax Protocol GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-protocol-graphql-api)\n\n[Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-services-reference-implementation)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/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-service-integration-guide/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/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-service-integration-guide/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-service-integration-guide/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/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-service-integration-guide/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-service-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-services-overview)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-services-specification)\n\n[Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-services-recipe)\n\n[Tax Protocol GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-protocol-graphql-api)\n\n[Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-services-reference-implementation)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/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-service-integration-guide/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/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-service-integration-guide/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-service-integration-guide/docs/guides)\n\nIntegration Guides\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-service-integration-guide)\n\nTax Service\n\nProtocol that defines how to build an integration of an external tax provider to VTEX.\n\n## Summary\n\n[ Overview A high-level explanation about how the Tax Protocol works ](tax-services-overview) \n\n[ Specification Understanding the protocol specification to better work with it ](tax-services-specification) \n\n[ Recipe Follow these steps to create your project using Tax Protocol ](tax-services-recipe) \n\n[ Reference Implementations Get to know best practices by checking these references. ](tax-services-reference-implementation) \n\nContributors\n\n1\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/tax-service-integration-guide.md)\n\n[Adding telesales impersonated email using the Session Manager« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide//docs/guides/adding-telesales-impersonated-email-using-the-session-manager)[OverviewNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide//docs/guides/tax-services-overview)\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-service-integration-guide%23summary)\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.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-service-integration-guide%23summary)\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_b70cfa3b
|
[
{
"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 catalog integration 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/catalog-integration/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/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/catalog-integration/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/catalog-integration/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/catalog-integration/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/catalog-integration/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/catalog-integration/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/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/catalog-integration/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/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/catalog-integration/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/catalog-integration/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/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/catalog-integration/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/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/catalog-integration/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/catalog-integration/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/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/catalog-integration/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/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/catalog-integration/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/catalog-integration/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/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/catalog-integration/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/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/catalog-integration/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/catalog-integration/docs/guides)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/catalog-integration)\n\nCatalog\n\nVTEX Catalog architecture is based on five fundamental concepts:\n\n* [Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/categories)\n* [Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/brands)\n* [Product](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/products)\n* [SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/skus)\n* [Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/specifications) ([product](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/product-specifications) and [SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/sku-specifications) attributes)\n\nBefore uploading your entire catalog to VTEX it is very important to think carefully about your desired catalog structure. The way you structure your catalog and product specifications can have a great impact on site navigation, order integration and other aspects of your store.\n\nIn VTEX, the category tree is the backbone of the Catalog. Categories represent the way you organize your products so that the user can easily find the desired products.\n\nWhen organized into categories, products can be classified hierarchically. Usually in up to three levels: department, category, and subcategory.\n\nVTEX Intelligent Search doesn't have a limit of category levels. Category works as an attribute. On the other hand, running under Classic CMS, we strongly suggest using a maximum of three levels.\n\nFor a product to be made available in your store, it must:\n\n* Be part of a brand, a category.\n* Have at least one active SKU.\n\n**Brands** are also an important aspect to consider, as it is very common for clients to search for products using them as a keyword. When brands are associated with products, you can use them as filters in your store navigation.\n\nVTEX Catalog structure requires that an SKU can only be created after defining product information since the SKU itself is the product variation. Therefore, we can say that an SKU is the physical unit of a product in stock.\n\nVTEX Catalog architecture also includes specifications, which are a category’s registered properties that attribute specific characteristics to products and SKUs linked to it.\n\nSuch specifications are, for example, SKU voltage, size, or color.\n\nAn example of a VTEX Catalog architecture blueprint is found below:\n\n\n\n## Integration flow\n\nCatalog integration must follow a specific workflow. The registers are related to each other, so following the correct order below is crucial:\n\n1. Department and Categories\n2. Specifications Fields\n3. Brand\n4. Products\n5. SKUs\n6. Product/SKU Specifications\n\n## Registering products\n\nVTEX provides three different ways to register products to a catalog:\n\n1. **API Integration:** the collection with all methods can be found at the following link: [Catalog API Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23overview).\n2. **Spreadsheets:** there are two possible ways to import a spreadsheet with your Catalog information. They are: a. **Google Drive Import:** import the Catalog from a single Google Drive file. See the [google-import app details](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/google-import)b. **Classic Method:** import the Catalog using multiple files (product, SKU, specification, image)\n3. **Manual input:** [Catalog data is loaded manually into VTEX Admin panel](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/1ROhz3Y7mfSMmCO1I1GxEL), by filling out each field.\n\nIn order to import your products, it is possible that you have to use more than one method, depending on how the data is structured and what types of software are used in your operation.\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/cvarela0702)\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.md)\n\n[Implementing reCAPTCHA in integrations« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration//docs/guides/implementing-recaptcha-in-integrations)[CategoriesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration//docs/guides/categories)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/cvarela0702)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/catalog-integration%23integration-flow)\n\n[Registering products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/catalog-integration%23registering-products)\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.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/catalog-integration%23integration-flow)\n\n[Registering products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/catalog-integration%23registering-products)\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_13044c06
|
[
{
"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 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/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/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/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/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/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/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/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n---\n\nStore performance\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n---\n\nStore performance\n\n---\n\nTroubleshooting\n\nFind practical solutions to development issues in our troubleshooting guides.\n\n\n\nFilters\n\n[I can't update the EAN of my SKUs via APIUpdating EANs in VTEX can lead to catalog sync issues affecting inventory.CatalogSKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api)\n\n[I am getting 500 errors in VTEX IO CLIRunning VTEX IO CLI commands returns a 500 internal server errorVTEX IOVTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration appErrors with the service configuration app occur depending on your workspace configurationVTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[I can't install VTEX IO CLIWhen installing VTEX IO CLI, it returns \"Error: Cannot find module vtex\".Store FrameworkVTEX IOVTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n* 1\n* 2\n* 3\n* ...\n* 6\n* 7\n\nStill having trouble?\n\n[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)\n\nThe VTEX Community is an ecosystem where our clients and partners can interact, ask questions, and exchange information among themselves. It's the go-to place to find answers and talk about VTEX products.\n\n[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/category/troubleshooting--39pDkp8qxSll6mGj0tWViz)\n\nThe Help Center contains beginner tutorials, reference guides and troubleshooting articles about the VTEX Admin panel.\n\n[Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support)\n\nAll clients have access to the services provided by our Technical Support team. These specialists are extensively prepared to give you the best experience possible when solving your tickets. To contact them, you need to open a ticket to VTEX support.\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_593e2905
|
[
{
"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 bulk import buyer organizations spreadsheet 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/bulk-import-buyer-organizations-spreadsheet/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/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/bulk-import-buyer-organizations-spreadsheet/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/bulk-import-buyer-organizations-spreadsheet/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/bulk-import-buyer-organizations-spreadsheet/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/bulk-import-buyer-organizations-spreadsheet/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/bulk-import-buyer-organizations-spreadsheet/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/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/bulk-import-buyer-organizations-spreadsheet/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\nB2B Organizations\n\n[Bulk Import Buyer Organizations Spreadsheet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet)\n\n[How to configure tradeName to use in the organization search field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field)\n\n[Enabling an access control list ACL in B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/enabling-an-access-control-list-acl-in-b2b-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/bulk-import-buyer-organizations-spreadsheet/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/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/bulk-import-buyer-organizations-spreadsheet/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/bulk-import-buyer-organizations-spreadsheet/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/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/bulk-import-buyer-organizations-spreadsheet/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\nB2B Organizations\n\n[Bulk Import Buyer Organizations Spreadsheet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet)\n\n[How to configure tradeName to use in the organization search field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field)\n\n[Enabling an access control list ACL in B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/enabling-an-access-control-list-acl-in-b2b-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/bulk-import-buyer-organizations-spreadsheet/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/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/bulk-import-buyer-organizations-spreadsheet/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/bulk-import-buyer-organizations-spreadsheet/docs/guides)\n\nB2B Suite\n\nB2B Organizations\n\n[Bulk Import Buyer Organizations Spreadsheet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet)\n\nBulk Import Buyer Organizations Spreadsheet\n\nThis guide will walk you through the process of filling out the bulk import spreadsheet for use with the [Bulk Import API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations) to efficiently manage Buyer Organizations, Cost Centers, and Members through bulk import functionality.\n\n## Before you begin\n\nTo use the bulk import of buyer organizations, you must first install and configure the [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite) which includes the [B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations) app.\n\n> Bulk Import does not allow updating (editing) existing data in organizations or cost centers. This functionality is exclusively intended for creating and managing members.\n\n## Step-by-step\n\n1. Download the [template file](https://read.calvincode.net/reader?url=https://images.ctfassets.net/alneenqid6w5/PkYPXgHoDpok9ajVXQcM2/e5ff6b732ad776d2d04946855e109f15/b2b-bulk-import-template%5Fv1.xlsx).\n2. Fill in the file with buyer organizations data following the specifications detailed in [File structure for import](#file-structure-for-import).\n\n> Ensure your file is in `.xlsx` format and does not exceed 50MB.\n\n1. Once your file is ready, upload it by making a request to the [Upload file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations%23post-/api/b2b/import/buyer-orgs) endpoint.\n2. Validate file content by making a request to the [Validate file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations%23post-/api/b2b/import/buyer-orgs/validate/-importId-) endpoint.\n3. Once the file is successfully validated, start the bulk data import by making a request to the [Start import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations%23post-/api/b2b/import/buyer-orgs/-importId-) endpoint.\n\n## File structure for import\n\nBefore starting the upload and import process, it is essential to understand the required file structure. Ensure your import file adheres to the guidelines outlined below.\n\n### File tabs\n\nThe import file should be structured with up to three tabs, each serving a distinct purpose:\n\n1. [Buyer Orgs tab](#columns-in-the-buyer-orgs-tab): Contains detailed information about buyer organizations.\n2. [Cost Centers tab](#columns-in-the-cost-centers-tab): Dedicated to managing cost centers within organizations.\n3. [Members tab](#columns-in-the-members-tab): Stores information regarding members associated with organizations and cost centers.\n\n### Columns in the Buyer Orgs tab\n\nEach new organization should have one cost center in the Buyer Orgs tab. Additional columns for each custom field configured for the merchant can be added at the end of the Buyer Orgs tab.\n\nCheck the default columns present in this tab in the table below. Mandatory information is marked with `*`.\n\n| Column | Type | Description |\n| ------------------- | ------ | ---------------------------------------------------------------------------------------- |\n| Buyer Org ID\\* | String | Unique identifier for the buyer organization, for tracking and future updates. |\n| Buyer Org Name\\* | String | Official name of the buyer organization. |\n| Admin First Name\\* | String | First name of the administrator overseeing the buyer organization. |\n| Admin Last Name\\* | String | Last name of the administrator overseeing the buyer organization. |\n| Admin Email\\* | String | Administrator's email address serves as the organization's primary point of contact. |\n| Cost Center ID\\* | String | Unique identifier for the cost center essential for tracking and future updates. |\n| Cost Center Name\\* | String | Name assigned to the cost center. |\n| Address Type\\* | String | Classification of the address (e.g., residential, commercial). |\n| Postal Code\\* | String | Postal code corresponding to the address. |\n| Street\\* | String | Street name of the address. |\n| Number\\* | String | Numerical identifier for the location (house/building number). |\n| Complement\\* | String | Additional information regarding the address if any. |\n| Neighborhood\\* | String | Neighborhood of the address. |\n| City\\* | String | City where the address is located. |\n| State\\* | String | State where the address is situated. |\n| Country\\* | String | Country of the address. |\n| Receiver Name\\* | String | Name of the individual who is the point of contact at the address. |\n| Phone Number\\* | String | Contact number for the receiver. |\n| Business Document\\* | String | Document that contains essential business information (e.g., tax identification number). |\n| Collections | String | Collections allowed to the buyer organization, separated by comma. |\n| Price Tables | String | Price tables allowed to the buyer organization, separated by comma. |\n| Payment Terms | String | Payment terms allowed to the buyer organization, separated by comma. |\n| Trade Policies | String | Trade policies allowed to the buyer organization, separated by comma. |\n| Sellers | String | Sellers allowed to the buyer organization, separated by comma. |\n\n### Columns in the cost centers tab\n\nThis tab is required only for organizations with multiple cost centers. If the buyer organization has only one cost center, do not fill this tab.\n\nCheck the default columns present in the Cost Centers tab in the table below. Mandatory information is marked with `*`.\n\n| Column | Type | Description |\n| ------------------- | ------ | --------------------------------------------------------------------------------------- |\n| Buyer Org ID\\* | String | Unique identifier for the buyer organization essential for tracking and future updates. |\n| Cost Center ID\\* | String | Unique identifier for the cost center essential for tracking and future updates. |\n| Cost Center Name\\* | String | Name assigned to the cost center. |\n| Address Type\\* | String | Classification of the address (e.g., residential, commercial). |\n| Postal Code\\* | String | Postal code corresponding to the address. |\n| Street\\* | String | Street name of the address. |\n| Number\\* | String | Numerical identifier for the location (house/building number). |\n| Complement\\* | String | Additional information regarding the address. |\n| Neighborhood\\* | String | Neighborhood of the address. |\n| City\\* | String | City where the address is located. |\n| State\\* | String | State where the address is situated. |\n| Country\\* | String | Country of the address. |\n| Receiver Name\\* | String | Name of the individual who is the point of contact at the address. |\n| Phone Number\\* | String | Contact number for the receiver. |\n| Business Document\\* | String | Document that contains essential business information (e.g. tax identification number). |\n\n### Columns in the Members tab\n\nThis tab is required only for organization with multiple members. If the buyer organization has only one member, do not fill this information.\n\nCheck the default columns present in the Cost Centers tab in the table below. Mandatory information is marked with `*`.\n\n| Column | Type | Description |\n| ---------------- | ------- | ------------------------------------------------------------------------------------ |\n| Buyer Org ID\\* | String | Unique identifier linking the member to a specific buyer organization. |\n| Cost Center ID\\* | String | Identifier linking the member to a specific cost center within the organization. |\n| Name\\* | String | Member's full name used for identification and communication. |\n| Email\\* | String | Email address of the member serving as a primary point of contact for communication. |\n| Role ID\\* | GUID | Unique identifier denoting the member's role within the organization. |\n| Can Impersonate | Boolean | Indicates if the member can impersonate another user within the system. |\n\n## Custom fields\n\nTo include custom fields in your spreadsheet, follow the steps below:\n\n1. Add the desired custom fields as the last columns in your tab.\n2. Use the prefix `CF_` followed by the exact name of the custom field as registered in the system. \n * Example: If you have a custom field named `DeliveryNote`, the column should be `CF_DeliveryNote`.\n3. Fill in the values according to the data type.\n\nContributors\n\n1\n\n[](https://github.com/geisecosta)\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/B2B-Suite/b2b-organizations/bulk-import-buyer-organizations-spreadsheet.md)\n\n[Delivery Promise« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet//docs/guides/delivery-promise)[How to configure tradeName to use in the organization search fieldNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet//docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field)\n\nContributors\n\n1\n\n[](https://github.com/geisecosta)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23before-you-begin)\n\n[Step-by-step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23step-by-step)\n\n[File structure for import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23file-structure-for-import)\n\n[File tabs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23file-tabs)[Columns in the Buyer Orgs tab](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23columns-in-the-buyer-orgs-tab)[Columns in the cost centers tab](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23columns-in-the-cost-centers-tab)[Columns in the Members tab](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23columns-in-the-members-tab)\n\n[Custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23custom-fields)\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/B2B-Suite/b2b-organizations/bulk-import-buyer-organizations-spreadsheet.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/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23before-you-begin)\n\n[Step-by-step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23step-by-step)\n\n[File structure for import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23file-structure-for-import)\n\n[File tabs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23file-tabs)[Columns in the Buyer Orgs tab](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23columns-in-the-buyer-orgs-tab)[Columns in the cost centers tab](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23columns-in-the-cost-centers-tab)[Columns in the Members tab](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23columns-in-the-members-tab)\n\n[Custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23custom-fields)\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_aaf19224
|
[
{
"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 listrak pixel 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.listrak-pixel/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/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.listrak-pixel/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.listrak-pixel/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.listrak-pixel/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.listrak-pixel/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.listrak-pixel/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/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.listrak-pixel/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.listrak-pixel/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/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.listrak-pixel/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.listrak-pixel/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.listrak-pixel/docs/vtex-io-apps)\n\nListrak\n\nOfficial extension\n\nVersion: 2.6.1\n\nLatest version: 2.6.1\n\n## ⚠️ Maintenance ⚠️\n\n_Starting June 1st 2023, this application will no longer be maintained by VTEX._\n\n---\n\nThis app provides pixel integration for Listrak metrics and cart abandonment functionality, and provides related routes and blocks for use in an account's store-theme.\n\nAdditionally, if you would like the app to send Order, Product, and Customer data to Listrak, you can create a [Listrak Data Integration](#Listrak-Data-Integration).\n\n## Configuration\n\n1. [Install](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/store/installing-an-app) the `listrak-pixel` app in the desired account;\n2. In the account's admin, access **Apps > My Apps** and then select the **Listrak** box;\n3. Once in the app's page, define the app’s configurations in the **Setup** section:\n* **Merchant ID**: Input your Listrak Merchant ID here.\n* **Subscription Point ID**: Input your `Subscribe ID` of the email Subscription Point from your Listrak account.\n* **Subscription Form IDs**: To capture a shoppers opt-in to an email subscription, enter the field IDs associated with the subscription form email input and submit button. Enter both IDs separated with commas and no spaces like `emailInputId,submitButtonId`. **If the Newsletter block from the `vtex.store-component` is used, no entry is necessary**.\n* **Email Input Field IDs**: Listrak's cart abandonment feature works in part by capturing email addresses when shoppers type them into certain fields. These field IDs can be specified here, separated with commas and no spaces like `emailField1,emailField2`.\n* **Preference Center Name**: This app creates a new store route with the path `/preference-center` which displays the Listrak Preference Center. Referencing your Listrak Preference Center integration instructions, input the value for the `data-ltk-prefcenter` attribute of the Preference Center div here.\n\nThe settings below are only needed if you have created a [Listrak Data Integration](#Listrak-Data-Integration).\n\n* **Client ID**: Your Listrak Data Integration Client ID.\n* **Client Secret**: Your Listrak Data Integration Client Secret.\n* **Full Catalog Import**: Send your entire product catalog to Listrak. This will happen on the first SKU update after enabling the option.\n* **Use SKU Reference ID**: Send Listrak SKU reference IDs instead of VTEX SKU IDs.\n* **Image Size (in pixels)**: Set dimensions for images imported to Listrak. If left blank, the default size for your store's thumbnail images wil be used, usually 100x100 pixels.\n\n**Listrak Fields and Values (Optional)**\n\nThe following optional settings allow you to map VTEX product specifications to specific Listrak fields. If left blank, they will be filled according to the default behavior explained below:\n\n* **Category**: Input the name of the product specification field containing the product's main category. If left blank, this will be automatically set as the first category that the product belongs to.\n* **Sub Category**: Input the name of the product specification field containing the product's secondary category. If left blank, this will be automatically set as \"Type/Silhouette\".\n* **Meta 1**: Input the name of the product specification field containing any additional data you wish to send. If left blank, this will be automatically set as a pipe-separated list of the item's unique SKU specifications.\n* **Meta 2**: Input the name of the product specification field containing any additional data you wish to send. If left blank, this will be automatically set with a placeholder value of \"meta\\_2\".\n* **Meta 3**: Input the name of the product specification field containing any additional data you wish to send. If left blank, this will be automatically set with a placeholder value of \"meta\\_3\".\n\n## (Optional) On-Site Recommendation Integration Block\n\nTo use this optional block in your `store-theme`, you must add the Listrak app to your `store-theme`'s peer dependencies in `manifest.json`:\n\n`1\n\n\"peerDependencies\": { \n\n2\n\n \"vtex.listrak-pixel\": \"1.x\" \n\n3\n\n } \n\n`\n\nThen you may use this block in your layouts:\n\n* `\"listrak-recommendations\"`: The Listrak app provides this block which is designed to be added to the product page (`store.product`). It renders Listrak's On-Site Recommendations product shelf. The block takes two props:\n\n| Prop name | Type | Description |\n| ------------------ | ------ | ----------------------------------------------------------------------- |\n| merchandiseBlockId | String | The Merchandise Block ID from Listrak's admin. Default: '' |\n| templateHTML | String | The HTML template for the recommender from Listrak's admin. Default: '' |\n\n:warning: Both props must be filled for the component to render.\n\nExample - Listrak provides sample template code that looks like this:\n\n`1\n\n<div \n\n2\n\n data-ltk-merchandiseblock=\"sample-merchandise-block-id\" \n\n3\n\n style=\"width:100%; padding:40px 0;\" \n\n4\n\n> \n\n5\n\n <script type=\"text/html\"> \n\n6\n\n <div style=\"box-sizing:border-box; vertical-align:top; display:inline-block; width:25%; padding:20px;\"> \n\n7\n\n <a href=\"@Recommendation.LinkUrl\"><img src=\"@Recommendation.ImageUrl\" title=\"@Recommendation.Title\" style={{ display: \"block\", width: \"auto\", height: \"100%\", maxHeight: \"200px\", margin: \"auto\", }} /></a> \n\n8\n\n <a href=\"@Recommendation.LinkUrl\" title=\"@Recommendation.Title\" style={{ display: \"block\", width: \"100%\", fontFamily: \"Segoe UI,Roboto,Helvetica Neue,sans-serif\", fontSize: \"15px\", fontWeight: \"500\", color: \"#333\", textDecoration: \"none\", textAlign: \"center\", paddingTop: \"8px\", }}>@Recommendation.Title</a> \n\n9\n\n <a href=\"@Recommendation.LinkUrl\" title=\"@Recommendation.Title\" style={{ display: \"block\", width: \"100%\", fontFamily: \"Segoe UI,Roboto,Helvetica Neue,sans-serif\", fontSize: \"13px\", fontWeight: \"700\", color: \"#d43e3e\", textDecoration: \"none\", textAlign: \"center\", paddingTop: \"8px\", }}>$@Recommendation.Price</a> \n\n10\n\n </div> \n\n11\n\n </script> \n\n12\n\n</div> \n\n`\n\nIn this case, your block's props would look like this:\n\n`1\n\n\"listrak-recommendations#example\": { \n\n2\n\n \"props\": { \n\n3\n\n \"merchandiseBlockId\": \"sample-merchandise-block-id\", \n\n4\n\n \"templateHTML\": \"<div style='box-sizing:border-box; vertical-align:top; display:inline-block; width:25%; padding:20px;'><a href='@(window.location.origin + Recommendation.LinkUrl)'><img src='@Recommendation.ImageUrl' title='@Recommendation.Title' style='display:block; width:auto; height: 100%; max-height:200px; margin:auto;' /></a><a href='@(window.location.origin + Recommendation.LinkUrl)' title='@Recommendation.Title' style='display:block; width:100%; font-family:Segoe UI,Roboto,Helvetica Neue,sans-serif; font-size: 15px; font-weight: 500; color:#333;text-decoration:none; text-align:center; padding-top:8px;'>@Recommendation.Title</a><a href='@(window.location.origin + Recommendation.LinkUrl)' title='@Recommendation.Title' style='display:block; width:100%; font-family:Segoe UI,Roboto,Helvetica Neue,sans-serif; font-size: 13px; font-weight: 700; color:#d43e3e; text-decoration:none; text-align:center; padding-top:8px;'>$@Recommendation.Price</a></div>\" \n\n5\n\n } \n\n6\n\n}, \n\n`\n\n:warning: Note that the HTML has all been combined into a single line, and double quotes `\"` replaced with single quotes `'`.\n\n:warning: Also note that each `@Recommendation.LinkUrl` has been replaced with `@(window.location.origin + Recommendation.LinkUrl)`. This is because the `LinkUrl` stored for each product in Listrak is a relative URL. `ImageUrl` does NOT need this same treatment because each `ImageUrl` is already an absolute URL.\n\n## Checkout Integration\n\nTo finalize a Listrak integration, custom JS code must be added to checkout in the `checkout6-custom.js` file:\n\n`1\n\n// Listrak \n\n2\n\n$(document).ready(function() { \n\n3\n\n var prevItems = [] \n\n4\n\n $(window).on('orderFormUpdated.vtex', function(evt, orderForm) { \n\n5\n\n ;(function() { \n\n6\n\n if (typeof _ltk == 'object') { \n\n7\n\n ltkCode() \n\n8\n\n } else { \n\n9\n\n ;(function(d) { \n\n10\n\n if (document.addEventListener) \n\n11\n\n document.addEventListener('ltkAsyncListener', d) \n\n12\n\n else { \n\n13\n\n e = document.documentElement \n\n14\n\n e.ltkAsyncProperty = 0 \n\n15\n\n e.attachEvent('onpropertychange', function(e) { \n\n16\n\n if (e.propertyName == 'ltkAsyncProperty') { \n\n17\n\n d() \n\n18\n\n } \n\n19\n\n }) \n\n20\n\n } \n\n21\n\n })(function() { \n\n22\n\n ltkCode() \n\n23\n\n }) \n\n24\n\n } \n\n25\n\n function ltkCode() { \n\n26\n\n _ltk_util.ready(function() { \n\n27\n\n _ltk.SCA.CaptureEmail('client-pre-email') \n\n28\n\n if (JSON.stringify(orderForm.items) != JSON.stringify(prevItems)) { \n\n29\n\n if (orderForm.items.length > 0) { \n\n30\n\n orderForm.items.forEach(item => { \n\n31\n\n _ltk.SCA.AddItemWithLinks( \n\n32\n\n item.id, \n\n33\n\n item.quantity, \n\n34\n\n (item.price / 100).toString(), \n\n35\n\n item.name, \n\n36\n\n item.imageUrl, \n\n37\n\n item.detailUrl \n\n38\n\n ) \n\n39\n\n }) \n\n40\n\n _ltk.SCA.Submit() \n\n41\n\n } else { \n\n42\n\n _ltk.SCA.ClearCart() \n\n43\n\n } \n\n44\n\n prevItems = orderForm.items \n\n45\n\n } \n\n46\n\n }) \n\n47\n\n } \n\n48\n\n })() \n\n49\n\n }) \n\n50\n\n}) \n\n51\n\nvar biJsHost = 'https:' == document.location.protocol ? 'https://' : 'http://' \n\n52\n\n;(function(d, s, id, tid, vid) { \n\n53\n\n var js, \n\n54\n\n ljs = d.getElementsByTagName(s)[0] \n\n55\n\n if (d.getElementById(id)) return \n\n56\n\n js = d.createElement(s) \n\n57\n\n js.id = id \n\n58\n\n js.src = \n\n59\n\n biJsHost + 'cdn.listrakbi.com/scripts/script.js?m=' + tid + '&v=' + vid \n\n60\n\n ljs.parentNode.insertBefore(js, ljs) \n\n61\n\n})(document, 'script', 'ltkSDK', 'LISTRAK-MERCHANT-ID', '1') \n\n62\n\n// end Listrak \n\n`\n\n:warning: Make sure to replace `'LISTRAK-MERCHANT-ID'` in the second-to-last line with your Listrak Merchant ID. No other customizations are needed.\n\n## Listrak Data Integration\n\nEnabling this feature will send additional Order, Customer, and Product data to listrak.\n\n* Orders data is sent when an order has been invoiced and/or updated if canceled.\n* Customer data is sent when the order is invoiced.\n* Product data is sent when a SKU has been created or updated.\n\nTo provide additional data to Listrak, you will need to create a new integration from the Listrak application and allow access to the Listrak API. Listrak provides some instructions [here](https://read.calvincode.net/reader?url=https://api.listrak.com/data%23section/INTEGRATION-SETUP).\n\n**Access Levels**\n\nThe app supports sending Order, Customer, and Product data and will need these access levels selected.\n\n**IP Address Whitelist**\n\nThere are three possible IPs the app may use to send data to the Listrak API, these will need to be added to the integration's whitelist.\n\n* 34.199.112.14\n* 107.23.210.212\n* 52.73.206.45\n\n## Customization\n\nIn order to apply CSS customizations to this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles |\n| --------------- |\n| recommendations |\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[⚠️ Maintenance ⚠️](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/apps/vtex.listrak-pixel%23-maintenance-)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/apps/vtex.listrak-pixel%23configuration)\n\n[(Optional) On-Site Recommendation Integration Block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/apps/vtex.listrak-pixel%23optional-on-site-recommendation-integration-block)\n\n[Checkout Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/apps/vtex.listrak-pixel%23checkout-integration)\n\n[Listrak Data Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/apps/vtex.listrak-pixel%23listrak-data-integration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/apps/vtex.listrak-pixel%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_c821bbc1
|
[
{
"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 productsummarybuybutton 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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/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.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/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.product-summary/productsummarybuybutton/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.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/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/productsummarybuybutton/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/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.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/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.product-summary/productsummarybuybutton/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.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/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/productsummarybuybutton/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/guides/basic-components)\n\nProduct Summary Buy Button\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\nProduct Summary Buy Button is the block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-summary) responsible for rendering a Buy Button in the [Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-summary-productsummaryshelf) block.\n\n\n\n> **The Product Summary Buy Button only effectively adds products to the Minicart if the store still uses the [Minicart v1](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/minicart/blob/383d7bbd3295f06d1b5854a0add561a872e1515c/docs/README.md)**. If the store uses the [Minicart v2](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/all/vtex.minicart/), please configure the [Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-add-to-cart-button/) in the `product-summary.shelf` block instead.\n\n## Configuration\n\n1. Import the `vtex.product-summary` app to your theme's dependencies in the `manifest.json`:\n\n`1\n\n dependencies: { \n\n2\n\n \"vtex.product-summary\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-summary-buy-button` block as a children of the `product-summary.shelf` block:\n\n`1\n\n { \n\n2\n\n \"product-summary.shelf\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"product-summary-image\", \n\n5\n\n \"product-summary-name\", \n\n6\n\n \"product-rating-inline\", \n\n7\n\n \"product-summary-space\", \n\n8\n\n \"product-summary-price\", \n\n9\n\n+ \"product-summary-buy-button\" \n\n10\n\n ] \n\n11\n\n }, \n\n12\n\n } \n\n`\n\n1. Then, declare the `product-summary-buy-button` and configure its behavior using the props stated below.\n\n`1\n\n{ \n\n2\n\n \"product-summary-buy-button\": { \n\n3\n\n \"props\": { \n\n4\n\n \"isOneClickBuy\": false \n\n5\n\n } \n\n6\n\n } \n\n7\n\n} \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| ----------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |\n| isOneClickBuy | boolean | Whether the user should be redirected to Checkout after clicking on the Buy Button (true) or not (false). | false |\n| buyButtonText | string | Custom text that overwrites the default Buy Button text. | undefined |\n| displayBuyButton | enum | Sets the Buy Button display mode. Possivle values are: displayButtonAlways (it will always be displayed), displayButtonHover (only displayed on hover), or displayButtonNone (it will be hidden for users). | displayButtonAlways |\n| customToastURL | string | Defines a redirect link to the Toast displayed when an item is added to your cart. | /checkout/#/cart |\n| buyButtonBehavior | enum | Sets the Buy Button behavior when it is clicked on. Possible values are: alwaysGoToProduct (redirect users to the product page), default (redirect users to the minicart), or alwaysAddToTheCart (add the selected SKU to the minicart). When choosing this last option, be careful: use it only if there are SKU Selectors for each product variation. This way, users can properly select their desired SKU. | default |\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| buyButtonContainer |\n| buyButton |\n| isHidden |\n\n[Product Summary Attachment List« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary/productsummaryattachmentlist)[Product Summary DescriptionNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary/productsummarydescription)\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/productsummarybuybutton/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[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary/productsummarybuybutton%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary/productsummarybuybutton%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton/docs/apps/vtex.product-summary/productsummarybuybutton%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_1e797a09
|
[
{
"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 making your theme content public 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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/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-making-your-theme-content-public/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/docs/guides/store-framework)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/docs/guides/getting-started-3)\n\n[7\\. Making your store theme public](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/docs/guides/vtex-io-documentation-making-your-theme-content-public)\n\n7\\. Making your theme content public\n\nLearn how to make your Store Framework theme public.\n\nA [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme) is a VTEX IO app that operates like any other app with built-in features such as versioning and deployment.\n\nIn this guide, you'll find instructions on how to make your Store Theme available to end users.\n\n## Instructions\n\nIf you're satisfied with the configurations you've made and want your theme to be available to all users, follow the steps below:\n\n1. [**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](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/) to test your changes.\n2. [**Release**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-releasing-a-new-app-version/) the theme.\n3. [**Publish**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/) it as a release candidate version.\n4. [**Install**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/) the theme in a [production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/) to test your changes with traffic.\n5. [**Validate**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/) it as a release candidate if no more changes are needed. Otherwise, go back to step 1 and use a development workspace. **Don't perform changes in a production workspace**.\n6. [**Deploy**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/) it as a stable version if you're sure about all the changes you've made.\n7. [**Promote the production workspace to master**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/) to make your theme public to your store's end users. Follow the [Deployment and workspace promotion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspaces-best-practices%23deployment-and-workspace-promotion) best practices to deploy changes and promote workspaces seamlessly.\n\nFor more details on each of these steps, see [Making your new app version publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available/).\n\n> To publish a new major version of your Store Theme, see also [Migrating CMS settings after a major theme update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update).\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-making-your-theme-content-public.md)\n\n[6\\. Building your own store theme« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public//docs/guides/vtex-io-documentation-6-buildingyourownstoretheme)[GlossaryNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public//docs/guides/store-framework-glossary)\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\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-making-your-theme-content-public/docs/guides/vtex-io-documentation-making-your-theme-content-public%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/Getting-Started/getting-started-3/vtex-io-documentation-making-your-theme-content-public.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-making-your-theme-content-public/docs/guides/vtex-io-documentation-making-your-theme-content-public%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_6cf4f207
|
[
{
"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 region section api quick start guides 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/region-section-api-quick-start-guides/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/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/region-section-api-quick-start-guides/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/region-section-api-quick-start-guides/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/region-section-api-quick-start-guides/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/region-section-api-quick-start-guides/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/region-section-api-quick-start-guides/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/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/region-section-api-quick-start-guides/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/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/region-section-api-quick-start-guides/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/region-section-api-quick-start-guides)\n\n[Get sellers by region or address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/get-sellers-by-region-or-address)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/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/region-section-api-quick-start-guides/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/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/region-section-api-quick-start-guides/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/region-section-api-quick-start-guides/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/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/region-section-api-quick-start-guides/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/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/region-section-api-quick-start-guides/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/region-section-api-quick-start-guides)\n\n[Get sellers by region or address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/get-sellers-by-region-or-address)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/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/region-section-api-quick-start-guides/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/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/region-section-api-quick-start-guides/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/region-section-api-quick-start-guides/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/checkout-api-overview)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides/docs/guides/region-section-api-quick-start-guides)\n\nRegion\n\nThis section contains the quick start guides of the endpoints described in the [Region section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview%23region) of the Checkout API Reference.\n\n* [Get sellers by region or address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address)\n\nContributors\n\n1\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/region-section-api-quick-start-guides.md)\n\n[Get address by postal code« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides//docs/guides/get-address-by-postal-code)[Get sellers by region or addressNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/region-section-api-quick-start-guides//docs/guides/get-sellers-by-region-or-address)\n\nContributors\n\n1\n\n[](https://github.com/ricardoaerobr)\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/region-section-api-quick-start-guides.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_eb511805
|
[
{
"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 basic components in VTEX."
},
{
"role": "assistant",
"content": "Title: Basic components\n\nURL Source: https://developers.vtex.com/docs/guides/basic-components\n\nMarkdown Content:\nBasic components\n\nUse our storefront components to create a seamless shopping experience for your customers.\n\n[Add to cart Button A button for adding items into the shopping cart. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button)[Breadcrumb Navigation scheme that shows a user's browsing history up to their current location in your store. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb)[Footer Displays your store's Footer. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer)[Google One-Tap Login Google One-tap delivers a seamless experience with a small pop-up that can authenticate a userwith a streamlined interface. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-one-tap-login)[Header Displays your store's Header. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-header)[Locale Switcher Component responsible for changing the current language of the store. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher)[Login Handles every functionality related to user login. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login)[Menu Rendersthe Menu component, displaying a bar containing links and drop-down sub-menus. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu)[Minicart Fetching data from the Checkout OrderForm API, the Minicart component displays a summary list of allitems added by customers in their shopping cart. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart)[Order Placed Renders the the orderPlaced page with all order data. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.order-placed)[Product Customizer Allows a product's attachments to be made available and ready to be chosen by users from theproduct page. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer)[Product Identifier Shows a product identifier, such as the product reference, product ID, sku EAN or skureference. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier)[Product List Works with Minicar to display all items in the user's cart, informing when some of them are unavailable. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list)[Product Price The app exports blocks related to the product's price, such as list price, selling price and savings. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price)[Product Quantity Allows users to a add a chosen amount of the displayed product in their cart. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity)[Product SpecificationBadges This block is exported by the Product Summary app and it is responsible fordisplaying badges with the product's specifications in other store blocks. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryspecificationbadges)[Product Summary App responsible for summarizing product information (such as name, price and image) in otherstore blocks, such as the Shelf and the Minicart. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary)[Product Summary AttachmentList This block is exported by the Product Summary app and it is responsible fordisplaying the product's attachments in other store blocks. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist)[Product Summary Brand This block is exported by the Product Summary app and it is responsible for displaying theproduct's brand in other store blocks. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybrand)[Product Summary Buy Button This block is exported by the Product Summary app and it is responsible for displaying aBuy Button block in other store blocks. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton)[Product Summary Description This block is exported by the Product Summary app and it is responsible for displayingthe product's description in other store blocks. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription)[Product Summary Image This block is exported by the Product Summary app and it is responsible for displaying theproduct's image in other store blocks. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryimage)[Product Summary List This block is exported by the Product Summary app and it is responsible for displaying aproducts list in other store blocks. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarylist)[Product Summary Name This block is exported by the Product Summary app and it is responsible for displaying theproduct's name in other store blocks. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname)[Product Summary SKU Selector This block is exported by the Product Summary app and it is responsible for displayingthe SKU Selector block in other store blocks. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuselector)[Rich Text The Rich Text brings texts to your store and everything else that Markdown language is able to. Itconverts texts written in Markdown language and displays its content as HTML elements. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text)[Search TheVTEX Search app is responsible for handling the new VTEX Intelligent Search solution in IO stores byproviding new UI components that enhance the search experience, such as the autocomplete feature. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search)[Search Result Handles the result fetched by the VTEX Search API and displaying it to users. The app exports allstore blocks expected in a search results page, such as the filters and the product gallery. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result)[Shelf Displays a list of products in the store home page. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf)[Store Image Render an pre-defined image on the UI. See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image)\n"
}
] |
doc_a8ba18ee
|
[
{
"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 3.178.5 ProductImages 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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductImages/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductImages/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductImages/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductImages/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductImages/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/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@3.178.5/ProductImages/docs/vtex-io-apps)\n\nProduct Images\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-images` block renders an image or video configured in the SKU settings. To learn which media formats are supported, see the [Media](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/media-overview--31fhjHTt4TBoo50AmGQ9b2) section in the [Adding or editing SKUs](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/adding-or-editing-skus--4ryZ6J45kwn3jDiQBxGiiN) guide.\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 `product-images` 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-images\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n1. Declare the `product-images` block using the props stated in the [Props](#props) table. Example:\n\n`1\n\n \"product-images\": { \n\n2\n\n \"props\": { \n\n3\n\n \"displayThumbnailsArrows\": true \n\n4\n\n } \n\n5\n\n }, \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| ----------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |\n| aspectRatio | string | Sets the image aspect ratio, determining whether it should be square, portrait, landscape, etc. Follow the [common aspect ratio notation](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/Aspect%5Fratio%5F%28image%29), represented by two numbers separated by a colon, such as 1:1 for square, 3:4 for portrait, or 1920:1080 for widescreen. | \"auto\" |\n| blockClass | string | Serves as the block's unique identifier for customization. | |\n| contentOrder | 'videos-first' \\| 'images-first' | Controls the order in which the images and videos are displayed. | 'images-first' |\n| contentType | enum | Controls the type of content that will be displayed in the block. Possible values are images, videos, or all. | all |\n| displayMode | enum | Defines how the product media should be displayed. Possible values are carousel (displays the product images and videos in a carousel), list (displays only the product images inline, with no extra markup), and first-image (displays only the first image available). **The list and first-image values don't display product videos and are only compatible with the maxHeight, hiddenImages, zoomFactor, aspectRatio,ModalZoomElement, and zoomMode props**. | carousel |\n| displayThumbnailsArrows | boolean | Displays navigation arrows on the thumbnail media (if there are enough thumbnails for them to scroll). | false |\n| hiddenImages | string | Hides images with labels that match the values listed in this prop. Intended to be used with the product-summary-sku-selector block. To learn more, see the [SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/skuselector) documentation. | skuvariation |\n| maxHeight | number | Maximum height for individual product images (in pixels). | 600 |\n| ModalZoom | block | Opens a modal to zoom in on the product image. This prop value must match the name of the block that triggers the modal containing the product image for zooming (for example, modal-layout from [Modal layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/apps/vtex.modal-layout) app). The ModalZoom prop will only work if the zoomMode prop is set as open-modal. To learn more, see the [Advanced configuration section](#Advanced-configuration). | undefined |\n| placeholder | string | Sets the URL for a placeholder image to be displayed when no product image or video is available. | undefined |\n| position | enum | Sets the position of the thumbnails (left or right). Only used when thumbnailsOrientation is vertical. | left |\n| showNavigationArrows | boolean | Defines if the navigation arrows should be displayed. | true |\n| showPaginationDots | boolean | Defines if the pagination dots should be displayed. | |\n| showImageLabel | boolean | Controls if the image label text should be rendered above each image. | true |\n| thumbnailVisibility | visible or hidden | Defines if the thumbnails should be displayed in carousel displayMode. | visible |\n| thumbnailAspectRatio | string | Sets the aspect ratio of the thumbnail image. For more information about aspect ratio, check out the aspectRatio prop. | \"auto\" |\n| thumbnailMaxHeight | number | Maximum height of the thumbnail image (in pixels). | 150 |\n| thumbnailsOrientation | enum | Sets the orientation of the thumbnails. It can be vertical or horizontal. | vertical |\n| zoomFactor | number | Sets how much the zoom increases the image size (for example, 2 will make the zoomed-in image twice as large). | 2 |\n| zoomMode | enum | Sets the image zoom behavior. Possible values are disabled (zoom is disabled), in-place-click (zoom is triggered when the image is clicked), in-place-hover (zoom is triggered when the image is hovered on), and open-modal (image is zoomed using a modal). | in-place-click |\n\n### Advanced configuration\n\nIn this section, you’ll learn how to use modal zoom, a property that allows you to open a popup displaying a product image for zooming. To use this feature, configure the `product-images` block by setting the `zoomMode` and `ModalZoom` props to `open-modal` and `modal-layout`, respectively.\n\nWhen configured as explained, the `zoomMode` prop allows the image to trigger a modal for zooming. Additionally, the `MozalZoom` prop will render the block defined as its value. In this case, the `modal-layout` is required. This allows you to configure a modal containing the product image for zooming.\n\nOnce both props are correctly configured, you must declare the `modal-layout` block and the `product-images.high-quality-image` block as its child.\n\nThe `modal-layout` block renders the modal component and triggers the image zoom in a popup box. The `product-images.high-quality-image` block, in turn, is a _special_ block used exclusively to render the `product-image` block inside the modal.\n\nExample:\n\n`1\n\n{ \n\n2\n\n \"product-images.high-quality-image\": { \n\n3\n\n \"props\": { \n\n4\n\n \"zoomMode\": \"in-place-click\", \n\n5\n\n \"zoomFactor\": 2 \n\n6\n\n } \n\n7\n\n }, \n\n8\n\n \"modal-layout#product-zoom\": { \n\n9\n\n \"children\": [ \n\n10\n\n // you can put any other block inside the modal, \n\n11\n\n // this is just a normal modal \n\n12\n\n \"flex-layout.row#product-name\", \n\n13\n\n \"product-images.high-quality-image\" \n\n14\n\n ] \n\n15\n\n }, \n\n16\n\n \"product-images\": { \n\n17\n\n \"props\": { \n\n18\n\n \"ModalZoom\": \"modal-layout#product-zoom\", \n\n19\n\n // to use the ModalZoom, the product-images zoomMode value must be set as open-modal \n\n20\n\n \"zoomMode\": \"open-modal\", \n\n21\n\n \"aspectRatio\": { \n\n22\n\n \"desktop\": \"auto\", \n\n23\n\n \"phone\": \"16:9\" \n\n24\n\n } \n\n25\n\n } \n\n26\n\n } \n\n27\n\n} \n\n`\n\nThe `product-images.high-quality-image` block must be declared as a child of `modal-layout`. You can also declare other blocks exported by the [Modal Layout app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout) as children.\n\nThe following table shows the props allowed by `product-images.high-quality-image`:\n\n| Prop name | Type | Description | Default value |\n| ----------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| aspectRatio | string | Sets the image aspect ratio, determining whether it should be square, portrait, landscape, etc. Follow the [common aspect ratio notation](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/Aspect%5Fratio%5F%28image%29), represented by two numbers separated by a colon, such as 1:1 for square, 3:4 for portrait, or 1920:1080 for widescreen. | auto |\n| defaultSize | number | Image default size (in px). | 1200 |\n| imageSizes | \\[number\\] | Image sizes (in px) to be used in the image [srcset HTML attribute](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia%5Fand%5Fembedding/Responsive%5Fimages). If no value is defined for this prop, the srcset will use the original image size. | undefined |\n| maxSize | number | Image maximum size (in px) for rendering, regardless of screen size. This prop only works if you also declare the imageSizes prop. | 4096 |\n| zoomFactor | number | Sets how much the zoom increases the image size (for example, 2 will make the zoomed-in image twice as large). | 2 |\n| zoomMode | enum | Sets the zoom behavior for the product-images.high-quality-image block. Possible values are disabled (no zoom), in-place-click (zoom on click), and in-place-hover (zoom on hover). Unlike the store-images prop, this one doesn’t accept the open-modal value. | disabled |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, 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\n| CSS Handles |\n| ---------------------------------------------- |\n| carouselContainer |\n| carouselCursorDefault |\n| carouselGaleryCursor |\n| carouselGaleryThumbs |\n| carouselIconCaretLeft |\n| carouselIconCaretRight |\n| carouselImagePlaceholder |\n| carouselInconCaretRight |\n| carouselThumbBorder |\n| figure |\n| figure--video |\n| highQualityContainer |\n| image |\n| imgZoom |\n| productImagesContainer (content is deprecated) |\n| productImagesContainer--carousel |\n| productImagesContainer--list |\n| productImagesGallerySlide |\n| productImagesGallerySwiperContainer |\n| productImagesThumb |\n| productImagesThumbActive |\n| productImagesThumbCaret |\n| productImagesThumbsSwiperContainer |\n| productImageTag--main |\n| productImageTag--zoon |\n| productImageTag |\n| productImageLabel |\n| productVideo |\n| swiper-pagination |\n| swiperBullet--active |\n| swiperBullet |\n| swiperCaret |\n| swiperCaretNext |\n| swiperCaretPrev |\n| thumbImg |\n| thumbImg--video |\n| video |\n| video |\n| videoContainer |\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@3.178.5/ProductImages/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@3.178.5/ProductImages/docs/apps/vtex.store-components@3.178.5/ProductImages%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductImages/docs/apps/vtex.store-components@3.178.5/ProductImages%23props)[Advanced configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductImages/docs/apps/vtex.store-components@3.178.5/ProductImages%23advanced-configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductImages/docs/apps/vtex.store-components@3.178.5/ProductImages%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_622b0e2c
|
[
{
"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 migrating cms settings after major update 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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/docs/guides/store-framework-updating-live-stores)\n\n[Migrating CMS settings after a Store Theme major update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update)\n\n[Installing apps on live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices)\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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/docs/guides/store-framework-updating-live-stores)\n\n[Migrating CMS settings after a Store Theme major update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update)\n\n[Installing apps on live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices)\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-migrating-cms-settings-after-major-update/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-migrating-cms-settings-after-major-update/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/docs/guides/store-framework)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/docs/guides/store-framework-updating-live-stores)\n\n[Migrating CMS settings after a Store Theme major update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update)\n\nMigrating CMS settings after a major theme update\n\nWhen making changes to the peer dependencies of your [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme) app, you may need to perform a major update. However, transitioning to a new major version of the Store Theme may lead to undesired consequences, such as losing the configured Admin page template settings.\n\nTo handle this situation, follow the steps below to migrate template settings.\n\n> hese instructions must be followed even when downgrading to a previous major theme version, such as from 5.x to 4.x.\n\n## Before you begin\n\nMake sure you have the following tools installed on your machine. They facilitate interactions with the VTEX platform and enhance your development experience:\n\n1. Install the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install).\n2. Install GraphQL IDE by running the following command: \n`1 \nvtex install vtex.admin-graphql-ide@3.x \n`\n\n## Instructions\n\n1. Open the terminal and log in to your account.\n2. Switch to the [**production workspace**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace) with your latest changes, and [publish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available%23step-2---publishing-the-new-app-version) a new major version of your Store Theme app.\n3. In the **production workspace**, install the Store Theme version published in the previous steps by running the following command: \n`1 \nvtex install {appVendor}.{appName}@{appVersion} \n`\n4. Open the VTEX Admin of the production workspace used in the previous steps and go to **GraphQL Admin IDE**: \n`1 \nvtex browse admin/graphql-ide \n`\n5. From the **Choose an app** dropdown list, select `vtex.pages-graphql@2.x`.\n6. Copy the code below and paste it into the GraphQL IDE. \n`1 \n mutation{ \n2 \n updateThemeIds(from:\"{appVendor}.{appName}@{oldMajor}.x\", to:\"{appVendor}.{appName}@{newMajor}.x\") \n3 \n} \n`\n\n> Replace only the values in curly brackets with those that apply to your scenario. Keep the `x` without replacing it with the minor and patch versions. If you do that, the mutation won't work.\n\n1. Run the code by clicking `Execute Query` (▶). \nThe expected response body is: \n`1 \n{ \n2 \n \"data\": { \n3 \n \"updateThemeIds\": true \n4 \n } \n5 \n} \n`\n2. In the VTEX Admin, go to the **Storefront** module and validate the content in its features, such as **Site Editor**, **Pages**, and **Redirects**.\n3. Once you have validated your data in the **Storefront** module, [promote your workspace to master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/).\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-documentation-migrating-cms-settings-after-major-update.md)\n\n[Updating live stores« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update//docs/guides/store-framework-updating-live-stores)[Installing apps on live storesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update//docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices)\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\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-migrating-cms-settings-after-major-update/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update%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-documentation-migrating-cms-settings-after-major-update.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-migrating-cms-settings-after-major-update/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update%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_cbbbc7b6
|
[
{
"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 digital signage 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/digital-signage/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/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/digital-signage/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/digital-signage/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/digital-signage/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/digital-signage/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/digital-signage/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/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/digital-signage/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/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/digital-signage/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/getting-started-with-vtex-ads-api)\n\n[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/synchronizing-the-catalog-with-vtex-ads)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/retrieving-ads)\n\n[Segmenting campaigns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/segmenting-campaigns)\n\n[Digital Signage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/digital-signage)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/ads-events)\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/digital-signage/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/digital-signage/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/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/digital-signage/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/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/digital-signage/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/getting-started-with-vtex-ads-api)\n\n[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/synchronizing-the-catalog-with-vtex-ads)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/retrieving-ads)\n\n[Segmenting campaigns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/segmenting-campaigns)\n\n[Digital Signage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/digital-signage)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/ads-events)\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/digital-signage/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/digital-signage/docs/guides)\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/getting-started-with-vtex-ads-api)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/retrieving-ads)\n\n[Digital Signage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/digital-signage)\n\nDigital Signage\n\nDeliver Retail Media experiences in physical stores via digital signage integration.\n\nThe Digital Signage integration uses the `POST` [Get ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api%23post-/v1/rma/-publisher%5Fid-), the same request used for retrieving ads for your digital platform.\n\n## Retrieving ads for generic screens\n\nAll ads that should be displayed will be returned. Once all ads have been displayed, the API must be called again to retrieve the next batch of items to be shown.\n\n> 🚧 Don't display the same items twice, as display metrics will only be counted once.\n\nRequest example:\n\n`1\n\n{ \n\n2\n\n \"context\": \"digital_signage\", \n\n3\n\n \"session_id\": \"random id\", \n\n4\n\n \"device_id\": \"screen identifier\", \n\n5\n\n \"store_name\": \"location identifier\", \n\n6\n\n \"placements\": { \n\n7\n\n \"name_of_the_location_where_the_screen_is\": { \n\n8\n\n \"size\": \"1080x1920\", \n\n9\n\n \"types\": [\"digital_signage\"], \n\n10\n\n \"quantity\": 1 \n\n11\n\n } \n\n12\n\n }, \n\n13\n\n \"segmentation\": [ \n\n14\n\n { \n\n15\n\n \"key\": \"STATE\", \n\n16\n\n \"values\": [ \n\n17\n\n \"RJ\" \n\n18\n\n ] \n\n19\n\n }, \n\n20\n\n { \n\n21\n\n \"key\": \"CITY\", \n\n22\n\n \"values\": [ \n\n23\n\n \"Rio de Janeiro\" \n\n24\n\n ] \n\n25\n\n }, \n\n26\n\n { \n\n27\n\n \"key\": \"NEIGHBOURHOOD\", \n\n28\n\n \"values\": [ \n\n29\n\n \"Cascadura\", \n\n30\n\n \"Madureira\" \n\n31\n\n ] \n\n32\n\n } \n\n33\n\n ] \n\n34\n\n} \n\n`\n\n## Retrieving ads during checkout at the POS\n\nIn some cases, it is possible to identify the user making a purchase, typically during the payment process at the point of sale (POS).\n\nOnce the user is identified, you can request a personalized ad for that user.\n\n> 🚧 For segmented campaigns, an audience integration is required.\n\nRequest example:\n\n`1\n\n{ \n\n2\n\n \"context\": \"digital_signage\", \n\n3\n\n \"user_id\": \"user identifier\", \n\n4\n\n \"session_id\": \"random id\", \n\n5\n\n \"device_id\": \"unique screen identifier\", \n\n6\n\n \"store_name\": \"unique location identifier\", \n\n7\n\n \"placements\": { \n\n8\n\n \"name_of_the_location_where_the_screen_is\": { \n\n9\n\n \"size\": \"1080x1920\", \n\n10\n\n \"types\": [\"digital_signage\"], \n\n11\n\n \"quantity\": 5 \n\n12\n\n } \n\n13\n\n }, \n\n14\n\n \"segmentation\": [ \n\n15\n\n { \n\n16\n\n \"key\": \"STATE\", \n\n17\n\n \"values\": [ \n\n18\n\n \"RJ\" \n\n19\n\n ] \n\n20\n\n }, \n\n21\n\n { \n\n22\n\n \"key\": \"CITY\", \n\n23\n\n \"values\": [ \n\n24\n\n \"Rio de Janeiro\" \n\n25\n\n ] \n\n26\n\n }, \n\n27\n\n { \n\n28\n\n \"key\": \"NEIGHBOURHOOD\", \n\n29\n\n \"values\": [ \n\n30\n\n \"Cascadura\", \n\n31\n\n \"Madureira\" \n\n32\n\n ] \n\n33\n\n } \n\n34\n\n ] \n\n35\n\n} \n\n`\n\n## Response\n\nSee the available response attributes on `POST` [Get ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api%23post-/v1/rma/-publisher%5Fid-).\n\nResponse example:\n\n`1\n\n{ \n\n2\n\n \"placement_name\": [ \n\n3\n\n { \n\n4\n\n \"type\": \"digital_signage\", \n\n5\n\n \n6\n\n \"assets\": [ \n\n7\n\n { \n\n8\n\n \"type\": \"image|video\", \n\n9\n\n \"url\": \"image URL\", \n\n10\n\n \"duration\": 30 \n\n11\n\n } \n\n12\n\n ], \n\n13\n\n \n14\n\n \"impression_url\": \"impression URL\" \n\n15\n\n } \n\n16\n\n ] \n\n17\n\n} \n\n`\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/VTEX Ads/getting-started-with-vtex-ads-api/retrieving-ads/digital-signage.md)\n\n[Segmenting campaigns« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage//docs/guides/segmenting-campaigns)[Ads eventsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage//docs/guides/ads-events)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Retrieving ads for generic screens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/digital-signage%23retrieving-ads-for-generic-screens)\n\n[Retrieving ads during checkout at the POS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/digital-signage%23retrieving-ads-during-checkout-at-the-pos)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/digital-signage%23response)\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 Ads/getting-started-with-vtex-ads-api/retrieving-ads/digital-signage.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Retrieving ads for generic screens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/digital-signage%23retrieving-ads-for-generic-screens)\n\n[Retrieving ads during checkout at the POS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/digital-signage%23retrieving-ads-during-checkout-at-the-pos)\n\n[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/digital-signage/docs/guides/digital-signage%23response)\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_f7b010f4
|
[
{
"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 setting your apps billing model 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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/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-setting-your-apps-billing-model/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-setting-your-apps-billing-model/docs/app-development)\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/docs/guides/vtex-app-store)\n\n[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/docs/guides/vtex-io-documentation-setting-your-apps-billing-model)\n\nSetting your app's billing model\n\nOnce your app has been developed and is ready to go live, it's time to think about its distribution. In this step, you must define who will be allowed to install your app, whether your app will be paid or not, and how much it will cost if so.\n\nWhen preparing your app for distribution, you must first establish if your new app will be private or public on the VTEX IO platform.\n\n* **Private apps** can only be installed by their `vendor` account (i.e., the account responsible for the app's development and maintenance).\n* **Public apps** are available to all accounts of the VTEX IO ecosystem. These apps can be charged or not.\n\n## Setting the app as private\n\nTake the following steps to make your app private:\n\n1. Open your project in any code editor of your preference.\n2. Open the `manifest.json` file and remove the `billingOptions` field.\n\nWithout `billingOptions`, VTEX IO will understand that the app in question should not be made available to any account other than the one specified in the `vendor` field of the `manifest.json` file.\n\n## Setting the app as public\n\nWhen making your app public available to the VTEX IO ecosystem, you must set up the `billingOptions` field in the app's [manifest.json](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest) file. In this context, you first need to define whether or not your app will be charged. For more information, please refer to the [billingOptions documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options).\n\n> You can [contact the VTEX support team](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM) to get more information about the contracts and accounts that have installed your app.\n\n### Instructions\n\nThe first step in making an app public is defining whether the app will be charged or not. Consider the following according to your scenario:\n\n* [Setting the app as free](#setting-the-app-as-free)\n* [Setting the app as charged](#setting-the-app-as-charged)\n\n#### Setting the app as free\n\n1. Open your app in any code editor of your preference.\n2. Open the `manifest.json` file.\n3. Add the `billingOptions` field to your app's `manifest.json` file and set the `type` property as `free`.\n4. Set up the `support` property to provide a support channel for the app users.\n5. Set up the `availableCountries` property to define in which countries the app will be available. If you want to make it available for all countries, use `*`. \n`1 \n \"billingOptions\": { \n2 \n \"type\": \"free\", \n3 \n \"support\": { \n4 \n \"email\": \"support@com.br\", \n5 \n \"url\": \"https://support.com/hc/requests\" \n6 \n }, \n7 \n \"availableCountries\" : [\"*\"] \n8 \n } \n`\n\n#### Setting the app as charged\n\n1. Open your app in any code editor of your preference.\n2. Open the `manifest.json` file.\n3. Create the `billingOptions` field in the app's `manifest.json` file and set the `type` property as `billable`.\n4. Set up the `support` property to provide a support channel for the app users.\n5. Set up the `availableCountries` property to define in which countries the app will be available. If you want to make it available for all countries, use `*`. \n`1 \n \"billingOptions\": { \n2 \n \"type\": \"billable\", \n3 \n \"support\": { \n4 \n \"email\": \"support@com.br\", \n5 \n \"url\": \"https://support.com/hc/requests\" \n6 \n }, \n7 \n \"availableCountries\" : [\"*\"] \n8 \n } \n`\n6. Now, choose one of the following billing options and follow the procedures corresponding to your selection. \n * [**Fixed subscription**](#fixed-subscription) \\- Charges a fixed subscription price per month. This billing model only allows a single subscription plan to be created for the app. \n * [**Fixed subscription + Variable rate**](#fixed-subscription--variable-rate) \\- Charges a fixed subscription price plus a variable charge based on the app's usage. Apps with a variable rate are charged according to a metric value. \n * [**Variable subscription + Variable rate**](#variable-subscription--variable-rate) \\- Charges a variable subscription price plus a variable rate based on the app's usage. Apps with a variable rate are charged according to a metric value.\n7. Finally, if you opt for a variable-charge pricing strategy, take the steps presented in the [Registering the metrics data](#registering-the-metrics-data-only-for-apps-with-a-variable-pricing-strategy) section.\n\n##### Fixed subscription\n\nEstablish a subscription plan for your app by setting up the `plan` property and its child properties:\n\n* `id`: Plan identifier.\n* `currency`: Currency code following the ISO.\n* `price.subscription`: Subscription price. This property is of type `number` and accepts values with or without cents. Examples: `10` (10 dollars), `60.25` (60 dollars and 25 cents), `0.9` (90 cents).\nExample of an app with a fixed subscription price\n\n`1\n\n \"billingOptions\": { \n\n2\n\n \"type\": \"billable\", \n\n3\n\n \"support\": { \n\n4\n\n \"email\": \"support@com.br\", \n\n5\n\n \"url\": \"https://support.com/hc/requests\" \n\n6\n\n }, \n\n7\n\n \"availableCountries\": [\"*\"], \n\n8\n\n \"plans\": [{ \n\n9\n\n \"id\": \"PlanBRL\", \n\n10\n\n \"currency\": \"BRL\", \n\n11\n\n \"price\": { \n\n12\n\n \"subscription\": 100 \n\n13\n\n } \n\n14\n\n }] \n\n15\n\n } \n\n`\n\n##### Fixed subscription + variable rate\n\n1. Establish a subscription plan for your app by setting up the `plan` property and its child properties:\n* `id`: Plan identifier.\n* `currency`: Currency code following the ISO.\n* `price.subscription`: Subscription price. This property is of type `number` and accepts values with or without cents. Examples: `10` (10 dollars), `60.25` (60 dollars and 25 cents), `0.9` (90 cents).\n* `price.metrics`: An array specifying the metric's id and the ranges related to the app's usage and associated extra charge. Notice that you can set one or more metrics to calculate the variable rate.\nExample of an app with a fixed subscription price plus a variable rate that considers only one metric\n\n`1\n\n \"billingOptions\": { \n\n2\n\n \"type\": \"billable\", \n\n3\n\n \"support\": { \n\n4\n\n \"email\": \"support@com.br\" \n\n5\n\n }, \n\n6\n\n \"availableCountries\": [\"*\"], \n\n7\n\n \"plans\": [{ \n\n8\n\n \"id\": \"PlanUSD\", \n\n9\n\n \"currency\": \"USD\", \n\n10\n\n \"price\": { \n\n11\n\n \"subscription\": 50, \n\n12\n\n \"metrics\": [{ \n\n13\n\n \"id\": \"smsSent\", \n\n14\n\n \"ranges\": [{ \n\n15\n\n \"exclusiveFrom\": 0, \n\n16\n\n \"inclusiveTo\": 2000, \n\n17\n\n \"multiplier\": 0.07 \n\n18\n\n }, \n\n19\n\n { \n\n20\n\n \"exclusiveFrom\": 2000, \n\n21\n\n \"inclusiveTo\": 4000, \n\n22\n\n \"multiplier\": 0.06 \n\n23\n\n }, \n\n24\n\n { \n\n25\n\n \"exclusiveFrom\": 4000, \n\n26\n\n \"multiplier\": 0.05 \n\n27\n\n } \n\n28\n\n ] \n\n29\n\n }] \n\n30\n\n } \n\n31\n\n }] \n\n32\n\n } \n\n`\n\nFrom the previous example, we have:\n\n* Each SMS costs `US$ 0.07` (`multiplier`) when more than `0` (`exclusiveFrom: 0`) SMSs _and_ less than or equal to `2000` (`inclusiveTo: 2000`) SMSs have already been sent.\n* Each SMS costs `US$ 0.06` (`multiplier`) when more than `2000` (`exclusiveFrom: 2000`) _and_ less than or equal to `4000` (`inclusiveTo: 4000`) SMSs have already been sent.\n* Each SMS costs `US$ 0.05` (`multiplier`) when more than `4000` (`exclusiveFrom: 4000`) SMSs have already been sent.\n\nTherefore, the extra variable rate would be charged as follows:\n\n* For 1500 SMSs = US$ 105.00 _(1500 x US$ 0.07 = US$ 105.00)_\n* For 3500 SMSs = US$ 210.00 _(3500 x US$ 0.06 = US$ 210.00)_\n* For 7000 SMSs = US$ 350.00 _(7000 x US$ 0.05 = US$ 350.00)_\nExample of an app with a fixed subscription price plus a variable rate that considers more than one metric\n\n`1\n\n \"billingOptions\": { \n\n2\n\n \"type\": \"billable\", \n\n3\n\n \"support\": { \n\n4\n\n \"url\": \"https://support.com/hc/requests\", \n\n5\n\n \"email\": \"support@com.br\", \n\n6\n\n \"phone\": \"+5521988887777\" \n\n7\n\n }, \n\n8\n\n \"availableCountries\": [\"USA\", \"GBR\", \"BRA\", \"ESP\"], \n\n9\n\n \"plans\": [{ \n\n10\n\n \"id\": \"PlanUSD\", \n\n11\n\n \"currency\": \"USD\", \n\n12\n\n \"price\": { \n\n13\n\n \"subscription\": 50, \n\n14\n\n \"metrics\": [{ \n\n15\n\n \"id\": \"myCredits\", \n\n16\n\n \"ranges\": [{ \n\n17\n\n \"exclusiveFrom\": 0, \n\n18\n\n \"multiplier\": 1, \n\n19\n\n \"inclusiveTo\": 100 \n\n20\n\n }, \n\n21\n\n { \n\n22\n\n \"exclusiveFrom\": 100, \n\n23\n\n \"multiplier\": 0.7 \n\n24\n\n }], \n\n25\n\n \"customUrl\": \"https://my.com/_v/metric/billing/info\" \n\n26\n\n }, \n\n27\n\n { \n\n28\n\n \"id\": \"myCredit2\", \n\n29\n\n \"ranges\": [{ \n\n30\n\n \"exclusiveFrom\": 0, \n\n31\n\n \"multiplier\": 0.5 \n\n32\n\n }], \n\n33\n\n \"customUrl\": \"https://my.com/_v/metric/billing/info\" \n\n34\n\n } \n\n35\n\n ] \n\n36\n\n } \n\n37\n\n }] \n\n38\n\n } \n\n`\n\n##### Variable subscription + variable rate\n\n1. Establish a subscription plan for your app by setting up the `plan` property and its child properties: \n * `id`: Plan identifier. \n * `currency`: Currency code following the ISO. \n * `price.subscription`: Subscription price. This property is of type `number` and accepts values with or without cents. Examples: `10` (10 dollars), `60.25` (60 dollars and 25 cents), `0.9` (90 cents). \n * `price.metrics`: An array specifying the metric's ID and the ranges related to the app's usage and associated extra charge. Notice that you can set one or more metrics to calculate the variable rate.\n2. Repeat the previous step to create a new subscription plan. This new plan will be a new object inside the `plan` array.\nExample of an app with a variable subscription and variable rate\n\n`1\n\n \"billingOptions\": { \n\n2\n\n \"type\": \"billable\", \n\n3\n\n \"support\": { \n\n4\n\n \"url\": \"https://support.com/hc/requests\", \n\n5\n\n \"email\": \"support@com.br\", \n\n6\n\n \"phone\": \"+5521988887777\" \n\n7\n\n }, \n\n8\n\n \"availableCountries\": [\"GBR\", \"BRA\", \"ESP\"], \n\n9\n\n \"plans\": [{ \n\n10\n\n \"id\": \"PlanBRL\", \n\n11\n\n \"currency\": \"BRL\", \n\n12\n\n \"price\": { \n\n13\n\n \"subscription\": 50, \n\n14\n\n \"metrics\": [{ \n\n15\n\n \"id\": \"myCredits\", \n\n16\n\n \"ranges\": [{ \n\n17\n\n \"exclusiveFrom\": 0, \n\n18\n\n \"multiplier\": 1, \n\n19\n\n \"inclusiveTo\": 100 \n\n20\n\n }, \n\n21\n\n { \n\n22\n\n \"exclusiveFrom\": 100, \n\n23\n\n \"multiplier\": 0.7 \n\n24\n\n } \n\n25\n\n ], \n\n26\n\n \"customUrl\": \"https://my.com/_v/metric/billing/info\" \n\n27\n\n }, \n\n28\n\n { \n\n29\n\n \"id\": \"myCredit2\", \n\n30\n\n \"ranges\": [{ \n\n31\n\n \"exclusiveFrom\": 0, \n\n32\n\n \"multiplier\": 0.5 \n\n33\n\n }], \n\n34\n\n \"customUrl\": \"https://my.com/_v/metric/billing/info\" \n\n35\n\n } \n\n36\n\n ] \n\n37\n\n } \n\n38\n\n }, \n\n39\n\n { \n\n40\n\n \"id\": \"PlanUSD\", \n\n41\n\n \"currency\": \"USD\", \n\n42\n\n \"price\": { \n\n43\n\n \"subscription\": 50, \n\n44\n\n \"metrics\": [{ \n\n45\n\n \"id\": \"myCredits\", \n\n46\n\n \"ranges\": [{ \n\n47\n\n \"exclusiveFrom\": 0, \n\n48\n\n \"multiplier\": 1, \n\n49\n\n \"inclusiveTo\": 100 \n\n50\n\n }, \n\n51\n\n { \n\n52\n\n \"exclusiveFrom\": 100, \n\n53\n\n \"multiplier\": 0.7 \n\n54\n\n } \n\n55\n\n ], \n\n56\n\n \"customUrl\": \"https://my.com/_v/metric/billing/info\" \n\n57\n\n }, \n\n58\n\n { \n\n59\n\n \"id\": \"myCredit2\", \n\n60\n\n \"ranges\": [{ \n\n61\n\n \"exclusiveFrom\": 0, \n\n62\n\n \"multiplier\": 0.5 \n\n63\n\n }], \n\n64\n\n \"customUrl\": \"https://my.com/_v/metric/billing/info\" \n\n65\n\n } \n\n66\n\n ] \n\n67\n\n } \n\n68\n\n } \n\n69\n\n ] \n\n70\n\n } \n\n`\n\n### Registering the `metrics` data (Only for apps with a variable pricing strategy)\n\nIf you opted for a variable-charge pricing strategy, you must ensure that your metrics are being tracked and updated over time. Otherwise, users won't be charged the right amount.\n\n1. Create the `policies` field in the app's `manifest.json` file and add the `vtex.billing:save-metrics` as its child.\n2. Make a POST request to `https://app.io.vtex.com/vtex.billing/v0/{account}/{workspace}/_v/billing-metrics` with the following body: \n`1 \n{ \n2 \n \"metric_id\": \"{metricId}\", \n3 \n \"value\": \"{metricAmount}\" \n4 \n} \n` \nRemember to remove the curly brackets from the endpoint and body replacing them with real values according to your own scenario. \n * `account` \\- VTEX account responsible for the app development and maintenance. \n * `Workspace` \\- Workspace being used for the app development. \n * `metricId` \\- ID of the metric specified in the `billingOptions` field. \n * `metricAmount` \\- Use of metrics for billing. For example: if your metric consists of charging for each SMS sent, the `metricAmount` should be equal to 1.\n3. Create a client for the `vtex.billing` app or complement it with the `saveBillingMetric` method: \n`` 1 \nimport {AppClient, IOContext, InstanceOptions} from '@vtex/api' \n2 \n \n3 \nconst routes = { \n4 \n billingMetrics: `/_v/billing-metrics`, \n5 \n} \n6 \n \n7 \nexport class BillingApp extends AppClient { \n8 \n public constructor(ioContext: IOContext, opts?: InstanceOptions) { \n9 \n super('vtex.billing@0.x', ioContext, opts) \n10 \n } \n11 \n \n12 \n public saveBillingMetric = (billingMetric: { \n13 \n metric_id: string \n14 \n value: number \n15 \n }) => \n16 \n this.http.post(routes.billingMetrics, billingMetric, { \n17 \n metric: 'save-billing-metric', \n18 \n }) \n19 \n} \n ``\n4. Call the `saveBillingMetric` method whenever you need to add a new quantity to the metric value: \n`1 \nasync function saveSMSBillingMetric( \n2 \n {clients: {billingApp}, vtex: {logger}}: ServiceContext<Clients>, \n3 \n res: SMSInfo, \n4 \n) { \n5 \n try { \n6 \n await billingApp.saveBillingMetric({ \n7 \n metric_id: 'smsSent', // metric_id is defined in the app's billingOptions \n8 \n value: 1, // value is a whole/integer number that you want to register. This is accumulative. \n9 \n }) \n10 \n } catch (e) { \n11 \n // That was an error trying to save the metric value \n12 \n } \n13 \n} \n`\n\nNow, all the specified billing metrics will be tracked and updated by the `saveBillingMetric` method.\n\nIt's worth mentioning that each time the metric is recorded, the date for each register is saved as well. This allows the system to determine which metrics will be charged within a given date frame.\n\nContributors\n\n2\n\n[](https://github.com/geisecosta)\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-app-store/vtex-io-documentation-setting-your-apps-billing-model.md)\n\n[Developing an app« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model//docs/guides/vtex-io-documentation-developing-an-app)[Preparing your app for distributionNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model//docs/guides/vtex-io-documentation-preparing-your-app-distribution)\n\nContributors\n\n2\n\n[](https://github.com/geisecosta)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Setting the app as private](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/docs/guides/vtex-io-documentation-setting-your-apps-billing-model%23setting-the-app-as-private)\n\n[Setting the app as public](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/docs/guides/vtex-io-documentation-setting-your-apps-billing-model%23setting-the-app-as-public)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/docs/guides/vtex-io-documentation-setting-your-apps-billing-model%23instructions)[Registering the metrics data (Only for apps with a variable pricing strategy)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/docs/guides/vtex-io-documentation-setting-your-apps-billing-model%23registering-the-metrics-data-only-for-apps-with-a-variable-pricing-strategy)\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-app-store/vtex-io-documentation-setting-your-apps-billing-model.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Setting the app as private](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/docs/guides/vtex-io-documentation-setting-your-apps-billing-model%23setting-the-app-as-private)\n\n[Setting the app as public](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/docs/guides/vtex-io-documentation-setting-your-apps-billing-model%23setting-the-app-as-public)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/docs/guides/vtex-io-documentation-setting-your-apps-billing-model%23instructions)[Registering the metrics data (Only for apps with a variable pricing strategy)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model/docs/guides/vtex-io-documentation-setting-your-apps-billing-model%23registering-the-metrics-data-only-for-apps-with-a-variable-pricing-strategy)\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_ac43be75
|
[
{
"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 working with 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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-site-editor/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-site-editor/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-site-editor/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-site-editor/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-site-editor/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-site-editor/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-site-editor/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-site-editor/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-site-editor/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-site-editor/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-site-editor/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-site-editor/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-site-editor/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-site-editor/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-site-editor/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-site-editor/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-site-editor/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-site-editor/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-site-editor/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-site-editor/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-site-editor/docs/guides/store-framework)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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/store-framework-working-with-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_24903f09
|
[
{
"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 marketplace 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/marketplace-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/guides/marketplace-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/marketplace-apis/)\n\nNotification\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/marketplace-apis-suggestions/)\n\nMatched Offers\n\nSeller Invite\n\nSeller Commissions\n\nSellers\n\n[Offer Management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/marketplace-apis-offer-management/)\n\nSales Channel Mapping\n\nAffiliates\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/guides/marketplace-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/guides/marketplace-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/guides/marketplace-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/guides/marketplace-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/guides/marketplace-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/marketplace-apis/)\n\nNotification\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/marketplace-apis-suggestions/)\n\nMatched Offers\n\nSeller Invite\n\nSeller Commissions\n\nSellers\n\n[Offer Management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/marketplace-apis-offer-management/)\n\nSales Channel Mapping\n\nAffiliates\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/guides/marketplace-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/guides/marketplace-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-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/guides/marketplace-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-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/guides/marketplace-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/guides/marketplace-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[DeDelete polygon« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/logistics-api%23delete-/api/logistics/pvt/configuration/geoshape/-polygonName-)[PoNotify marketplace of price updateNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api/docs/api-reference/marketplace-apis%23post-/notificator/-sellerId-/changenotification/-skuId-/price)\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_5595d255
|
[
{
"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 overwriting the messages app 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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/docs/guides/vtex-io-multi-language-stores)\n\n[Internationalizing product prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-internationalizing-product-prices)\n\n[Disabling automatic translation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-disabling-automatic-translation)\n\n[Translating storefront content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/storefront-content-internationalization)\n\n[Translating Catalog content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/catalog-internationalization)\n\n[Overwriting the Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-overwriting-the-messages-app)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/docs/guides/vtex-io-multi-language-stores)\n\n[Internationalizing product prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-internationalizing-product-prices)\n\n[Disabling automatic translation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-disabling-automatic-translation)\n\n[Translating storefront content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/storefront-content-internationalization)\n\n[Translating Catalog content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/catalog-internationalization)\n\n[Overwriting the Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-overwriting-the-messages-app)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/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-overwriting-the-messages-app/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/store-framework)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-multi-language-stores)\n\n[Overwriting the Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-overwriting-the-messages-app)\n\nOverwriting the Messages app\n\nLearn how to overwrite automatic translations.\n\nMessages is VTEX IO's key tool for your store's internationalization since it's responsible for translating any website message (that is, website text content) for rendering.\n\nHowever, you may feel that some translations done by the app are not what you want them to be. Therefore, you may want to change the translated content to something more specific or representative of your store, such as a special login message for Spanish-speaking users from Argentina.\n\nIn the next section, we present you a step-by-step on how to overwrite a translation from your store's catalog, such as a product name or a product description, and text messages exported from an app.\n\n## Instructions\n\n1. [Install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) the **GraphQL IDE app** by running the following in your terminal.\n\n`1\n\nvtex install vtex.admin-graphql-ide@3.x \n\n`\n\n1. Access the Admin and go to **Store Setting > Storefront > GraphQL IDE**.\n2. From the dropdown list, choose the `vtex.messages` app.\n3. Write the following mutation command in the text box that is displayed:\n\n`1\n\nmutation Save($saveArgs: SaveArgsV2!) { \n\n2\n\n saveV2(args: $saveArgs) \n\n3\n\n} \n\n`\n\n1. Then, click on **Query Variables** at the bottom of the page. Now, your screen may look like the following:\n\n\n\n1. To fill in the `Query Variables` box, check the next sections **according to your store's desired scenario** (_catalog_ or _app_ messages translations).\n2. After adjusting your query, click the play button to run the declared mutation. For both scenarios, the expected response is as follows:\n\n`1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"saveV2\": true \n\n4\n\n } \n\n5\n\n} \n\n`\n\nOnce you receive the expected response, no further actions are needed: you are ready to check out the desired changes in your store.\n\nYou can also confirm whether Messages properly saved the new translations by performing a query. To know further, check out the **Checking your changes** section.\n\n### Catalog translations\n\nUse the following example as a guide if you aim to translate text messages from your store's catalog, such as a product name or description.\n\n`1\n\n{ \n\n2\n\n \"saveArgs\": { \n\n3\n\n \"to\": \"pt-BR\", \n\n4\n\n \"messages\": [ \n\n5\n\n { \n\n6\n\n \"srcLang\": \"en-US\", \n\n7\n\n \"srcMessage\": \"Original product name in English\", \n\n8\n\n \"context\": \"543123\", \n\n9\n\n \"targetMessage\": \"Nome do produto em português\" \n\n10\n\n } \n\n11\n\n ] \n\n12\n\n } \n\n13\n\n} \n\n`\n\n**These variables are flexible and must fit your store's given scenario**. The variables for the store catalog translations are as follows:\n\n* `to`: target translation locale.\n* `messages`: a list of the messages you want to translate, containing the following parameters: \n * `srcLang`: source message locale. \n * `srcMessage`: source message string. \n * `context`: ID of the product/brand/category you want to translate. IDs can be found in your store's registration on the admin under Product > Catalog. \n * `targetMessage`: translated message string.\n\nTo better understand the full process of overwriting a product message translation, check the following gif:\n\n\n\n### App messages translations\n\nUse the following example as a guide to translate text messages exported from an app (declared in the app's `messages` folder).\n\n`1\n\n{ \n\n2\n\n \"saveArgs\": { \n\n3\n\n \"to\": \"en-US\", \n\n4\n\n \"messages\": [ \n\n5\n\n { \n\n6\n\n \"srcLang\": \"en-DV\", \n\n7\n\n \"srcMessage\": \"store/search.placeholder\", \n\n8\n\n \"context\": \"vtex.store-components@3.x\", \n\n9\n\n \"targetMessage\": \"My personalized Search message\" \n\n10\n\n } \n\n11\n\n ] \n\n12\n\n } \n\n13\n\n} \n\n`\n\n**These variables are flexible and must match your store's desired scenario**. The variables for app message translations are as follows:\n\n* `to`: target translation locale.\n* `messages`: a list of the messages you want to translate, containing the following parameters: \n * `srcLang`: source message locale. This variable must contain the value `en-DV`, no matter which locale is rendered on the app's interface. \n * `srcMessage`: the `id` of your message string declared in the app's `messages` folder. \n * `context`: the name of the app in which the message is being overwritten. \n * `targetMessage`: translated message string.\n\nTo better understand the full process of overwriting an app message translation, check the following gif:\n\n\n\n### VTEX Intelligent Search context\n\nUse the following example as a guide to translate text messages exported from the [VTEX Intelligent Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search).\n\n`1\n\n{ \n\n2\n\n \"saveArgs\": { \n\n3\n\n \"to\": \"en-GB\", \n\n4\n\n \"messages\": [ \n\n5\n\n { \n\n6\n\n \"srcLang\": \"it-IT\", \n\n7\n\n \"srcMessage\": \"Category 1\", \n\n8\n\n \"context\": \"intelligentSearchFacets\", \n\n9\n\n \"targetMessage\": \"Category\" \n\n10\n\n } \n\n11\n\n ] \n\n12\n\n } \n\n13\n\n} \n\n`\n\n**These variables are flexible and must fit your store's given scenario**. The variables for the store catalog translations are as follows:\n\n* `to`: target translation locale.\n* `messages`: a list of the messages you want to translate, containing the following parameters: \n * `srcLang`: store's locale default. In the VTEX Intelligent Search context, this variable must be the store's binding default. \n * `srcMessage`: source message string. Check the table below for the possible values of this variable. \n | Value | Definition | \n | ----------- | ----------- | \n | Category 1 | Department | \n | Category 2 | Category | \n | Category 3 | Subcategory | \n | Price | Price | \n | Promotion | Promotion | \n | New Release | New Release | \n | Location | Location | \n | Brand | Brand | \n * `context`: `intelligentSearchFacets`, which defines the context of the VTEX Intelligent Search. \n * `targetMessage`: translated message string.\n\n## Checking your changes\n\nIf you have already performed the desired mutations, you can check your changes through a query in the GraphQL IDE, **according to your store's desired scenario** (_catalog_ or _app_ messages translations).\n\n### Checking catalog message translations\n\n1. In the **GraphQL admin IDE**, after choosing the `vtex.messages` app, write the following query command in the text box that is displayed:\n\n`1\n\nquery GetTranslation($args2: TranslateArgs!) { \n\n2\n\n translate(args: $args2) \n\n3\n\n} \n\n`\n\n1. Then, to fill in the `Query Variables` box, you must provide the following parameters:\n* `from`: source message locale.\n* `messages`: a list of the messages you want to check translations, containing the following parameters: \n * `content`: source message string. \n * `context`: ID of the product/brand/category you want to check the translation. IDs can be found in your store's registration on the admin under Product > Catalog.\n* `to`: target translation locale.\n\nTake the following example:\n\n`1\n\n{ \n\n2\n\n \"args2\": { \n\n3\n\n \"indexedByFrom\": [ \n\n4\n\n { \n\n5\n\n \"from\": \"en-US\", \n\n6\n\n \"messages\": [ \n\n7\n\n { \n\n8\n\n \"content\": \"Original product name in English\", \n\n9\n\n \"context\": \"543123\" \n\n10\n\n } \n\n11\n\n ] \n\n12\n\n } \n\n13\n\n ], \n\n14\n\n \"to\": \"pt-BR\" \n\n15\n\n } \n\n16\n\n} \n\n`\n\n1. After adjusting your query, click the play button to run it. The expected response is the translated message in the target locale.\n\nFor the given example, the expected response is as follows:\n\n`1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"translate\": [ \n\n4\n\n \"Nome do produto em português\" \n\n5\n\n ] \n\n6\n\n } \n\n7\n\n} \n\n`\n\n### Checking app messages translations\n\n1. In the **GraphQL admin IDE**, after choosing the `vtex.messages` app, write the following query command in the text box that is displayed:\n\n`1\n\nquery GetTranslation($args: TranslateWithDependenciesArgs!) { \n\n2\n\n translateWithDependencies(args: $args) \n\n3\n\n} \n\n`\n\n1. Then, to fill in the `Query Variables` box, you must provide the following parameters:\n* `from`: source message locale.\n* `messages`: a list of the messages you want to check translations, containing the following parameters: \n * `content`: the `id` of your message string declared in the app's `messages` folder. \n * `context`: the name of the app in which the message has been overwritten.\n* `to`: target translation locale.\n* `depTree`: the dependency tree as in `\"[{\\\"id\\\": \\\"{context}\\\"}]\"`.\n\nTake the following example:\n\n`1\n\n{ \n\n2\n\n\"args\": { \n\n3\n\n \"indexedByFrom\": [ \n\n4\n\n { \n\n5\n\n \"from\": \"en-DV\", \n\n6\n\n \"messages\": [ \n\n7\n\n { \n\n8\n\n \"content\": \"store/search.placeholder\", \n\n9\n\n \"context\": \"vtex.store-components@3.x\" \n\n10\n\n } \n\n11\n\n ] \n\n12\n\n } \n\n13\n\n ], \n\n14\n\n \"to\": \"en-US\", \n\n15\n\n \"depTree\": \"[{\\\"id\\\": \\\"vtex.store-components@3.x\\\"}]\" \n\n16\n\n } \n\n17\n\n} \n\n`\n\n1. After adjusting your query, click the play button to run it. The expected response is the translated message in the target locale.\n\nFor the given example, the expected response is as follows:\n\n`1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"translateWithDependencies\": [ \n\n4\n\n \"My personalized Search message\" \n\n5\n\n ] \n\n6\n\n } \n\n7\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/Storefront-Guides/vtex-io-multi-language-stores/vtex-io-documentation-overwriting-the-messages-app.md)\n\n[Translating Catalog content« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app//docs/guides/catalog-internationalization)[RoutingNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app//docs/guides/store-framework-routing)\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-overwriting-the-messages-app/docs/guides/vtex-io-documentation-overwriting-the-messages-app%23instructions)\n\n[Catalog translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-overwriting-the-messages-app%23catalog-translations)[App messages translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-overwriting-the-messages-app%23app-messages-translations)[VTEX Intelligent Search context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-overwriting-the-messages-app%23vtex-intelligent-search-context)\n\n[Checking your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-overwriting-the-messages-app%23checking-your-changes)\n\n[Checking catalog message translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-overwriting-the-messages-app%23checking-catalog-message-translations)[Checking app messages translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-overwriting-the-messages-app%23checking-app-messages-translations)\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-multi-language-stores/vtex-io-documentation-overwriting-the-messages-app.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-overwriting-the-messages-app/docs/guides/vtex-io-documentation-overwriting-the-messages-app%23instructions)\n\n[Catalog translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-overwriting-the-messages-app%23catalog-translations)[App messages translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-overwriting-the-messages-app%23app-messages-translations)[VTEX Intelligent Search context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-overwriting-the-messages-app%23vtex-intelligent-search-context)\n\n[Checking your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-overwriting-the-messages-app%23checking-your-changes)\n\n[Checking catalog message translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-overwriting-the-messages-app%23checking-catalog-message-translations)[Checking app messages translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app/docs/guides/vtex-io-documentation-overwriting-the-messages-app%23checking-app-messages-translations)\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_d6ba7837
|
[
{
"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 availability 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-availability/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-availability/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-availability/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-availability/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-availability/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-availability/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-availability/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-availability/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/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.product-availability/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/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.product-availability/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.product-availability/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/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.product-availability/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/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.product-availability/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/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-availability/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/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-availability/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-availability/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-availability/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/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-availability/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/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.product-availability/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/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.product-availability/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.product-availability/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/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.product-availability/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/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.product-availability/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/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-availability/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/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-availability/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-availability/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-availability/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/guides/advanced-components)\n\nProduct Availability\n\nOfficial extension\n\nVersion: 0.3.2\n\nLatest version: 0.3.2\n\n[](#contributors-)\n\nThe Product Availability app displays text messages regarding the in-stock quantity for products.\n\n\n\n## Configuration\n\n1. Add the Product Availability app to your theme's dependencies in the `manifest.json` file:\n\n`1\n\n \"dependencies\": { \n\n2\n\n+ \"vtex.product-availability\": \"0.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-availability` block to the desired theme block whose data is fetched from the [Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-context), such as the [Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-minicart). For example:\n\n`1\n\n\"product-availability\": { \n\n2\n\n \"props\": { \n\n3\n\n \"threshold\": \"10\", \n\n4\n\n \"lowStockMessage\": \"Only {quantity} left!\", \n\n5\n\n \"highStockMessage\": \"Item in stock!\" \n\n6\n\n } \n\n7\n\n} \n\n`\n\n| Prop name | Type | Description | Default value |\n| ---------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| threshold | number | Minimum product quantity that makes the low stock message to be displayed (if any message is set in the lowStockMessage prop). | 0 |\n| lowStockMessage | string | Message text to be displayed when the in-stock quantity is lower than the quantity defined in the threshold prop. This prop value must have {quantity} inside the string text in order to properly display the stock quantity according to the threshold. For example: \"Only {quantity} left!. Notice: if this prop's value is left empty, no message will be shown. | \"\" |\n| highStockMessage | string | Message text to be displayed when the in-stock quantity is higher or equal than the quantity defined in the threshold prop. Notice: if this prop's value is left empty, no message will be shown. | \"\" |\n\n## 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://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS Handles |\n| ----------------- |\n| container |\n| highStockText |\n| lowStockHighlight |\n| lowStockText |\n\n[Personal Shopper« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtexventures.personal-shopper-free)[Product ComparisonNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.product-comparison)\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.product-availability/docs/apps/vtex.product-availability%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-availability/docs/apps/vtex.product-availability%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_da394fcc
|
[
{
"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 master data 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/master-data-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-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/master-data-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/master-data-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/master-data-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/master-data-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/master-data-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/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/master-data-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/understanding-master-data)\n\n[Master Data components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-components)\n\n[Master Data infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-infrastructure)\n\n[Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-api)\n\n[Data consistency and synchronization in Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/data-consistency-and-synchronization-in-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-v1)\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/master-data-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-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/master-data-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/master-data-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/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/master-data-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/understanding-master-data)\n\n[Master Data components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-components)\n\n[Master Data infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-infrastructure)\n\n[Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-api)\n\n[Data consistency and synchronization in Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/data-consistency-and-synchronization-in-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-v1)\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/master-data-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-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/master-data-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/master-data-api/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/understanding-master-data)\n\n[Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-api)\n\nMaster Data API\n\nLearn how to manage and retrieve documents, define data structures, and configure searchable fields in Master Data.\n\nMaster Data API provides a structured way to store, retrieve, and manage data. It is organized into two categories:\n\n* **[Data Plane](#data-plane):** Manages records, enabling tasks such as searching and accessing documents.\n* **[Control Plane](#control-plane):** Defines the structure of records and access configurations.\n\n## Data Plane\n\nThe Data Plane stores and retrieves documents. Designed for high-volume operations, the Data Plane ensures quick and reliable data access for store operations.\n\n### Getting a document by `id`\n\nThe `/documents` endpoint is used to store and retrieve individual documents. To retrieve a document, you must provide the `id` value of the desired document, which serves as the unique identifier of the document.\n\n### Searching for documents\n\nWhen the `id` of a document is unknown, you can use the following APIs to locate it using searchable fields or indexes:\n\n* `/search`: Retrieves documents using Index fields. Learn more about Indices in [Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components).\n* `/scroll`: Handles large datasets, enabling bulk document retrieval through Searchable fields.\n\n> Searchable fields are configured to work with the `/search` and `/scroll` endpoints. In Master Data v1, they are defined using the `Is Filter` property. In Master Data v2, they use the `v-indexed` property.\n\n> Learn more about [Extracting data from Master Data with search and scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll).\n\n## Control Plane\n\nThe Control Plane manages the structure and behavior of the Data Plane. It enables developers to configure data validation, searchable fields and triggers within data entities. Control Plane operations are less frequent but crucial for defining data structures.\n\n### Master Data v1\n\nMaster Data v1 does not provide a Control Plane API. All configurations are handled via the VTEX Admin through the Dynamic Storage at **Store Settings > Storefront > Master Data > ⚙ > Data structure** (`https://{{accountName}}.ds.vtexcrm.com.br`).\n\n### Master Data v2\n\nMaster Data v2 has the `/schema` and `/indices` endpoints, allowing for the creation and management of [JSON Schemas](https://read.calvincode.net/reader?url=https://json-schema.org/) for data entities. These schemas define the structure of stored data and directly influence how the Data Plane processes and validates documents.\n\n> JSON Schemas are exclusive to Master Data v2.\n\n## Master Data API endpoints\n\nThe table below summarizes the available endpoints, their categories, descriptions, and supported versions.\n\n| Endpoint | Category | Description | Master Data v1 Documentation | Master Data v2 Documentation |\n| ---------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| /schemas | Control Plane | Creates and manages schemas for a data entity. The use of schemas enables searches with custom fields and to add rules when managing documents. Learn more in [Schema Lifecycle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-schema-lifecycle). | N/A | [Get schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/schemas)[Get schema by name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/schemas/-schemaName-)[Save schema by name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23put-/api/dataentities/-dataEntityName-/schemas/-schemaName-)[Delete schema by name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23delete-/api/dataentities/-dataEntityName-/schemas/-schemaName-) |\n| /indices | Control Plane | Manages indices for fast document access via fields other than id. Learn more in [Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components). | N/A | [Get indices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/indices)[Put indices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23put-/api/dataentities/-dataEntityName-/indices)[Get index by name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/indices/-index%5Fname-)[Delete index by name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23delete-/api/dataentities/-dataEntityName-/indices/-index%5Fname-) |\n| /documents | Data Plane | Manages individual documents using their id. | [Create new document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23post-/api/dataentities/-acronym-/documents)[Create document with custom ID or Update entire document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23put-/api/dataentities/-acronym-/documents/-id-)[Create or update partial document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23patch-/api/dataentities/-acronym-/documents)[Get document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/documents/-id-)[Update entire document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23put-/api/dataentities/-acronym-/documents/-id-)[Update partial document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23patch-/api/dataentities/-acronym-/documents/-id-)[Delete document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23delete-/api/dataentities/-acronym-/documents/-id-) | [Create new document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23post-/api/dataentities/-dataEntityName-/documents)[Create partial document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23patch-/api/dataentities/-dataEntityName-/documents)[Get document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/documents/-id-)[Create document with custom ID or Update entire document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23put-/api/dataentities/-dataEntityName-/documents/-id-)[Update partial document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23patch-/api/dataentities/-dataEntityName-/documents/-id-)[Delete document](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 | Data Plane | Retrieves documents based on parameters like schemas and indexed fields. | [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/search) | [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/search) |\n| /scroll | Data Plane | Retrieves large amount of documents. | [Scroll documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/scroll) | [Scroll documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/scroll) |\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/Master-Data/understanding-master-data/master-data-api.md)\n\n[Master Data infrastructure« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api//docs/guides/master-data-infrastructure)[Data consistency and synchronization in Master DataNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api//docs/guides/data-consistency-and-synchronization-in-master-data)\n\nSee also\n\n[Master Data API V2API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/api-reference/master-data-api-v2)[Masterdata APIAPI Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/api-reference/masterdata-api)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Data Plane](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-api%23data-plane)\n\n[Getting a document by id](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-api%23getting-a-document-by-id)[Searching for documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-api%23searching-for-documents)\n\n[Control Plane](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-api%23control-plane)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-api%23master-data-v1)[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-api%23master-data-v2)\n\n[Master Data API endpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-api%23master-data-api-endpoints)\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/Master-Data/understanding-master-data/master-data-api.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Data Plane](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-api%23data-plane)\n\n[Getting a document by id](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-api%23getting-a-document-by-id)[Searching for documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-api%23searching-for-documents)\n\n[Control Plane](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-api%23control-plane)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-api%23master-data-v1)[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-api%23master-data-v2)\n\n[Master Data API endpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-api/docs/guides/master-data-api%23master-data-api-endpoints)\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_42dbb908
|
[
{
"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 disabling automatic translation 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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/docs/guides/vtex-io-multi-language-stores)\n\n[Internationalizing product prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/guides/vtex-io-documentation-internationalizing-product-prices)\n\n[Disabling automatic translation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/guides/vtex-io-documentation-disabling-automatic-translation)\n\n[Translating storefront content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/guides/storefront-content-internationalization)\n\n[Translating Catalog content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/guides/catalog-internationalization)\n\n[Overwriting the Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/guides/vtex-io-documentation-overwriting-the-messages-app)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/docs/guides/vtex-io-multi-language-stores)\n\n[Internationalizing product prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/guides/vtex-io-documentation-internationalizing-product-prices)\n\n[Disabling automatic translation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/guides/vtex-io-documentation-disabling-automatic-translation)\n\n[Translating storefront content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/guides/storefront-content-internationalization)\n\n[Translating Catalog content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/guides/catalog-internationalization)\n\n[Overwriting the Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/guides/vtex-io-documentation-overwriting-the-messages-app)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/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-disabling-automatic-translation/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/guides/store-framework)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/guides/vtex-io-multi-language-stores)\n\n[Disabling automatic translation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation/docs/guides/vtex-io-documentation-disabling-automatic-translation)\n\nDisabling automatic translation\n\nAutomatic translation is enabled by default in the Messages app, a standalone application that provides message translations for rendering.\n\nThe Messages app aggregates all the translation services in the VTEX platform, regardless of the app nature (backend or frontend) and the actor responsible for that translation (e.g., app definition, automatic translation service, or overwritten messages via APIs).\n\nWhen deciding which translation the store should display, the Messages app first processes translations defined via API requests at an account-level. Then, if there's no account-level translation, the Messages app goes through storefront app translations (defined within the `/messages` folder). Finally, if no custom translation is found, the Messages app falls back to the automatic translation service.\n\n> Follow [this link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization) to learn how to overwrite storefront messages.\n\n> Follow [this link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-internationalization) to learn how to overwrite messages from the catalog.\n\n> Follow [this link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io) to learn how to set translatable messages in your React component.\n\nTo disable the Messages' automatic translation service, check the following section.\n\n## Instructions\n\n1. Access the admin.\n2. Go to _Account Settings > My apps_.\n3. Search for the VTEX Messages app.\n4. Uncheck the following checkbox: **Enable Automatic Translations**.\n\n\n\n1. Save your changes.\n\nThat's it! Now, messages that don't have custom translations won't be automatically translated anymore.\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/vtex-io-multi-language-stores/vtex-io-documentation-disabling-automatic-translation.md)\n\n[Internationalizing product prices« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation//docs/guides/vtex-io-documentation-internationalizing-product-prices)[Translating storefront contentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation//docs/guides/storefront-content-internationalization)\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-disabling-automatic-translation/docs/guides/vtex-io-documentation-disabling-automatic-translation%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-multi-language-stores/vtex-io-documentation-disabling-automatic-translation.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-disabling-automatic-translation/docs/guides/vtex-io-documentation-disabling-automatic-translation%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_9b300e29
|
[
{
"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 organisms navbar slider 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/organisms-navbar-slider/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/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/organisms-navbar-slider/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/organisms-navbar-slider/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/organisms-navbar-slider/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/organisms-navbar-slider/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/organisms-navbar-slider/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/organisms-navbar-slider/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/organisms-navbar-slider/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/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/organisms-navbar-slider/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/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/organisms-navbar-slider/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-slide-over)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/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/organisms-navbar-slider/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/organisms-navbar-slider/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/organisms-navbar-slider/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/organisms-navbar-slider/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/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/organisms-navbar-slider/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/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/organisms-navbar-slider/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/organisms-navbar-slider/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/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/organisms-navbar-slider/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/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/organisms-navbar-slider/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-slide-over)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/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/organisms-navbar-slider/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/organisms-navbar-slider/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/organisms-navbar-slider/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/organisms-navbar-slider/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/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/organisms-navbar-slider/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/components-index)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-overview)\n\nNavbarSlider\n\nAs part of the Navbar, this component it its mobile version used to list the navigation links.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/organisms/NavbarSlider)\n\nAs part of the [Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar), this component is its **mobile version** used to list the navigation links (through the [NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links)).\n\nThis component is part of the [Navigation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation) feature and must be used in the [Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar) context.\n\n> This component is intended to be used only in the **mobile version**, but it can be adapted to a desktop version by customizing the component styles.\n\nExample\n\nCode\n\nOpen Menu\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { \n\n2\n\n NavbarSlider, \n\n3\n\n NavbarSliderHeader, \n\n4\n\n NavbarSliderContent, \n\n5\n\n NavbarSliderFooter, \n\n6\n\n} 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/organisms/NavbarSlider/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## Design tokens\n\n| Local token | Default value/Global token linked |\n| --------------------------- | --------------------------------- |\n| \\--fs-navbar-slider-padding | var(--fs-spacing-3) |\n\n### Design tokens: Header\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------------- | --------------------------------- |\n| \\--fs-navbar-slider-header-height | 5rem |\n| \\--fs-navbar-slider-header-padding-bottom | var(--fs-spacing-2) |\n| \\--fs-navbar-slider-header-button-margin-right | calc(-1 \\* var(--fs-spacing-1)) |\n\n### Design tokens: Footer\n\n| Local token | Default value/Global token linked |\n| -------------------------------------- | --------------------------------------------- |\n| \\--fs-navbar-slider-footer-padding-top | var(--fs-navbar-slider-header-padding-bottom) |\n| \\--fs-navbar-slider-footer-margin-top | var(--fs-navbar-slider-header-padding-bottom) |\n\n### Design tokens: Logo\n\n| Local token | Default value/Global token linked |\n| ------------------------------------- | --------------------------------- |\n| \\--fs-navbar-slider-logo-padding | 0 |\n| \\--fs-navbar-slider-logo-margin-right | var(--fs-spacing-5) |\n\n---\n\n## Data attributes\n\nYou can target and override `NavbarSlider` styles using the following data attributes:\n\n`data-fs-navbar-slider`\n\n`data-fs-navbar-slider-header`\n\n`data-fs-navbar-slider-content`\n\n`data-fs-navbar-slider-footer`\n\n---\n\n## Props\n\n### NavbarSlider\n\n| Name | Type | Description | Default | | | | | | |\n| ------------------------ | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | -- | ------------------------ | --------------------------- | ------------------- | ----------- | ----------------------------------- |\n| **isOpen** | false \\| true | A boolean value that represents the state of the slider. | true | | | | | | |\n| **direction** | \"leftSide\" \\| \"rightSide\" | Represents the side that the slider comes from. | leftSide | | | | | | |\n| **size** | \"full\" \\| \"partial\" | Represents the size of the slider. | full | | | | | | |\n| **aria-labelledby** | string | Identifies the element (or elements) that labels the current element. @see aria-labelledby https://www.w3.org/TR/wai-aria-1.1/#aria-labelledby | | | | | | | |\n| **children\\*** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Children or function as a children. |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-navbar-slider | | | | | | |\n| **onEntered** | () => void | Callback function when the modal is opened. | | | | | | | |\n| **onDismiss** | () => void | This function is called whenever the user clicks outside. the modal content | | | | | | | |\n| **overlayProps** | Props | Props forwarded to the \\`Overlay\\` component. | | | | | | | |\n| **disableEscapeKeyDown** | false \\| true | Disable being closed using the Escape key. | | | | | | | |\n| **fade\\*** | \"in\" \\| \"out\" | Represents the fade effect of the SlideOver. | | | | | | | |\n\n### NavbarSliderHeader\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-navbar-slider-header | | | | | | |\n| **children** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | A react component to be used as the title in the header. |\n| **closeBtnProps** | Partial<Omit<IconButtonProps, \"onClick\">> | Props for the Close Button component. | | | | | | | |\n| **onClose\\*** | () => void | Function called when Close Button is clicked. | | | | | | | |\n\n### NavbarSliderContent\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-navbar-slider-content |\n\n### NavbarSliderFooter\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-navbar-slider-footer |\n\n---\n\n## Related components\n\n* Storefront \n[Login](#) \nSet location \n * [Office](#) \n * [Home Appliances](#) \n * [Computer and Software](#) \n * [Technology](#) \nNavbar \nRepresents the page header and groups features like Search and Regionalization. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar)\n* Set location \n * [Office](#) \n * [Home Appliances](#) \n * [Computer and Software](#) \n * [Technology](#) \nNavbarLinks \nDisplays a set of navigation links. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/molecules-navbar-links)\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/organisms/navbar-slider.mdx)\n\n[ImageGallery« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-image-gallery)[NavbarNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar)\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/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23design-tokens)\n\n[Design tokens: Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23design-tokens-header)[Design tokens: Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23design-tokens-footer)[Design tokens: Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23design-tokens-logo)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23props)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23navbarslider)[NavbarSliderHeader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23navbarsliderheader)[NavbarSliderContent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23navbarslidercontent)[NavbarSliderFooter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23navbarsliderfooter)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23related-components)\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/organisms/navbar-slider.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/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23design-tokens)\n\n[Design tokens: Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23design-tokens-header)[Design tokens: Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23design-tokens-footer)[Design tokens: Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23design-tokens-logo)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23props)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23navbarslider)[NavbarSliderHeader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23navbarsliderheader)[NavbarSliderContent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23navbarslidercontent)[NavbarSliderFooter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23navbarsliderfooter)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider/docs/guides/faststore/organisms-navbar-slider%23related-components)\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_3f3420c9
|
[
{
"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 api extensions extending queries using fragments 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/api-extensions-extending-queries-using-fragments/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-overview)\n\n[Extending API schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-api-schema)\n\n[Extending queries using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments)\n\n[Consuming FastStore API extension with custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-consuming-api-extensions)\n\n[Best practices for using API extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-best-practices)\n\n[API extensions - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-use-cases-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-overview)\n\n[Extending API schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-api-schema)\n\n[Extending queries using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments)\n\n[Consuming FastStore API extension with custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-consuming-api-extensions)\n\n[Best practices for using API extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-best-practices)\n\n[API extensions - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-use-cases-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/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/api-extensions-extending-queries-using-fragments/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-overview)\n\nExtending queries using fragments\n\nAfter [defining the new fields exposed by the FastStore API Extension](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-api-schema), the next step is to specify where these fields will be used within GraphQL fragments.\n\n[Fragments](https://read.calvincode.net/reader?url=https://graphql.org/learn/queries/%23fragments) in GraphQL are reusable units that enhance query functionality. FastStore associates these fragments with the existing queries on its pages to incorporate the newly exposed fields.\n\n> To access the list of queries and their corresponding fragments, check the [extendable queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments) section.\n\nFollow the steps below to add custom fields to an [existing query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23extendable-queries). We will use the `ServerProduct` query as an example to illustrate how to extend it.\n\n---\n\n## Before you begin\n\n### Avoid over-fetching data on pages\n\nEven though you can add information to the FastStore API schema, you must be careful not to over-fetch data on your pages. See the [best practices for fetching data on your storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview%23best-practices-for-fetching-data).\n\n---\n\n## Instructions\n\n### Step 1: Create a new file\n\n1. In the `src` folder of your store code, create a `fragments` folder.\n\n`1\n\nmkdir fragments \n\n`\n\n1. In the `fragments` folder, create a file named `ServerProduct.ts`.\n\n`1\n\ntouch ServerProduct.ts \n\n`\n\n> The file name should match the name of the query you want to extend.\n\n### Step 2: Define the GraphQL fragment\n\nIn the `ServerProduct.ts` file, define the GraphQL fragment corresponding to the new fields you want to retrieve. In this example, the `customData` property represents the new field. Use the following syntax as a guideline:\n\nsrc/fragments/ServerProduct.ts\n\n`` 1\n\n \n2\n\nimport { gql } from '@faststore/core/api' \n\n3\n\n \n4\n\nexport const fragment = gql(` \n\n5\n\n fragment ServerProduct on Query { \n\n6\n\n product(locator: $locator) { \n\n7\n\n customData \n\n8\n\n } \n\n9\n\n } \n\n10\n\n`) \n\n ``\n\nNow, you can consume `customData` by following the [Consuming FastStore API extension with custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions/consuming-api-extensions) guide.\n\n## Extendable queries\n\nExtendable queries in FastStore's GraphQL API are predefined queries that form the basis for fetching data from the API. These queries enable customization by allowing the addition or modification of fields to align data retrieval with your store-specific requirements.\n\n### `ClientProductGalleryQuery`\n\n| **Fragment** | **Side** | **Query operation** | **Page** | **Usage** | **Return** | Parameters |\n| -------------------- | -------- | ------------------- | -------- | ---------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |\n| ClientProductGallery | Client | search | PLP | In the hook useProductGalleryQuery() from the ProductListingPage (PLP) and Search Pages. | Products totalCount from [StorePageInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storepageinfo), and facets ([StoreFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storefacetboolean)) from [StoreSearchResult](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storesearchresult). | Frontend data from the useSearch() and useLocalizedVariables() hooks, the latter uses useSession(). |\n\nConsuming the query\n\nUse the `usePage()` hook when you have a single section that is used in more than one type of page.\n\n`1\n\nimport { usePage } from \"@faststore/core\" \n\n2\n\n \n3\n\nconst context = usePage() \n\n`\n\nThis hook returns one of the following types as context: `PDPContext`, `PLPContext`, or `SearchPageContext`, and you can decide how to handle it depending on the page that will use this hook by passing the types as generics.\n\n`1\n\nimport { usePage } from \"@faststore/core\" \n\n2\n\n \n3\n\nconst context = usePage<PLPContext | SearchPageContext>() \n\n`\n\n### `ServerCollectionPageQuery`\n\n| **Fragment** | **Side** | **Query operation** | **Page** | **Usage** | **Return** | Parameters |\n| -------------------- | -------- | ------------------- | -------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |\n| ServerCollectionPage | Server | collection | PLP | In the function getStaticProps() from PLP. | seo, breadcrumbList and metaData from the collection ([StoreCollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storecollection)). | Collection slug that comes from URL. |\n\nConsuming the query\n\nUse the `usePLP()` hook when integrating your section with a Product Listing Page (PLP).\n\n`1\n\nimport { usePLP } from \"@faststore/core\" \n\n2\n\n \n3\n\nconst context = usePLP() \n\n`\n\n### `ServerProductQuery`\n\n| **Fragment** | **Side** | **Query operation** | **Page** | **Usage** | **Return** | Parameters |\n| ------------- | -------- | ------------------- | -------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -------------------------------- |\n| ServerProduct | Server | product | PDP | In the function getStaticProps() from PDP. | General product data from [StoreProduct](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeproduct). | The locator with slug key/value. |\n\nConsuming the query\n\n`usePDP()`: Use this hook when integrating your section with a Product Detail Page (PDP).\n\n`1\n\nimport { usePDP } from \"@faststore/core\" \n\n2\n\n \n3\n\nconst context = usePDP() \n\n`\n\n### `ClientProductQuery`\n\n| **Fragment** | **Side** | **Query operation** | **Page** | **Usage** | **Return** | Parameters |\n| ------------- | -------- | ------------------- | -------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |\n| ClientProduct | Client | product | PDP | In the hook useProductQuery() from PDP. | General product data from [StoreProduct](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeproduct) to update product data inside PDP (product coming from ServerProductQuery as fallback). | Frontend data from the useSession() hook in the locator array with id, channel, locale as key/values. |\n\nConsuming the query\n\n`usePDP()`: Use this hook when integrating your section with a Product Detail Page (PDP).\n\n`1\n\nimport { usePDP } from \"@faststore/core\" \n\n2\n\n \n3\n\nconst context = usePDP() \n\n`\n\n> When using both [ServerProductQuery](#serverproductquery) and ClientProductQuery on the PDP, remember that `ServerProductQuery` fetches the initial product data from the server, while `ClientProductQuery` updates that data based on user actions. Make sure to manage how these queries interact to ensure data accuracy. When developing API extensions, prioritize keeping the data consistent and using both queries appropriately to provide users with the most up-to-date information.\n\n### `ClientManyProductsQuery`\n\n| **Fragment** | **Side** | **Query operation** | **Page** | **Usage** | **Return** | Parameters |\n| ------------------ | -------- | ------------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |\n| ClientManyProducts | Client | search | PLP, Search Page, and pages that use ProductShelf, and ProductTiles components. | In the hook usePageProductsQuery() from PLP and Search Page.In the hook useProductsPrefetch() to prefetch the previous (prev) and next (next) page from the current PLP or Search Page.In the hook useProductsQuery(), in ProductShelf, ProductTiles components, that can be used on multiple pages. | General products data ([StoreProduct](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeproduct)) with the totalCount from [StorePageInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storepageinfo). | Frontend data from the useLocalizedVariables() and useSession() hooks. |\n\nConsuming the query\n\nUse the `usePage()` hook when you have a single section that is used in more than one type of page.\n\n`1\n\nimport { usePage } from \"@faststore/core\" \n\n2\n\n \n3\n\nconst context = usePage() \n\n`\n\nThis hook returns one of the following types as context: `PDPContext`, `PLPContext`, or `SearchPageContext`, and you can decide how to handle it depending on the page that will use this hook by passing the types as generics.\n\n`1\n\nimport { usePage } from \"@faststore/core\" \n\n2\n\n \n3\n\nconst context = usePage<PLPContext | SearchPageContext>() \n\n`\n\n### `ClientShippingSimulationQuery`\n\n| **Fragment** | **Side** | **Query operation** | **Page** | **Usage** | **Return** | Parameters |\n| ------------------------ | -------- | ------------------- | -------- | ------------------------------------ | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |\n| ClientShippingSimulation | Client | shipping | PDP | In the ShippingSimulation component. | General shipping simulation data with the address and logisticsInfo. | Frontend country, and postalCode from useSession() hook, and the items Array of IShippingItem (id, quantity, and seller). |\n\nConsuming the query\n\nYou can use the experimental `useShippingSimulation_unstable()` hook, or the `getShippingSimulation_unstable()` function to retrieve shipping data in Overridable (custom) components.\n\n### `ClientSearchSuggestionsQuery`\n\n| **Fragment** | **Side** | **Query operation** | **Page** | **Usage** | **Return** | Parameters |\n| ----------------------- | -------- | ------------------- | ----------------------------------------- | ----------------------------- | ------------------------------------------------------ | ------------------------------------------------------------ |\n| ClientSearchSuggestions | Client | search | SearchInput component from GlobalSection. | In the SearchInput component. | General search data with the suggestions and products. | Frontend data from useSession() hook, and the term searched. |\n\nConsuming the query\n\nYou can use the experimental `useSuggestions_unstable()` hook to retrieve the search suggestions data in Overridable (custom) components.\n\n### `ClientTopSearchSuggestionsQuery`\n\n| **Fragment** | **Side** | **Query operation** | **Page** | **Usage** | **Return** | Parameters |\n| -------------------------- | -------- | ------------------- | ----------------------------------------- | ----------------------------- | ----------------------------- | ------------------------------------- |\n| ClientTopSearchSuggestions | Client | search | SearchInput component from GlobalSection. | In the SearchInput component. | The top searched suggestions. | Frontend data from useSession() hook. |\n\nConsuming the query\n\nYou can use the experimental `useTopSearch_unstable()` hook to retrieve the top search suggestions data in Overridable (custom) components.\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/hellofanny)\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/api-extensions/extending-queries-using-fragments.mdx)\n\n[Extending API schemas« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-api-schema)[Consuming FastStore API extension with custom componentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-consuming-api-extensions)\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/hellofanny)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23before-you-begin)\n\n[Avoid over-fetching data on pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23avoid-over-fetching-data-on-pages)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23instructions)\n\n[Step 1: Create a new file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23step-1-create-a-new-file)[Step 2: Define the GraphQL fragment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23step-2-define-the-graphql-fragment)\n\n[Extendable queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23extendable-queries)\n\n[ClientProductGalleryQuery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23clientproductgalleryquery)[ServerCollectionPageQuery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23servercollectionpagequery)[ServerProductQuery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23serverproductquery)[ClientProductQuery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23clientproductquery)[ClientManyProductsQuery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23clientmanyproductsquery)[ClientShippingSimulationQuery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23clientshippingsimulationquery)[ClientSearchSuggestionsQuery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23clientsearchsuggestionsquery)[ClientTopSearchSuggestionsQuery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23clienttopsearchsuggestionsquery)\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/api-extensions/extending-queries-using-fragments.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/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23before-you-begin)\n\n[Avoid over-fetching data on pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23avoid-over-fetching-data-on-pages)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23instructions)\n\n[Step 1: Create a new file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23step-1-create-a-new-file)[Step 2: Define the GraphQL fragment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23step-2-define-the-graphql-fragment)\n\n[Extendable queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23extendable-queries)\n\n[ClientProductGalleryQuery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23clientproductgalleryquery)[ServerCollectionPageQuery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23servercollectionpagequery)[ServerProductQuery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23serverproductquery)[ClientProductQuery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23clientproductquery)[ClientManyProductsQuery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23clientmanyproductsquery)[ClientShippingSimulationQuery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23clientshippingsimulationquery)[ClientSearchSuggestionsQuery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23clientsearchsuggestionsquery)[ClientTopSearchSuggestionsQuery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments/docs/guides/faststore/api-extensions-extending-queries-using-fragments%23clienttopsearchsuggestionsquery)\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_7cd6f742
|
[
{
"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 locator 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-locator/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-locator/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-locator/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-locator/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-locator/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-locator/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-locator/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-locator/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/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-locator/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-locator/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/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-locator/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-locator/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-locator/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-locator/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-locator/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/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-locator/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/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-locator/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/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-locator/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/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-locator/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-locator/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-locator/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/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-locator/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/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-locator/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-locator/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/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-locator/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-locator/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-locator/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-locator/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-locator/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/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-locator/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/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-locator/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/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-locator/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/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-locator/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-locator/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-locator/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/guides/advanced-components)\n\nStore Locator\n\nOfficial extension\n\nVersion: 1.0.1\n\nLatest version: 1.0.1\n\n## ⚠️ Maintenance ⚠️\n\n_Starting June 1st 2023, this application will no longer be maintained by VTEX._\n\n---\n\n[](#contributors-)\n\nThe Store Locator app fetches the Pickup point data in order to display address location for retail stores.\n\n\n\n\n\n## Configuration\n\n1. [Install](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/installing-an-app/) the Store Locator app in your VTEX account by running `vtex install vtex.store-locator` in your terminal.\n2. In your account's admin page, select **Inventory & Shipping** section and then access **Settings**.\n3. Type in the Google Geolocation API key and save your changes.\n4. Open your Store Theme app directory in your code editor.\n5. Add the Store Locator app as a `peerDependency` in the `manifest.json` file:\n\n`1\n\n \"peerDependencies\": { \n\n2\n\n+ \"vtex.store-locator\": \"0.x\" \n\n3\n\n } \n\n`\n\nOnce installed, the app will generate a new route called `/stores` for your store, listing the retail stores registered in the **Pickup Points** section (under the **Inventory & Shipping** module).\n\nThe new page already contains a default template with all blocks exported by the Store Locator app, meaning the `/stores` page is ready to be rendered and no further actions are required. However, you can **customize the new page overwriting the template by creating a brand new one**. To do so, check the [**Advanced configuration**](./README.md#advanced-configuration) section below.\n\n> _This app will also **add a new entry to your store's `/sitemap.xml` file so that all your pickup points are available to search engines** \\- make sure you already have the `vtex.store-sitemap@2.x` app installed in your VTEX account!_\n\n### Advanced configuration\n\nIn order to define the Store Locator custom page UI, you must use the blocks exported by the `vtex.store-locator` app. Namely, they are:\n\n| Block name | Description |\n| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| store-list | Renders a list of retail stores and a map with all their locations marked. |\n| store-group | Provides the Pickup Point data to other blocks exported by the app, such as the ones listed below. |\n| store-name | Renders the store name. |\n| store-back-link | Renders a link to return to the previous page. |\n| store-map | Renders a map with the retail store's location. |\n| store-address | Renders the store's address. |\n| store-hours | Renders the store's opening hours. This information comes by default from the Pickup Points configuration, but you can also define manually through the Store's theme |\n| store-instructions | Renders the desired instructions to access the retail store. |\n\n1. Open your Store Theme app directory in your code editor.\n2. In the `/store/blocks` folder of your Store Theme app, create a new file called `storelocator.json`.\n3. Create a new store template in it called `store.storelocator`. In its blocks array, paste the default implementation stated below:\n\n`1\n\n{ \n\n2\n\n \"store.storelocator\": { \n\n3\n\n \"blocks\": [\"flex-layout.row#title\", \"flex-layout.row#container\"] \n\n4\n\n }, \n\n5\n\n \"flex-layout.row#title\": { \n\n6\n\n \"children\": [\"flex-layout.col#title\"] \n\n7\n\n }, \n\n8\n\n \"flex-layout.row#container\": { \n\n9\n\n \"children\": [\"store-list\"] \n\n10\n\n }, \n\n11\n\n \"flex-layout.col#title\": { \n\n12\n\n \"children\": [\"rich-text#title\"], \n\n13\n\n \"props\": { \n\n14\n\n \"blockClass\": \"title\", \n\n15\n\n \"preventVerticalStretch\": true \n\n16\n\n } \n\n17\n\n }, \n\n18\n\n \"rich-text#title\": { \n\n19\n\n \"props\": { \n\n20\n\n \"text\": \"## Store Locator\" \n\n21\n\n } \n\n22\n\n }, \n\n23\n\n \"store.storedetail\": { \n\n24\n\n \"blocks\": [\"flex-layout.row#titleStore\", \"store-group\"] \n\n25\n\n }, \n\n26\n\n \"store-group\": { \n\n27\n\n \"children\": [\"flex-layout.row#containerStore\"], \n\n28\n\n \"props\": { \n\n29\n\n \"title\": \"{storeName} Store\" \n\n30\n\n } \n\n31\n\n }, \n\n32\n\n \"flex-layout.row#titleStore\": { \n\n33\n\n \"children\": [\"flex-layout.col#titleStore\"] \n\n34\n\n }, \n\n35\n\n \"flex-layout.row#containerStore\": { \n\n36\n\n \"children\": [\"flex-layout.col#detail\", \"flex-layout.col#store\"] \n\n37\n\n }, \n\n38\n\n \"flex-layout.col#titleStore\": { \n\n39\n\n \"children\": [\"rich-text#titleStore\"], \n\n40\n\n \"props\": { \n\n41\n\n \"blockClass\": \"title\", \n\n42\n\n \"preventVerticalStretch\": true \n\n43\n\n } \n\n44\n\n }, \n\n45\n\n \"rich-text#titleStore\": { \n\n46\n\n \"props\": { \n\n47\n\n \"text\": \"## Store Detail\" \n\n48\n\n } \n\n49\n\n }, \n\n50\n\n \"flex-layout.col#detail\": { \n\n51\n\n \"children\": [ \n\n52\n\n \"store-back-link\", \n\n53\n\n \"store-map\", \n\n54\n\n \"store-address\", \n\n55\n\n \"store-hours\", \n\n56\n\n \"store-instructions\" \n\n57\n\n ], \n\n58\n\n \"props\": { \n\n59\n\n \"width\": \"30%\", \n\n60\n\n \"preventVerticalStretch\": true \n\n61\n\n } \n\n62\n\n }, \n\n63\n\n \"flex-layout.col#store\": { \n\n64\n\n \"children\": [\"store-name\"], \n\n65\n\n \"props\": { \n\n66\n\n \"width\": \"70%\" \n\n67\n\n } \n\n68\n\n }, \n\n69\n\n \"store-hours\": { \n\n70\n\n \"props\": { \n\n71\n\n \"label\": \"Business hours:\", \n\n72\n\n \"format\": \"12h\", \n\n73\n\n \"businessHours\": [ \n\n74\n\n { \n\n75\n\n \"dayOfWeek\": \"Sunday\", \n\n76\n\n \"openingTime\": \"11:00am\", \n\n77\n\n \"closingTime\": \"5:00pm\" \n\n78\n\n }, \n\n79\n\n { \n\n80\n\n \"dayOfWeek\": \"Monday\", \n\n81\n\n \"openingTime\": \"11:00am\", \n\n82\n\n \"closingTime\": \"6:00pm\" \n\n83\n\n }, \n\n84\n\n { \n\n85\n\n \"dayOfWeek\": \"Tuesday\", \n\n86\n\n \"openingTime\": \"11:00am\", \n\n87\n\n \"closingTime\": \"6:00pm\" \n\n88\n\n }, \n\n89\n\n { \n\n90\n\n \"dayOfWeek\": \"Wednesday\", \n\n91\n\n \"openingTime\": \"11:00am\", \n\n92\n\n \"closingTime\": \"6:00pm\" \n\n93\n\n }, \n\n94\n\n { \n\n95\n\n \"dayOfWeek\": \"Thursday\", \n\n96\n\n \"openingTime\": \"11:00am\", \n\n97\n\n \"closingTime\": \"6:00pm\" \n\n98\n\n }, \n\n99\n\n { \n\n100\n\n \"dayOfWeek\": \"Friday\", \n\n101\n\n \"openingTime\": \"11:00am\", \n\n102\n\n \"closingTime\": \"6:00pm\" \n\n103\n\n }, \n\n104\n\n { \n\n105\n\n \"dayOfWeek\": \"Saturday\", \n\n106\n\n \"openingTime\": \"11:00am\", \n\n107\n\n \"closingTime\": \"5:00pm\" \n\n108\n\n } \n\n109\n\n ] \n\n110\n\n } \n\n111\n\n }, \n\n112\n\n \"store-back-link\": { \n\n113\n\n \"props\": { \n\n114\n\n \"label\": \"Back to all stores\" \n\n115\n\n } \n\n116\n\n }, \n\n117\n\n \"store-instructions\": { \n\n118\n\n \"props\": { \n\n119\n\n \"label\": \"\" \n\n120\n\n } \n\n121\n\n } \n\n122\n\n} \n\n`\n\n1. Configure each one of the blocks previously declared as you wish using their props (check out the following tables).\n\n#### `store-list`\n\n| Prop name | Type | Description | Default value |\n| ----------- | ------ | ------------------------------------------------------------------------ | -------------------- |\n| filterByTag | string | Filter fetched Pickup Points by this tag. | undefined |\n| icon | string | Icon used to display store location in map. Input icon URL (svg or png). | Google's default |\n| iconWidth | number | Icon width in pixels (px). | Image default width |\n| iconHeight | number | Icon height in pixels (px). | Image default height |\n| zoom | number | Map zoom as a number. | 10 |\n| lat | number | Latitude coordinate. | undefined |\n| long | number | Longitude coordinate. | undefined |\n| sortBy | string | Property (name or distance) used to sort the stores list. | distance |\n\n> _Use the `lat` and `long` props to display Pickup Points configured in seller accounts. If these props are not configured and you do not have any pick up points set up in your main account, the app will display no stores._\n\n> _The `filterByTag` prop cannot be used along with `lat` and `long`. If you set a value for `filterByTag`, the `lat` and `long` props will be ignored._\n\n#### `store-group` props\n\n| Prop name | Type | Description | Default value |\n| ------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| title | string | Title used in the page's HTML title tag and Structured Data for SEO purposes. The {storeName}, {storeCity}, and / or {storeState} variables can be used in the title text. | {storeName} |\n| description | string | Description text used in the page's HTML description meta tag and Structured Data for SEO purposes. The {storeName}, {storeCity}, and / or {storeState} variables can be used in the description text. | empty string |\n| imageSelector | string | CSS Selector to select the images included in the page's Structured Data. | empty string |\n| instructionsAsPhone | boolean | To provide a unique phone number for each store, a phone number can be entered in the Instructions field in the Pickup Points section. The store-instructions will display a phone number and it will be included in the page's Structured Data. | false |\n\n⚠️ _Both `imageSelector` and `instructionsAsPhone` must be declared with valid values in order to provide Structured Data for SEO purposes._\n\n#### `store-name` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| text | string | Text to be displayed as store name. {storeName}, {storeCity}, and / or {storeState} values can be used to generate the store name. | undefined |\n| tag | string | HTML element to wrap the store-name block when rendered on the UI. | div |\n\n#### `store-back-link` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ---------------------------------------------------------------- | ------------------ |\n| label | string | Text displayed by store-back-link block when rendered on the UI. | Back to all stores |\n\n#### `store-map` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------- | ------------------------------------------------------------------------ | ------------- |\n| width | string | Map width. | 100% |\n| height | string | Map height. | 200px |\n| zoom | integer | Map zoom as a number | 14 |\n| icon | string | Icon used to display store location in map. Input icon URL (svg or png). | undefined |\n\n#### `store-address` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ---------------------------------------------------------- | ------------- |\n| label | string | Label for the store-address block when rendered on the UI. | Store address |\n\n#### `store-hours` props\n\n| Prop name | Type | Description | Default value. |\n| ------------- | --------------- | ------------------------------------------------------------------------------- | -------------- |\n| label | string | Label for the store-hours block when rendered on the UI. | Store hours |\n| format | enum | Hour format. Possible values are 12h and 24h. | 24h |\n| businessHours | array of object | format {\"dayOfWeek\": \"Sunday\",\"openingTime\": \"11:00am\",\"closingTime\": \"5:00pm\"} | undefined |\n\n#### `store-description` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| text | string | Text to be displayed on the store page. Use {storeName}, {storeCity}, or {storeState} within your text to display that store's specific value. | undefined |\n\n#### `store-instructions` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | --------------------------------------------------------------- | ------------- |\n| label | string | Label for the store-instructions block when rendered on the UI. | Information |\n\n## 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| addressContainer |\n| addressLabel |\n| addressListFirstItem |\n| addressListItem |\n| addressListLink |\n| addressList |\n| addressStoreAddress |\n| addressStoreName |\n| addressStoreAddressGroupA |\n| addressStoreAddressNumber |\n| addressStoreAddressStreet |\n| backlinkContainer |\n| backlink |\n| businessHours |\n| container |\n| descriptionContainer |\n| descriptionText |\n| dayOfWeek |\n| divider |\n| hourRow |\n| hoursContainer |\n| hoursLabel |\n| instructionsContainer |\n| instructionsLabel |\n| instructionsText |\n| listingMapContainer |\n| loadAll |\n| markerInfoAddress |\n| markerInfoLink |\n| markerInfoStoreName |\n| markerInfo |\n| noResults |\n| storeName |\n| storesListCol |\n| storesList |\n| storesMapCol |\n\n[Store Drawer« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-drawer)[Store FormNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-form)\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[⚠️ Maintenance ⚠️](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-locator%23-maintenance-)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-locator%23configuration)\n\n[Advanced configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-locator%23advanced-configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-locator/docs/apps/vtex.store-locator%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_8cd7d6fc
|
[
{
"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 select 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-select-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-select-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-select-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-select-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-select-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-select-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-select-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-select-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-select-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-select-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-select-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-select-field/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-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-select-field/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-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-select-field/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-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-select-field/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-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-select-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-select-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-select-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-select-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-select-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-select-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-select-field/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-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-select-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-select-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-select-field/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-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-select-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-select-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-select-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-select-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-select-field/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-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-select-field/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-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-select-field/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-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-select-field/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-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-select-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-select-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-select-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-select-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-select-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-select-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-select-field/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-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-select-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-select-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-select-field/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-overview)\n\nSelectField\n\nGroups a Select input and its corresponding Label.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/Alert)\n\nThe `SelectField` component wraps a [Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select) input and its corresponding [Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label). It allows users to select one option from a set.\n\nExample\n\nCode\n\nSelect a Status:\n\nGreatOkBad\n\nSelect a Status:\n\nGreatOkBad\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { SelectField } 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/SelectField/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## Design tokens\n\n| Local token | Default value/Global token linked |\n| ------------------------------- | --------------------------------- |\n| \\--fs-select-label-color | var(--fs-color-text-light) |\n| \\--fs-select-label-margin-right | var(--fs-spacing-1) |\n\n---\n\n## Data attributes\n\nYou can target and override `SelectField` styles using the following data attributes:\n\n`data-fs-select-field`\n\n`data-fs-select-field-label`\n\n---\n\n## Props\n\n| Name | Type | Description | Default |\n| ------------- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- |\n| **label\\*** | string | Defines the text displayed in the label right next to the Select. | |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-select-field |\n| **id\\*** | string | Assigns an identifier to link the UISelect component and its label. | |\n| **options\\*** | Record<string, string> | Defines the options available in the select. The SelectOptions object keys are the property names, while the values correspond to the text that will be displayed in the UI. | |\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/select-field.mdx)\n\n[SearchTop« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-search-top)[SKUSelectorNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-sku-selector)\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-select-field/docs/guides/faststore/molecules-select-field%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-select-field%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-select-field%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-select-field%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-select-field%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-select-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/select-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-select-field/docs/guides/faststore/molecules-select-field%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-select-field%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-select-field%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-select-field%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-select-field%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field/docs/guides/faststore/molecules-select-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_ed8a758c
|
[
{
"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 vtex do 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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-api/docs/api-reference/vtex-do-api/)\n\nNote\n\nTask\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-do-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-do-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-do-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-do-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-do-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-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/vtex-do-api/docs/api-reference/vtex-do-api/)\n\nNote\n\nTask\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-do-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/vtex-do-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/vtex-do-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[GeGet Delivery Service by Invoice« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-do-api/docs/api-reference/tracking%23get-/services/invoice)[PoCreate noteNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-do-api/docs/api-reference/vtex-do-api%23post-/notes)\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_e4935a86
|
[
{
"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 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/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/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/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/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/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/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/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/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/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/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/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/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/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/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/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/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/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/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/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/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/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/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/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/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/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/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/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/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/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/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/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/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/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/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/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/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/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/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/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/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/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/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/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework)\n\nStore Framework\n\nStore Framework is a front-end development framework designed to enhance and simplify the creation of ecommerce websites within VTEX. Built on the [VTEX IO development platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io) and [React](https://read.calvincode.net/reader?url=https://reactjs.org/) technology, the framework offers native storefront components in JSON format.\n\nStore Framework relies on the following pillars:\n\n| Aspect | Description |\n| ----------------------------- | ---------------------------------------------------------------------------------------------------- |\n| Composability | Assemble pre-built and custom components to create a storefront tailored to specific business needs. |\n| Flexibility and customization | Adapt storefronts to unique design requirements and functional preferences. |\n| Workspaces | Create multiple store versions and test them to guarantee reliability and deploy changes safely. |\n| A/B tests | Experiment with different versions of a storefront to enhance user experience and performance. |\n| VTEX IO cloud infrastructure | Develop in a fully managed auto-scalable infrastructure. |\n\n## Store Framework architecture\n\nCodebase\n\nBuild process\n\nDeployment\n\nCustomer touchpoint\n\nUser touchpoint\n\nCloud - AWS\n\nVTEX IO apps\n\nBuilder Hub\n\nHousekeeper\n\nPWA\n\nWebstore\n\nCMS / Site Editor\n\nDeveloper Tools\n\nDevelopment workspaces\n\nVTEX IO CLI\n\nA/B tests\n\nProduction workspaces\n\nEdition apps\n\nBuilders\n\nAdmin\n\nGraphQL\n\nReact\n\nStore\n\nNode\n\nPixel\n\nTechnologies\n\nNode\n\nReact\n\nTypescript\n\nGraphQL\n\nThe diagram shows a typical Store Framework architectural flow, which includes the following components:\n\n* **Codebase:** The source code for Store Framework and VTEX IO apps is cloud-native.\n* **Build process:** The process of converting the source code into a deployable application, based on [VTEX IO Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders).\n* **Deployment:** The process of deploying the application to a production environment.\n* **Business user touchpoint:** where administrative users interact with storefront settings, on CMS and Site Editor.\n* **Customer touchpoint:** where customers interact with the storefront, usually on a webstore or PWA.\n\n### Developer Tools\n\nDevelopers using Store Framework can count on a set of tools:\n\n* [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): Interact with the VTEX platform using our command-line tool.\n* [A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ab-tests): Compare traffic between two workspaces.\n* [Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app): Streamline your setup by installing a preset bundle of settings, policies, backend and frontend apps.\n* [Development workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace): Test and preview your code in workspaces dedicated to development, without affecting the live store.\n* [Production workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace): Run tests and quality assurance in a workspace that is ready to handle live traffic.\n* [Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders): Connect your apps to our services quickly using VTEX IO Builders.\n\n### Technologies\n\nTo work with this framework, you should be familiar with the following technologies:\n\n* [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io)\n* [React](https://read.calvincode.net/reader?url=https://reactjs.org/)\n* [Node.js](https://read.calvincode.net/reader?url=https://nodejs.org/en)\n* [TypeScript](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/)\n* [GraphQL](https://read.calvincode.net/reader?url=https://graphql.org/)\n\n## Quickstart\n\nThis quickstart guide is a brief introduction to the VTEX Store Framework. For more detailed step-by-step documentation, check [Store Framework - Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3).\n\n### 1\\. Initial settings\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). You will need it to run commands in the following steps.\n2. Log in to your VTEX account: \n`1 \nvtex login {accountName} \n`\n3. Open a [support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/support?/cultureInfo=en-us) to set up your account’s Edition app to `vtex.edition-store@3.x` or higher. Refer to the [Edition App article](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) to identify the most suitable version for your scenario.\n4. Install Intelligent Search (if the account’s Edition app is `vtex.edition-store@4.x` or lower) and integrate it with your store’s catalog according to [this guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites%23step-2-implementing-the-vtex-intelligent-search).\n\n### 2\\. Setting up the project\n\n1. Navigate to a local file directory where you want our [boilerplate store theme](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme) to be saved: \n`1 \ncd {folderName} \n`\n2. Start a new project: \n`1 \nvtex init \n`\n3. Select `store` by navigating with your arrow keys and pressing `Enter`. When prompted to confirm, type `y` to clone the `minimum-boilerplate-theme` to your folder.\n4. Create a workspace: \n`1 \nvtex use {workspaceName} \n`\n5. Navigate to the `minimum-boilerplate-theme` directory: \n`1 \ncd minimum-boilerplate-theme \n`\n6. Link your local repository with the workspace: \n`1 \nvtex link \n`\n7. Access your workspace: \n`1 \nvtex browse \n`\n\nNow you can make changes to the local repository and test them live in the workspace without altering the store's final public version.\n\n## Next steps\n\n### Customizing your theme\n\n[Building your own store themeLearn how to create your store theme from scratch.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme)[Building pagesCreate custom pages for your ecommerce.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page)[Using componentsLeverage from premade components to build your store theme.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-carousel-using-slider-layout)[StylingCustomize your store's style.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-contributing-with-new-css-handles)\n\n### Deploying your changes\n\n[Making your theme content publicPublish your new store theme.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public)[Going liveMake your store available to shoppers.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\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/Storefront-Guides/store-framework.md)\n\n[Tracing the error source« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework//docs/guides/faststore/troubleshooting-tracing-the-error-source)[Store ThemeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework//docs/guides/vtex-io-documentation-store-theme)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Store Framework architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23store-framework-architecture)\n\n[Developer Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23developer-tools)[Technologies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23technologies)\n\n[Quickstart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23quickstart)\n\n[1\\. Initial settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%231-initial-settings)[2\\. Setting up the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%232-setting-up-the-project)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23next-steps)\n\n[Customizing your theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23customizing-your-theme)[Deploying your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23deploying-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/guides/vtex-io/Storefront-Guides/store-framework.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Store Framework architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23store-framework-architecture)\n\n[Developer Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23developer-tools)[Technologies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23technologies)\n\n[Quickstart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23quickstart)\n\n[1\\. Initial settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%231-initial-settings)[2\\. Setting up the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%232-setting-up-the-project)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23next-steps)\n\n[Customizing your theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23customizing-your-theme)[Deploying your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23deploying-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_ce2cefbe
|
[
{
"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 seller portal edition app 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/seller-portal-edition-app/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/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/seller-portal-edition-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/managing-edition-apps)\n\n[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-edition-app)\n\n[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-sponsor-account)\n\n[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)\n\n[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app)\n\n[Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-updating-edition-apps)\n\n[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/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/seller-portal-edition-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/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/seller-portal-edition-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/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/seller-portal-edition-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/managing-edition-apps)\n\n[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-edition-app)\n\n[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-sponsor-account)\n\n[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)\n\n[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app)\n\n[Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-updating-edition-apps)\n\n[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/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/seller-portal-edition-app/docs/app-development)\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/managing-edition-apps)\n\n[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app)\n\nSeller Portal Edition App\n\nLearn how marketplaces can configure their own Edition App to create a customized Seller Portal.\n\nThe [Seller Portal](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/seller-portal-primeiros-passos--6w1vBdRH2uuBGmUqgNQjwK) is a VTEX platform edition used by sellers to connect and sell their products on VTEX marketplaces. What differentiates it from a regular VTEX Admin is the curation of pages: we have selected only the key pages from VTEX’s Admin that fit the most with a seller’s operations.\n\nThat selection is possible because Seller Portal is actually a VTEX IO app. All pages available on the Seller Portal are declared in an Edition App, built using VTEX IO. This means that all sellers added to the marketplace’s Seller Portal will see the same experience, which is defined in the edition app.\n\nIn this guide, we will review some key concepts around the Edition App’s architecture and point out how marketplaces can configure their own Edition App to create a customized Seller Portal.\n\n## App sponsor\n\nEvery Seller Portal account is created from a VTEX IO [Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app), which is defined by its [sponsor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account). The sponsor is the entity responsible for defining which pages will be included in that edition. In the code, they are defined as the app’s vendor. The `vendor` field represents the sponsor, and the `name` field, the seller’s edition app.\n\n`1\n\n{ \n\n2\n\n \"vendor\": \"vtex\", \n\n3\n\n \"name\": \"edition-seller\", \n\n4\n\n} \n\n`\n\n> It is not possible to create edition apps without a VTEX account as the sponsor.\n\nTwo entities can become an Edition app’s sponsor: VTEX or a VTEX marketplace.\n\n### VTEX as the sponsor\n\nIn default Seller Portal environments, VTEX is the sponsor of the edition. This means that VTEX is responsible for:\n\n* Selecting which pages would be included in Seller Portal’s default environment.\n* Creating the edition app that will become the default Seller Portal.\n\nVTEX has therefore defined its own edition for the Seller Portal, which includes the default pages that come within an account.\n\n### Marketplace as the sponsor\n\nIt is also possible for marketplaces to create their own custom editions of Seller Portal by becoming sponsors of their own edition app. When a marketplace wishes to select extra pages to be included in the seller’s experience, they can create their custom editions of Seller Portal by becoming sponsors of a an edition app.\n\nMarketplaces that choose to be sponsors of their own edition app usually want:\n\n* To have all the default pages that come with VTEX’s Seller Portal edition included for their sellers in an easy and quick way.\n* To automatically add specific pages that are not included in VTEX’s default edition to all their sellers using Seller Portal.\n\nThe edition app sponsored by the marketplace should become the app’s sponsor and add VTEX’s edition as a “dependency” field. We will go over the step-by-step process of building your app in the [Configuring your Edition App](#configuring-your-edition-app) section of this article.\n\n> To sponsor an app, please open a ticket to VTEX Support so your account can be enabled as a sponsor.\n\n### App dependencies\n\nMaking VTEX’s edition app a `dependency` automatically includes all of VTEX’s default pages, updates, and bug fixes. In this way, you don’t have to manually include all apps in the default experience. They can just import what is in VTEX’s edition.\n\nOnce VTEX’s edition is declared as a dependency, you can add your own desired pages in the edition/apps.json file.\n\n`1\n\n{ \n\n2\n\n \"dependencies\": { \n\n3\n\n \"vtex.edition-seller\": \"0.x\" \n\n4\n\n }, \n\n5\n\n} \n\n`\n\nEvery **Edition App** has a **dependency** declared, which imports pages from another edition app.\n\nApplied edition\n\nApplied edition\n\nApplied edition\n\nApplied edition\n\nmarketplace1.edition-seller\n\nDefault Apps from Seller Portal\n\nCustom Apps from Marketplace 1\n\nDependency: vtex.edition-seller\n\nvtex.edition-store\n\nDefault pages from Edition Store\n\nvtex.edition-seller\n\nDefault Apps from Seller Portal\n\nVTEX\n\nMarketplace 1\n\nSeller 1\n\nSeller 2\n\nSeller 3\n\n## Configuring your Edition App\n\nTo configure your Edition app, follow these steps:\n\n### Cloning the repository\n\n1. Open the terminal and 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) to log in to the desired VTEX account.\n2. Run `vtex init`.\n3. Choose the `edition app` option.\n\nIf you don't have VTEX IO CLI installed, you can also clone it manually:\n\n`git clone https://github.com/vtex/edition-hello edition-hello`\n\n`cd edition-hello`\n\n### Defining the Manifest\n\nAfter cloning the repository, follow the instructions below to configure your app:\n\n1. In the `manifest.json`, change the `name` to `sponsor.edition-seller`.\n\n> The name `sponsor.edition-seller` is mandatory, if another name is configured, the application will not work. By standard, VTEX adopts the edition-seller- prefix in all edition apps.\n\n1. Change the `vendor` field to your store’s account name, to become the app’s sponsor.\n\n> Make sure you request through VTEX Support that your store is enabled to become the app’s sponsor.\n\n1. Set the appropriate parent edition in the `dependencies` field.\n\n> The dependency must be published by the vendor's sponsor.\n\n### Adding apps for sub-accounts\n\nAfter configuring your manifest, you can specify apps to be installed in the sub-accounts that have this edition configured. You do that through the `edition/apps.json` file, adding an entry to the object under the `apps` key in the format:\n\n`1\n\n{ \n\n2\n\n \"<vendor>.<name>\": { \n\n3\n\n \"major\": \"<desired major>\", \n\n4\n\n \"settings\": \"<initial settings>\" \n\n5\n\n }, \n\n6\n\n} \n\n`\n\nThe settings are optional and can be omitted, but they will define the initial settings that should be configured for the app when it is installed through the current edition.\n\nE.g.: The contents of the `apps.json` file could be:\n\n`1\n\n{ \n\n2\n\n \"apps\": { \n\n3\n\n \"vtex.node-getting-started\": { \"major\": 0 } \n\n4\n\n } \n\n5\n\n} \n\n`\n\n### Testing\n\nTo test the app, make sure you have [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install) installed.\n\nEdition apps cannot be linked, so for testing, you need to launch a pre-release version and set them on test accounts or workspaces for validation. To do so:\n\n1. Launch a pre-release of your edition: `vtex release patch beta`.\n2. Check the edition of the current account/workspace: `vtex edition`.\n3. Set the edition in the current account/workspace: `vtex edition set <edition>@<version>`.\n\nAll the apps configured in the `apps.json` file will be automatically installed in that workspace where the edition was set. You can validate that by inspecting the `vtex ls` command output.\n\n## Multiple marketplaces using the same edition\n\nThere is another scenario where more than one marketplace, which is under the same parent company, wishes to operate with the same Seller Portal edition app.\n\nIn the example below we guide you through the architecture that enables this scenario.\n\n### Scenario example\n\n**Scenario:** Two separate marketplaces, with different sellers, wish to provide the same Seller Portal experience to their sellers, without the complexity of creating multiple edition apps.\n\nWe have two marketplaces: The **MKPSeller** and the **Cosmetics2**. They are both part of the same holding, but they're different marketplace accounts.\n\nThe **MKPSeller** has created an edition app, based on our default, **vtex.edition-seller**, and added other custom pages they wish to provide for their sellers. They called the edition they sponsored the `mkpseller.edition-seller` .\n\nThey declare the default edition that VTEX has sponsored, or `vtex.edition-seller`, as a dependency on their app’s code. This action automatically imports all the default Seller Portal apps to their edition app.\n\n`1\n\n{ \n\n2\n\n \"vendor\": \"mkpseller\", \n\n3\n\n \"name\": \"edition-seller\", \n\n4\n\n \"version\": \"0.1.0\", \n\n5\n\n \"title\": \"MKP Seller edition apps\", \n\n6\n\n \"description\": \"VTEX IO edition for seller accounts\", \n\n7\n\n \"builders\": { \n\n8\n\n \"edition\": \"0.x\" \n\n9\n\n }, \n\n10\n\n \"dependencies\": { \n\n11\n\n \"vtex.edition-seller\": \"0.x\" \n\n12\n\n }, \n\n13\n\n \"$schema\": \"https://raw.githubusercontent.com/vtex/node-vtex-api/master/gen/manifest.schema\" \n\n14\n\n} \n\n`\n\nMeanwhile, **Cosmetics2** also wants to create an edition app, copying **MKPseller’s** edition, since they came to the conclusion that **MKPseller's** edition fits all their needs.\n\nInstead of creating an edition app and manually adding the desired custom pages one by one, they can simply create their app, and declare **MKPSeller's** edition as a dependency.\n\n`1\n\n{ \n\n2\n\n \"vendor\": \"cosmetics2\", \n\n3\n\n \"name\": \"edition-seller\", \n\n4\n\n \"version\": \"0.1.0\", \n\n5\n\n \"title\": \"Cosmetics2 edition apps\", \n\n6\n\n \"description\": \"VTEX IO edition for seller accounts\", \n\n7\n\n \"builders\": { \n\n8\n\n \"edition\": \"0.x\" \n\n9\n\n }, \n\n10\n\n \"dependencies\": { \n\n11\n\n \"mkpseller.edition-seller\": \"0.x\" \n\n12\n\n }, \n\n13\n\n \"$schema\": \"https://raw.githubusercontent.com/vtex/node-vtex-api/master/gen/manifest.schema\" \n\n14\n\n} \n\n`\n\nFor the dependency to work, **MKPSeller** must be **Cosmetics2** app’s sponsor. This means that **Cosmetics2** has an edition belonging to **MKPSeller** associated to it.\n\n> To know which edition is associated with an account, run `vtex edition get` on the terminal.\n\nThis way, **Cosmetics2** edition app will include everything declared in `mkpseller.edition-seller` . This means including:\n\n* VTEX’s default apps, since they were declared as a dependency.\n* The custom pages added by **MKPSeller**, since they created their custom edition.\n\nSumming it up, to declare VTEX or another marketplace’s **Edition app** as a **dependency**, this dependency’s owner must be the app’s **sponsor**.\n\n### Limitations for multiple marketplace architecture\n\nThe current multiple marketplace architecture has some limitations:\n\n* The apps included in an edition can only belong to the same sponsor, or to VTEX. E.g. MKPSeller cannot add apps from Cosmetics2's edition.\n* An edition cannot have more than one sponsor.\n* For this architecture to work, we can only include an edition as a dependency if it belongs to the same app vendor, or to the vendor’s sponsor.\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/managing-edition-apps/seller-portal-edition-app.md)\n\n[Updating Edition apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app//docs/guides/vtex-io-documentation-updating-edition-apps)[Frequently asked questionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app//docs/guides/vtex-io-documentation-frequently-asked-questions)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[App sponsor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23app-sponsor)\n\n[VTEX as the sponsor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23vtex-as-the-sponsor)[Marketplace as the sponsor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23marketplace-as-the-sponsor)[App dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23app-dependencies)\n\n[Configuring your Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23configuring-your-edition-app)\n\n[Cloning the repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23cloning-the-repository)[Defining the Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23defining-the-manifest)[Adding apps for sub-accounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23adding-apps-for-sub-accounts)[Testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23testing)\n\n[Multiple marketplaces using the same edition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23multiple-marketplaces-using-the-same-edition)\n\n[Scenario example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23scenario-example)[Limitations for multiple marketplace architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23limitations-for-multiple-marketplace-architecture)\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/managing-edition-apps/seller-portal-edition-app.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[App sponsor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23app-sponsor)\n\n[VTEX as the sponsor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23vtex-as-the-sponsor)[Marketplace as the sponsor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23marketplace-as-the-sponsor)[App dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23app-dependencies)\n\n[Configuring your Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23configuring-your-edition-app)\n\n[Cloning the repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23cloning-the-repository)[Defining the Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23defining-the-manifest)[Adding apps for sub-accounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23adding-apps-for-sub-accounts)[Testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23testing)\n\n[Multiple marketplaces using the same edition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23multiple-marketplaces-using-the-same-edition)\n\n[Scenario example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23scenario-example)[Limitations for multiple marketplace architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23limitations-for-multiple-marketplace-architecture)\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_6dfdb4df
|
[
{
"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 organisms filter 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/organisms-filter/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/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/organisms-filter/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/organisms-filter/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/organisms-filter/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/organisms-filter/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/organisms-filter/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/organisms-filter/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/organisms-filter/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/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/organisms-filter/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/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/organisms-filter/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-slide-over)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/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/organisms-filter/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/organisms-filter/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/organisms-filter/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/organisms-filter/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/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/organisms-filter/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/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/organisms-filter/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/organisms-filter/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/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/organisms-filter/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/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/organisms-filter/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-slide-over)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/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/organisms-filter/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/organisms-filter/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/organisms-filter/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/organisms-filter/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/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/organisms-filter/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/components-index)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-overview)\n\nFilter\n\nFilters products inside the Product Listing Page (PLP) and Search Page.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/organisms/Filter)\n\nThe `Filter` component is used to filter products inside the [Product Listing Page (PLP)](https://read.calvincode.net/reader?url=https://starter.vtex.app/office) and Search Page. The `Filter` component is a compound of the following:\n\n* `Filter`: wraps an `Accordion` along with the component title.\n* `FilterSlider`: `SlideOver` that wraps the `Filter` for small screen dimensions.\n* `FilterFacets`: wraps an `AccordionItem` with its `AccordionButton` and an `AccordionPanel` for every Facet.\n* `FilterFacetBoolean`: wraps the list of the `FilterFacetBooleanItem`.\n* `FilterFacetBooleanItem`: wraps a `Checkbox` with its `Label` and the `Badge` that represents the child of the `FilterFacetBoolean`.\n* `FilterFacetRange`: wraps a `PriceRange` for a given Facet with the Range type.\n\nExample\n\nCode\n\n## Filters\n\nPrice\n\nCategory\n\nBrand\n\nOpen Filters\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { \n\n2\n\n Filter, \n\n3\n\n FilterFacets, \n\n4\n\n FilterFacetBoolean, \n\n5\n\n FilterFacetBooleanItem, \n\n6\n\n FilterFacetRange, \n\n7\n\n} 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/organisms/Filter/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## Design tokens\n\n### Title\n\n| Local token | Default value/Global token linked |\n| -------------------------------- | --------------------------------- |\n| \\--fs-filter-title-height | var(--fs-spacing-6) |\n| \\--fs-filter-title-margin-bottom | var(--fs-spacing-0) |\n| \\--fs-filter-title-text-size | var(--fs-text-size-2) |\n| \\--fs-filter-title-line-height | 1.25 |\n\n### Accordion\n\n| Local token | Default value/Global token linked |\n| --------------------------------------------- | --------------------------------- |\n| \\--fs-filter-accordion-border-width-notebook | var(--fs-border-width) |\n| \\--fs-filter-accordion-border-color-notebook | var(--fs-border-color-light) |\n| \\--fs-filter-accordion-border-radius-notebook | var(--fs-border-radius) |\n\n### Accordion Item Button\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------------------- | -------------------------------------------------------- |\n| \\--fs-filter-accordion-button-text-size | var(--fs-text-size-lead) |\n| \\--fs-filter-accordion-button-text-weight | var(--fs-text-weight-regular) |\n| \\--fs-filter-accordion-button-line-height | 1.5 |\n| \\--fs-filter-accordion-button-text-size-notebook | var(--fs-text-size-2) |\n| \\--fs-filter-accordion-button-line-height-notebook | 1.25 |\n| \\--fs-filter-accordion-button-padding-right-notebook | var(--fs-spacing-4) |\n| \\--fs-filter-accordion-button-padding-left-notebook | var(--fs-filter-accordion-button-padding-right-notebook) |\n\n### Accordion Item Panel\n\n| Local token | Default value/Global token linked |\n| -------------------------------------------------------- | ------------------------------------------------------------ |\n| \\--fs-filter-accordion-item-panel-padding-right-notebook | var(--fs-spacing-4) |\n| \\--fs-filter-accordion-item-panel-padding-left-notebook | var(--fs-filter-accordion-item-panel-padding-right-notebook) |\n\n### Accordion Item List\n\n| Local token | Default value/Global token linked |\n| -------------------------------- | --------------------------------- |\n| \\--fs-filter-list-padding-bottom | var(--fs-spacing-3) |\n\n### List Item\n\n| Local token | Default value/Global token linked |\n| --------------------------------------------- | --------------------------------- |\n| \\--fs-filter-list-item-not-last-margin-bottom | var(--fs-spacing-3) |\n\n### List Item Checkbox\n\n| Local token | Default value/Global token linked |\n| -------------------------------------- | ----------------------------------------- |\n| \\--fs-filter-list-item-checkbox-width | 1.25rem |\n| \\--fs-filter-list-item-checkbox-height | var(--fs-filter-list-item-checkbox-width) |\n\n### List Item Label\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------- | --------------------------------- |\n| \\--fs-filter-list-item-label-width | 100% |\n| \\--fs-filter-list-item-label-margin-left | var(--fs-spacing-1) |\n| \\--fs-filter-list-item-label-text-size | var(--fs-text-size-2) |\n| \\--fs-filter-list-item-label-line-height | 1.25 |\n\n### List Item Badge\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------- | --------------------------------- |\n| \\--fs-filter-list-item-badge-margin-left | var(--fs-spacing-1) |\n\n---\n\n## Data attributes\n\nYou can target and override `Filter` styles using the following data attributes:\n\n`data-fs-filter`\n\n`data-fs-filter-title`\n\n`data-fs-filter-accordion`\n\n`data-fs-filter-accordion-item`\n\n`data-fs-filter-list`\n\n`data-fs-filter-list-item`\n\n`data-fs-filter-list-item-checkbox`\n\n`data-fs-filter-list-item-label`\n\n`data-fs-filter-list-item-badge`\n\n`data-fs-filter-facet-range`\n\n---\n\n## Props\n\n### Filter\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). | |\n| **title** | string | Title for the \\`Filter\\` component. | |\n| **indicesExpanded\\*** | Set<number> | The expanded items from the \\`Accordion\\`. | |\n| **onAccordionChange\\*** | (index: number) => void | This function is called when \\`Accordion\\` is expanded or collapsed. | |\n\n### FilterFacets\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). | |\n| **index\\*** | number | Current Facet's position in a list of facets. | |\n| **type\\*** | string | Current Facet's type, usually \\`StoreFacetBoolean\\` or \\`StoreFacetRange\\`. | |\n| **label\\*** | string | The text displayed to identify the Facet. | |\n| **description** | string | The description displayed to identify the Facet. | |\n\n### FilterFacetBooleanItem\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). | | | | | | | |\n| **label\\*** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | The text displayed to identify the Boolean Facet Item. |\n| **value\\*** | string | Value to be emitted when Checkbox is clicked. | | | | | | | |\n| **selected\\*** | false \\| true | Boolean that represents the Checkbox checked state. | | | | | | | |\n| **quantity** | number | Counter badge shown besides the Facet Item. | | | | | | | |\n| **id\\*** | string | ID to identify the Checkbox and corresponding label. | | | | | | | |\n| **facetKey\\*** | string | String that identifies the current Facet key. | | | | | | | |\n| **onFacetChange\\*** | OnFacetChange | This function is called when \\`Checkbox\\` from the facet changes. | | | | | | | |\n| **type** | \"checkbox\" \\| \"radio\" | Type of the Facet Item. | checkbox | | | | | | |\n\n### FilterFacetRange\n\n| Name | Type | Description | Default |\n| ------------------- | --------------------------------------- | ----------------------------------------------------------------------- | ------- |\n| **min\\*** | { selected: number; absolute: number; } | The minimum value of the Slider Range Facet | |\n| **max\\*** | { selected: number; absolute: number; } | The maximum value of the Slider Range Facet | |\n| **facetKey\\*** | string | String that identifies the current Facet key. | |\n| **formatter\\*** | (value: number) => string | Formatter function that transforms the raw value and render the result. | |\n| **onFacetChange\\*** | OnFacetChange | This function is called when \\`Checkbox\\` from the facet changes. | |\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\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/organisms/filter.mdx)\n\n[FilterSlider« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter-slider)[HeroNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-hero)\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\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/organisms-filter/docs/guides/faststore/organisms-filter%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23design-tokens)\n\n[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23title)[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23accordion)[Accordion Item Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23accordion-item-button)[Accordion Item Panel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23accordion-item-panel)[Accordion Item List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23accordion-item-list)[List Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23list-item)[List Item Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23list-item-checkbox)[List Item Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23list-item-label)[List Item Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23list-item-badge)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23props)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23filter)[FilterFacets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23filterfacets)[FilterFacetBooleanItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23filterfacetbooleanitem)[FilterFacetRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23filterfacetrange)\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/organisms/filter.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/organisms-filter/docs/guides/faststore/organisms-filter%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23design-tokens)\n\n[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23title)[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23accordion)[Accordion Item Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23accordion-item-button)[Accordion Item Panel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23accordion-item-panel)[Accordion Item List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23accordion-item-list)[List Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23list-item)[List Item Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23list-item-checkbox)[List Item Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23list-item-label)[List Item Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23list-item-badge)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23props)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23filter)[FilterFacets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23filterfacets)[FilterFacetBooleanItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23filterfacetbooleanitem)[FilterFacetRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23filterfacetrange)\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_f121d13d
|
[
{
"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 store components notification 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-store-components-notification/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-notification/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-store-components-notification/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-store-components-notification/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-store-components-notification/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-store-components-notification/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-store-components-notification/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-notification/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-notification/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-notification/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-notification/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-notification/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-notification/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-notification/updates/release-notes)\n\nNotification\n\nThe `notification` component displays text content in a bar style (`notification.bar`) or inline (`notification.inline`). 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\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `notification` block to any template of your choice. For example:\n\n`1\n\n \"store.home\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n+ \"notification.bar\", \n\n4\n\n \"carousel#home\", \n\n5\n\n \"shelf#home\" \n\n6\n\n ] \n\n7\n\n }, \n\n`\n\n1. Then, declare the `notification` block using the props stated in the [Props](#props) table.\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| --------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| content | String | Text to be used in the bar. | '' |\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\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| notificationBarContainer |\n| notificationBarInner |\n| notificationContent |\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/store-components/vtex-store-components-notification.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/vtex-store-components-notification/docs/guides/vtex-store-components-notification%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-notification/docs/guides/vtex-store-components-notification%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-notification/docs/guides/vtex-store-components-notification%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/store-components/vtex-store-components-notification.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/vtex-store-components-notification/docs/guides/vtex-store-components-notification%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-notification/docs/guides/vtex-store-components-notification%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-notification/docs/guides/vtex-store-components-notification%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_ff15f996
|
[
{
"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 1 setting up your environment 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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/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-1-setting-up-your-environment/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/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-1-setting-up-your-environment/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/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-1-setting-up-your-environment/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/getting-started-overview)\n\nSetting up your environment\n\nPrepare your account and local setup to start developing with FastStore.\n\nThis is the first step in the FastStore track. In this guide, you’ll prepare your local environment and VTEX account to ensure reliable onboarding, builds, and CMS synchronization.\n\n> Skipping these prerequisites can lead to failed installations, duplicated content during onboarding, or local development errors.\n\n## Step 1\\. Installing the VTEX IO CLI\n\nThe [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) is the command-line interface used to manage your VTEX projects. If you haven’t already installed it, follow [this guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) to install it on your machine.\n\n## Step 2\\. Installing Headless CMS and its dependencies\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview) is the native VTEX content management solution for FastStore projects. Before proceeding, ensure the following apps are installed in your account to avoid build errors or duplicated content:\n\n* `vtex.admin-cms@1.x`\n* `vtex.admin-cms-graphql-rc`\n\nTo check whether you have them installed, follow the instructions below:\n\n1. Open the terminal and log in to your account using the following command. Replace `{accountName}` with your VTEX account name. \n`1 \nvtex login {accountName} \n`\n2. Run `vtex ls` to list all the installed apps in your account.\n3. Check if `vtex.admin-cms@1.x` and `vtex.admin-cms-graphql-rc` are in the list. If so, proceed to the [next step](#step-3-installing-headless-cms-plugins). Otherwise, follow these instructions.\n4. After logging into your account, install `vtex.admin-cms@1.x` by running the following command: \n`1 \nvtex install vtex.admin-cms@1.x vtex.admin-cms-graphql-rc \n` \nA success message will confirm the installation: \n\n\n## Step 3\\. Installing the Headless CMS plugins\n\nTo use the Headless CMS through the CLI, install its plugins:\n\n1. Open the terminal and log in to your VTEX account using the VTEX IO CLI. Replace `accountName` with your VTEX account name. \n`1 \nvtex login {accountName} \n`\n2. Install the Headless CMS plugin: \n`1 \nvtex plugins install cms \n`\n3. Verify the installation by running the following command: \n`1 \nvtex cms \n`\n\n\n\n> **Windows users:** If you experience installation issues, refer to the [Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms) article.\n> \n> **macOS users:** If you encounter problems, run `yarn config set ignore-engines true` to ignore the Node.js version incompatibility, then run `vtex plugins install cms` again.\n> \n> We recommend using Node.js version **15.0.0** or higher.\n\n## Step 4\\. Enabling the VTEX Intelligent Search app\n\nThe [VTEX Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search) app enhances the user experience by providing accurate and personalized search results throughout the shopping journey. Before developing a storefront in FastStore, you need to enable the app in your account. For more information about Intelligent Search and its integration, please refer to the [VTEX Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search) and [Integration Settings](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/6wKQgKmu2FT6084BJT7z5V) guides.\n\nTo enable the app, check which version of the [Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) is installed in your account.\n\nBased on the edition version, follow the instructions below.\n\n> To confirm which Edition App version is installed in your account, open the terminal and use the VTEX IO CLI. Log in to your account by running `vtex login {accountName}` and run `vtex edition get` to see the Edition App version installed in the current account.\n\n**Accounts using the `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 must integrate it via VTEX Admin.\n\nTo integrate VTEX Intelligent Search, go to the VTEX Admin, access **Store Settings > Intelligent Search > Integrations**, and click `START INTEGRATION`.\n\n**Accounts using an edition version below `5.x`**\n1. In the VTEX IO CLI, log in to your VTEX account by running `vtex login {accountName}`. Remember to replace the value between curly brackets with your account name.\n2. If the VTEX Intelligent Search app is not installed in your account, run the following command to install it: \n`1 \nvtex install vtex.search-resolver@1.x vtex.admin-search@1.x \n`\n\nAfter successfully installing the app, access VTEX Admin, navigate to **Store Settings > Intelligent Search > Integrations**, and click `START INTEGRATION`.\n\n**Accounts wishing to migrate to the `5.x`**\n\nIf you are 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 the Edition Store `vtex.edition-store@5.x`.\n\n## Step 5\\. Installing the FastStore WebOps app\n\nThe [FastStore WebOps app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project) helps you create, deploy, and manage your FastStore projects. It also provides performance insights and deployment management tools.\n\n> The FastStore WebOps app only works in stores using the [Edition Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app%23list-of-native-edition-apps). If your store uses the Edition Business, also known as using the [Legacy CMS Portal](https://read.calvincode.net/reader?url=https://help.vtex.com/es/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj) technology, make sure to [open a support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support) to change it to the Edition Store.\n\nOnce you have changed the edition, follow the instructions in this [requirements guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-requirements%23install-the-vtex-io-cli-on-your-machine).\n\nTo install the app, follow these steps.\n\n1. In a terminal, log in to your VTEX account by running the following command. Replace `{accountName}` with your store account name, for example, `vtex login store`. \n`1 \nvtex login {accountName} \n`\n2. Install the FastStore WebOps app by running the following command: \n`1 \nvtex install vtex.webops \n` \n> The FastStore WebOps app only works in the production environment, so you must install it exclusively in your account's master environment.\n3. A confirmation message will appear. Type `y` to proceed. \n`1 \n? Are you sure you want to force this operation on the master workspace on the account store? » (y/N) \n`\n\nThe FastStore WebOps app is now installed in your account. Refer to the [FastStore WebOps app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project) guide to create your first FastStore project.\n\n## Next step\n\nNow that your environment is ready, learn how to access and use the WebOps app: [2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project)\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/1-setting-up-your-environment.mdx)\n\n[Getting Started« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/getting-started-overview)[2\\. Starting a new FastStore projectNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/getting-started-2-starting-the-project)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Step 1\\. Installing the VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/getting-started-1-setting-up-your-environment%23step-1-installing-the-vtex-io-cli)\n\n[Step 2\\. Installing Headless CMS and its dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/getting-started-1-setting-up-your-environment%23step-2-installing-headless-cms-and-its-dependencies)\n\n[Step 3\\. Installing the Headless CMS plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/getting-started-1-setting-up-your-environment%23step-3-installing-the-headless-cms-plugins)\n\n[Step 4\\. Enabling the VTEX Intelligent Search app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/getting-started-1-setting-up-your-environment%23step-4-enabling-the-vtex-intelligent-search-app)\n\n[Step 5\\. Installing the FastStore WebOps app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/getting-started-1-setting-up-your-environment%23step-5-installing-the-faststore-webops-app)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/getting-started-1-setting-up-your-environment%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/1-setting-up-your-environment.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Step 1\\. Installing the VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/getting-started-1-setting-up-your-environment%23step-1-installing-the-vtex-io-cli)\n\n[Step 2\\. Installing Headless CMS and its dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/getting-started-1-setting-up-your-environment%23step-2-installing-headless-cms-and-its-dependencies)\n\n[Step 3\\. Installing the Headless CMS plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/getting-started-1-setting-up-your-environment%23step-3-installing-the-headless-cms-plugins)\n\n[Step 4\\. Enabling the VTEX Intelligent Search app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/getting-started-1-setting-up-your-environment%23step-4-enabling-the-vtex-intelligent-search-app)\n\n[Step 5\\. Installing the FastStore WebOps app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/getting-started-1-setting-up-your-environment%23step-5-installing-the-faststore-webops-app)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment/docs/guides/faststore/getting-started-1-setting-up-your-environment%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_e301800b
|
[
{
"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 search auto complete 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-search-auto-complete/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-search-auto-complete/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-search-auto-complete/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-search-auto-complete/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-search-auto-complete/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-search-auto-complete/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-search-auto-complete/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-search-auto-complete/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-search-auto-complete/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/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-search-auto-complete/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/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-search-auto-complete/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/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-search-auto-complete/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-search-auto-complete/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-search-auto-complete/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-search-auto-complete/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/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-search-auto-complete/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-search-auto-complete/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/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-search-auto-complete/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-search-auto-complete/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/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-search-auto-complete/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/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-search-auto-complete/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/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-search-auto-complete/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-search-auto-complete/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-search-auto-complete/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-search-auto-complete/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/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-search-auto-complete/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-search-auto-complete/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-search-auto-complete/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-overview)\n\nSearchAutoComplete\n\nList of auto completing suggestions based on searched term.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/SearchAutoComplete)\n\nList of auto completing suggestions based on searched term. This component is part of the [Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search) feature.\n\nExample\n\nCode\n\nSearching for: `Appl`\n\n1. [appl**e airpods**](#)\n2. [appl**e tv**](#)\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { SearchAutoComplete, SearchAutoCompleteTerm } 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/SearchAutoComplete/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## Other Icons\n\nExample\n\nCode\n\nSearching for: `So`\n\n1. [so**ny headphone**](#)\n2. [so**und speaker**](#)\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------------- | -------------------------------------------- |\n| \\--fs-search-auto-complete-padding-top | var(--fs-spacing-2) |\n| \\--fs-search-auto-complete-padding-right | var(--fs-spacing-3) |\n| \\--fs-search-auto-complete-padding-bottom | var(--fs-search-auto-complete-padding-top) |\n| \\--fs-search-auto-complete-padding-left | var(--fs-search-auto-complete-padding-right) |\n| \\--fs-search-auto-complete-transition-property | var(--fs-transition-property) |\n| \\--fs-search-auto-complete-transition-function | var(--fs-transition-function) |\n| \\--fs-search-auto-complete-transition-timing | var(--fs-transition-timing) |\n\n### Design tokens: Item\n\n| Local token | Default value/Global token linked |\n| ----------------------------------------------- | ---------------------------------- |\n| \\--fs-search-auto-complete-item-column-gap | var(--fs-spacing-1) |\n| \\--fs-search-auto-complete-item-text-size | var(--fs-text-size-2) |\n| \\--fs-search-auto-complete-item-line-height | 1.25 |\n| \\--fs-search-auto-complete-item-bkg-color-hover | var(--fs-color-tertiary-bkg-hover) |\n\n### Design tokens: Icon\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------ | --------------------------------- |\n| \\--fs-search-auto-complete-item-icon-color | var(--fs-color-neutral-4) |\n| \\--fs-search-auto-complete-item-icon-size | 1.125rem |\n\n---\n\n## Data attributes\n\nYou can target and override `SearchAutoComplete` styles using the following data attributes:\n\n`data-fs-search-auto-complete`\n\n`data-fs-search-auto-complete-item`\n\n`data-fs-search-auto-complete-item-link`\n\n`data-fs-search-auto-complete-item-icon`\n\n---\n\n## Props\n\n### SearchAutoComplete\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-search-auto-complete |\n\n### SearchAutoCompleteTerm\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-search-auto-complete-term | | | | | | | |\n| **linkProps** | Partial<LinkProps<LinkElementType>> | Props for the link from term component. | | | | | | | | |\n| **icon** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | A React component that will be rendered as an icon. | <Icon name=\"MagnifyingGlass\" width={18} height={18} /> |\n| **term\\*** | string | Term researched. | | | | | | | | |\n| **suggestion\\*** | string | Suggestion proposed with auto complete. | | | | | | | | |\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/search-auto-complete.mdx)\n\n[RegionBar« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-region-bar)[SearchDropdownNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-dropdown)\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-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23examples)\n\n[Other Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23other-icons)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23design-tokens)\n\n[Design tokens: Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23design-tokens-item)[Design tokens: Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23design-tokens-icon)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23props)\n\n[SearchAutoComplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23searchautocomplete)[SearchAutoCompleteTerm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23searchautocompleteterm)\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/search-auto-complete.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-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23examples)\n\n[Other Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23other-icons)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23design-tokens)\n\n[Design tokens: Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23design-tokens-item)[Design tokens: Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23design-tokens-icon)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23props)\n\n[SearchAutoComplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23searchautocomplete)[SearchAutoCompleteTerm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-auto-complete/docs/guides/faststore/molecules-search-auto-complete%23searchautocompleteterm)\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_601e672b
|
[
{
"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 peerdependencies 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-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n[Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-manifest)\n\n[Billing Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-billing-options)\n\n[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-builders)\n\n[Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-dependencies)\n\n[Peer Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-peerdependencies)\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n[Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-manifest)\n\n[Billing Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-billing-options)\n\n[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-builders)\n\n[Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-dependencies)\n\n[Peer Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-peerdependencies)\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/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-peerdependencies/docs/app-development)\n\nProject structure\n\n[Peer Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-peerdependencies)\n\nPeer Dependencies\n\nLearn what peer dependencies are their use cases.\n\nPeer dependencies are specified within the `manifest.json` file of a VTEX IO app under the `peerDependencies` field. This JSON object is used to declare the set of IO apps that an app requires to function seamlessly. Unlike regular [dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-dependencies), which are automatically installed when someone installs an app, peer dependencies are not automatically handled by the system. Instead, it is the responsibility of the app user to ensure that the required peer dependencies are installed in their VTEX account.\n\nPeer dependencies become particularly useful in scenarios where an app depends on paid apps or requires a specific major version of another app.\n\n\n\n## Example\n\nLet's illustrate this concept with an example. Suppose you have an app named `vtex.example` with the following `manifest.json` configuration:\n\n`1\n\n{ \n\n2\n\n \"name\": \"vtex.example\", \n\n3\n\n ... \n\n4\n\n \"peerDependencies\": { \n\n5\n\n \"vtex.store\": \"2.x\", \n\n6\n\n \"vtex.paid-app-example\": \"1.x\" \n\n7\n\n }, \n\n8\n\n \"dependencies\": { \n\n9\n\n \"vtex.styleguide\": \"9.x\" \n\n10\n\n } \n\n11\n\n ... \n\n12\n\n} \n\n`\n\nIn this example, anyone who wants to install the `vtex. example` app must first manually install the exact versions of `vtex.store` and `vtex.paid-app-example` apps specified in the `peerDependencies` field.\n\n## Use cases\n\n### Handling paid dependencies\n\nWhen your app relies on a paid app, it's crucial to specify it as a peer dependency. This ensures that users who want to use your app must manually install the required paid app. This practice not only helps maintain licensing and payment compliance but also ensures that users are aware of the additional costs associated with your app's dependencies.\n\n### Enforcing a specific major version\n\nConsider a situation where your app depends on another app that has multiple major versions, each with significant differences that may affect your app's functionality. Instead of specifying it under `dependencies` that would install the latest version of the app, you can use the `peerDependencies` field to declare the exact major version your app requires. Users who want to install your app must ensure that the specified major version of the dependency is already installed in their account.\n\n## Adding a peer dependency to a Store Theme app\n\nIf you want to add a new peer dependency to a Store Theme app, it involves deploying a new major version of the app. To ensure a smooth deployment, please refer to the [Migrating CMS settings after a theme major version update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update) guide.\n\n## Developing an app that relies on an app with peerDependencies\n\nNow, let's consider a development scenario where you are working on an app named `X`, and this app directly depends on the `vtex.example` app. To indicate this dependency, you list `vtex.example` in the `dependencies` field of `X`'s `manifest.json` file.\n\nSince `vtex.example` specifies `vtex.store@2.x` and `vtex.paid-app-example@1.x` as its `peerDependencies`, this means that to develop `X` (which includes `vtex.example` in its `dependencies`), you must manually install `vtex.store@2.x` and `vtex.paid-app-example@1.x` in the VTEX account in which you are working.\n\n> Keep in mind: Peer dependencies are not automatically installed. You must manually install them in your working account.\n\nIf your account lacks these specific versions of `vtex.store@2.x` and `vtex.paid-app-example@1.x`, you won't be able to install the `vtex.example` and your development flow will be interrupted.\n\nNotice that the `vtex.example` requires every account installing it also to have `vtex.store@2.x` and `vtex.paid-app-example@1.x` installed.\n\nRemember that these dependencies are a manual prerequisite and should be documented clearly for your users.\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/Reference/concepts/vtex-io-documentation-peerdependencies.md)\n\n[Dependencies« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies//docs/guides/vtex-io-documentation-dependencies)[VTEX IO CLINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies//docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-peerdependencies%23example)\n\n[Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-peerdependencies%23use-cases)\n\n[Handling paid dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-peerdependencies%23handling-paid-dependencies)[Enforcing a specific major version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-peerdependencies%23enforcing-a-specific-major-version)\n\n[Adding a peer dependency to a Store Theme app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-peerdependencies%23adding-a-peer-dependency-to-a-store-theme-app)\n\n[Developing an app that relies on an app with peerDependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-peerdependencies%23developing-an-app-that-relies-on-an-app-with-peerdependencies)\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/Reference/concepts/vtex-io-documentation-peerdependencies.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/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-peerdependencies%23example)\n\n[Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-peerdependencies%23use-cases)\n\n[Handling paid dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-peerdependencies%23handling-paid-dependencies)[Enforcing a specific major version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-peerdependencies%23enforcing-a-specific-major-version)\n\n[Adding a peer dependency to a Store Theme app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-peerdependencies%23adding-a-peer-dependency-to-a-store-theme-app)\n\n[Developing an app that relies on an app with peerDependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-peerdependencies/docs/guides/vtex-io-documentation-peerdependencies%23developing-an-app-that-relies-on-an-app-with-peerdependencies)\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_bdc6ff3c
|
[
{
"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 giftcard hub 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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-api/docs/api-reference/giftcard-hub-api/)\n\nGift cards\n\nProviders\n\nTransactions\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-api/docs/api-reference/giftcard-hub-api/)\n\nGift cards\n\nProviders\n\nTransactions\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-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/giftcard-hub-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[GeList All GiftCard Transactions Settlements« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-api/docs/api-reference/giftcard-provider-protocol%23get-/giftcards/-giftCardId-/transactions/-tId-/settlements)[PoCreate GiftCard in GiftCard ProviderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-api/docs/api-reference/giftcard-hub-api%23post-/api/giftcardproviders/-giftCardProviderId-/giftcards)\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_31f3e106
|
[
{
"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 app 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/external-marketplace-integration-app-template/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-app-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/external-marketplace-integration-app-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/external-marketplace-integration-app-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/external-marketplace-integration-app-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/external-marketplace-integration-app-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/external-marketplace-integration-app-template/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-app-template/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-app-template/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-app-template/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-app-template/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/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-app-template/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-app-template/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-app-template/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-app-template/docs/guides/external-marketplace-integration-app-template)\n\n[External Marketplace Integration app GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-graphql-api)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/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-app-template/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-app-template/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-app-template/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-app-template/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-app-template/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-app-template/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-app-template/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-app-template/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/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-app-template/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-app-template/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-app-template/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-app-template/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-app-template/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-app-template/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-app-template/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-app-template/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/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-app-template/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/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-app-template/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/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-app-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---\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-app-template/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-app-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/external-marketplace-integration-app-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/external-marketplace-integration-app-template/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/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-app-template/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-app-template/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-app-template/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-app-template/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/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-app-template/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-app-template/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-app-template/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-app-template/docs/guides/external-marketplace-integration-app-template)\n\n[External Marketplace Integration app GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-graphql-api)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/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-app-template/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-app-template/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-app-template/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-app-template/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-app-template/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-app-template/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-app-template/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-app-template/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/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-app-template/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-app-template/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-app-template/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-app-template/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-app-template/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-app-template/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-app-template/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-app-template/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/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-app-template/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/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-app-template/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/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-app-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---\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-app-template/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-app-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/external-marketplace-integration-app-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/external-marketplace-integration-app-template/docs/guides)\n\nIntegration Guides\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-guide)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template)\n\nCreating an integration app from a Template\n\nCreate an app to integrate with external marketplaces.\n\nThe integration Template App is a pre-built app developed by VTEX for our partners to reduce development and implementation time when integrating with external marketplaces. By using the template to build your integration app, connectors will also have the app displayed in the [VTEX App Store](https://read.calvincode.net/reader?url=https://apps.vtex.com/).\n\n## What the App Template includes for the VTEX Admin\n\nAn integration app created from our App Template already includes:\n\n* **Standard set up page** containing: \n * Activate/deactivate the integration button \n * Field identifying the affiliate ID \n * Field to inform the email that will receive notifications about changes in the affiliate \n * Callback URL used by the VTEX notification system \n * Field for the [sales channel](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) ID \n * Fields included in the [sales channel form](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-a-trade-policy--563tbcL0TYKEKeOY4IAgAE%23filling-in-the-fields) \n * Save Settings button\n* **Custom settings page** containing: \n * Button to activate/deactivate [franchise accounts](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-franchise-account--kWQC6RkFSCUFGgY5gSjdl)\n* Complete **search endpoint** to retrieve seller configurations using [AppKey and AppToken](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/api-keys--4bFEmcHXgpNksoePchZyy6) generated in the seller’s account, defined by the appVendor.\n* **Link to [VTEX Mapper Registration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper%23post-/api/mkp-category-mapper/connector/register)**, allowing sellers to map their catalog according to the marketplace’s definitions.\n\n## Before you begin\n\nThe Template App runs in [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io). Before you begin creating your app from our template, make sure to:\n\n* [Set up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio).\n* [Install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install).\n* Have your VTEX Partner account in hand for step 2.\n\n> If you do not have access to a VTEX Account, join our [Partner Program](https://read.calvincode.net/reader?url=https://vtex.com/us-en/partner), to become a certified partner.\n\n## Step 1 - Creating your repository from the template\n\n1. Access the [Template App’s repository](https://read.calvincode.net/reader?url=https://github.com/vtex/mkp-app-template).\n2. Don't forget to request the use of the builders necessary for the development of the app. Read the article [Filling 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) and request the builders: admin, docs, graphql, messages, node and react.\n3. Click on `Use this template`.\n4. Add a **name** to your repository.\n5. Select the `Private` option.\n6. Do not check the **Include all branches** option.\n7. Click on `Create repository from template`.\n\n## Step 2 - App configurations\n\nOnce your repository is created from the template, you must configure your app by substituting placeholders and setting up the necessary Template App Configurations.\n\n### Substituting placeholders\n\nFollow the list below to substitute placeholders properly. Once placeholders are replaced, the App’s foundation will include the fields needed to set up the seller and the integration on VTEX's side.\n\n> Placeholders within the `manifest.json` file must follow the rules described in [Manifest Fields Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest).\n\n| Placeholder | Description | Files where it can be found |\n| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |\n| appName | Name of the app. This value must follow the kebab case (only minor case letters and the - character). | manifest.json, navigation.json, routes.json, node/service.json, node/constants/variables.ts, react/package.json |\n| appVendor | Name of the app’s owner, responsible for its distribution and maintenance. It must be the Partner’s VTEX accountName. | manifest.json, navigation.json, node/routes.json, node/service.json, node/constants/variables.json |\n| appTitle | Title of the app that will appear in the VTEX Admin’s screen and left navigation, once the seller accesses it. | messages/context.json, messages/en.json, messages/pt.json, messages/es.json, node/constants/variables.ts |\n| connectorEndpoint | Base URL of the backend connector to which notifications coming from VTEX will be sent. Examples: <https://externalconnector.com> or relative URL; <https://externalconnector.com/api/vtex>. | node/constants/variables.ts, react/areas/ConfigArea/DefaultConfigs/endpoint.tsx |\n| connectorEndpointHost | Endpoint host informed in the connectorEndpoint placeholder. Example: externalconnector.com. | manifest.json |\n| affiliateId | Affiliate identifier code, which consists of three consonants, whether they are repeated or not. | react/areas/ConfigArea/index.tsx |\n| manifestTitle | App’s title in the VTEX App Store. | manifest.json |\n| manifestDescription | App’s description in the VTEX App Store. | manifest.json |\n| mapperId | Connector’s ID in VTEX Mapper. | admin/navigation.json |\n| connectorId | Connector's ID registered in Channel Manager. | node/constants/variables.json |\n\nThe fields listed above come with the App Template as default. However, it is possible to remove fields that represent features not used by your integration, like the VTEX Mapper. They are listed ahead in the section [CustomConfigs](#customconfigs).\n\n#### Receiving notifications\n\nTo receive notifications from VTEX, the seller needs to implement specific API routes in the endpoint informed in connectorEndpoint. These endpoints are described in the following sections:\n\n* [Catalog notification](#catalog-notification)\n* [Store configuration notification](#store-configuration-notification)\n\n##### Catalog notification\n\nTo receive product update notifications and product variations (including stock, price and trade policy), you must implement the POST `{{connectorEndpoint}}/catalog/notification` route.\n\nThis notification follows the format of our VTEX [Broadcaster Adapter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-broadcaster%23sku-data).\n\n##### Store configuration notification\n\nTo receive notifications of updates to store or seller settings, you must implement the POST `{{connectorEndpoint}}/store-config/notification` route.\n\nThe store configuration notification format will vary according to the configuration you implement in your app. The default fields are:\n\n| **Field name** | **Description** | **Type** |\n| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |\n| accountName | Name of the seller’s account in VTEX. | string |\n| active | Flag that indicates if the seller wants to be active in the marketplace. If false, the connector should deactivate the seller’s products on the marketplace. | boolean |\n| affiliateId | Unique affiliate ID configured in the seller that identifies its connection with the marketplace. | string |\n| salesChannel | Sales channel/trade policy ID configured in the seller and being used for this marketplace. | string |\n| email | Email that’ll be notified about changes related to the affiliate. | string |\n| cookie | App’s auth cookie. This token can be used when making requests to VTEX APIs with the seller’s account. | string |\n| allowFranchiseAccounts | Flag indicates if the seller also wants to synchronize their franchise accounts catalog/orders with the marketplace, through the Multilevel Omnichannel Inventory feature. | boolean |\n\n### Template App Configurations\n\nThe Template App is divided into two areas:\n\n* **TitleArea:** where the app's title goes, defined by the `{{appTitle}}` field.\n* **ConfigArea:** where the app's set up fields go. The ConfigArea has two types of configurations: Default Configurations and Custom Configurations.\n\n#### DefaultConfigs\n\nDefaultConfigs is where the mandatory fields for all apps are included. This section does not need to be changed, regardless of the marketplace's needs, since they are internal configurations used by VTEX. This section already includes:\n\n* Toggle indicating if the integration is activated or inactivated.\n* Input field showing the marketplace's affiliateId.\n* Input field showing the connector's endpoint, for notifying product and order updates occurred in VTEX.\n* Input field for sellers to fill in the email registered as the affiliate.\n* Button leading to the account's Affiliate page.\n* Selection box showing a list of countries, currencies, time zones and other [information](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-a-trade-policy--563tbcL0TYKEKeOY4IAgAE) registered in the [sales channels](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) that the seller has set up in their account. This way, sellers can create or edit their sales channel information directly through the Default Configs page.\n* Field showing the sales channel's name used for the marketplace, with a button leading to the VTEX account's Sales channels page. This becomes available after the initial set up of the fields listed above.\n\n#### CustomConfigs\n\nThe CustomConfigs section is where you find configurations that come as default but are optional, like VTEX Mapper and AllowFranchiseAccounts.\n\n##### Removing VTEX Mapper\n\nYou can remove [VTEX Mapper Registration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper%23post-/api/mkp-category-mapper/connector/register) from the app, if the integration does not require mapping categories, or the partner already has a solution for mapping catalog architecture. To remove VTEX Mapper, on the `admin/navigation.json`, remove file the object that defines the Mapper endpoint in the Admin:\n\n`1\n\n{ \n\n2\n\n \"labelId\": \"admin/app.mapper.tile\", \n\n3\n\n \"path\": \"/admin/mkp-category-mapper/{{mapperId}}\" \n\n4\n\n} \n\n`\n\n##### Removing _AllowFranchiseAccounts_\n\nWhen the configuration _AllowFranchiseAccounts_ is configured, the component becomes a toggle indicating whether [franchise accounts](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-franchise-account--kWQC6RkFSCUFGgY5gSjdl) are permitted.\n\n\n\nYou can remove the configuration by performing the following actions:\n\n| Instruction | Files where it can be found |\n| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| Remove component AllowFranchiseAccounts | react/areas/ConfigArea/CustomConfigs/index.tsx |\n| Remove field allowFranchiseAccounts | react/graphql/getConfig.gqlgraphql/schema.graphqlgraphql/types.graphqlnode/typings/configuration.d.tsreact/typings/config.d.ts |\n| Set the atribution allowFranchiseAccounts as false | react/areas/ConfigArea/index.tsx: |\n\n#### Adding your own CustomConfigs\n\nCustomConfigs is also where connectors can add their custom fields and most of the app’s development will be made, in case it is necessary to add extra fields like input field for the marketplace’s token, or a button to activate a connector’s new feature, for example. To add custom fields in the App:\n\n1. In the folder `react/areas/configArea/customConfigs`, create a file with the field’s **name** and **.tsx** extension. Ex. _email.tsx_, _token.tsx_.\n2. In the file, add the following **code**, replacing the `ExampleComponent` field with the name you wish to give it.\n\n`1\n\nimport React from \"react\" \n\n2\n\nimport { DefaultProps } from '../../../typings/props' \n\n3\n\n \n4\n\nconst ExampleComponent: React.FC<DefaultProps> = ({ intl, config }) => { \n\n5\n\n return ( \n\n6\n\n ) \n\n7\n\n} \n\n8\n\n \n9\n\nexport default ExampleComponent \n\n`\n\n| **Field** | **Description** | **Files where it can be found** |\n| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |\n| DefaultProps | Defines attributes used by all components present in the integration. The attributes include intl (used for field internationalization) and config (represents the seller’s current configuration). | react/typings/props.tsx |\n\n1. To add more properties to the `DefaultProps` for a specific field, **extend the `DefaultProps` interface**, adding the extra properties. This step is optional.\n\n`1\n\nimport React from \"react\" \n\n2\n\n \n3\n\nexport interface CustomProps extends DefaultProps { \n\n4\n\n newProp: string \n\n5\n\n} \n\n6\n\n \n7\n\nconst FieldName: React.FC<CustomProps > = ({ intl, config, newProp}) => { \n\n8\n\n return ( \n\n9\n\n ) \n\n10\n\n} \n\n11\n\n \n12\n\nexport default FieldName \n\n`\n\nIn the example above, a new interface called `CustomProps` was created, that can `extend` the `DefaultProps`, by adding a `newProp` string property. Thus, it is possible to use `CustomProps` in place of `DefaultProps`, and the component can now accept the extra `newProp` property.\n\n1. To use other properties that are not listed in `DefaultProps`, define a **new interface** with the needed properties.\n\nIn the example below, a new interface called `CustomProps` is created, with only two properties: `prop1` (string) and `prop2` (number).\n\n`1\n\nimport React from \"react\" \n\n2\n\n \n3\n\nexport interface CustomProps { \n\n4\n\n prop1: string. \n\n5\n\n prop2: number \n\n6\n\n} \n\n7\n\n \n8\n\nconst FieldName: React.FC<CustomProps > = ({ prop1, prop2 }) => { \n\n9\n\n return ( \n\n10\n\n ) \n\n11\n\n} \n\n12\n\n \n13\n\nexport default FieldName \n\n`\n\n1. Add **components developed** to the app’s template.\n\nHere’s an example code for adding an input field:\n\n`1\n\nimport React from \"react\" \n\n2\n\nimport InputComponent from \"../../../components/InputComponent\" \n\n3\n\nimport { DefaultProps } from \"../../../typings/props\" \n\n4\n\n \n5\n\nexport interface ExampleProps extends DefaultProps { \n\n6\n\n setConfig: React.Dispatch<React.SetStateAction<Configuration>> \n\n7\n\n} \n\n8\n\n \n9\n\nconst ExampleComponent: React.FC<ExampleProps> = ({ intl, config, setConfig }) => { \n\n10\n\n return ( \n\n11\n\n <InputComponent \n\n12\n\n id={example} \n\n13\n\n label={example} \n\n14\n\n canEdit={true} \n\n15\n\n initValue={config.email} \n\n16\n\n type={'text'} \n\n17\n\n required={false} \n\n18\n\n tooltip={intl.formatMessage({ id: \"admin/app.example\" })} \n\n19\n\n onChange={value => { \n\n20\n\n if(value !== undefined){ \n\n21\n\n setConfig(oldConfig => ({ ...oldConfig, email: value })) \n\n22\n\n } \n\n23\n\n } \n\n24\n\n } \n\n25\n\n /> \n\n26\n\n ) \n\n27\n\n} \n\n28\n\n \n29\n\nexport default ExampleComponent \n\n`\n\nThe example above creates an input field called `ExampleComponent`. It uses an extra property, or the `setConfig`, used in this case within the `onChange` property of the Input component. This updates the `email` field in the config, whenever the seller types something within the field. This is how it is rendered in the UI:\n\n\n\n1. To finalize the new field’s inclusion, add the new field within the **CustomConfigsArea**. To do that:\n* In the `react/areas/configArea/customConfigs/index.tsx` field, add an **import** to the new component developed. Following the example above: _import ExampleComponent from './example'_\n* Add the component within the `` of `CustomConfigArea`.\n\n`1\n\nconst CustomConfigsArea: React.FC<CustomConfigsProps> = ({ intl, config, setConfig }) => { \n\n2\n\n return ( \n\n3\n\n <div> \n\n4\n\n <ExemploComponent \n\n5\n\n config={config} \n\n6\n\n intl={intl} \n\n7\n\n setConfig={setConfig} \n\n8\n\n /> \n\n9\n\n </div> \n\n10\n\n ) \n\n11\n\n} \n\n`\n\nNote that the `CustomConfigArea` in the template does not include `intl`, `config` and `setConfig`. They must be added, like in the example above, depending on which properties are needed. To add more properties, repeat step 3.\n\n1. If other components are necessary, add them in the `return` object.\n\nThe order of components within the `return` affects the order in which components are rendered in the app.\n\n## Step 3 - Translating a component\n\nThe app’s internationalization is made using the `intl` library in the `messages` builder, declared in the `manifest.json`. This builder’s addition comes in the Template App as default and does not need to be altered. It is only necessary to add translations for new inserted fields. Check out [Translating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component) to know more.\n\nThe `intl` library gets what locale is being used in the VTEX Admin’s context and searches in the `messages` file the corresponding translated text in the `{messageId}`. In case the VTEX Admin is using a language that is not translated in the app, the library will search the id of a language mapped in the app, and automatically translate it to the Admin’s locale.\n\nTo add translations to the app:\n\n1. Add the translations in the `messages` folder. The Template app already includes the files:\n* **en.json:** english\n* **es.json:** spanish\n* **pt.json:** portuguese\n\nThe following languages are also available in the VTEX Admin: italian (it), japanese (ja), korean (ko), dutch (nl) and romanian (ro).\n\n1. Add the translations in the `{messageId}` to the corresponding locale’s file in the format `\"admin/{messageId}\": \"translation\"`.\n2. In the selected property that needs translation, substitute the text for the code `intl.formatMessage({ id: 'admin/{messageId}' })`.\n* **admin/:** used to identify a translation of a component installed in the VTEX Admin. It must be every Id’s prefix.\n* **messageId:** can be substituted for any text. It only accepts letters and `-` to define the text.\n\nTo illustrate with an example, let’s suppose we have the following component:\n\n`1\n\nimport React from \"react\" \n\n2\n\nimport InputComponent from \"../../../components/InputComponent\" \n\n3\n\nimport { DefaultProps } from '../../../typings/props' \n\n4\n\n \n5\n\nconst ExemploComponent: React.FC<DefaultProps> = ({ intl }) => { \n\n6\n\n return ( \n\n7\n\n <InputComponent \n\n8\n\n canEdit={true} \n\n9\n\n id={'test'} \n\n10\n\n initValue={\"\"} \n\n11\n\n label={intl.formatMessage({ id: 'admin/app.test.title' })} \n\n12\n\n type={'text'} \n\n13\n\n /> \n\n14\n\n ) \n\n15\n\n} \n\n16\n\n \n17\n\nexport default ExemploComponent \n\n`\n\nIn this case, we have an Input component, type “text”, and its label will be translated according to the VTEX Admin’s locale. If we do not add the id `\"admin/app.test.title\"` in the `messages` folder, this is what is rendered in the UI:\n\n\n\nSince the id does not exist in any `messages` file, it renders the id itself as a response.\n\nTo add the id to the file, we add the code: `“admin/app.test.title”: “Teste no en.json”`. Once the id is rendered in all files, the component will then render:\n\n\n\n## Step 4 - Testing the app locally\n\n1. With the app already configured, open a CLI in the project’s **root**.\n2. Login into a test account using the command: `vtex login {{account}}`. Substitute {{account}} by the test account’s _accountName_.\n3. Once logged into the account, use the command `vtex use {{workspace}}` to access a development workspace to link the app. Substitute _{{workspace}}_ by any name you choose.\n4. Use the command `vtex setup` to adjust IO types and variables based on the values set in the app’s configuration.\n5. Use the command `vtex link` to link the app so it operates on VTEX IO’s infrastructure.\n6. Access the following address:`https://{{workspace}}--{{account}}.myvtex.com/admin/{{appVendor}}/{{appName}}` substituting the placeholders for the chosen values in the previous steps.\n\n### Collecting the app’s configurations\n\nOnce the app is configured, it is possible to recover the seller’s configuration through the app. To search a seller’s configuration:\n\n1. Call the following API: `https://{{workspace}}--{(account}}.myvtex.com/_v/{{appVendor}}/{{appName}}/config`\n\n| **Field** | **Description** |\n| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| workspace | Environment where the app was linked. In production, the workspace is not included in the call, so the endpoint is as follows: https://{(account}}.myvtex.com/\\_v/{{appVendor}}/{{appName}}/config |\n| account | Seller’s VTEX account you wish to recover configuration information from. |\n| appVendor | Name of the app’s owner, responsible for its distribution and maintenance. It must be the Partner’s VTEX accountName. |\n| appName | Name of the app. This value must follow the kebab case (only minor case letters and the \\- character). |\n\n1. Generate the account’s [AppKey and AppToken](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/api-keys--4bFEmcHXgpNksoePchZyy6) to authenticate it.\n\n#### Request’s curl in a workspace\n\n`1\n\ncurl --location -g --request GET 'https://{{workspace}}--{{account}}.myvtex.com/_v/{{appVendor}}/{{appName}}/config' \\ --header 'appkey: {{appkey}}' \\ --header 'apptoken: {{apptoken}}' \n\n`\n\n#### Request’s curl in production\n\n`1\n\ncurl --location -g --request GET 'https://{{account}}.myvtex.com/_v/{{appVendor}}/{{appName}}/config' \\ --header 'appkey: {{appkey}}' \\ --header 'apptoken: {{apptoken}}' \n\n`\n\n## Step 5 - Publishing the app in the VTEX App Store\n\nOnce all steps are completed, you must publish the app in VTEX’s App Store, so it is available for clients to install it in their accounts. Follow the instructions on [Submitting your app in the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store) for this step.\n\nContributors\n\n4\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/anabaarbosa)\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-app-template.md)\n\n[Store setup for VTEX Seller« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template//docs/guides/external-marketplace-integration-vtex-seller-setup)[External Marketplace Integration app GraphQL APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template//docs/guides/external-marketplace-integration-app-graphql-api)\n\nContributors\n\n4\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/anabaarbosa)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[What the App Template includes for the VTEX Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23what-the-app-template-includes-for-the-vtex-admin)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23before-you-begin)\n\n[Step 1 - Creating your repository from the template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23step-1-creating-your-repository-from-the-template)\n\n[Step 2 - App configurations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23step-2-app-configurations)\n\n[Substituting placeholders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23substituting-placeholders)[Template App Configurations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23template-app-configurations)\n\n[Step 3 - Translating a component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23step-3-translating-a-component)\n\n[Step 4 - Testing the app locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23step-4-testing-the-app-locally)\n\n[Collecting the app’s configurations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23collecting-the-apps-configurations)\n\n[Step 5 - Publishing the app in the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23step-5-publishing-the-app-in-the-vtex-app-store)\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-app-template.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[What the App Template includes for the VTEX Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23what-the-app-template-includes-for-the-vtex-admin)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23before-you-begin)\n\n[Step 1 - Creating your repository from the template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23step-1-creating-your-repository-from-the-template)\n\n[Step 2 - App configurations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23step-2-app-configurations)\n\n[Substituting placeholders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23substituting-placeholders)[Template App Configurations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23template-app-configurations)\n\n[Step 3 - Translating a component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23step-3-translating-a-component)\n\n[Step 4 - Testing the app locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23step-4-testing-the-app-locally)\n\n[Collecting the app’s configurations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23collecting-the-apps-configurations)\n\n[Step 5 - Publishing the app in the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-template/docs/guides/external-marketplace-integration-app-template%23step-5-publishing-the-app-in-the-vtex-app-store)\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_fa2efba1
|
[
{
"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 enums 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-enums/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-enums/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-enums/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-enums/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-enums/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-enums/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-enums/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-enums/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-enums/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/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-enums/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/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-enums/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/faststore-api-overview)\n\n[Queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-queries)\n\n[Mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-mutations)\n\n[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-objects)\n\n[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-inputs)\n\n[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-enums)\n\n[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/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-enums/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-enums/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-enums/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-enums/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-enums/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-enums/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/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-enums/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-enums/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/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-enums/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-enums/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/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-enums/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/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-enums/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/faststore-api-overview)\n\n[Queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-queries)\n\n[Mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-mutations)\n\n[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-objects)\n\n[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-inputs)\n\n[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-enums)\n\n[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/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-enums/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-enums/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-enums/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-enums/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-enums/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-enums/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/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-enums/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-enums/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-enums/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/faststore-api-overview)\n\nEnums\n\n### StoreCollectionType\n\nProduct collection type. Possible values are `Department`, `Category`, `Brand`, `Cluster`, `SubCategory` or `Collection`.\n\n| Value | Description | | **Department** | First level of product categorization. |\n| --------------- | --------------------------------------- | ----------------- | -------------------------------------- |\n| **Category** | Second level of product categorization. | | |\n| **SubCategory** | Third level of product categorization. | | |\n| **Brand** | Product brand. | | |\n| **Cluster** | Product cluster. | | |\n| **Collection** | Product collection. | | |\n\n### StoreFacetType\n\nSearch facet type.\n\n| Value | Description | | **BOOLEAN** | Indicates a filter with boolean options (e.g., yes and no), for narrowing search results. |\n| --------- | --------------------------------------------------------------------------------------------------------- | -------------- | ----------------------------------------------------------------------------------------- |\n| **RANGE** | Indicates a filter to choose between a range of values (e.g., price, size, etc) to refine search results. | | |\n\n### StoreSort\n\nProduct search results sorting options.\n\n| Value | Description | | **price\\_desc** | Sort by price, from highest to lowest. |\n| ------------------ | ----------------------------------------------- | ------------------ | -------------------------------------- |\n| **price\\_asc** | Sort by price, from lowest to highest. | | |\n| **orders\\_desc** | Sort by orders, from highest to lowest. | | |\n| **name\\_desc** | Sort by name, in reverse alphabetical order. | | |\n| **name\\_asc** | Sort by name, in alphabetical order. | | |\n| **release\\_desc** | Sort by release date, from highest to lowest. | | |\n| **discount\\_desc** | Sort by discount value, from highest to lowest. | | |\n| **score\\_desc** | Sort by product score, from highest to lowest. | | |\n\n### StoreStatus\n\nStatus used to indicate a message type. For instance, a shopping cart informative or error message.\n\n| Value | Description | | **INFO** | Indicates non-critical notifications or informative messages related to the user's action. |\n| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ----------- | ------------------------------------------------------------------------------------------ |\n| **WARNING** | Indicates a potential issue or unexpected behavior that might require user attention but doesn't necessarily prevent them from continuing. | | |\n| **ERROR** | Indicates a critical issue that prevents the user from completing an action or indicates a problem with the system. | | |\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/enums.mdx)\n\n[Inputs« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-inputs)[ScalarsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-scalars)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[StoreCollectionType](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-enums%23storecollectiontype)\n\n[StoreFacetType](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-enums%23storefacettype)[StoreSort](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-enums%23storesort)[StoreStatus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-enums%23storestatus)\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/enums.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[StoreCollectionType](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-enums%23storecollectiontype)\n\n[StoreFacetType](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-enums%23storefacettype)[StoreSort](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-enums%23storesort)[StoreStatus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums/docs/guides/faststore/schema-enums%23storestatus)\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_cd8938f9
|
[
{
"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 listing an accounts 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/vtex-io-documentation-listing-an-accounts-apps/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-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-apps/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-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-apps/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n[Installing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-apps/docs/guides/vtex-io-documentation-installing-an-app)\n\n[Listing an account’s apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-apps/docs/guides/vtex-io-documentation-listing-an-accounts-apps)\n\n[Linking an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-apps/docs/guides/vtex-io-documentation-linking-an-app)\n\n[Deprecating an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-apps/docs/guides/vtex-io-documentation-deprecating-an-app)\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-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-apps/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-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-apps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-apps/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-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-apps/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-apps/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-apps/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-apps/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-apps/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-apps/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-apps/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-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-apps/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n[Installing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-apps/docs/guides/vtex-io-documentation-installing-an-app)\n\n[Listing an account’s apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-apps/docs/guides/vtex-io-documentation-listing-an-accounts-apps)\n\n[Linking an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-apps/docs/guides/vtex-io-documentation-linking-an-app)\n\n[Deprecating an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-apps/docs/guides/vtex-io-documentation-deprecating-an-app)\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-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-apps/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-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-apps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-apps/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-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-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/vtex-io-documentation-listing-an-accounts-apps/docs/app-development)\n\nManaging apps\n\n[Listing an account’s apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-apps/docs/guides/vtex-io-documentation-listing-an-accounts-apps)\n\nListing an account’s apps\n\nUnderstanding the apps installed or linked to an account is pivotal for effective development and account management. 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) simplifies this task by providing a straightforward command to access the list of apps associated with a specific account and workspace.\n\n## Instructions\n\n1. Open the terminal and log into the desired account 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). If applicable, switch to the desired [workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace).\n2. Run the following command: \n`1 \nvtex list \n`\n\nUpon executing this command, the VTEX IO CLI will display a detailed list of installed and linked apps within the account. This list includes vital information such as app names and their respective versions.\n\n**Example output:**\n\n`1\n\n$ vtex list \n\n2\n\n \n3\n\nEdition Apps in mystore at workspace master \n\n4\n\nvtex.admin 4.56.3 \n\n5\n\nvtex.admin-account-details 1.0.3 \n\n6\n\nvtex.admin-apps 4.3.1 \n\n7\n\nvtex.admin-audit 2.13.5 \n\n8\n\n... \n\n9\n\nvtex.workspace-analytics 0.1.7 \n\n10\n\n \n11\n\nInstalled Apps in mystore at workspace master \n\n12\n\nvtex.affiliates 1.8.0 \n\n13\n\nvtex.app-store-seller 0.12.9 \n\n14\n\nvtex.availability-notify 1.12.1 \n\n15\n\n... \n\n16\n\nvtex.social-selling 0.8.0 \n\n17\n\n \n18\n\nLinked Apps in mystore at workspace master \n\n19\n\nYou have no linked apps \n\n`\n\nNote that the list is organized into three categories:\n\n* **Edition Apps**: Apps installed by an [Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app). Modifying these app versions and configurations is restricted to the [Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account).\n* **Installed Apps**: Independently [installed apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app).\n* **Linked Apps**: Apps [linked](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) in a [development workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-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-listing-an-accounts-apps.md)\n\n[Installing an app« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-apps//docs/guides/vtex-io-documentation-installing-an-app)[Linking an appNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-apps//docs/guides/vtex-io-documentation-linking-an-app)\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-listing-an-accounts-apps/docs/guides/vtex-io-documentation-listing-an-accounts-apps%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/configuring-workspaces/vtex-io-documentation-listing-an-accounts-apps.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-listing-an-accounts-apps/docs/guides/vtex-io-documentation-listing-an-accounts-apps%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_2b564d51
|
[
{
"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 managing edition 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/managing-edition-apps/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-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/managing-edition-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/managing-edition-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/managing-edition-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/managing-edition-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/managing-edition-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/managing-edition-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/managing-edition-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/managing-edition-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/managing-edition-apps/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-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/managing-edition-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/managing-edition-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/managing-edition-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/managing-edition-apps/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/managing-edition-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/managing-edition-apps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-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/managing-edition-apps/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/guides/managing-edition-apps)\n\n[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/guides/vtex-io-documentation-edition-app)\n\n[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/guides/vtex-io-documentation-sponsor-account)\n\n[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)\n\n[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/guides/vtex-io-documentation-configuring-an-edition-app)\n\n[Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/guides/vtex-io-documentation-updating-edition-apps)\n\n[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/guides/seller-portal-edition-app)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-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/managing-edition-apps/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-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/managing-edition-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/managing-edition-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/managing-edition-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/managing-edition-apps/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-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/managing-edition-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/managing-edition-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/managing-edition-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/managing-edition-apps/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/managing-edition-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/managing-edition-apps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-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/managing-edition-apps/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/guides/managing-edition-apps)\n\n[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/guides/vtex-io-documentation-edition-app)\n\n[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/guides/vtex-io-documentation-sponsor-account)\n\n[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)\n\n[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/guides/vtex-io-documentation-configuring-an-edition-app)\n\n[Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/guides/vtex-io-documentation-updating-edition-apps)\n\n[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/guides/seller-portal-edition-app)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-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/managing-edition-apps/docs/app-development)\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps/docs/guides/managing-edition-apps)\n\nEdition Apps\n\n[Becoming a Sponsor AccountWant to publish Edition apps for child accounts? First learn how to configure all requirements to become a Sponsor Account.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)[Configuring an Edition appIf you already match all requirements to become a Sponsor Account, learn now how to configure your own Edition Apps for child accounts.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app)[Updating Edition appsLearn how to publish a new version of an Edition app.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps)[Seller Portal Edition appLearn how to use the Seller Portal Edition app if you are a marketplace seller.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-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/App-Guides/managing-edition-apps.md)\n\n[Documentation guidelines« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps//docs/guides/vtex-io-documentation-docs-guidelines)[Edition AppNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-edition-apps//docs/guides/vtex-io-documentation-edition-app)\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/App-Guides/managing-edition-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_e1ec4a0d
|
[
{
"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 recommendation shelf 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.recommendation-shelf/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/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.recommendation-shelf/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.recommendation-shelf/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.recommendation-shelf/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.recommendation-shelf/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.recommendation-shelf/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/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.recommendation-shelf/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.recommendation-shelf/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/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.recommendation-shelf/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.recommendation-shelf/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.recommendation-shelf/docs/vtex-io-apps)\n\nRecommendation Shelf\n\nOfficial extension\n\nVersion: 2.14.2\n\nLatest version: 2.14.2\n\n> This app is currently under development and research by the VTEX Search and Personalization team. During this phase, it should only be installed on selected accounts participating in the closed beta phase of the [Product Recommendations](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/product-recommendations-beta--2QIexbD2FSXBxELUnFtg7g) feature. For other accounts, installing this app will not have any effect. If you want to adopt this feature for your business, please contact [our Support](https://read.calvincode.net/reader?url=https://support.vtex.com/hc/en-us/requests).\n\nThe Recommendation Shelf app is a store component that displays a collection of products using recommendation strategies.\n\n\n\n> Learn more about [Product Recommendations](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/product-recommendations-beta--2QIexbD2FSXBxELUnFtg7g).\n\n## Before you begin\n\nMost recommendation strategies rely on user navigation data as input. Therefore, your store must be configured with our pixel for the `recommendation-shelf` to work properly. This configuration is managed by the VTEX team, so please wait for our confirmation before proceeding with the integration.\n\n## Installation\n\nThis app uses our store builder with the blocks architecture. To learn more about Store Builder, [click here.](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/understanding-storebuilder-and-stylesbuilder%23structuring-and-configuring-our-store-with-object-object)\n\nFollow these steps to use the Recommendation Shelf app in your store:\n\n1. Add the app as a dependency in your store theme. In your `manifest.json` file, add the following to the `dependencies` section: \n`1 \n\"dependencies\": { \n2 \n \"vtex.recommendation-shelf\": \"2.x\" \n3 \n} \n`\n2. Add the `recommendation-shelf` block into your app theme where you want the shelf to appear.\n3. Customize the behavior of the shelf block. \nThe example below shows the following configuration of the `recommendation-shelf` block and its supporting blocks: \n * It creates a `recommendation-shelf#visual-similarity` block that uses the \"VISUAL\\_SIMILARITY\" recommendation strategy and sets the shelf title to \"Similar items\". \n * It defines a `list-context.product-list-static` block, which includes the `product-summary.shelf` block and a child slider layout. \n * It configures the `slider-layout#recommendation-slider` block to control how many items are shown per page on desktop, tablet, and phone, and enables infinite scrolling. \nExample: \n`1 \n\"recommendation-shelf#visual-similarity\": { \n2 \n \"blocks\": [\"list-context.product-list-static\"], \n3 \n \"props\": { \n4 \n \"campaignVrn\": \"vrn:recommendations:biggy:rec-similar-v2:00318b68-cb1b-4d5a-8b0f-cc7fbcdd014b\", \n5 \n \"title\": \"Similar items\" \n6 \n } \n7 \n}, \n8 \n\"list-context.product-list-static\": { \n9 \n \"blocks\": [ \n10 \n \"product-summary.shelf\" \n11 \n ], \n12 \n \"children\": [ \n13 \n \"slider-layout#recommendation-slider\" \n14 \n ] \n15 \n}, \n16 \n\"slider-layout#recommendation-slider\": { \n17 \n \"props\": { \n18 \n \"itemsPerPage\": { \n19 \n \"desktop\": 5, \n20 \n \"tablet\": 3, \n21 \n \"phone\": 2 \n22 \n }, \n23 \n \"infinite\": true \n24 \n } \n25 \n} \n`\n4. Customize the product summary (optional). \nThe Recommendation Shelf relies on the `slider-layout` and `product-summary.shelf` components. You can further customize the shelf by creating a custom product summary, for example: \n`1 \n\"product-summary.shelf#custom\": { \n2 \n \"children\": [ \n3 \n \"product-summary-name\", \n4 \n \"product-summary-description\", \n5 \n \"product-summary-image\", \n6 \n \"product-summary-price\", \n7 \n \"product-summary-sku-selector\", \n8 \n \"product-summary-buy-button\" \n9 \n ] \n10 \n} \n` \nFor more information, see the [Product Summary API configuration](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/product-summary/blob/master/README.md%23configuration).\n\n### Configuration\n\nYou can configure the `recommendation-shelf` block in your theme app using the following props:\n\n### Props\n\nConfigure the `recommendation-shelf` block using the following properties:\n\n| Prop name | Type | Description | Default value |\n| ------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| title | string | Shelf title displayed to users. | \\- |\n| campaignVrn | string | VRN identifier for the recommendation campaign. | \\- |\n| displayTitle | boolean | Whether to show the shelf title (true) or hide it (false). | true |\n| itemsContext | array | Context source for items in the recommendation request (PDP or CART). Useful for enabling shelves on the cart page with CROSS\\_SELL. | \\['PDP'\\] |\n\n## Recommendation strategies\n\nBelow are the available recommendation strategies that can be used to fetch product suggestions:\n\n| strategy | Description | Pages |\n| ------------------ | ----------------------------------------------------------------------------------------- | ------------- |\n| TOP\\_ITEMS | Returns the most bought products in the store. | Any |\n| PERSONALIZED | Returns recommended products based on the last products clicked by the user in the store. | Any |\n| LAST\\_SEEN | Returns recommended products based on the last products viewed by the user in the store. | Any |\n| CROSS\\_SELL | Returns complementary products related to the current product or the items in the cart. | Any |\n| VISUAL\\_SIMILARITY | Returns products considered visually similar to the current product. | store.product |\n| SIMILAR\\_ITEMS | Returns products considered most similar to the current product. | store.product |\n\n## Troubleshooting\n\nCheck if others have encountered similar issues [here](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/recommendation-shelf/issues). Feel free to [open issues](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/recommendation-shelf/issues/new) or contribute with pull requests.\n\n[](#contributors-)\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[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/apps/vtex.recommendation-shelf%23before-you-begin)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/apps/vtex.recommendation-shelf%23installation)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/apps/vtex.recommendation-shelf%23configuration)[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/apps/vtex.recommendation-shelf%23props)\n\n[Recommendation strategies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/apps/vtex.recommendation-shelf%23recommendation-strategies)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.recommendation-shelf/docs/apps/vtex.recommendation-shelf%23troubleshooting)\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_8f6673bf
|
[
{
"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 3.178.5 ProductHighlights 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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductHighlights/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductHighlights/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductHighlights/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductHighlights/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductHighlights/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/docs/vtex-io-apps)\n\nProduct Highlights\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\n\n\n> Warning\n> \n> **The Product Highlights block has been deprecated in favor of the [Product Specifications app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-specifications/).** Although support for this block is still granted, we strongly recommend you to update your store theme with the Product Specification's blocks in order to keep up with the component's evolution.\n\nThe `product-highlights` block shows the general specifications of a product.\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\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-highlights` block to any child of the `store.product` or `product-summary` templates. For example:\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n+ \"product-highlights\", \n\n4\n\n ] \n\n5\n\n }, \n\n`\n\n1. Then, declare the `product-highlights` block using the props stated in the [Props](#props) table.\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| ---------- | ----------------- | ------------------------ | ------------- |\n| highlights | Array(Highlights) | Highlights of a product. | \\[\\] |\n\n#### `highlights` props\n\n| Prop name | Type | Description |\n| --------- | -------------- | ------------------ |\n| name | String! | Highlights name. |\n| values | Array(String)! | Highlights values. |\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| highlightContent |\n| itemHighlight |\n| highlightTitle |\n| highlightValue |\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@3.178.5/ProductHighlights/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@3.178.5/ProductHighlights/docs/apps/vtex.store-components@3.178.5/ProductHighlights%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductHighlights/docs/apps/vtex.store-components@3.178.5/ProductHighlights%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductHighlights/docs/apps/vtex.store-components@3.178.5/ProductHighlights%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_82b1e764
|
[
{
"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 region bar 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-region-bar/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-region-bar/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-region-bar/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-region-bar/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-region-bar/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-region-bar/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-region-bar/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-region-bar/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-region-bar/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/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-region-bar/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/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-region-bar/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/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-region-bar/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-region-bar/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-region-bar/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-region-bar/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/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-region-bar/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-region-bar/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/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-region-bar/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-region-bar/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/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-region-bar/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/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-region-bar/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/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-region-bar/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-region-bar/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-region-bar/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-region-bar/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/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-region-bar/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-region-bar/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-region-bar/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-overview)\n\nRegionBar\n\nThis component is a custom button, designed primarily for mobile devices, that triggers the `RegionModal`.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/RegionBar)\n\nThe `RegionBar` is a custom button, usually used only on mobile devices. It should trigger the [RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal).\n\nThe component is part of the [Regionalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization) feature.\n\nExample\n\nCode\n\nSet your location\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { RegionBar } 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/RegionBar/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## Design tokens\n\n| Local token | Default value/Global token linked |\n| ------------------------------------ | ------------------------------------------------------------- |\n| \\--fs-region-bar-width | 100% |\n| \\--fs-region-bar-padding | var(--fs-spacing-0) 0 var(--fs-spacing-0) var(--fs-spacing-2) |\n| \\--fs-region-bar-text-color | var(--fs-color-text-display) |\n| \\--fs-region-bar-bkg-color | var(--fs-color-body-bkg) |\n| \\--fs-region-bar-border-bottom-width | var(--fs-border-width) |\n| \\--fs-region-bar-border-bottom-color | var(--fs-border-color-light) |\n\n### CTA (Call to Action) \n\n\n\n| Local token | Default value/Global token linked |\n| ------------------------------------ | --------------------------------- |\n| \\--fs-region-bar-cta-margin-left | auto |\n| \\--fs-region-bar-cta-text-decoration | underline |\n\n### Message \n\n\n\n| Local token | Default value/Global token linked |\n| ------------------------------------- | --------------------------------- |\n| \\--fs-region-bar-message-margin-right | auto |\n\n### Postal Code \n\n\n\n| Local token | Default value/Global token linked |\n| ----------------------------------------- | --------------------------------- |\n| \\--fs-region-bar-postal-code-margin-right | auto |\n\n### Icon\n\n| Local token | Default value/Global token linked |\n| ---------------------------------- | --------------------------------- |\n| \\--fs-region-bar-icon-margin-right | var(--fs-spacing-1) |\n\n### Location\n\n| Local token | Default value/Global token linked |\n| -------------------------------- | --------------------------------- |\n| \\--fs-region-bar-location-height | var(--fs-spacing-4) |\n\n---\n\n## Data attributes\n\nYou can target and override `RegionBar` styles using the following data attributes:\n\n`data-fs-region-bar`\n\n`data-fs-region-bar-postal-code`\n\n`data-fs-region-bar-cta`\n\n`data-fs-region-bar-message`\n\n`data-fs-region-bar-filter`\n\n`data-fs-region-bar-filter-message`\n\n`data-fs-region-bar-location`\n\n`data-fs-region-bar-location-city`\n\n`data-fs-region-bar-location-message`\n\n`data-fs-region-bar-location-postal-code`\n\n---\n\n## Props\n\n| Name | Type | Description | Default | | | | | | |\n| --------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ------- | -- | ------------------------ | --------------------------- | ------------------- | ----------- | ------------------------------------------------------------- |\n| **city** | string | City to be displayed in the component. | | | | | | | |\n| **postalCode** | string | Postal code string to be display in the component. | | | | | | | |\n| **icon** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | A React component that will be rendered as the location icon. |\n| **label\\*** | string | Specifies a label for the location text. | | | | | | | |\n| **editLabel** | string | Specifies a label for the edit location text. @deprecated | | | | | | | |\n| **buttonIcon** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | A React component that will be rendered as an icon. |\n| **onButtonClick** | () => void | Function called when location button is clicked. | | | | | | | |\n| **shouldDisplayPostalCode** | false \\| true | Boolean to control whether postal code should be visible or not. | true | | | | | | |\n| **filterButton** | { icon?: ReactNode; label?: string; selectedFilter?: string; shouldDisplayFilterButton?: boolean; onClick?: () => void; } | Properties of the global filter button. | | | | | | | |\n\nContributors\n\n4\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\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/region-bar.mdx)\n\n[RatingField« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-rating-field)[SearchAutocompleteNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-search-auto-complete)\n\nContributors\n\n4\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\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-region-bar/docs/guides/faststore/molecules-region-bar%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23design-tokens)\n\n[CTA (Call to Action) {\"base64\":\" \",\"img\":{\"width\":71,\"height\":20,\"type\":\"svg\",\"mime\":\"image/svg+xml\",\"wUnits\":\"px\",\"hUnits\":\"px\",\"url\":\"https://img.shields.io/badge/deprecated-lightgrey\"}}](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23cta-call-to-action-base64-imgwidth71height20typesvgmimeimagesvgxmlwunitspxhunitspxurlhttpsimgshieldsiobadgedeprecated-lightgrey)[Message {\"base64\":\" \",\"img\":{\"width\":71,\"height\":20,\"type\":\"svg\",\"mime\":\"image/svg+xml\",\"wUnits\":\"px\",\"hUnits\":\"px\",\"url\":\"https://img.shields.io/badge/deprecated-lightgrey\"}}](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23message-base64-imgwidth71height20typesvgmimeimagesvgxmlwunitspxhunitspxurlhttpsimgshieldsiobadgedeprecated-lightgrey)[Postal Code {\"base64\":\" \",\"img\":{\"width\":71,\"height\":20,\"type\":\"svg\",\"mime\":\"image/svg+xml\",\"wUnits\":\"px\",\"hUnits\":\"px\",\"url\":\"https://img.shields.io/badge/deprecated-lightgrey\"}}](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23postal-code-base64-imgwidth71height20typesvgmimeimagesvgxmlwunitspxhunitspxurlhttpsimgshieldsiobadgedeprecated-lightgrey)[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23icon)[Location](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23location)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%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/region-bar.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-region-bar/docs/guides/faststore/molecules-region-bar%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23design-tokens)\n\n[CTA (Call to Action) {\"base64\":\" \",\"img\":{\"width\":71,\"height\":20,\"type\":\"svg\",\"mime\":\"image/svg+xml\",\"wUnits\":\"px\",\"hUnits\":\"px\",\"url\":\"https://img.shields.io/badge/deprecated-lightgrey\"}}](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23cta-call-to-action-base64-imgwidth71height20typesvgmimeimagesvgxmlwunitspxhunitspxurlhttpsimgshieldsiobadgedeprecated-lightgrey)[Message {\"base64\":\" \",\"img\":{\"width\":71,\"height\":20,\"type\":\"svg\",\"mime\":\"image/svg+xml\",\"wUnits\":\"px\",\"hUnits\":\"px\",\"url\":\"https://img.shields.io/badge/deprecated-lightgrey\"}}](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23message-base64-imgwidth71height20typesvgmimeimagesvgxmlwunitspxhunitspxurlhttpsimgshieldsiobadgedeprecated-lightgrey)[Postal Code {\"base64\":\" \",\"img\":{\"width\":71,\"height\":20,\"type\":\"svg\",\"mime\":\"image/svg+xml\",\"wUnits\":\"px\",\"hUnits\":\"px\",\"url\":\"https://img.shields.io/badge/deprecated-lightgrey\"}}](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23postal-code-base64-imgwidth71height20typesvgmimeimagesvgxmlwunitspxhunitspxurlhttpsimgshieldsiobadgedeprecated-lightgrey)[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23icon)[Location](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23location)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar/docs/guides/faststore/molecules-region-bar%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_1c53d017
|
[
{
"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 reviews and ratings 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.reviews-and-ratings/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/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.reviews-and-ratings/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.reviews-and-ratings/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.reviews-and-ratings/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.reviews-and-ratings/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.reviews-and-ratings/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/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.reviews-and-ratings/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/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.reviews-and-ratings/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.reviews-and-ratings/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/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.reviews-and-ratings/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/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.reviews-and-ratings/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/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.reviews-and-ratings/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.reviews-and-ratings/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/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.reviews-and-ratings/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/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.reviews-and-ratings/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.reviews-and-ratings/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/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.reviews-and-ratings/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/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.reviews-and-ratings/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/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.reviews-and-ratings/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.reviews-and-ratings/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.reviews-and-ratings/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/guides/advanced-components)\n\nReviews and Ratings\n\nOfficial extension\n\nVersion: 3.20.2\n\nLatest version: 3.20.2\n\n> This app is no longer maintained by VTEX. This means support and maintenance are no longer provided.\n\n**Reviews & Ratings** allows customers to submit reviews and ratings for products and see them while navigating the store.\n\n\n\n## Configuration\n\n### Step 1 - Installing the Reviews and Ratings app\n\n1. Open your terminal and log in to your account by running the command `vtex login {accountName}`. Replace the values between the curly brackets according to your scenario.\n2. Run the `vtex install vtex.reviews-and-ratings@3.x` command to install the Reviews and Ratings app in your account. It’s expected that you receive the message: `info: Installed app vtex.reviews-and-ratings@3.x successfully`.\n\n### Step 2 - Defining app settings\n\n1. Access the Admin, go to `Apps > My Apps` and then click the `Reviews and Ratings` card:\n\n\n\n1. On the app settings page, define the following settings based on the desired scenario:\n\n\n\n* **Allow Anonymous Reviews:** If unchecked, only logged-in customers will be able to review products.\n* **Require Admin Approval:** Checking this box activates the review moderation system. Newly submitted reviews will not be displayed on the store until an admin approves them in the Admin account. For more information, see the [App behavior](#app-behavior) section below.\n* **Ask For Reviewer Location:** Checking this box activates an optional review field. Customers who submit reviews will be asked to enter their current location (for example: \"Boston, MA\").\n* **Default all review accordions to open:** The app displays reviews on the product page inside collapsible accordions. Checking this box will cause all review accordions to default to open when the page is loaded, with review text limited to three lines. Reviews with more than three lines of text will be truncated with an ellipsis and a `Show more` link that can be used to display the whole review text.\n* **Number of open review accordions:** Checking this box allows you to set a specific number of review accordions (instead of all of them) to automatically open when the page is loaded, displaying all the review text. If the `Default all review accordions to open` setting is active, this option is ignored.\n* **Display graph:** Checking this box allows you to display the reviews graph on the product details page.\n* **Display stars in `product-rating-summary` if there are no reviews:** Checking this box allows you to display empty stars even if the product has no reviews yet.\n* **Display total reviews number on `product-rating-summary` block:** Checking this box allows you to display the total number of reviews for a product.\n* **Display `Add review` button on `product-rating-summary` block:** Checking this box allows you to display an `Add review` button under the stars.\n* **Display stars in `product-rating-summary` if there are no reviews:** Checking this box allows you to display empty stars even if the product has no reviews yet.\n* **Display total reviews number on `product-rating-summary` block:** Checking this box allows you to display the total number of reviews for a product.\n* **Display `Add review` button on `product-rating-summary` block:** Checking this box allows you to display an `Add review` button under the stars.\n\n### Step 3 - Declaring the app blocks in your store theme\n\nOnce the app is configured, place the following blocks in your Store Theme app:\n\n* `product-reviews`: This block can be added to the product page template (`store.product`). It renders a paginated list of reviews for the product being viewed and a form for the customer to add a new review.\n* `product-rating-summary`: This block can be added to the product page template (`store.product`) and renders the average rating for the product being viewed as well as the number of reviews that have been submitted. Only approved reviews will count toward these figures if the account uses moderation.\n* `product-rating-inline`: Similar to the previous block (`product-rating-summary`), but intended to be used in [product shelves](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/). This block only displays the product average rating.\n\n## App behavior\n\nAs described above, the app may be configured to use a **review moderation interface** where an admin is responsible for approving the reviews before they are displayed on the store.\n\nTo access and use the review moderation admin interface, follow the instructions below:\n\n1. Enable the **Require Admin Approval** setting as described above.\n2. Open the Admin and navigate to **Catalog > Reviews**.\n3. You may view either **Pending** or **Approved** reviews using the tabs at the top of the page.\n\n> You can export reviews to XLS files from the **Download** tab. The export is limited to 800 reviews at a time. Please use the date pickers to choose the time range of reviews you want to export.\n\n> If you have updated to version 3.x after using a prior version of **Reviews and Ratings**, you may see the **Migrate Data** button instead of a list of reviews in the **Catalog > Reviews** page. Clicking this button will migrate all existing review data from the previous storage solution (VBASE) to the new solution (Masterdata V2). Once the migration is finished, the page will automatically refresh, and the list of reviews will become available.\n\nIndividual pending reviews may be approved or deleted using the kebab menu (3 dots button) in the right column or by selecting the checkbox on the left. Multiple reviews can also be selected using the checkboxes to approve or delete in bulk.\n\nApproved reviews may be deleted as well, either individually or in bulk.\n\n## Customization\n\nTo 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://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS handles |\n| ----------------------- |\n| container |\n| formContainer |\n| formSection |\n| formBottomLine |\n| formRating |\n| formName |\n| formLocation |\n| formEmail |\n| formReview |\n| formSubmit |\n| formInvalidMessage |\n| graphBar |\n| graphBarContainer |\n| graphBarPercent |\n| graphContent |\n| graphContainer |\n| graphText |\n| graphTextLabel |\n| loginLink |\n| reviewComment |\n| reviewMessage |\n| reviewCommentRating |\n| reviewCommentsContainer |\n| reviewCommentUser |\n| reviewsHeading |\n| reviewsRating |\n| reviewsRatingAverage |\n| reviewsRatingCount |\n| reviewsOrderBy |\n| reviewsPaging |\n| reviewInfo |\n| reviewVerifiedPurchase |\n| reviewDate |\n| reviewDateSubmitted |\n| reviewDateValue |\n| reviewAuthor |\n| reviewAuthorBy |\n| reviewAuthorName |\n| star--empty |\n| star--filled |\n| star |\n| starpicker |\n| stars |\n| starsContainer |\n| summaryContainer |\n| summaryButtonContainer |\n| writeReviewContainer |\n| graphContent |\n| graphContainer |\n| graphText |\n| graphTextLabel |\n| graphBarContainer |\n| graphBar |\n| graphBarPercent |\n| summaryButtonContainer |\n| summaryTotalReviews |\n| writeReviewContainer |\n| writeReviewButton |\n\n## Rest APIs\n\nTo see how to use the list of REST APIs, read [Reviews and Ratings API overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/reviews-and-ratings-api%23overview).\n\n## GraphQL IDE\n\nTo see how to use the graphQL queries and mutations, follow these steps:\n\n1. Open the Admin [GraphQL IDE app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-graphql-ide).\n2. Select the`vtex.reviews-and-ratings` app.\n3. Click `docs` in the top right corner. \n> An error occurred while loading the image https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/public/metadata/images/screenshots/graphQL\\_docs.png\n\nYou will see the list of all available queries and mutations, including schemas and variable descriptions.\n\n[Quantity On Cart« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtexarg.quantity-on-cart)[Querying personal MasterData Information with SafeDataNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.safedata)\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.reviews-and-ratings/docs/apps/vtex.reviews-and-ratings%23configuration)\n\n[Step 1 - Installing the Reviews and Ratings app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.reviews-and-ratings%23step-1-installing-the-reviews-and-ratings-app)[Step 2 - Defining app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.reviews-and-ratings%23step-2-defining-app-settings)[Step 3 - Declaring the app blocks in your store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.reviews-and-ratings%23step-3-declaring-the-app-blocks-in-your-store-theme)\n\n[App behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.reviews-and-ratings%23app-behavior)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.reviews-and-ratings%23customization)\n\n[Rest APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.reviews-and-ratings%23rest-apis)\n\n[GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings/docs/apps/vtex.reviews-and-ratings%23graphql-ide)\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_b0d3188e
|
[
{
"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 2.18.8 Banner 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@2.18.8/Banner/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@2.18.8/Banner/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@2.18.8/Banner/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@2.18.8/Banner/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@2.18.8/Banner/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@2.18.8/Banner/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@2.18.8/Banner/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@2.18.8/Banner/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/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@2.18.8/Banner/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/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@2.18.8/Banner/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@2.18.8/Banner/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@2.18.8/Banner/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/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@2.18.8/Banner/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/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@2.18.8/Banner/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/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@2.18.8/Banner/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@2.18.8/Banner/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@2.18.8/Banner/docs/vtex-io-apps)\n\nBanner\n\n[vtex.search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search)\n\nVersion: 2.18.8\n\nLatest version: 2.18.8\n\nBanner is the Intelligent Search feature that displays banners on the customer search results page, depending on the search context.\n\n## Before you begin\n\nMake sure you have added the `search` app to your theme dependencies within 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## Configuration\n\nThe banner entity is composed of the following fields:\n\n| Field | Description |\n| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |\n| Active | Indicates if the banner is active or not. |\n| Banner name | Unique identifier for the banner. |\n| Type banner | Specifies the type of banner, which can be either HTML or IMAGE. |\n| HTML / Image URL | HTML code or image to be inserted. |\n| Area | Indicates the section of the page where the banner will be displayed. It's important when multiple banners are present on the same page. |\n| Terms | List of terms for this banner. |\n| Period | The period that this banner will be active. |\n| Attributes | List of selected attributes for this banner. |\n\n## Usage\n\nAdd the `search-banner` block to `search-result-layout.desktop` or `search-result-layout.mobile`. For example:\n\n`1\n\n{ \n\n2\n\n \"search-result-layout.desktop\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"flex-layout.row#banner-one\" \n\n5\n\n ] \n\n6\n\n }, \n\n7\n\n \"search-banner#one\": { \n\n8\n\n \"props\": { \n\n9\n\n \"area\": \"one\", \n\n10\n\n \"blockClass\": \"myBanner\", \n\n11\n\n \"horizontalAlignment\": \"center\" \n\n12\n\n } \n\n13\n\n }, \n\n14\n\n \"flex-layout.row#banner-one\": { \n\n15\n\n \"children\": [ \n\n16\n\n \"search-banner#one\" \n\n17\n\n ] \n\n18\n\n } \n\n19\n\n} \n\n`\n\n## Props\n\n| Prop name | Type | Description | Default value |\n| ------------------- | ------ | -------------------------------------------------------------------- | ------------- |\n| area | String | Indicates the area. It must match the area configured in the banner. | \\- |\n| blockClass | String | Defines a custom class to the banner div. | \\- |\n| horizontalAlignment | String | Defines the horizontal alignment for the banner. | \"center\" |\n\nThe possible values for `horizontalAlignment` are:\n\n| Values |\n| -------- |\n| \"left\" |\n| \"right\" |\n| \"center\" |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, follow the instructions in the guide [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| searchBanner |\n\nSee also\n\n[Vtex.searchVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/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@2.18.8/Banner/docs/apps/vtex.search@2.18.8/Banner%23before-you-begin)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/docs/apps/vtex.search@2.18.8/Banner%23configuration)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/docs/apps/vtex.search@2.18.8/Banner%23usage)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/docs/apps/vtex.search@2.18.8/Banner%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@2.18.8/Banner/docs/apps/vtex.search@2.18.8/Banner%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_44ac1e8a
|
[
{
"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 productsummaryname 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/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/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.product-summary/productsummaryname/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/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.product-summary/productsummaryname/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.product-summary/productsummaryname/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/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/productsummaryname/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/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.product-summary/productsummaryname/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/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.product-summary/productsummaryname/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.product-summary/productsummaryname/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/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/productsummaryname/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/guides/basic-components)\n\nProduct Summary Name\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\nProduct Summary Name is a block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-summary) responsible for rendering the product name.\n\n\n\n## Configuration\n\n1. Import the `vtex.product-summary` app to your theme's dependencies in the `manifest.json`:\n\n`1\n\n dependencies: { \n\n2\n\n \"vtex.product-summary\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-summary-name` block to your store theme as a child of `product-summary.shelf`. For example:\n\n`1\n\n \"product-summary.shelf\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"product-summary-image\", \n\n4\n\n+ \"product-summary-name\", \n\n5\n\n \"product-summary-space\", \n\n6\n\n \"product-summary-column#1\" \n\n7\n\n ] \n\n8\n\n }, \n\n`\n\n1. Then, declare the `product-summary-name` and configure its behavior using the props stated below.\n\n| Prop name | Type | Description | Default value |\n| --------------- | ------ | --------------------------------------------- | --------------------------------------------------------------------- |\n| showFieldsProps | object | Defines the visibility on certain properties. | { showProductReference: false, showBrandName: false, showSku: false } |\n| tag | string | HTML tag used. It can be: div, h1, h2, h3. | h1 |\n\n* `showFieldsProps` object:\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ------- | ---------------------- | ------------- |\n| showSku | Boolean | Show product SKU | false |\n| showProductReference | Boolean | Show product reference | false |\n| showBrandName | Boolean | Show brand name | false |\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| nameContainer |\n| nameWrapper |\n| brandName |\n| skuName |\n| productReference |\n| productNameLoader |\n\n[Product Summary List« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-summary/productsummarylist)[Product Summary ShelfNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-summary/productsummaryshelf)\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/productsummaryname/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[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-summary/productsummaryname%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryname/docs/apps/vtex.product-summary/productsummaryname%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_79389ba4
|
[
{
"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 functional 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/functional-apps/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-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/functional-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/functional-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/functional-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/functional-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/functional-apps/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-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/functional-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/functional-apps/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-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/functional-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/functional-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/functional-apps/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/guides/guides/functional-apps)\n\nFunctional Apps\n\nCheck the full list of functional apps below.\n\nBeyond layout and UI apps, these functional apps operate behind the scenes, executing critical functions for a seamless shopping experience.\n\n[Checkout UI CustomCustomize the UI of your store's checkout through the VTEX Admin.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.checkout-ui-custom)[Checkout UI SettingsExport scripts to build a custom Checkout UI.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.checkout-ui-settings)[Product ContextFetch and access product data in your component.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.product-context)[Responsive ValuesUtility for using props that accept different values for different devices and media queries.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.responsive-values)[Store IconsExport the icons used in your storefront components.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.store-icons)[Store SitemapAutomatically generate a sitemap.xml file of your store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.store-sitemap)[TelemarketingEnable call center operators to act on behalf of your store customers.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps/docs/apps/vtex.telemarketing)\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/functional-apps.md)\n\n[B2B Quotes GraphQL API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps//docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api)[AB TesterNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/functional-apps//docs/apps/vtexarg.abtester)\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/functional-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_82292dcf
|
[
{
"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 using themes mixins breakpoints 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/using-themes-mixins-breakpoints/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-overview)\n\n[Styling the layout and breakpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-mixins-breakpoints)\n\n[Styling a component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-components)\n\n[Styling a section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-pages)\n\n[Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-importing-ui-components-styles)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-overview)\n\n[Styling the layout and breakpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-mixins-breakpoints)\n\n[Styling a component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-components)\n\n[Styling a section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-pages)\n\n[Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-importing-ui-components-styles)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/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/using-themes-mixins-breakpoints/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/styling-overview)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-overview)\n\nStyling the layout and breakpoints\n\n## Breakpoints\n\nFastStore simplifies screen breakpoint customization for projects by using [Include-Media](https://read.calvincode.net/reader?url=https://eduardoboucas.github.io/include-media/%23features), a Sass library for writing CSS media queries in an easy and maintainable way, using a natural and simplistic syntax. Each project has the following five pre-defined screen breakpoints:\n\n`1\n\n$breakpoints: ( \n\n2\n\n \"phone\": 320px, \n\n3\n\n \"phonemid\": 375px, \n\n4\n\n \"tablet\": 768px, \n\n5\n\n \"notebook\": 1280px, \n\n6\n\n \"desktop\": 1440px, \n\n7\n\n); \n\n`\n\n### Customizing Breakpoints\n\nFollow the steps below to override the pre-defined sizing system for the screen breakpoints.\n\n> Modifying these breakpoints implies changes to certain global tokens. See [Grid & Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-grid-and-layout%23breakpoints) for more details.\n\n1. Go to the `src` folder and create the `styles` folder inside it. You can run the following command to create it:\n\nmacOS and Linux\n\nWindows\n\n`1\n\nmkdir src/styles \n\n`\n\n1. Inside the `styles` folder, create a new file called `custom-mixins.scss`\n\nmacOS and Linux\n\nWindows\n\n`1\n\ntouch src/styles/custom-mixins.scss \n\n`\n\n1. Add the following code snippet into the file:\n\nsrc/styles/custom-mixins.scss\n\n`1\n\n@import \"@faststore/ui/src/styles/base/utilities\"; \n\n2\n\n \n3\n\n// Overwrites Breakpoints & Mixins //////////////////// \n\n4\n\n \n5\n\n$breakpoints: ( \n\n6\n\n \"phone\": 320px, \n\n7\n\n \"phonemid\": 375px, \n\n8\n\n \"tablet\": 768px, \n\n9\n\n \"notebook\": 1280px, \n\n10\n\n \"desktop\": 1500px, \n\n11\n\n); \n\n`\n\n> You need to declare all the variants (phone, phonemid, tablet, notebook, and desktop) even when changing only one of the values.\n\n1. Run `yarn dev` in the terminal to start the development server. You should be able to see the changes.\n\n---\n\n## Mixins\n\nThe [Sass @mixin](https://read.calvincode.net/reader?url=https://sass-lang.com/documentation/at-rules/mixin/) allows you to define styles that can be re-used throughout your application. Within FastStore projects, these mixins are categorized into three groups: `Global Mixins`, `Layout & Spacing Mixins`, and `Focus Ring Mixins`.\n\nGlobal Mixins\n\nLayout & Spacing Mixins\n\nFocus Ring Mixins\n\n`1\n\n$base: 16px !default; \n\n2\n\n \n3\n\n@function rem($size) { \n\n4\n\n $rem: math.div($size, $base); \n\n5\n\n \n6\n\n @return #{$rem}rem; \n\n7\n\n} \n\n8\n\n \n9\n\n@mixin truncate-title($max-lines: var(--fs-text-max-lines)) { \n\n10\n\n display: -webkit-box; \n\n11\n\n overflow: hidden; \n\n12\n\n -webkit-box-orient: vertical; \n\n13\n\n -moz-box-orient: vertical; \n\n14\n\n -webkit-line-clamp: $max-lines; \n\n15\n\n line-clamp: $max-lines; \n\n16\n\n text-overflow: -o-ellipsis-lastline; \n\n17\n\n text-overflow: ellipsis; \n\n18\n\n white-space: normal; \n\n19\n\n} \n\n`\n\n### Customizing Mixins\n\nOverriding the predefined mixins follows a process similar to the [customizing breakpoints steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints%23customizing-breakpoints). If you already have a `custom-mixin.scss` file, you can skip to _Step 3_. Otherwise, follow the steps below:\n\n1. Go to the `src` folder and create the `styles` folder inside it. You can run the following command to create it:\n\nmacOS and Linux\n\nWindows\n\n`1\n\nmkdir src/styles \n\n`\n\n1. Inside the `styles` folder, create a new file called `custom-mixins.scss`\n\nmacOS and Linux\n\nWindows\n\n`1\n\ntouch src/styles/custom-mixins.scss \n\n`\n\n1. Choose the [mixin](#mixins) you want to override and add it to the file:\n\nsrc/styles/custom-mixins.scss\n\n`1\n\n@import \"@faststore/ui/src/styles/base/utilities\"; \n\n2\n\n \n3\n\n// Overwrites Breakpoints & Mixins //////////////////// \n\n4\n\n \n5\n\n@mixin input-focus-ring($outline: #{var(--fs-color-focus-ring-danger)}, $border: #{--fs-color-danger-border}) { \n\n6\n\n [...] \n\n7\n\n} \n\n`\n\nThis code will make the following changes on the default `@mixin input-focus-ring`:\n\n`1\n\n- @mixin input-focus-ring($outline: #{var(--fs-color-focus-ring)}, $border: #{var(--fs-border-color-active)}) { \n\n2\n\n+ @mixin input-focus-ring($outline: #{var(--fs-color-focus-ring-danger)}, $border: #{var(--fs-color-danger-border)}) { \n\n3\n\n [...] \n\n4\n\n} \n\n`\n\n1. Run `yarn dev` to start the development server.\n\nYou should see that all components that use the `focus-ring` now have a red shadow when focused. Click on the input to see the change.\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/using-themes/mixins-breakpoints.mdx)\n\n[Using themes« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-overview)[Styling a componentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-components)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Breakpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-mixins-breakpoints%23breakpoints)\n\n[Customizing Breakpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-mixins-breakpoints%23customizing-breakpoints)\n\n[Mixins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-mixins-breakpoints%23mixins)\n\n[Customizing Mixins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-mixins-breakpoints%23customizing-mixins)\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/using-themes/mixins-breakpoints.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Breakpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-mixins-breakpoints%23breakpoints)\n\n[Customizing Breakpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-mixins-breakpoints%23customizing-breakpoints)\n\n[Mixins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-mixins-breakpoints%23mixins)\n\n[Customizing Mixins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-mixins-breakpoints/docs/guides/faststore/using-themes-mixins-breakpoints%23customizing-mixins)\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_4a87bacf
|
[
{
"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 product 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/product-specifications/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-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/product-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/product-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/product-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/product-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/product-specifications/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-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/product-specifications/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-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/product-specifications/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-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/product-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/product-specifications/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-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/product-specifications/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-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/product-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/product-specifications/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-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/product-specifications/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-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/product-specifications/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-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/product-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/product-specifications/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-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/product-specifications/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-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/product-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/product-specifications/docs/guides)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/catalog-integration)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/product-specifications)\n\nProduct specifications\n\nLearn more with this [article about specifications](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2NQoBv8m4Yz3oQaLgDRagP?%26utm%5Fsource=autocomplete%23).\n\n> If you wish to implement color variation in your products, we recommend you do not use 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## Data Model\n\n| Field | Description | Required | Format | Default |\n| ------------ | ----------------------------------------------------------------------- | ---------------------------------------------------------------- | ------- | ------------- |\n| Id | ID of Specification. This Id is used to delete/update the specification | No | Integer | AutoIncrement |\n| ProductId | ID of Product | Yes | Integer | \\- |\n| FieldId | Field ID | Yes | Integer | \\- |\n| FieldValueId | ID of FieldValue. ONLY for FieldTypeId(5,6,7). | Mandatory for 5,6,7\\. MUST NOT be used for any other field types | Integer | null |\n| Text | Value of specification. Only for FieldTypeId different from (5,6,7) | Mandatory for all fields EXCEPT 5,6,7 where it MUSTN’T be used | String | null |\n\n## Implementation\n\nTo create a product specification, use the API below. Remembering that you must have saved the ID of the field for which you want to create a specification.\n\n> If the specification field is of the Combo, Radio or Checkbox type (`FieldTypeId` of 5, 6 and 7 respectively), the `FieldValueId` field is required and the `Text` field is not.\\\\n- For text type fields, it is not necessary to create values for the field, that is, the `FieldValueId` attribute must be `null` and the `Text` attribute must be provided with the specification value.\n\n### Create Specification - Example #1 (text field)\n\nPOST\n\n`1\n\nhttps://{{accountName}}.vtexcommercestable.com.br/api/catalog/pvt/product/{{productId}}/specification \n\n`\n\nBody:\n\n`1\n\n{ \n\n2\n\n \"FieldId\": 21, \n\n3\n\n \"Text\": \"This is a test for specification field type text\", \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\": 39, \n\n3\n\n \"ProductId\": 42, \n\n4\n\n \"FieldId\": 21, \n\n5\n\n \"FieldValueId\": null, \n\n6\n\n \"Text\": \"This is a test for specification field type text\" \n\n7\n\n} \n\n`\n\n### Create Specification - Example #2 (Non-text field)\n\nPOST\n\n`1\n\nhttps://{{accountName}}.vtexcommercestable.com.br/api/catalog/pvt/product/{{productId}}/specification \n\n`\n\nBody:\n\n`1\n\n{ \n\n2\n\n \"FieldId\": 22, \n\n3\n\n \"FieldValueId\": 65, \n\n4\n\n} \n\n`\n\nHeaders:\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\": 38, \n\n3\n\n \"ProductId\": 42, \n\n4\n\n \"FieldId\": 22, \n\n5\n\n \"FieldValueId\": 65, \n\n6\n\n \"Text\": \"Metal\" \n\n7\n\n} \n\n`\n\n### Get all specifications from a product\n\nTo get all specification fields and values from a product, use the [Get product specification and its information by product ID endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/product/-productId-/specification). See an example response below.\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"Id\": 38, \n\n4\n\n \"ProductId\": 42, \n\n5\n\n \"FieldId\": 22, \n\n6\n\n \"FieldValueId\": 65, \n\n7\n\n \"Text\": \"Metal\" \n\n8\n\n }, \n\n9\n\n { \n\n10\n\n \"Id\": 39, \n\n11\n\n \"ProductId\": 42, \n\n12\n\n \"FieldId\": 21, \n\n13\n\n \"FieldValueId\": null, \n\n14\n\n \"Text\": \"This is a test for specification field type text\" \n\n15\n\n } \n\n16\n\n] \n\n`\n\n### Update product specification\n\nTo update a product specification use the [Update a product specification by product ID API endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog%5Fsystem/pvt/products/-productId-/specification). It's also possible to update specification values in bulk.\n\n> Updating product specification by `fieldName` does not work.\n\n#### Example request\n\nBody:\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"value\": [ \n\n4\n\n \"Metal\" \n\n5\n\n ], \n\n6\n\n \"Id\": 22 \n\n7\n\n }, \n\n8\n\n { \n\n9\n\n \"value\": [ \n\n10\n\n \"This is the second test for specification field type text\" \n\n11\n\n ], \n\n12\n\n \"Id\": 21 \n\n13\n\n } \n\n14\n\n] \n\n`\n\nResponse:\n\n`1\n\nStatus: 200 OK \n\n`\n\n### Remove product specifications\n\nTo remove a specification from a product, use the [Delete product specification API endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/product/-productId-/specification/-specificationId-).\n\n### Remove all specifications from a product\n\nTo delete all specifications registered in a product, use the [Delete all product specification API endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/product/-productId-/specification).\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/catalog-integration/product-specifications.md)\n\n[Specifications« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications//docs/guides/specifications)[SKU specificationsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications//docs/guides/sku-specifications)\n\nContributors\n\n2\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/product-specifications/docs/guides/product-specifications%23data-model)\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/product-specifications%23implementation)\n\n[Create Specification - Example #1 (text field)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/product-specifications%23create-specification-example-1-text-field)[Create Specification - Example #2 (Non-text field)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/product-specifications%23create-specification-example-2-non-text-field)[Get all specifications from a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/product-specifications%23get-all-specifications-from-a-product)[Update product specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/product-specifications%23update-product-specification)[Remove product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/product-specifications%23remove-product-specifications)[Remove all specifications from a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/product-specifications%23remove-all-specifications-from-a-product)\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/product-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/product-specifications/docs/guides/product-specifications%23data-model)\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/product-specifications%23implementation)\n\n[Create Specification - Example #1 (text field)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/product-specifications%23create-specification-example-1-text-field)[Create Specification - Example #2 (Non-text field)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/product-specifications%23create-specification-example-2-non-text-field)[Get all specifications from a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/product-specifications%23get-all-specifications-from-a-product)[Update product specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/product-specifications%23update-product-specification)[Remove product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/product-specifications%23remove-product-specifications)[Remove all specifications from a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications/docs/guides/product-specifications%23remove-all-specifications-from-a-product)\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_3fc3724a
|
[
{
"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 store components productimages 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-store-components-productimages/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/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-store-components-productimages/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-store-components-productimages/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-store-components-productimages/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-store-components-productimages/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-store-components-productimages/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/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/vtex-store-components-productimages/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/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/vtex-store-components-productimages/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/vtex-store-components-productimages/docs/vtex-io-apps)\n\nProduct Images\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-images` block renders an image or video configured in the SKU settings. To learn which media formats are supported, see the [Media](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/media-overview--31fhjHTt4TBoo50AmGQ9b2) section in the [Adding or editing SKUs](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/adding-or-editing-skus--4ryZ6J45kwn3jDiQBxGiiN) guide.\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 `product-images` 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-images\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n1. Declare the `product-images` block using the props stated in the [Props](#props) table. Example:\n\n`1\n\n \"product-images\": { \n\n2\n\n \"props\": { \n\n3\n\n \"displayThumbnailsArrows\": true \n\n4\n\n } \n\n5\n\n }, \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| ----------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |\n| aspectRatio | string | Sets the image aspect ratio, determining whether it should be square, portrait, landscape, etc. Follow the [common aspect ratio notation](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/Aspect%5Fratio%5F%28image%29), represented by two numbers separated by a colon, such as 1:1 for square, 3:4 for portrait, or 1920:1080 for widescreen. | \"auto\" |\n| blockClass | string | Serves as the block's unique identifier for customization. | |\n| contentOrder | 'videos-first' \\| 'images-first' | Controls the order in which the images and videos are displayed. | 'images-first' |\n| contentType | enum | Controls the type of content that will be displayed in the block. Possible values are images, videos, or all. | all |\n| displayMode | enum | Defines how the product media should be displayed. Possible values are carousel (displays the product images and videos in a carousel), list (displays only the product images inline, with no extra markup), and first-image (displays only the first image available). **The list and first-image values don't display product videos and are only compatible with the maxHeight, hiddenImages, zoomFactor, aspectRatio,ModalZoomElement, and zoomMode props**. | carousel |\n| displayThumbnailsArrows | boolean | Displays navigation arrows on the thumbnail media (if there are enough thumbnails for them to scroll). | false |\n| hiddenImages | string | Hides images with labels that match the values listed in this prop. Intended to be used with the product-summary-sku-selector block. To learn more, see the [SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/skuselector) documentation. | skuvariation |\n| maxHeight | number | Maximum height for individual product images (in pixels). | 600 |\n| ModalZoom | block | Opens a modal to zoom in on the product image. This prop value must match the name of the block that triggers the modal containing the product image for zooming (for example, modal-layout from [Modal layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/apps/vtex.modal-layout) app). The ModalZoom prop will only work if the zoomMode prop is set as open-modal. To learn more, see the [Advanced configuration section](#Advanced-configuration). | undefined |\n| placeholder | string | Sets the URL for a placeholder image to be displayed when no product image or video is available. | undefined |\n| position | enum | Sets the position of the thumbnails (left or right). Only used when thumbnailsOrientation is vertical. | left |\n| showNavigationArrows | boolean | Defines if the navigation arrows should be displayed. | true |\n| showPaginationDots | boolean | Defines if the pagination dots should be displayed. | |\n| showImageLabel | boolean | Controls if the image label text should be rendered above each image. | true |\n| thumbnailVisibility | visible or hidden | Defines if the thumbnails should be displayed in carousel displayMode. | visible |\n| thumbnailAspectRatio | string | Sets the aspect ratio of the thumbnail image. For more information about aspect ratio, check out the aspectRatio prop. | \"auto\" |\n| thumbnailMaxHeight | number | Maximum height of the thumbnail image (in pixels). | 150 |\n| thumbnailsOrientation | enum | Sets the orientation of the thumbnails. It can be vertical or horizontal. | vertical |\n| zoomFactor | number | Sets how much the zoom increases the image size (for example, 2 will make the zoomed-in image twice as large). | 2 |\n| zoomMode | enum | Sets the image zoom behavior. Possible values are disabled (zoom is disabled), in-place-click (zoom is triggered when the image is clicked), in-place-hover (zoom is triggered when the image is hovered on), and open-modal (image is zoomed using a modal). | in-place-click |\n\n### Advanced configuration\n\nIn this section, you’ll learn how to use modal zoom, a property that allows you to open a popup displaying a product image for zooming. To use this feature, configure the `product-images` block by setting the `zoomMode` and `ModalZoom` props to `open-modal` and `modal-layout`, respectively.\n\nWhen configured as explained, the `zoomMode` prop allows the image to trigger a modal for zooming. Additionally, the `MozalZoom` prop will render the block defined as its value. In this case, the `modal-layout` is required. This allows you to configure a modal containing the product image for zooming.\n\nOnce both props are correctly configured, you must declare the `modal-layout` block and the `product-images.high-quality-image` block as its child.\n\nThe `modal-layout` block renders the modal component and triggers the image zoom in a popup box. The `product-images.high-quality-image` block, in turn, is a _special_ block used exclusively to render the `product-image` block inside the modal.\n\nExample:\n\n`1\n\n{ \n\n2\n\n \"product-images.high-quality-image\": { \n\n3\n\n \"props\": { \n\n4\n\n \"zoomMode\": \"in-place-click\", \n\n5\n\n \"zoomFactor\": 2 \n\n6\n\n } \n\n7\n\n }, \n\n8\n\n \"modal-layout#product-zoom\": { \n\n9\n\n \"children\": [ \n\n10\n\n // you can put any other block inside the modal, \n\n11\n\n // this is just a normal modal \n\n12\n\n \"flex-layout.row#product-name\", \n\n13\n\n \"product-images.high-quality-image\" \n\n14\n\n ] \n\n15\n\n }, \n\n16\n\n \"product-images\": { \n\n17\n\n \"props\": { \n\n18\n\n \"ModalZoom\": \"modal-layout#product-zoom\", \n\n19\n\n // to use the ModalZoom, the product-images zoomMode value must be set as open-modal \n\n20\n\n \"zoomMode\": \"open-modal\", \n\n21\n\n \"aspectRatio\": { \n\n22\n\n \"desktop\": \"auto\", \n\n23\n\n \"phone\": \"16:9\" \n\n24\n\n } \n\n25\n\n } \n\n26\n\n } \n\n27\n\n} \n\n`\n\nThe `product-images.high-quality-image` block must be declared as a child of `modal-layout`. You can also declare other blocks exported by the [Modal Layout app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout) as children.\n\nThe following table shows the props allowed by `product-images.high-quality-image`:\n\n| Prop name | Type | Description | Default value |\n| ----------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| aspectRatio | string | Sets the image aspect ratio, determining whether it should be square, portrait, landscape, etc. Follow the [common aspect ratio notation](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/Aspect%5Fratio%5F%28image%29), represented by two numbers separated by a colon, such as 1:1 for square, 3:4 for portrait, or 1920:1080 for widescreen. | auto |\n| defaultSize | number | Image default size (in px). | 1200 |\n| imageSizes | \\[number\\] | Image sizes (in px) to be used in the image [srcset HTML attribute](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia%5Fand%5Fembedding/Responsive%5Fimages). If no value is defined for this prop, the srcset will use the original image size. | undefined |\n| maxSize | number | Image maximum size (in px) for rendering, regardless of screen size. This prop only works if you also declare the imageSizes prop. | 4096 |\n| zoomFactor | number | Sets how much the zoom increases the image size (for example, 2 will make the zoomed-in image twice as large). | 2 |\n| zoomMode | enum | Sets the zoom behavior for the product-images.high-quality-image block. Possible values are disabled (no zoom), in-place-click (zoom on click), and in-place-hover (zoom on hover). Unlike the store-images prop, this one doesn’t accept the open-modal value. | disabled |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, 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\n| CSS Handles |\n| ---------------------------------------------- |\n| carouselContainer |\n| carouselCursorDefault |\n| carouselGaleryCursor |\n| carouselGaleryThumbs |\n| carouselIconCaretLeft |\n| carouselIconCaretRight |\n| carouselImagePlaceholder |\n| carouselInconCaretRight |\n| carouselThumbBorder |\n| figure |\n| figure--video |\n| highQualityContainer |\n| image |\n| imgZoom |\n| productImagesContainer (content is deprecated) |\n| productImagesContainer--carousel |\n| productImagesContainer--list |\n| productImagesGallerySlide |\n| productImagesGallerySwiperContainer |\n| productImagesThumb |\n| productImagesThumbActive |\n| productImagesThumbCaret |\n| productImagesThumbsSwiperContainer |\n| productImageTag--main |\n| productImageTag--zoon |\n| productImageTag |\n| productImageLabel |\n| productVideo |\n| swiper-pagination |\n| swiperBullet--active |\n| swiperBullet |\n| swiperCaret |\n| swiperCaretNext |\n| swiperCaretPrev |\n| thumbImg |\n| thumbImg--video |\n| video |\n| video |\n| videoContainer |\n\nSee also\n\n[Vtex.store ComponentsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/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/guides/vtex-store-components-productimages/docs/apps/vtex.store-components/ProductImages%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/apps/vtex.store-components/ProductImages%23props)[Advanced configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/apps/vtex.store-components/ProductImages%23advanced-configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productimages/docs/apps/vtex.store-components/ProductImages%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_326a0aa1
|
[
{
"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 5 integrating with 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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-the-headless-cms/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-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-5-integrating-with-the-headless-cms/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-with-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-5-integrating-with-the-headless-cms/docs/guides/faststore/getting-started-overview)\n\n5\\. Integrating your project with the Headless CMS\n\nConnect your FastStore project with the Headless CMS to manage and publish your store’s content efficiently.\n\nIn this step, you'll connect your FastStore project to [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview) so editors can create, preview, and publish content. You'll also configure the webhooks that keep builds and previews in sync—without this integration, CMS changes won't reach your storefront.\n\n## What you'll accomplish\n\nBy the end of this step, you will have:\n\n* Configured Headless CMS webhooks to trigger builds when content is published\n* Set up preview URLs for content editors to see changes before going live\n* Configured WebOps to communicate CMS updates back to your Git repository\n* Established a complete content workflow where CMS changes automatically sync with your codebase\n\nThis integration enables your content team to manage store content independently while keeping everything in sync with your development workflow.\n\n## Step 1: Configuring the Headless CMS\n\nConfigure the URLs of the webhooks used by the Headless CMS app.\n\n1. In the VTEX Admin, access **Storefront > Headless CMS**.\n2. In the FastStore project interface, click on `Settings` (⚙️).\n3. In **Settings**, click the `Build` tab.\n4. In **Build Webhook URL**, click `Add`.\n5. Enter the following value. _Replace the values between curly brackets according to your scenario._ \n`1 \nhttps://app.io.vtex.com/vtex.cms-builder-sf-jamstack/v1/{account}/master/build-releases \n`\n6. Click **SAVE**.\n\n> When an editor clicks to publish a page using the Headless CMS interface, the CMS calls the **Build Webhook URL**, which changes the page's status to `published`. The CMS then waits for the content to be built in the background.\n\n1. Fill in the **Preview URL** field with your production URL. This URL activates the button on the Headless CMS, allowing you to preview the changes made to a page. _Replace the values between curly brackets according to your scenario._\n\n## Step 2: Communicating WebOps updates to the Headless CMS\n\nIf you are developing your FastStore project with CI/CD and Headless CMS, you must ensure that CI/CD is aware of every CMS update performed via the VTEX Admin. To do so, you must configure the WebOps webhooks responsible for communicating with the Headless CMS as follows.\n\n1. Open your FastStore project in any code editor of your preference.\n2. Edit the `discovery.config.js` file in the root directory of your project.\n3. In the Headless CMS configuration, add the `webhookUrls` property corresponding to your store website as follows: \ndiscovery.config.js \n`1 \n\"vtexHeadlessCms\": { \n2 \n webhookUrls: [ \n3 \n \"https://{account}.myvtex.com/cms-releases/webhook-releases\" \n4 \n ] \n5 \n} \n`\n4. Open a Pull Request in your project, including the previous changes.\n5. Merge the Pull Request.\n\nNow you can make changes to the Headless CMS and check if commits are being created in the project. In the following example, the `Hero` title was modified to `10% off on first purchase`, and we can see that it generated a commit in the repository.\n\n\n\n## Next step\n\nNow that Headless CMS is integrated, set up content types and sections for your editors: [Setting up the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-2-setting-up-the-headless-cms)\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/faststore/docs/getting-started/5-integrating-your-project-with-the-headless-cms.mdx)\n\n[4\\. Understanding the project structure« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-with-the-headless-cms/docs/guides/faststore/getting-started-4-understanding-the-project-structure)[Setting up the Headless CMSNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-with-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms)\n\nSee also\n\n[VTEX IO CLIGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-with-the-headless-cms/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\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-5-integrating-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23what-youll-accomplish)\n\n[Step 1: Configuring the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23step-1-configuring-the-headless-cms)\n\n[Step 2: Communicating WebOps updates to the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23step-2-communicating-webops-updates-to-the-headless-cms)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-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/5-integrating-your-project-with-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-5-integrating-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23what-youll-accomplish)\n\n[Step 1: Configuring the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23step-1-configuring-the-headless-cms)\n\n[Step 2: Communicating WebOps updates to the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23step-2-communicating-webops-updates-to-the-headless-cms)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-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_32765c62
|
[
{
"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 migrating v1 to v2 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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/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-migrating-v1-to-v2/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/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-migrating-v1-to-v2/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/docs/guides/faststore/overrides-section-styles)\n\n[\\`getOverriddenSection\\` function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/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-migrating-v1-to-v2/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/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-migrating-v1-to-v2/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/docs/guides/faststore/overrides-section-styles)\n\n[\\`getOverriddenSection\\` function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/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-migrating-v1-to-v2/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/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-migrating-v1-to-v2/docs/guides/faststore/overrides-overview)\n\nUpgrading from Section Override v1 to v2\n\n[Section Override v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview) allows you to customize the appearance and functionality of existing components in your store. Compared to v1, v2 offers an adaptable approach.\n\n> We strongly recommend using [Section Override v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview) in favor of [Section Override v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1).\n\n## Main differences\n\n| Feature | Section Override v1 | Section Override v2 |\n| ---------------------------- | ------------------------------------------------------ | --------------------------------------------------------------------- |\n| Overrides per section | One override per section. | Multiple overrides per section. |\n| Importing Section | String passed to section key. | Section component imported and passed to Section key (uppercase S). |\n| Native section | The new component overrides the native one. | The new component is based on the native one and can coexist with it. |\n| Headless CMS property schema | No customization, limited to native schemas. | Customizable schema allowing definition of new properties. |\n| Feature availability | Experimental feature and may not function as expected. | Stable feature. |\n\nCheck out the main differences related to the code syntax:\n\n* In Section Override v1, a section is overridden by specifying the section name and component: \n`1 \nimport { SectionOverride } from \"@faststore/core\"; \n2 \n \n3 \nconst SECTION = \"Alert\" as const; \n4 \n \n5 \nconst override: SectionOverride = { \n6 \n section: SECTION, \n7 \n components: { \n8 \n Alert: { Component: CustomAlert }, \n9 \n }, \n10 \n}; \n11 \n \n12 \nexport { override }; \n`\n* Section Override v2 introduces a more component-centric approach. It directly references the section component (e.g., `AlertSection` from `@faststore/core`) using a dedicated function (`getOverriddenSection`) and builds the override object around it, emphasizing the component being overridden. This shift in v2 promotes clearer code and offers more control during the override creation process. \n`1 \nimport { AlertSection, getOverriddenSection } from \"@faststore/core\"; \n2 \n \n3 \nconst NewAlert = getOverriddenSection({ \n4 \nSection: AlertSection, \n5 \ncomponents: { \n6 \n Alert: { Component: CustomAlert }, \n7 \n}, \n8 \n}); \n9 \n \n10 \nexport default NewAlert; \n`\n\n## Updating your project to Section Override v2\n\nMake sure your store's `@faststore/core` package is version 3.0.0 or higher to work with Section Override v2\\. For update instructions, refer to the [release note](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/releases/tag/v3.0.0).\n\n### Identify existing overrides (v1)\n\nIdentify all overrides currently implemented using [Section Override v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overriding-components-and-props). Once identified, adjust your code to use [Section Override v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview).\n\n> We strongly recommend using Section Override v2 instead of Section Override v1.\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/migrating-v1-to-v2.mdx)\n\n[Syncing components with the Headless CMS« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms)[Overriding native components and props (v1)Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/overrides-components-and-props-v1)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Main differences](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/overrides-migrating-v1-to-v2%23main-differences)\n\n[Updating your project to Section Override v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/overrides-migrating-v1-to-v2%23updating-your-project-to-section-override-v2)\n\n[Identify existing overrides (v1)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/overrides-migrating-v1-to-v2%23identify-existing-overrides-v1)\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/migrating-v1-to-v2.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Main differences](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/overrides-migrating-v1-to-v2%23main-differences)\n\n[Updating your project to Section Override v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/overrides-migrating-v1-to-v2%23updating-your-project-to-section-override-v2)\n\n[Identify existing overrides (v1)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-migrating-v1-to-v2/docs/guides/faststore/overrides-migrating-v1-to-v2%23identify-existing-overrides-v1)\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_32a6c6d1
|
[
{
"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 smarthint 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.smarthint/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/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.smarthint/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.smarthint/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.smarthint/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.smarthint/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.smarthint/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/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.smarthint/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/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.smarthint/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.smarthint/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/guides/pixel-apps)\n\nsmarthint\n\nOfficial extension\n\nVersion: 1.0.0\n\nLatest version: 1.0.0\n\nVTEX SmartHint first-party app\n\n## How to install\n\nOpen the VTEX App Store and install this app on your store.\n\nNow, open the app settings on your admin and fill in the your SmartHint key.\n\n[Shareasale« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.shareasale)[SuiteshareNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.suite-share)\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[How to install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.smarthint/docs/apps/vtex.smarthint%23how-to-install)\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_5ddcb551
|
[
{
"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 tab 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.tab-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.tab-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.tab-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.tab-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.tab-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.tab-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.tab-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.tab-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-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.tab-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-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.tab-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.tab-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.tab-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.tab-layout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-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.tab-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-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.tab-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-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.tab-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.tab-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.tab-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.tab-layout/docs/vtex-io-apps)\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/guides/layout-apps)\n\nTab Layout\n\nOfficial extension\n\nVersion: 0.4.6\n\nLatest version: 0.4.6\n\n[](#contributors-)\n\nThe Tab Layout app provides you the needed structure to create different layouts within the store's main one from the use of _tabs_.\n\n|  |\n| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Example of a storefront with tabs (Perfumes até 40%off, Presentes, and Best Sellers) displaying different content for users. |\n\n## Configuration\n\n1. Add the Tab Layout app to your theme's dependencies in the `manifest.json` file:\n\n`1\n\n{ \n\n2\n\n \"dependencies\": { \n\n3\n\n \"vtex.tab-layout\": \"0.x\" \n\n4\n\n } \n\n5\n\n} \n\n`\n\nNow, you are able to use all the blocks exported by the `tab-layout` app. Check out the full list below:\n\n| Block name | Description |\n| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| tab-layout |  Parent block that merely defines the logic (via its children blocks) for the layout structure, declaring the desired list of tabs and its content. |\n| tab-list |  Defines the list of tabs to be rendered. It only accepts the tab-list.item block as a child. |\n| tab-list.item |  Defines the rendering for a given tab. Notice that it does not define the tab content, which is handled by the tab-content.item block. |\n| tab-list.item.children | Flexible alternative to tab-list.item. Defines the rendering for a given tab and also accepts any array of blocks as its children. |\n| tab-content |  Defines the list of content to be rendered in each tab. It only accepts the tab-content.item block as a child. |\n| tab-content.item |  Defines the content for a given tab. |\n\n1. In the desired page template (e.g., `store.home`), add the `tab-layout` block:\n\n`1\n\n{ \n\n2\n\n \"store.home\": { \n\n3\n\n \"blocks\": [ \n\n4\n\n \"tab-layout#home\" \n\n5\n\n ] \n\n6\n\n }, \n\n`\n\n1. Declare the `tab-list` and the `tab-content` blocks as `tab-layout`'s children. Do not forget to use the `tab-layout`'s props, for example:\n\n`1\n\n{ \n\n2\n\n \"store.home\": { \n\n3\n\n \"blocks\": [ \n\n4\n\n \"tab-layout#home\" \n\n5\n\n ] \n\n6\n\n }, \n\n7\n\n \"tab-layout#home\": { \n\n8\n\n \"children\": [ \n\n9\n\n \"tab-list#home\", \n\n10\n\n \"tab-content#home\" \n\n11\n\n ], \n\n12\n\n \"props\": { \n\n13\n\n \"blockClass\": \"home\", \n\n14\n\n \"defaultActiveTabId\": \"home1\" \n\n15\n\n } \n\n16\n\n } \n\n17\n\n} \n\n`\n\n1. Add and then declare the desired `tab-list.item` blocks as `tab-list`'s children:\n\n`1\n\n{ \n\n2\n\n \"store.home\": { \n\n3\n\n \"blocks\": [ \n\n4\n\n \"tab-layout#home\" \n\n5\n\n ] \n\n6\n\n }, \n\n7\n\n \"tab-layout#home\": { \n\n8\n\n \"children\": [ \n\n9\n\n \"tab-list#home\", \n\n10\n\n \"tab-content#home\" \n\n11\n\n ], \n\n12\n\n \"props\": { \n\n13\n\n \"blockClass\": \"home\", \n\n14\n\n \"defaultActiveTabId\": \"home1\" \n\n15\n\n } \n\n16\n\n }, \n\n17\n\n \"tab-list#home\": { \n\n18\n\n \"children\": [ \n\n19\n\n \"tab-list.item#home1\", \n\n20\n\n \"tab-list.item#home2\" \n\n21\n\n ] \n\n22\n\n }, \n\n23\n\n \"tab-list.item#home1\": { \n\n24\n\n \"props\": { \n\n25\n\n \"tabId\": \"home1\", \n\n26\n\n \"label\": \"Home 1\", \n\n27\n\n \"defaultActiveTab\": true \n\n28\n\n } \n\n29\n\n }, \n\n30\n\n \"tab-list.item#home2\": { \n\n31\n\n \"props\": { \n\n32\n\n \"tabId\": \"home2\", \n\n33\n\n \"label\": \"Home 2\" \n\n34\n\n } \n\n35\n\n } \n\n36\n\n} \n\n`\n\n1. Add and then declare the desired `tab-content.item` blocks as `tab-content`'s children:\n\n`1\n\n{ \n\n2\n\n \"store.home\": { \n\n3\n\n \"blocks\": [ \n\n4\n\n \"tab-layout#home\" \n\n5\n\n ] \n\n6\n\n }, \n\n7\n\n \"tab-layout#home\": { \n\n8\n\n \"children\": [ \n\n9\n\n \"tab-list#home\", \n\n10\n\n \"tab-content#home\" \n\n11\n\n ], \n\n12\n\n \"props\": { \n\n13\n\n \"blockClass\": \"home\", \n\n14\n\n \"defaultActiveTabId\": \"home1\" \n\n15\n\n } \n\n16\n\n }, \n\n17\n\n \"tab-list#home\": { \n\n18\n\n \"children\": [ \n\n19\n\n \"tab-list.item#home1\", \n\n20\n\n \"tab-list.item#home2\" \n\n21\n\n ] \n\n22\n\n }, \n\n23\n\n \"tab-list.item#home1\": { \n\n24\n\n \"props\": { \n\n25\n\n \"tabId\": \"home1\", \n\n26\n\n \"label\": \"Home 1\", \n\n27\n\n \"defaultActiveTab\": true \n\n28\n\n } \n\n29\n\n }, \n\n30\n\n \"tab-list.item#home2\": { \n\n31\n\n \"props\": { \n\n32\n\n \"tabId\": \"home2\", \n\n33\n\n \"label\": \"Home 2\" \n\n34\n\n } \n\n35\n\n }, \n\n36\n\n \"tab-content#home\": { \n\n37\n\n \"children\": [ \n\n38\n\n \"tab-content.item#home1\", \n\n39\n\n \"tab-content.item#home2\" \n\n40\n\n ] \n\n41\n\n }, \n\n42\n\n \"tab-content.item#home1\": { \n\n43\n\n \"children\": [ \n\n44\n\n \"carousel#home\" \n\n45\n\n ], \n\n46\n\n \"props\": { \n\n47\n\n \"tabId\": \"home1\" \n\n48\n\n } \n\n49\n\n }, \n\n50\n\n \"tab-content.item#home2\": { \n\n51\n\n \"children\": [ \n\n52\n\n \"shelf#home\", \n\n53\n\n \"info-card#home\", \n\n54\n\n \"rich-text#question\", \n\n55\n\n \"rich-text#link\", \n\n56\n\n \"newsletter\" \n\n57\n\n ], \n\n58\n\n \"props\": { \n\n59\n\n \"tabId\": \"home2\" \n\n60\n\n } \n\n61\n\n } \n\n62\n\n} \n\n`\n\n> Make sure to declare the `tab-content.item`'s children blocks in order to properly render the tab content.\n\n### `tab-layout` props\n\n| Prop name | Type | Description | Default value |\n| ------------------ | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| defaultActiveTabId | string | ID of the desired tab to be rendered as the default one. If no value is provided, the first tab declared in the theme will be used as default. | undefined |\n| blockClass | string | Block ID of your choosing to be used in [CSS customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization). | undefined |\n\n### `tab-list` props\n\n| Prop name | Type | Description | Default value |\n| ---------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| blockClass | string | Block ID of your choosing to be used in [CSS customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization). | undefined |\n\n### `tab-list.item` props\n\n| Prop name | Type | Description | Default value |\n| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| blockClass | string | Block ID of your choosing to be used in [CSS customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization). | undefined |\n| tabId | string | Tab ID of your choosing. It will be used to match the tab to its content (defined by the tab-content.item block). | undefined |\n| label | string | Defines the tab's text label. | undefined |\n| defaultActiveTab | boolean | Defines the item as the default active tab. | false |\n\n### `tab-list.item.children` props\n\n| Prop name | Type | Description | Default value |\n| ---------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| blockClass | string | Block ID of your choosing to be used in [CSS customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization). | undefined |\n| tabId | string | Tab ID of your choosing. It will be used to match the tab to a given content (defined by the tab-content.item block). | undefined |\n\n### `tab-content` props\n\n| Prop name | Type | Description | Default value |\n| ---------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| blockClass | string | Block ID of your choosing to be used in [CSS customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization). | undefined |\n\n### `tab-content.item` props\n\n| Prop name | Type | Description | Default value |\n| ---------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| blockClass | string | Block ID of your choosing to be used in [CSS customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization). | undefined |\n| tabId | string | Tab ID of your choosing. It will be used to match the content to a given tab (defined by the tab-list.item / tab-list.item.children blocks). | undefined |\n\n> Be mindful of the `tabID` specified in both `tab-list.item` and `tab-content.item` blocks, as this parameter couples a tab and its corresponding content.\n\n## 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://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS Handle |\n| ---------------------- |\n| container |\n| contentContainer |\n| contentItem |\n| listContainer |\n| listItem |\n| listItemActive |\n| listItemChildren |\n| listItemChildrenActive |\n\n[Sticky Layout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.sticky-layout)[Pixel AppsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/guides/pixel-apps)\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.tab-layout/docs/apps/vtex.tab-layout%23configuration)\n\n[tab-layout props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.tab-layout%23tab-layout-props)[tab-list props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.tab-layout%23tab-list-props)[tab-list.item props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.tab-layout%23tab-listitem-props)[tab-list.item.children props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.tab-layout%23tab-listitemchildren-props)[tab-content props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.tab-layout%23tab-content-props)[tab-content.item props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.tab-layout%23tab-contentitem-props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.tab-layout/docs/apps/vtex.tab-layout%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_7e020af3
|
[
{
"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 productsummarydescription 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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/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.product-summary/productsummarydescription/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/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.product-summary/productsummarydescription/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.product-summary/productsummarydescription/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/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/productsummarydescription/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/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.product-summary/productsummarydescription/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/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.product-summary/productsummarydescription/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.product-summary/productsummarydescription/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/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/productsummarydescription/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/guides/basic-components)\n\nProduct Summary Description\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\nProduct Summary Description is a block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-summary) responsible for rendering the description of the product.\n\n\n\n## Configuration\n\n1. Import the `vtex.product-summary` app to your theme's dependencies in the `manifest.json`:\n\n`1\n\n dependencies: { \n\n2\n\n \"vtex.product-summary\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-summary-description` block to your store theme as a child of `product-summary.shelf`. For example:\n\n`1\n\n \"product-summary.shelf\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"product-summary-image\", \n\n4\n\n \"product-summary-name\", \n\n5\n\n+ \"product-summary-description\", \n\n6\n\n \"product-summary-attachment-list\", \n\n7\n\n \"product-summary-space\", \n\n8\n\n \"product-summary-column#1\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\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| description |\n\n[Product Summary Buy Button« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-summary/productsummarybuybutton)[Product Summary ImageNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-summary/productsummaryimage)\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/productsummarydescription/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[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-summary/productsummarydescription%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarydescription/docs/apps/vtex.product-summary/productsummarydescription%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_2753b56c
|
[
{
"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 ProductSummaryShelf 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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/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/ProductSummaryShelf/docs/vtex-io-apps)\n\nProduct Summary Shelf\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 Shelf is the main block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary). It includes the child blocks required to display the Product Summary component in your store.\n\n\n\n) \n\n## Configuration\n\n1. Import the `vtex.product-summary` app to your theme dependencies in the `manifest.json` file:\n\n`1\n\n dependencies: { \n\n2\n\n \"vtex.product-summary\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-summary.shelf` block as a child of the [list-context.product-list block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarylist%23product-list-block):\n\n`1\n\n \"list-context.product-list\": { \n\n2\n\n+ \"blocks\": [\"product-summary.shelf\"] \n\n3\n\n }, \n\n`\n\n1. Declare the `product-summary.shelf` block, passing the desired blocks exported by the Product Summary app to build your Product Summary component. For example:\n\n`1\n\n{ \n\n2\n\n+ \"product-summary.shelf\": { \n\n3\n\n+ \"children\": [ \n\n4\n\n+ \"product-summary-image\", \n\n5\n\n+ \"product-summary-name\", \n\n6\n\n+ \"product-rating-inline\", \n\n7\n\n+ \"product-summary-space\", \n\n8\n\n+ \"product-summary-price\", \n\n9\n\n+ \"product-summary-buy-button\" \n\n10\n\n+ ] \n\n11\n\n+ } \n\n12\n\n} \n\n`\n\n> Remember to define the other Product Summary blocks in your theme, otherwise the component will not be displayed.\n\n| Prop name | Type | Description | Default value |\n| ---------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |\n| priceBehavior | enum | Determines whether the component should fetch the most up-to-date price (async) or (default). Remember to configure the [Search Result](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/content-blocks/vtex.search-result@3.79.1/%23configuration)'s simulationBehavior prop to skip and use the Product Price [product-price-suspense](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/product-price/blob/master/docs/README.md) block to render a loading spinner while the price information is being fetched. | default |\n| trackListName | boolean | Determines whether the component should send the list name to the product page when the product summary is clicked. Disabling it will prevent the productDetail GTM event sent on the PDP to identify from which list the user navigated. | true |\n| sponsoredBadgeLabel | String | The text of the \"Sponsored\" tag, if applicable. | \"store/sponsored-badge.label\" |\n| sponsoredBadgePosition | enum | The position of the \"Sponsored\" tag, if applicable. Possible values are titleTop, containerTopLeft and none. | \"containerTopLeft\" |\n\n## Customization\n\nThe Product Summary Shelf merely establishes the block structure to render the Product Summary component. Therefore, this block does not have CSS Handles for its specific customization.\n\nInstead, you should use its child block Handles.\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/ProductSummaryShelf/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[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryShelf/docs/apps/vtex.product-summary@2.91.0/ProductSummaryShelf%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryShelf/docs/apps/vtex.product-summary@2.91.0/ProductSummaryShelf%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_ef14065f
|
[
{
"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 set a discount using the checkout 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/set-a-discount-using-the-checkout-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-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/set-a-discount-using-the-checkout-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/set-a-discount-using-the-checkout-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/set-a-discount-using-the-checkout-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/set-a-discount-using-the-checkout-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/set-a-discount-using-the-checkout-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/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/set-a-discount-using-the-checkout-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/discounts)\n\n[Set a discount using the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/set-a-discount-using-the-checkout-api)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/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/set-a-discount-using-the-checkout-api/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/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/set-a-discount-using-the-checkout-api/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-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/set-a-discount-using-the-checkout-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-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/set-a-discount-using-the-checkout-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/set-a-discount-using-the-checkout-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/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/set-a-discount-using-the-checkout-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/discounts)\n\n[Set a discount using the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/set-a-discount-using-the-checkout-api)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/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/set-a-discount-using-the-checkout-api/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/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/set-a-discount-using-the-checkout-api/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-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/set-a-discount-using-the-checkout-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-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/set-a-discount-using-the-checkout-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/set-a-discount-using-the-checkout-api/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/checkout-api-overview)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/discounts)\n\n[Set a discount using the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api/docs/guides/set-a-discount-using-the-checkout-api)\n\nSet a discount using the Checkout API\n\nOne of the most used customer attraction strategies in ecommerce is applying a discount to the cash price when choosing a specific payment method. Commonly, the discount price is visible only at the checkout payment stage after the user has already chosen the payment method that grants the discount.\n\nThis Checkout configuration sets the discount price and links it to a payment method. To configure, follow the steps below:\n\n1. Use 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 to enter the desired payment method ID in the `paymentSystemToCheckFirstInstallment` property.\n2. To get the payment method ID, access Settings in the **Payments** module. The ID of the condition you want to use is on the right side of the screen in the **Payments Settings > Payments Conditions** section.\n\n\n\n1. After updating `paymentSystemToCheckFirstInstallment`, you can [Simulate a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart). Thus, you will be able to verify that the chosen payment method has been updated with the discount in the cash payment option in the `installmentOptions` section, within `paymentData`.\n\n`1\n\n\"paymentData\":{ \n\n2\n\n \"installmentOptions\":[ \n\n3\n\n { \n\n4\n\n \"paymentSystem\":\"6\", \n\n5\n\n \"paymentName\":\"Boleto Bancário\", \n\n6\n\n \"paymentGroupName\":\"bankInvoicePaymentGroup\", \n\n7\n\n \"value\":10000, \n\n8\n\n \"installments\":[ \n\n9\n\n { \n\n10\n\n \"count\":1, \n\n11\n\n \"hasInterestRate\":false, \n\n12\n\n \"interestRate\":0, \n\n13\n\n \"value\":9000, \n\n14\n\n \"total\":9000, \n\n15\n\n } \n\n16\n\n ] \n\n17\n\n } \n\n18\n\n ] \n\n19\n\n} \n\n`\n\nFor more information, check [Configuring a discount for orders prepaid in full](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configurar-desconto-de-preco-a-vista--7Lfcj9Wb5dpYfA2gKkACIt).\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/discounts/set-a-discount-using-the-checkout-api.md)\n\n[Discounts« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api//docs/guides/discounts)[FeaturesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api//docs/guides/features)\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\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/Checkout/discounts/set-a-discount-using-the-checkout-api.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_e3b50068
|
[
{
"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 storefront permissions 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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-api/docs/api-reference/storefront-permissions-api/)\n\nStorefront Permissions\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/storefront-permissions-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/storefront-permissions-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/storefront-permissions-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/storefront-permissions-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/storefront-permissions-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-api/docs/api-reference/storefront-permissions-api/)\n\nStorefront Permissions\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-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/storefront-permissions-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PuInstall or renew SSL certificate« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/storefront-permissions-api/docs/api-reference/ssl-certificates-api%23put-/api/edge/certificates)[PoAssign storefront roles or create user with storefront rolesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/storefront-permissions-api/docs/api-reference/storefront-permissions-api%23post-/api/license-manager/storefront/users)\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_6719b372
|
[
{
"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 using weni run to execute tool tests 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/using-weni-run-to-execute-tool-tests/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/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/using-weni-run-to-execute-tool-tests/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/using-weni-run-to-execute-tool-tests/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/using-weni-run-to-execute-tool-tests/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/using-weni-run-to-execute-tool-tests/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/using-weni-run-to-execute-tool-tests/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/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/using-weni-run-to-execute-tool-tests/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/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/using-weni-run-to-execute-tool-tests/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/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/using-weni-run-to-execute-tool-tests/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\nWeni by VTEX CLI\n\n[Using the Weni by VTEX CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/using-the-weni-by-vtex-cli)\n\n[Weni by VTEX CLI Command Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/weni-by-vtex-cli-command-reference)\n\n[Authenticating with your Weni by VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/authenticating-with-your-weni-by-vtex-account)\n\n[Managing your Weni by VTEX projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/managing-your-weni-by-vtex-projects)\n\n[Understanding the core concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/weni-by-vtex-understanding-the-core-concepts)\n\n[Working with Weni by VTEX agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/working-with-weni-by-vtex-agents)\n\n[Fetching and filtering logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/weni-by-vtex-fetching-and-filtering-logs)\n\n[Using Weni Run to execute tool tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/using-weni-run-to-execute-tool-tests)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/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/using-weni-run-to-execute-tool-tests/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/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/using-weni-run-to-execute-tool-tests/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/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/using-weni-run-to-execute-tool-tests/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\nWeni by VTEX CLI\n\n[Using the Weni by VTEX CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/using-the-weni-by-vtex-cli)\n\n[Weni by VTEX CLI Command Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/weni-by-vtex-cli-command-reference)\n\n[Authenticating with your Weni by VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/authenticating-with-your-weni-by-vtex-account)\n\n[Managing your Weni by VTEX projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/managing-your-weni-by-vtex-projects)\n\n[Understanding the core concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/weni-by-vtex-understanding-the-core-concepts)\n\n[Working with Weni by VTEX agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/working-with-weni-by-vtex-agents)\n\n[Fetching and filtering logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/weni-by-vtex-fetching-and-filtering-logs)\n\n[Using Weni Run to execute tool tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/using-weni-run-to-execute-tool-tests)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides)\n\nWeni by VTEX\n\nWeni by VTEX CLI\n\n[Using Weni Run to execute tool tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/using-weni-run-to-execute-tool-tests)\n\nUsing Weni Run to execute tool tests\n\nLearn how to use the Tool Run feature.\n\nWeni Run is a scalable way to build your tool and test it in real-time. With this feature, it's simple to debug problems and create a tool that is both scalable and performant at the same time.\n\n### What is required to run a tool?\n\nFirst, you need to have your tool. If you don't know how to create a tool or still have questions about this subject, you can read the [Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/core-concepts%23tools) page.\n\nNext, you need to write your test. Let's take the following tool as an example:\n\n`1\n\ntools: \n\n2\n\n - get_address: \n\n3\n\n name: \"Get Address\" \n\n4\n\n source: \n\n5\n\n path: \"tools/get_address\" \n\n6\n\n entrypoint: \"main.GetAddressWithAuth\" \n\n7\n\n path_test: \"test_definition.yaml\" \n\n8\n\n description: \"Function to get the address from the postal code\" \n\n9\n\n parameters: \n\n10\n\n - cep: \n\n11\n\n description: \"postal code of a place\" \n\n12\n\n type: \"string\" \n\n13\n\n required: true \n\n14\n\n contact_field: true \n\n`\n\nNotice that my tool has a specific parameter called \"cep\". Therefore, the expected input for this tool to be processed is a postal code. This way, I'll create a test file for this tool in the same directory as the specific tool code.\n\nMy test file would look something like this:\n\n**test\\_definition.yaml:**\n\n`1\n\ntests: \n\n2\n\n test_1: \n\n3\n\n parameters: \n\n4\n\n cep: \"57160000\" \n\n5\n\n test_2: \n\n6\n\n parameters: \n\n7\n\n cep: \"57038-635\" \n\n8\n\n test_3: \n\n9\n\n parameters: \n\n10\n\n cep: \"57160-000\" \n\n`\n\nMake sure that `path_test` corresponds to the correct path of your tool test.\n\nIt's also important to note that if your tool uses any external libraries, you must include a `requirements.txt` file in the same directory as your tool code. This file should list all the dependencies needed for your tool to run properly.\n\n### How to run a test\n\nFollowing the previous steps, we can now run a test, but how?\n\nThe command works as follows:\n\n`1\n\nweni run [agent_definition_file] [agent_key] [tool_key] [-f FILE] [-v] \n\n`\n\nA practical example of the command considering the agent definition that was mentioned above would be:\n\n`1\n\nweni run agent_definition.yaml cep_agent get_address \n\n`\n\nResult:\n\n> An error occurred while loading the image https://github.com/vtexdocs/dev-portal-content/main/docs/guides/Weni-by-VTEX/CLI/assets/run-no-v.png\n\nThere is also a variation of this command in case you need to include ways to debug the code. You can add the `-v` argument at the end of the command to get more detailed logs of your tool, like this:\n\n`1\n\nweni run agent_definition.yaml cep_agent get_address -v \n\n`\n\n#### Choosing a test file\n\n* Use `-f/--file` to specify a test definition YAML located in the tool folder.\n* If `-f` is omitted, the CLI looks for `test_definition.yaml` in the tool's `source.path` directory.\n* You can also set `source.path_test` in your agent definition to point to a custom test file; when present, the CLI uses that path by default.\n\n#### Credentials and globals discovery\n\nFor development, the CLI will read optional files from the tool directory:\n\n* `.env` for credentials exposed to your tool via `context.credentials`\n* `.globals` for key/value pairs exposed via `context.globals`\n\nBoth files follow a simple `KEY=VALUE` per line format.\n\nResult:\n\n> An error occurred while loading the image https://github.com/vtexdocs/dev-portal-content/main/docs/guides/Weni-by-VTEX/CLI/assets/run-with-v.png\n\n### Running Tools That Require Credentials\n\nWhen your tool needs to interact with external services that require authentication, you'll need to provide credentials during testing. The official method for handling credentials with `weni run` is using your agent definition and a `.env` file.\n\n#### Using Agent Definition and .env File\n\nThis approach mimics how credentials work in production, making your local development environment consistent with deployment.\n\nFirst, update your agent definition to include credentials:\n\n`1\n\nagents: \n\n2\n\n cep_agent: \n\n3\n\n credentials: \n\n4\n\n api_key: \n\n5\n\n label: \"API Key\" \n\n6\n\n placeholder: \"Api Key\" \n\n7\n\n name: \"CEP Agent\" \n\n8\n\n description: \"Weni's CEP agent\" \n\n9\n\n instructions: \n\n10\n\n - \"You are an expert in providing addresses to the user based on a postal code provided by the user\" \n\n11\n\n - \"The user will send a ZIP code (postal code) and you must provide the address corresponding to this code.\" \n\n12\n\n guardrails: \n\n13\n\n - \"Don't talk about politics, religion or any other sensitive topic. Keep it neutral.\" \n\n14\n\n tools: \n\n15\n\n - get_address: \n\n16\n\n name: \"Get Address\" \n\n17\n\n source: \n\n18\n\n path: \"tools/get_address\" \n\n19\n\n entrypoint: \"main.GetAddressWithAuth\" \n\n20\n\n path_test: \"test_definition.yaml\" \n\n21\n\n description: \"Function to get the address from the postal code\" \n\n22\n\n parameters: \n\n23\n\n - cep: \n\n24\n\n description: \"postal code of a place\" \n\n25\n\n type: \"string\" \n\n26\n\n required: true \n\n27\n\n contact_field: true \n\n`\n\nThen, create a `.env` file inside the tool folder (e.g., `tools/get_address/.env`) with the actual credential values:\n\n`1\n\napi_key=your_actual_api_key_here \n\n`\n\nNow you can run your tool test with credentials using the same command:\n\n`1\n\nweni run agent_definition.yaml cep_agent get_address \n\n`\n\nThe CLI will automatically pick up the credentials from the tool folder `.env` file and make them available to your tool during execution.\n\n#### Accessing Credentials in Your Tool Code\n\nYour tool code should access credentials through the `Context` object as shown below:\n\n`1\n\nfrom weni import Tool \n\n2\n\nfrom weni.context import Context \n\n3\n\nfrom weni.responses import TextResponse \n\n4\n\nimport requests \n\n5\n\n \n6\n\nclass GetAddressWithAuth(Tool): \n\n7\n\n def execute(self, context: Context) -> TextResponse: \n\n8\n\n # Get parameters from context \n\n9\n\n cep = context.parameters.get(\"cep\", \"\") \n\n10\n\n \n11\n\n # Get credentials from context \n\n12\n\n api_key = context.credentials.get(\"api_key\") \n\n13\n\n \n14\n\n address_response = self.get_address_by_cep(cep=cep, api_key=api_key) \n\n15\n\n \n16\n\n return TextResponse(data=address_response) \n\n17\n\n \n18\n\n def get_address_by_cep(self, cep, api_key): \n\n19\n\n url = f\"https://viacep.com.br/ws/{cep}/json/\" \n\n20\n\n \n21\n\n headers = { \n\n22\n\n \"Authorization\": f\"Bearer {api_key}\" \n\n23\n\n } \n\n24\n\n \n25\n\n response = requests.get(url, headers=headers) \n\n26\n\n \n27\n\n return response.json() \n\n`\n\nThe key line is `api_key = context.credentials.get(\"api_key\")`, which retrieves the credential value that was defined in your agent definition and stored in your tool folder `.env` file.\n\n> **Important**: Never hardcode credentials in your tool code. Always access them through the Context object to ensure your code remains secure and works consistently across different environments.\n\nContributors\n\n1\n\n[](https://github.com/mariananantua)\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/Weni-by-VTEX/CLI/using-weni-run-to-execute-tool-tests.md)\n\n[Fetching and filtering logs« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests//docs/guides/weni-by-vtex-fetching-and-filtering-logs)\n\nContributors\n\n1\n\n[](https://github.com/mariananantua)\n\nON THIS PAGE\n\n[What is required to run a tool?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/using-weni-run-to-execute-tool-tests%23what-is-required-to-run-a-tool)\n\n[How to run a test](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/using-weni-run-to-execute-tool-tests%23how-to-run-a-test)[Running Tools That Require Credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/using-weni-run-to-execute-tool-tests%23running-tools-that-require-credentials)\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/Weni-by-VTEX/CLI/using-weni-run-to-execute-tool-tests.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[What is required to run a tool?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/using-weni-run-to-execute-tool-tests%23what-is-required-to-run-a-tool)\n\n[How to run a test](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/using-weni-run-to-execute-tool-tests%23how-to-run-a-test)[Running Tools That Require Credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-weni-run-to-execute-tool-tests/docs/guides/using-weni-run-to-execute-tool-tests%23running-tools-that-require-credentials)\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_ac9f391f
|
[
{
"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 1 getting started with the 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/services-1-getting-started-with-the-boilerplate/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-boilerplate/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-boilerplate/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-boilerplate/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-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/services-1-getting-started-with-the-boilerplate/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-boilerplate/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-boilerplate/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-boilerplate/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-boilerplate/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-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/services-1-getting-started-with-the-boilerplate/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-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/services-1-getting-started-with-the-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/services-1-getting-started-with-the-boilerplate/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/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-1-getting-started-with-the-boilerplate/docs/guides/services-1-getting-started-with-the-boilerplate)\n\nGetting started with the boilerplate\n\nThe first thing you need to do is clone the [service-course-template](https://read.calvincode.net/reader?url=https://github.com/vtex-trainings/service-course-template) boilerplate, which is a template repository that we provide with all the initial files that you need to get started in this course.\n\nFollow the step-by-step instructions to get started with the boilerplate and its dependencies.\n\n## Cloning the boilerplate repository\n\nClone the `service-course-template` boilerplate by running the command presented in the left. This will create a local copy of the project, equipping you with the necessary files to start the course.\n\n## Understanding the app structure\n\nOpen the [service-course-template](https://read.calvincode.net/reader?url=https://github.com/vtex-trainings/service-course-template) project in the code editor of your preference. You will notice the project contains three directories (`/docs`, `/node` and `/graphql`), 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, which is 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| dependencies | object | Lists other VTEX IO apps on which the app relies. For example, the app is dependent on the [events-example](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/events-example) app, which we will use in the following steps to trigger events. |\n\n### `/node` folder\n\nThe `/node` folder houses 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\nIn this project, our Node code is organized as in the following:\n\n| Folder or file | Description |\n| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| /node/clients | Holds placeholder files for implementing custom [VTEX IO clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients). |\n| /node/handlers | Contains handler functions and logic designed to handle specific tasks and events. |\n| /node/utils | Holds global constants declarations (/node/constants.ts) and other utility fuctions. |\n| /node/index.ts | Encompasses initial declarations for app functionality, such as cache and service declarations. This file will evolve throughout the course and also allow for the export of resolver function implementations for GraphQL. |\n| /node/service.json | Describes the behavior of the service and attributes that impact the app's infrastructure. |\n\nNote that most of the directories are empty and will be filled throughout this course.\n\n#### `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. |\n\n### `/graphql` folder\n\nThe `/graphql` folder, though currently empty, will be used to house GraphQL-related files in the project. The `/graphql/schema.graphql` file is a common convention for storing the GraphQL schema definition. In a GraphQL schema, you define the types, queries, mutations, and subscriptions that your GraphQL service supports. As our app evolves, we will populate this file with our GraphQL schema.\n\n`git clone https://github.com/vtex-trainings/service-course-template \n\n1\n\nroot \n\n2\n\n ┣ 📂 docs \n\n3\n\n ┣ 📂 node \n\n4\n\n ┣ 📂 graphql \n\n5\n\n ┣ 📄 README.md \n\n6\n\n ┣ 📄 manifest.json \n\n7\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/services/services-1-getting-started-with-the-boilerplate.mdx)\n\n[Developing services on VTEX IO« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate//docs/guides/developing-services-on-vtex-io)[2\\. Handling and receiving eventsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate//docs/guides/services-2-handling-and-receiving-events)\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/services-1-getting-started-with-the-boilerplate/docs/guides/services-1-getting-started-with-the-boilerplate%23cloning-the-boilerplate-repository)\n\n[Understanding the app structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/docs/guides/services-1-getting-started-with-the-boilerplate%23understanding-the-app-structure)\n\n[manifest.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/docs/guides/services-1-getting-started-with-the-boilerplate%23manifestjson-file)[/node folder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/docs/guides/services-1-getting-started-with-the-boilerplate%23node-folder)[/graphql folder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/docs/guides/services-1-getting-started-with-the-boilerplate%23graphql-folder)\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-1-getting-started-with-the-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/services-1-getting-started-with-the-boilerplate/docs/guides/services-1-getting-started-with-the-boilerplate%23cloning-the-boilerplate-repository)\n\n[Understanding the app structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/docs/guides/services-1-getting-started-with-the-boilerplate%23understanding-the-app-structure)\n\n[manifest.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/docs/guides/services-1-getting-started-with-the-boilerplate%23manifestjson-file)[/node folder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/docs/guides/services-1-getting-started-with-the-boilerplate%23node-folder)[/graphql folder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-1-getting-started-with-the-boilerplate/docs/guides/services-1-getting-started-with-the-boilerplate%23graphql-folder)\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_730fc5f9
|
[
{
"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 setting up white label seller as pickup point 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/setting-up-white-label-seller-as-pickup-point/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-shipping-network)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/multilevel-omnichannel-inventory)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-shipping-network)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/multilevel-omnichannel-inventory)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/docs/guides)\n\nLogistics\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point)\n\nSetting up white label seller as pickup point\n\nEvery [franchise account](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-franchise-account--kWQC6RkFSCUFGgY5gSjdl) created in VTEX is also automatically a [white label seller](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/white-label-seller--5orlGHyDHGAYciQ64oEgKa) of the main account. So any [pickup points](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) configured in the franchise account will be available options for shoppers who place orders in the main account.\n\n> Items will only be displayed for shoppers at Checkout with the pickup point option if the SKU is available in the [inventory](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/inventory-management--tutorials%5F139) of the main account and also in the inventory of the franchise account.\n\n## Initial setup\n\nTo set up a white label seller as a pickup point, you have to make the following configurations in the franchise account:\n\n* [Pickup point](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-pickup-points--2R5ClQiwe4KoSQgsuiOw4E): create the pickup point with the franchise account address. You can use the [Create/Update Pickup Point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23put-/api/logistics/pvt/configuration/pickuppoints/-pickupPointId-) endpoint.\n* [Shipping policy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/shipping-policy--tutorials%5F140): set up a shipping policy and link it to a registered pickup point. You can use the [Create shipping policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/shipping-policies) endpoint.\n* [Loading dock](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/managing-loading-docks--7K3FultD8I2cuuA6iyGEiW): configure a loading dock and link it to the shipping policy associated with the pickup point. You can use the [Create/update dock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/configuration/docks) endpoint.\n* [Warehouse](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/managing-warehouses--tutorials%5F137): you must configure a warehouse and link it to the shipping policy associated with the pickup point. You can use the [Create/update warehouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/configuration/warehouses) endpoint.\n\n## Fill in inventory level\n\nAfter setting the pickup point, the shipping policy, the loading dock, and the warehouse, fill in the quantity of the items in inventory. You can also use the [Update inventory by SKU and warehouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23put-/api/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-) endpoint.\n\nThe franchise account does not have its own catalog, it inherits products and SKU information from the main account, so it is necessary to update quantity through the [import and export of the inventory spreadsheet](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/importing-and-exporting-an-inventory-spreadsheet--tutorials%5F2034).\n\n## Validate settings\n\nOnce you've made the pickup point settings correctly in the franchise account, SKUs with inventory levels and price values configured can be sold on the main account. The franchise account will work as a white label seller and the main account will work as marketplace.\n\n> Make sure your white label seller is active. In your VTEX Admin, go to **Marketplace > Sellers > Management**, and in the seller row in column _Status_, click `Active`.\n\n### White label seller and franchise account\n\nTo check if the white label seller, which is the franchise account, is delivering a SKU through the registered pickup point, use the [Cart simulation endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForms/simulation).\n\n**POST** \\- `https://{accountName}.{environment}.com.br/api/checkout/pub/orderForms/simulation`\n\n#### Request body example\n\n`1\n\n{ \n\n2\n\n \"items\": [ \n\n3\n\n { \n\n4\n\n \"id\": \"1\", \n\n5\n\n \"quantity\": 1, \n\n6\n\n \"seller\": \"1\" \n\n7\n\n } \n\n8\n\n ], \n\n9\n\n \"country\": \"BRA\", \n\n10\n\n \"postalCode\": \"12345-000\", \n\n11\n\n \"geoCoordinates\": [ \n\n12\n\n -47.924747467041016 \n\n13\n\n ] \n\n14\n\n} \n\n`\n\n#### Response body example\n\n`1\n\n{ \n\n2\n\n \"items\": [ \n\n3\n\n { \n\n4\n\n \"id\": \"1\", \n\n5\n\n \"requestIndex\": 0, \n\n6\n\n \"quantity\": 1, \n\n7\n\n \"seller\": \"1\", \n\n8\n\n \"sellerChain\": [ \n\n9\n\n \"1\" \n\n10\n\n ], \n\n11\n\n \"tax\": 0, \n\n12\n\n \"priceValidUntil\": \"2023-07-12T11:49:01Z\", \n\n13\n\n \"price\": 9999, \n\n14\n\n \"listPrice\": 9999, \n\n15\n\n \"rewardValue\": 0, \n\n16\n\n \"sellingPrice\": 2999700, \n\n17\n\n \"offerings\": [], \n\n18\n\n \"priceTags\": [ \n\n19\n\n { \n\n20\n\n \"name\": \"DISCOUNT@MANUALPRICE\", \n\n21\n\n \"value\": -5000, \n\n22\n\n \"rawValue\": -50, \n\n23\n\n \"isPercentual\": false, \n\n24\n\n \"identifier\": \"1234abc-5678b-1234c\" \n\n25\n\n } \n\n26\n\n ], \n\n27\n\n \"measurementUnit\": \"un\", \n\n28\n\n \"unitMultiplier\": 300, \n\n29\n\n \"parentItemIndex\": null, \n\n30\n\n \"parentAssemblyBinding\": null, \n\n31\n\n \"availability\": \"available\", \n\n32\n\n \"priceDefinition\": { \n\n33\n\n \"calculatedSellingPrice\": 2999700, \n\n34\n\n \"total\": 2999700, \n\n35\n\n \"sellingPrices\": [ \n\n36\n\n { \n\n37\n\n \"value\": 2999700, \n\n38\n\n \"quantity\": 1 \n\n39\n\n } \n\n40\n\n ] \n\n41\n\n } \n\n42\n\n } \n\n43\n\n ], \n\n44\n\n \"ratesAndBenefitsData\": { \n\n45\n\n \"rateAndBenefitsIdentifiers\": [], \n\n46\n\n \"teaser\": [] \n\n47\n\n }, \n\n48\n\n \"paymentData\": { \n\n49\n\n \"installmentOptions\": [ \n\n50\n\n { \n\n51\n\n \"paymentSystem\": \"2\", \n\n52\n\n \"bin\": null, \n\n53\n\n \"paymentName\": \"Visa\", \n\n54\n\n \"paymentGroupName\": \"creditCardPaymentGroup\", \n\n55\n\n \"value\": 2999700, \n\n56\n\n \"installments\": [ \n\n57\n\n { \n\n58\n\n \"count\": 1, \n\n59\n\n \"hasInterestRate\": false, \n\n60\n\n \"interestRate\": 0, \n\n61\n\n \"value\": 2999700, \n\n62\n\n \"total\": 2999700, \n\n63\n\n \"sellerMerchantInstallments\": [ \n\n64\n\n { \n\n65\n\n \"id\": \"brenoStore\", \n\n66\n\n \"count\": 1, \n\n67\n\n \"hasInterestRate\": false, \n\n68\n\n \"interestRate\": 0, \n\n69\n\n \"value\": 2999700, \n\n70\n\n \"total\": 2999700 \n\n71\n\n } \n\n72\n\n ] \n\n73\n\n } \n\n74\n\n ] \n\n75\n\n } \n\n76\n\n ], \n\n77\n\n \"paymentSystems\": [ \n\n78\n\n { \n\n79\n\n \"id\": 2, \n\n80\n\n \"name\": \"Visa\", \n\n81\n\n \"groupName\": \"creditCardPaymentGroup\", \n\n82\n\n \"validator\": null, \n\n83\n\n \"stringId\": \"2\", \n\n84\n\n \"template\": \"creditCardPaymentGroup-template\", \n\n85\n\n \"requiresDocument\": false, \n\n86\n\n \"displayDocument\": false, \n\n87\n\n \"isCustom\": false, \n\n88\n\n \"description\": \"\", \n\n89\n\n \"requiresAuthentication\": false, \n\n90\n\n \"dueDate\": \"2022-07-19T11:39:36.37197Z\", \n\n91\n\n \"availablePayments\": null \n\n92\n\n } \n\n93\n\n ], \n\n94\n\n \"payments\": [], \n\n95\n\n \"giftCards\": [], \n\n96\n\n \"giftCardMessages\": [], \n\n97\n\n \"availableAccounts\": [], \n\n98\n\n \"availableTokens\": [], \n\n99\n\n \"availableAssociations\": {} \n\n100\n\n }, \n\n101\n\n \"selectableGifts\": [], \n\n102\n\n \"marketingData\": { \n\n103\n\n \"utmSource\": \"app\", \n\n104\n\n \"utmMedium\": \"CPC\", \n\n105\n\n \"utmCampaign\": \"Black friday\", \n\n106\n\n \"utmipage\": \"true\", \n\n107\n\n \"utmiPart\": \"true\", \n\n108\n\n \"utmiCampaign\": \"true\", \n\n109\n\n \"coupon\": null, \n\n110\n\n \"marketingTags\": [ \n\n111\n\n \"tag1\", \n\n112\n\n \"tag2\" \n\n113\n\n ] \n\n114\n\n }, \n\n115\n\n \"country\": \"BRA\", \n\n116\n\n \"postalCode\": \"12345-000\", \n\n117\n\n \"geoCoordinates\": [ \n\n118\n\n -47.924747467041016, \n\n119\n\n -15.832582473754883 \n\n120\n\n ], \n\n121\n\n \"logisticsInfo\": [ \n\n122\n\n { \n\n123\n\n \"itemIndex\": 0, \n\n124\n\n \"addressId\": null, \n\n125\n\n \"selectedSla\": null, \n\n126\n\n \"selectedDeliveryChannel\": null, \n\n127\n\n \"quantity\": 1, \n\n128\n\n \"shipsTo\": [ \n\n129\n\n \"BRA\" \n\n130\n\n ], \n\n131\n\n \"slas\": [], \n\n132\n\n \"deliveryChannels\": [ \n\n133\n\n { \n\n134\n\n \"id\": \"pickup-in-point\" \n\n135\n\n } \n\n136\n\n ] \n\n137\n\n } \n\n138\n\n ], \n\n139\n\n \"messages\": [], \n\n140\n\n \"purchaseConditions\": { \n\n141\n\n \"itemPurchaseConditions\": [ \n\n142\n\n { \n\n143\n\n \"id\": \"1\", \n\n144\n\n \"seller\": \"1\", \n\n145\n\n \"sellerChain\": [ \n\n146\n\n \"1\" \n\n147\n\n ], \n\n148\n\n \"slas\": [ \n\n149\n\n { \n\n150\n\n \"id\": \"Normal\", \n\n151\n\n \"deliveryChannel\": \"delivery\", \n\n152\n\n \"name\": \"Normal\", \n\n153\n\n \"deliveryIds\": [ \n\n154\n\n { \n\n155\n\n \"courierId\": \"1\", \n\n156\n\n \"warehouseId\": \"1_1\", \n\n157\n\n \"dockId\": \"1\", \n\n158\n\n \"courierName\": \"Transportadora\", \n\n159\n\n \"quantity\": 1, \n\n160\n\n \"kitItemDetails\": [] \n\n161\n\n } \n\n162\n\n ], \n\n163\n\n \"shippingEstimate\": \"3bd\", \n\n164\n\n \"shippingEstimateDate\": null, \n\n165\n\n \"lockTTL\": \"10d\", \n\n166\n\n \"availableDeliveryWindows\": { \n\n167\n\n \"startDateUtc\": \"2017-03-27T00:00:00+00:00\", \n\n168\n\n \"endDateUtc\": \"2017-03-27T00:00:00+00:00\", \n\n169\n\n \"price\": 0, \n\n170\n\n \"lisPrice\": 0, \n\n171\n\n \"tax\": 0 \n\n172\n\n }, \n\n173\n\n \"deliveryWindow\": { \n\n174\n\n \"startDateUtc\": \"2014-04-21T09:00:00+00:00\", \n\n175\n\n \"endDateUtc\": \"2014-04-21T12:00:00+00:00\", \n\n176\n\n \"price\": 0, \n\n177\n\n \"listprice\": 1000, \n\n178\n\n \"tax\": 0 \n\n179\n\n }, \n\n180\n\n \"price\": 1500, \n\n181\n\n \"listPrice\": 1500, \n\n182\n\n \"tax\": 0, \n\n183\n\n \"pickupStoreInfo\": { \n\n184\n\n \"isPickupStore\": false, \n\n185\n\n \"friendlyName\": null, \n\n186\n\n \"address\": null, \n\n187\n\n \"additionalInfo\": null, \n\n188\n\n \"dockId\": null \n\n189\n\n }, \n\n190\n\n \"pickupPointId\": null, \n\n191\n\n \"pickupDistance\": 0, \n\n192\n\n \"polygonName\": null, \n\n193\n\n \"transitTime\": \"3bd\" \n\n194\n\n } \n\n195\n\n ], \n\n196\n\n \"price\": 9999, \n\n197\n\n \"listPrice\": 9999 \n\n198\n\n } \n\n199\n\n ] \n\n200\n\n }, \n\n201\n\n \"pickupPoints\": [ \n\n202\n\n { \n\n203\n\n \"friendlyName\": \"Locker Arizona\", \n\n204\n\n \"address\": { \n\n205\n\n \"addressType\": \"pickup\", \n\n206\n\n \"receiverName\": null, \n\n207\n\n \"addressId\": \"1cc6116\", \n\n208\n\n \"postalCode\": \"85004\", \n\n209\n\n \"city\": \"Phoenix\", \n\n210\n\n \"state\": \"AZ\", \n\n211\n\n \"country\": \"USA\", \n\n212\n\n \"street\": \"North 3rd Street\", \n\n213\n\n \"number\": \"752\", \n\n214\n\n \"neighborhood\": \"Downtown\", \n\n215\n\n \"complement\": \"\", \n\n216\n\n \"reference\": null, \n\n217\n\n \"geoCoordinates\": [ \n\n218\n\n 3345.231544494628906, \n\n219\n\n -11206.918148040771484 \n\n220\n\n ] \n\n221\n\n }, \n\n222\n\n \"additionalInfo\": \"Bring your ID\", \n\n223\n\n \"id\": \"1cc6116\", \n\n224\n\n \"businessHours\": [] \n\n225\n\n } \n\n226\n\n ], \n\n227\n\n \"subscriptionData\": null, \n\n228\n\n \"totals\": [ \n\n229\n\n { \n\n230\n\n \"id\": \"Items\", \n\n231\n\n \"name\": \"Total dos Itens\", \n\n232\n\n \"value\": 2999700 \n\n233\n\n } \n\n234\n\n ], \n\n235\n\n \"itemMetadata\": { \n\n236\n\n \"items\": [] \n\n237\n\n } \n\n`\n\nWhen the configuration was made correctly, the call will return the shipping information of a given SKU. That is enough to check if the shipping is occurring by the registered pickup point.\n\n### Marketplace and main account\n\nTo check if the main account, which is the marketplace, is including the SKU of the white label seller in the shopping cart, use the same [Cart simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForms/simulation) endpoint mentioned in the previous section.\n\nFill in the `id` field of the [request body](#request-body-example) with the SKU ID sold by the white label seller and make sure to use a shipping address covered by your logistic operation. The [response body](#response-body-example) you will get should display valid shopping cart information, which shows that the SKU is been sold by the main account as well.\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/setting-up-white-label-seller-as-pickup-point.md)\n\n[Change chain orders in external marketplaces« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point//docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces)[Delivery PromiseNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point//docs/guides/delivery-promise)\n\nContributors\n\n1\n\n[](https://github.com/Isabella-Veloso)\n\nON THIS PAGE\n\n[Initial setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23initial-setup)\n\n[Fill in inventory level](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23fill-in-inventory-level)\n\n[Validate settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23validate-settings)\n\n[White label seller and franchise account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23white-label-seller-and-franchise-account)[Marketplace and main account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23marketplace-and-main-account)\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/setting-up-white-label-seller-as-pickup-point.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Initial setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23initial-setup)\n\n[Fill in inventory level](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23fill-in-inventory-level)\n\n[Validate settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23validate-settings)\n\n[White label seller and franchise account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23white-label-seller-and-franchise-account)[Marketplace and main account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23marketplace-and-main-account)\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_71120a71
|
[
{
"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 powerreviews 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-powerreviews/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/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-powerreviews/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-powerreviews/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-powerreviews/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-powerreviews/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-powerreviews/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/updates/release-notes)\n\nPowerReviews\n\nThe PowerReviews app provides a way to bring your PowerReviews content into your VTEX store. The app also implements the PowerReviews Checkout Beacon during checkout, sending customer purchase data to the PowerReviews platform.\n\n## Configuration\n\nBefore you can start using the app, you will need an existing [PowerReviews](https://read.calvincode.net/reader?url=https://www.powerreviews.com/) account and API key.\n\n### Step 1 - Defining the app settings\n\nIn your VTEX account's admin, perform the following actions:\n\n1. Access the **Apps** section and then **My Apps**.\n2. Select the **PowerReviews** app box.\n3. Complete the following required fields in the Settings section:\n* `App Key` \\- The API Key provided by PowerReviews.\n* `Merchant ID` \\- Your unique PowerReviews merchant ID.\n* `Merchant Group ID` \\- Your PowerReviews merchant group ID.\n* `Client ID` \\- Your PowerReviews Client ID\n* `Client Secret` \\- Your PowerReviews Client Secret\n* `Send Email After Invoicing` \\- Instead of sending email after checkout, we can send email after an order has been invoiced. Enabling this disables purchase pixel's ability to track checkout\n* `API Unique Id` \\- The product field used as the identifier (or pageId) on PowerReviews.\n\nOptionally, the `Use Legacy Review Display Component` checkbox allows you to use the PowerReviews Review Display component instead of the VTEX Reviews component.\n\nIf needed, provide a URL path to a CSS stylesheet to override the styles of the PowerReviews Write-a-Review, Questions & Answers, or Review Display components.\n\n### Step 2 - Update your store theme\n\n1. Add the `powerreviews` app as a `peerDependency` in your theme's `manifest.json` file:\n\n`1\n\n \"peerDependencies\": { \n\n2\n\n+ \"vtex.powerreviews\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. If not already present, add the following to your theme's `dependencies`:\n\n`1\n\n \"vtex.product-review-interfaces\": \"1.x\", \n\n2\n\n \"vtex.product-summary-context\": \"0.x\", \n\n3\n\n \"vtex.product-context\": \"0.x\", \n\n4\n\n \"vtex.store-header\": \"2.x\", \n\n5\n\n \"vtex.pixel-interfaces\": \"1.x\", \n\n6\n\n \"vtex.store-image\": \"0.x\", \n\n`\n\n### Step 3 - Defining the app's blocks\n\nThe PowerReviews app integrates with the following store framework blocks.\n\n| Block name | Description |\n| ----------------------------- | ---------------------------------------------------------------------------------------------------------------- |\n| product-reviews | Display a paginated list of reviews for the product being viewed. This must be placed on the store.product page. |\n| product-rating-summary | Display the average rating for the product being viewed. This must be placed on the store.product page. |\n| product-rating-inline | Display the average rating for the product being viewed, intended for use on the product shelf. |\n| product-review-form | Display the PowerReviews Write-a-Review form component. This must be placed on the product-review-form page. |\n| product-questions-and-answers | Display the PowerReviews Questions & Answers component for the product being viewed. |\n\nAn example of the blocks above in use:\n\n`1\n\n \"store.product\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"product-rating-summary\", \n\n4\n\n \"product-reviews\", \n\n5\n\n \"product-questions-and-answers\" \n\n6\n\n ] \n\n7\n\n } \n\n`\n\n`1\n\n \"store.product-review-form\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"product-review-form\" \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/pixel-apps/vtex-powerreviews.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/vtex-powerreviews/docs/guides/vtex-powerreviews%23configuration)\n\n[Step 1 - Defining the app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/guides/vtex-powerreviews%23step-1-defining-the-app-settings)[Step 2 - Update your store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/guides/vtex-powerreviews%23step-2-update-your-store-theme)[Step 3 - Defining the app's blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/guides/vtex-powerreviews%23step-3-defining-the-apps-blocks)\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/vtex-powerreviews.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/vtex-powerreviews/docs/guides/vtex-powerreviews%23configuration)\n\n[Step 1 - Defining the app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/guides/vtex-powerreviews%23step-1-defining-the-app-settings)[Step 2 - Update your store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/guides/vtex-powerreviews%23step-2-update-your-store-theme)[Step 3 - Defining the app's blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/guides/vtex-powerreviews%23step-3-defining-the-apps-blocks)\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_7691e978
|
[
{
"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 analytics 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/analytics-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/analytics-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/analytics-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/analytics-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/analytics-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/analytics-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/analytics-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/analytics-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/analytics-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-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/analytics-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-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/analytics-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview)\n\n[sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-send-analytics-event)\n\n[useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-use-analytics-event)\n\n[Sending custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-sending-custom-events)\n\n[Extending and customizing native types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-extending-and-customizing-native-types)\n\n[Use case: Implementing custom newsletter analytics events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/search-overview)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/session-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-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/analytics-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/analytics-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/analytics-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-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/analytics-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/analytics-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-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/analytics-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/analytics-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-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/analytics-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-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/analytics-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview)\n\n[sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-send-analytics-event)\n\n[useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-use-analytics-event)\n\n[Sending custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-sending-custom-events)\n\n[Extending and customizing native types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-extending-and-customizing-native-types)\n\n[Use case: Implementing custom newsletter analytics events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/search-overview)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/session-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-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/analytics-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/analytics-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/analytics-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-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/analytics-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/analytics-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/analytics-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/sdk-overview)\n\nAnalytics\n\nThe Analytics module manages events on a website. The module is composed of two main functions:\n\n* [sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event): Fires events in the browser. Events fired using this function are shared only with the website's origin. The event is wrapped and sent to the [Window object](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/API/Window) via standard `postMessage` calls.\n* [useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-use-analytics-event): Intercepts fired events and usually communicates with an analytics provider.\n\n\n\n> Events sent via the Analytics module are not automatically sent to any analytics provider (e.g., Google Analytics). To connect with a provider, configure the [useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-use-analytics-event) hook.\n\nThe Analytics module supports sending and receiving different events, allowing you to implement custom event types and override default ones.\n\nAdditionally, the Analytics module offers built-in [ecommerce event](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/14434488?hl=en) types based on the [Google Analytics 4 (GA4) data model](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events).\n\n## List of native event types\n\nThe Analytics module comes with native types based on [ecommerce events](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/14434488?hl=en). All event types are available for use and extension. Here is a list of events natively supported by the Analytics module:\n\n| Type | Parameters |\n| ------------------- | ------------------------------------------------------------------------------- |\n| add\\_payment\\_info | currency, value, coupon, payment\\_type, and items |\n| add\\_shipping\\_info | currency, value, coupon, shipping\\_tier, and items |\n| add\\_to\\_cart | currency, value, and items |\n| add\\_to\\_wishlist | currency, value, and items |\n| begin\\_checkout | currency, value, coupon, and items |\n| login | method |\n| page\\_view | page\\_title, page\\_location, and send\\_page\\_view |\n| purchase | currency, transaction\\_id, value, affiliation, coupon, shipping, tax, and items |\n| refund | currency, transaction\\_id, value, affiliation, coupon, shipping, tax, and items |\n| remove\\_from\\_cart | currency, value, and items |\n| search | search\\_term |\n| select\\_item | item\\_list\\_id, item\\_list\\_name, and items |\n| select\\_promotion | item\\_list\\_id, item\\_list\\_name, and items |\n| share | method, content\\_type, and item\\_id |\n| signup | method, content\\_type, and item\\_id |\n| view\\_cart | currency, value, and items |\n| view\\_item | currency, value, and items |\n| view\\_item\\_list | item\\_list\\_id, item\\_list\\_name, and items |\n| view\\_promotion | items |\n\nEach event exports at least two types: one for the event parameters and one for the event type itself. For example, the `add_to_cart` event has two exported types: `AddToCartParams<T extends Item = Item>` and `AddToCartEvent<T extends Item = Item>`.\n\nSome types are [common](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/blob/main/packages/sdk/src/analytics/events/common.ts) to all events, such as the `Item` type. These types are particularly useful when overriding `Item` properties or a whole `Item` itself.\n\n## Google Analytics 4\n\nGoogle Analytics is the industry-leading analytics solution that most ecommerce websites use, and the Analytics module was designed with this in mind. All the helper functions and hooks in the module use the [Google Analytics 4 (GA4) data model](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events) by default. This allows you to use [code hinting](#code-hinting) tools to receive suggestions of GA4 events and their recommended properties while coding.\n\nTo send the events to Google Analytics, use the [useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-use-analytics-event) hook. The hook must listen to events from [sendAnalyticsEvents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event) and add them to the `dataLayer` (recommended for Google Tag Manager) or call the `gtag` function directly (for `gtag` script implementations).\n\n## Code hinting\n\nBy leveraging the type definitions in the Analytics module, you can use [IntelliSense](https://read.calvincode.net/reader?url=https://code.visualstudio.com/docs/editor/intellisense) suggestions for code hinting.\n\n\n\n## Next steps\n\n[sendAnalyticsEventLearn how to trigger and manage analytics events in your store using the sendAnalyticsEvent function, which follows the Google Analytics 4 (GA4) data model.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event)[useAnalyticsEventLearn how to use the useAnalyticsEvent hook to intercept and respond to both native and custom analytics events triggered by the sendAnalyticsEvent function.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-use-analytics-event)\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/sdk/analytics/overview.mdx)\n\n[FastStore SDK« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/sdk-overview)[sendAnalyticsEventNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-send-analytics-event)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[List of native event types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview%23list-of-native-event-types)\n\n[Google Analytics 4](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview%23google-analytics-4)\n\n[Code hinting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview%23code-hinting)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview%23next-steps)\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/sdk/analytics/overview.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[List of native event types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview%23list-of-native-event-types)\n\n[Google Analytics 4](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview%23google-analytics-4)\n\n[Code hinting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview%23code-hinting)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview%23next-steps)\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_914e6822
|
[
{
"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 customization guide 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-customization-guide/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/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-customization-guide/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-customization-guide/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-customization-guide/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-customization-guide/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-customization-guide/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/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-customization-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/customization)\n\n[Checkout customization guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide)\n\n[Customize checkout confirmation pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/customize-checkout-confirmation-pages)\n\n[Change payment method names in Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/change-payment-method-names-in-checkout)\n\n[Enable an Observation field on the Checkout page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/enable-an-observation-field-on-the-checkout-page)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/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-customization-guide/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-customization-guide/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/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-customization-guide/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-customization-guide/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/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-customization-guide/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/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-customization-guide/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-customization-guide/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/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-customization-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/customization)\n\n[Checkout customization guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide)\n\n[Customize checkout confirmation pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/customize-checkout-confirmation-pages)\n\n[Change payment method names in Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/change-payment-method-names-in-checkout)\n\n[Enable an Observation field on the Checkout page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/enable-an-observation-field-on-the-checkout-page)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/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-customization-guide/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-customization-guide/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/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-customization-guide/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-customization-guide/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/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-customization-guide/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/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-customization-guide/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-customization-guide/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-api-overview)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/customization)\n\n[Checkout customization guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide)\n\nCheckout customization guide\n\nAll VTEX stores have a native Checkout UI ready to be used from the beginning of their operations on the platform. However, if the merchant wants to change some features on this UI, VTEX also offers the option of customizing the Checkout. This functionality can be performed in two ways: by Admin VTEX or Apps.\n\n## Customizing Checkout UI - Admin VTEX\n\nIn the Checkout section, located in the Admin VTEX side menu, you can access one or more websites (stores) registered in your account and perform checkout settings, including UI customization.\n\nBy clicking on the `blue gear` button of the chosen website, and selecting the **Code** tab, you will have access to a list of files and templates, where you can edit or import the HTML information.\n\n> The same files shown in the Code tab are publicly available in the route `https://{accountName}.myvtex.com/files/`.\n\n### Edit Information\n\nTo edit Checkout UI information, access the following files/templates:\n\n* HTML Header: _template_ _checkout-header_\n* HTML Footer: _template_ _checkout-footer_\n* CSS: _file checkout6-custom.css_\n* JS: _file checkout6-custom.js_\n\n> It is not possible to edit information in HTML body of the page.\n\n### Import Information\n\nYou can import additional information and files by clicking on the `New` button and then on **File upload**, located in the **Code** tab.\n\n> The action of importing information is not recommended for CSS files and it is prohibited for JS files. Using non-standard files can cause side effects, such as your store breaking or stopping your sales.\n\nFor more information, access [configuring template in the SmartCheckout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configurar-template-no-smartcheckout--frequentlyAskedQuestions%5F599%23).\n\n\n\n### Legacy CMS Portal\n\nIn stores using the Legacy CMS Portal, files are managed by the **Files Manager**. The CMS and JS files are located in the route `https://{accountName}.myvtex.com/arquivos/`, and named respectively as _checkout-custom.css_ and _checkout-custom.js_.\n\n> Modifications made to Legacy CMS Portal files will be applied to all websites (stores) of your account at the same time.\n\nFor more information, access [View the contents of the store's CSS files](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/view-the-contents-of-the-stores-css-files--U5v7DXpRSee86uqiKQUQi%23).\n\n\n\n> VTEX does not support the use of custom scripts and is not responsible for any damages that their use may cause. Using custom scripts can break your store or stop sales.\n\n## Customizing Checkout UI - Apps\n\nIn addition to Admin VTEX, you can use two apps to customize your store’s Checkout UI: _Checkout UI Settings_ and _Checkout UI Custom_.\n\n> If you want to use the Checkout UI Settings app, any script changes made through it will override HTML, CSS, and JS information made through [Admin VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-settings).\n\n### Checkout UI Settings app\n\nThe Checkout UI Settings app allows you to customize your store's through the terminal and the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install). This app, if compared to the [Admin VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-settings) method, offers the possibility to:\n\n* Perform A/B Testing\n* Easily track all changes made to the UI (through app versions)\n* Apply quick rollbacks to a previous version, if needed.\n\n> It is highly recommended that you have prior experience using IO apps (VTEX Store Framework) before choosing this checkout UI configuration option.\n\nFor more information, access the [Checkout UI Settings Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-settings).\n\n### Checkout UI Custom app\n\nThe Checkout UI Custom app can be used to quickly apply pre-defined customization options (e.g. show items unit price, text size, colors) that have already been approved by VTEX. For more information, access the [Checkout UI Custom Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0).\n\n\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\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/customization/checkout-customization-guide.md)\n\n[Customization« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide//docs/guides/customization)[Customize checkout confirmation pagesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide//docs/guides/customize-checkout-confirmation-pages)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[Customizing Checkout UI - Admin VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23customizing-checkout-ui-admin-vtex)\n\n[Edit Information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23edit-information)[Import Information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23import-information)[Legacy CMS Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23legacy-cms-portal)\n\n[Customizing Checkout UI - Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23customizing-checkout-ui-apps)\n\n[Checkout UI Settings app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23checkout-ui-settings-app)[Checkout UI Custom app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23checkout-ui-custom-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/Checkout/customization/checkout-customization-guide.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Customizing Checkout UI - Admin VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23customizing-checkout-ui-admin-vtex)\n\n[Edit Information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23edit-information)[Import Information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23import-information)[Legacy CMS Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23legacy-cms-portal)\n\n[Customizing Checkout UI - Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23customizing-checkout-ui-apps)\n\n[Checkout UI Settings app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23checkout-ui-settings-app)[Checkout UI Custom app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23checkout-ui-custom-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_cf33acfa
|
[
{
"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 production workspace 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-production-workspace/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-production-workspace/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-production-workspace/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-production-workspace/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-production-workspace/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-production-workspace/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-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/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-production-workspace/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/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-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/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-creating-a-production-workspace/docs/app-development)\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/docs/guides/vtex-io-documentation-workspace)\n\n[Creating a Production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/docs/guides/vtex-io-documentation-creating-a-production-workspace)\n\nCreating a Production workspace\n\nLearn how to create and use a production workspace.\n\nProduction [workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/) are ready to handle live traffic. This guide provides step-by-step instructions on creating and managing a Production workspace.\n\nProduction workspaces serve multiple purposes, including quality assurance, testing, running A/B tests, and validating VTEX IO apps. It's important to note that for making changes or developing a new VTEX IO app, you must use a [Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace).\n\n## Creating a production workspace\n\n1. [Log in to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) your VTEX account.\n2. Create a production workspace by running the following command:\n\n`1\n\nvtex use {workspaceName} --production \n\n`\n\n> Replace `{workspaceName}` according to your scenario.\n\n### Next steps\n\nAfter testing your app and configurations, you can [promote a Production workspace to Master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master) to make your code changes available to the end-user.\n\nCreating a Production workspace is one of the steps to making your code's new version public. Refer to the [Making your new app version publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available) guide for detailed information on subsequent steps.\n\n## Deleting a workspace\n\nYou can manually delete workspaces that are no longer in use by running the following command:\n\n`1\n\nvtex workspace delete {workspaceName} \n\n`\n\n> Deleting a workspace is irreversible, and its content cannot be restored.\n\n## Production workspace behavior\n\nIn Production workspaces, certain actions are permitted while others are restricted to maintain stability and reliability. Here is a summary of allowed and restricted actions:\n\n| Action | Allowed |\n| ------------------------------------------------------------------------------------------------------------------- | ------- |\n| [Install apps.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) | ✅ |\n| [Run A/B tests.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing) | ✅ |\n| Handle traffic. | ✅ |\n| [Promote to master.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master) | ✅ |\n| App development. | ❌ |\n| [Link an app.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) | ❌ |\n| [Publish an app.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app) | ❌ |\n\n## Key considerations\n\n* **Code modifications:** Production workspaces strictly prohibit code changes in VTEX IO apps. To implement code modifications, it is necessary to switch to a dedicated [Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/).\n* **Workspace inheritance:** Production workspaces are initiated independently and do not inherit code changes from a [Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace). Therefore, any modifications made in a Development workspace must be manually replicated to the new Production workspace.\n* **Data persistency:** Workspace settings persist unless conflicts arise with the Master workspace. In such cases, Master settings take precedence over settings in other workspaces, including the Development ones.\n* **Expiration:** Once created, Production workspaces have no expiration date.\n* **Deletion:** Unused workspaces are not automatically deleted. It is recommended to perform manual deletion to optimize platform resources and maintain an efficient operational state.\n* **Organization:** Maintain a concise list of workspaces for organizational and resource efficiency reasons.\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-creating-a-production-workspace.md)\n\n[Creating a Development workspace for a Legacy CMS store« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace//docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy)[Workspace behavior with app installationsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace//docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Creating a production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/docs/guides/vtex-io-documentation-creating-a-production-workspace%23creating-a-production-workspace)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/docs/guides/vtex-io-documentation-creating-a-production-workspace%23next-steps)\n\n[Deleting a workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/docs/guides/vtex-io-documentation-creating-a-production-workspace%23deleting-a-workspace)\n\n[Production workspace behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/docs/guides/vtex-io-documentation-creating-a-production-workspace%23production-workspace-behavior)\n\n[Key considerations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/docs/guides/vtex-io-documentation-creating-a-production-workspace%23key-considerations)\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-creating-a-production-workspace.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Creating a production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/docs/guides/vtex-io-documentation-creating-a-production-workspace%23creating-a-production-workspace)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/docs/guides/vtex-io-documentation-creating-a-production-workspace%23next-steps)\n\n[Deleting a workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/docs/guides/vtex-io-documentation-creating-a-production-workspace%23deleting-a-workspace)\n\n[Production workspace behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/docs/guides/vtex-io-documentation-creating-a-production-workspace%23production-workspace-behavior)\n\n[Key considerations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/docs/guides/vtex-io-documentation-creating-a-production-workspace%23key-considerations)\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_cf9e6ae1
|
[
{
"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 safely enabling performance settings 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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/store-framework-managing-performance)\n\n[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\n[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-debugging-performance-issues)\n\n[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)\n\n[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n\n[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\n[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\n[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\n[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/store-framework-managing-performance)\n\n[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\n[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-debugging-performance-issues)\n\n[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)\n\n[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n\n[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\n[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\n[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\n[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/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-safely-enabling-performance-settings/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/store-framework)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/store-framework-managing-performance)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\nEnabling performance settings\n\nFor ecommerce businesses, appealing offers, high-quality products, or brand recognition might not be enough to convert leads if the user experience falls short. Store website performance is essential to the user experience, directly impacting sales conversion rate, user session time, and other metrics. Every millisecond counts and affects the consumer decision-making process and website ranking in search engine results.\n\nThis guide outlines actions you can implement to optimize store performance. These [optimization options](#optimization-options) can improve SEO score and page loading time. You can measure these improvements using tools like [Google Lighthouse](https://read.calvincode.net/reader?url=https://developers.google.com/web/tools/lighthouse) and [Google Analytics](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/1205784?hl=en). Learn more in the **Monitoring tools** section in the [Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance) guide.\n\nThis guide is divided into the following sections:\n\n* [Instructions](#instructions): Instructions for enabling and deploying performance optimizations in your store, including workspace setup, Admin configuration, and promoting changes to production.\n* [Optimization options](#optimization-options): Methods to enhance store performance, categorized by: \n * [Store settings](#store-settings): Actions that can be performed directly in the VTEX Admin. \n * [Manual optimizations](#manual-optimizations): Additional manual actions for advanced performance that require direct code changes.\n\n## Instructions\n\n### Step 1 - (Optional) Testing manual optimizations\n\nIf you have implemented [manual optimizations](#manual-optimizations), make sure to use a [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace) to test them before making your new app version publicly available. Learn more about this process in 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).\n\n### Step 2 - Applying changes in a production workspace\n\n1. Using the terminal and 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/), log in to the desired account by running `vtex login {account}`.\n2. Run the command `vtex use {productionWorkspace} --production` to create and use a **new** [production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/). \n> Replace the values between the curly braces based on your scenario.\n3. Using your browser, access the Admin for that workspace.\n4. In the account's Admin, go to **Store Settings > Storefront > Store > Advanced**.\n5. Follow the instructions in the [Store settings](#store-settings) section to activate the desired features, then save the changes.\n6. Access your store in the workspace you're using and check whether the performance improvements were applied.\n\n> Changes may take some time to be reflected.\n\n### Step 3 - Testing and analyzing performance\n\n1. Review and test all main pages, ensuring the changes didn't cause any side effects, such as style inconsistencies or undesired behaviors.\n2. Access [Google PageSpeed Insights](https://read.calvincode.net/reader?url=https://developers.google.com/speed/pagespeed/insights).\n3. Using the following URL pattern: `https://{account}.myvtex.com/?workspace={productionWorkspace}`, check store performance in the production workspace where you're currently working.\n\n> Using the standard URL pattern `https://{workspace}--{account}.myvtex.com/` won't show the store performance score in the specified workspace. To analyze performance in a workspace, **you must use the `?workspace={productionWorkspace}` query string** as shown in Step 3.3.\n\n### Step 4 - Making your changes publicly available\n\nIf you're satisfied with the results, run `vtex promote` to promote your workspace and benefit from a faster store. Before promoting your workspace to master, measure the performance improvements by comparing the performance scores in the production and master workspaces.\n\n## Optimization options\n\n### Store settings\n\nStore settings are actions you can configure directly in the VTEX Admin by navigating to **Store Settings > Storefront > Store > Advanced**.\n\n\n\n#### OrderForm optimization\n\nThis action disables the legacy `orderForm` provider.\n\nThe `orderForm` is an object that stores and retrieves data from user orders, including each item added to the cart. To give other Store Theme blocks access to the data stored in the `orderForm` and allow them to render it, Store Framework runs the `OrderFormProvider` object on each store page. This object exports all the necessary `orderForm` information to these blocks.\n\nHowever, all stores using VTEX IO Store Framework currently have two `OrderFormProviders`: a legacy version, still consumed by native blocks such as `minicart` and `buy-button`, and a newer version, better suited for replacement.\n\nWe recommend that stores using `minicart.v2` and `add-to-cart-button` blocks (instead of `minicart` and `buy-button`, respectively) disable the legacy provider. Consuming a single provider will improve store performance.\n\nLearn more in the guide [Enabling OrderForm optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/).\n\n#### Service worker\n\nThis action adds the default service worker provided by VTEX.\n\nThe VTEX IO platform provides a native service worker to every store using Store Framework. If you need to use a third-party service with its service worker, you may face conflicts. You can deactivate the native VTEX service worker to resolve this.\n\nLearn more in the guide [Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/).\n\n#### Critical CSS optimization\n\nThis action enables CSS optimizations on your pages to boost performance and improve Lighthouse scores. It lets the browser identify and load essential CSS needed for critical, above-the-fold content first, while loading the remaining CSS code asynchronously.\n\n\n\nHowever, by default, the browser initiates the rendering of a web page after it finishes loading, parsing, and executing all related CSS files. Consequently, the more extensive the CSS code, the longer it takes to render the critical part of the page.\n\nThis optimization can be enabled for the following pages:\n\n* Homepage\n* Search page\n* Custom pages\n* Product page\n\n> Enabling these options might cause style inconsistencies in the store layout. Test these changes carefully before enabling them on a production workspace. If you notice any side effects, [open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\n#### Enable CSS concatenation\n\nThis action concatenates a page's CSS in a single file for faster download, reducing the HTTP requests required to load each CSS file separately.\n\n\n\n#### Enable prefetch\n\nThis action prefetches pages when a user hovers over a link.\n\nWhen enabled, the page content is proactively downloaded in the background when you hover over a link. This means that the page is already loaded or partially loaded when you click the link.\n\n#### Enable lazy runtime\n\nThis action enables lazy loading of page metadata.\n\nBefore displaying a web page, the VTEX IO service app that renders server-side (Render Runtime) interprets the page metadata script. See the example below:\n\n`1\n\n<script> \n\n2\n\n __RUNTIME__ = {\"account\":\"vtexstore\",\"amp\":false,\"bindingChanged\":false,\"binding\":{\"id\":\"aacb04t3-a8fa-4bab-b5bd-2d654d20dcd8\",\"canonicalBaseAddress\":\"vtexstore.vtex.com\"},\"culture\":{\"availableLocales\":[],\"country\":\"USA\",\"currency\":\"USD\",\"language\":\"en\",\"locale\":\"en-US\",\"customCurrencyDecimalDigits\":null,\"customCurrencySymbol\":\"$\"},\"production\":true,\"query\":{},\"settings\":{.... \n\n`\n\nThis script contains significant web page data and can be long, demanding significant browser processing. When you enable lazy runtime, the script is broken into smaller scripts to avoid compromising the total blocking time of the store website. This helps avoid lengthy tasks, leading to a faster store experience.\n\n> Some apps might not work as expected when this option is enabled. Test with caution before enabling it on a production workspace. If you notice any side effects, [open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\n#### Enable lazy rendering of submenu items\n\nBy enabling this action, menus containing submenus automatically apply the `experimentalOptimizeRendering` prop. This configuration prevents the entire set of `submenus` from loading unnecessarily, as `submenus` only load when the user interacts with the parent menu where the prop is set.\n\n> Google won't be able to track the hidden submenu items for SEO, as their content only loads with user interaction. Make sure your SEO strategy is covered by the store sitemap or the first meaningfully painted content.\n\n#### Enable lazy rendering of search results and facets\n\nThis action enables lazy rendering for the scrollable facet box and search results pages. Content within the user's viewport loads first, and content outside the viewport loads only as the user scrolls.\n\n> Enabling this option might cause unexpected behaviors, such as gaps while scrolling. If you notice any side effects, [open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\n#### Enable loading scripts asynchronously\n\nThis action allows the browser to load and execute scripts asynchronously. This means the browser doesn't wait for the script to fully download and execute before continuing to parse and render the rest of the page. Instead, it can process other elements of the page concurrently while the script loads in the background.\n\n#### Enable concurrent React mode\n\nThis action helps the store stay responsive by adjusting to the capabilities of the user's device and network speed. This means rendering tasks can be prioritized and interrupted based on user interactions or current network conditions.\n\nFor example, if a user begins typing in a search bar while other content is still loading, concurrent mode can pause loading to process your input, ensuring the search bar remains responsive. Once the input is handled, rendering can resume without perceived delays.\n\n#### Enable fetching filters partially\n\nWhen you enable this action, search results pages display a maximum of 10 facets per filter.\n\nThe search query won't automatically retrieve any additional facets or show them to the user. Instead, a `Show more` button allows users to load the remaining facets.\n\n> A facet is a filter value. For example, `Color` is a filter, and `Blue` is a facet of that filter.\n\n#### Enable executing all GraphQL queries on the product page\n\nThis action allows the product page to fetch additional data necessary to render components positioned above-the-fold. This helps ensure that product details, images, and any other components in the main view display together without delays or missing information.\n\n> Enable this only if your product page truly needs it; otherwise, it may lead to deoptimization.\n\n#### Enable lazy rendering of the page footer\n\nThis action renders the page footer and loads its assets lazily, which helps improve performance when first rendering the page.\n\n#### Enable lazy loading of assets below the fold\n\nThis action enables lazy loading of the JavaScript files of the components below the `_fold_` block. This keeps the initial load fast and reduces unnecessary bandwidth usage for users who never scroll.\n\n#### Enable page number in meta title\n\nThis option adds a `#{Number}` to the HTML title. This helps both users and search engines know exactly which page they're viewing and avoids duplicate titles, which can impact SEO.\n\n> It's best suited for stores using traditional pagination. After enabling, review your page titles to make sure they remain clear and consistent.\n\n#### Canonical URL without URL parameters\n\nThis action removes the map parameter from the canonical URL, so search engines focus on a single, clean address for each page.\n\n> This may cause issues when visiting a page with selected facets. Test with caution after turning it on.\n\n#### Remove store name from title\n\nThis action removes the store name from the end of page titles on product and category pages, resulting in shorter titles that may highlight product keywords better for SEO.\n\n#### Enable custom currency symbol\n\nThis action uses the `Currency Symbol` field defined in the trade policy. This ensures that prices are displayed in the format and symbol your customers expect, which is especially important for international or multi-currency stores.\n\n#### \\[BETA\\] Show sponsored products on search results\n\nThis action enables stores in the Retail Media Network (RMN) pilot to place advertiser-sponsored products alongside organic search results.\n\n> This action is available only for stores that have joined the RMN pilot. For more information, email **[rmn@vtex.com](mailto:rmn@vtex.com)**.\n\n#### Enable default browser navigation\n\nEnabling this action means each store page loads separately with full reloads instead of rendering through the VTEX IO service app on the server (Render Runtime). This default browser navigation can be useful for troubleshooting or when experiencing issues with client-side routing.\n\n> Full-page reloads are generally slower and consume more bandwidth than the standard VTEX navigation. Use this only when necessary for testing or for compatibility, and consider whether the change impacts user experience or conversion rates.\n\n### Manual optimizations\n\nIn addition to the features configured in the VTEX Admin, you can apply manual optimizations directly in the project source code to enhance store performance.\n\n#### Improving scrolling performance\n\nUse the `__fold__` block for scrollable pages. This allows you to specify which interface components load initially (above the fold) and which are lazy-loaded as the user scrolls.\n\nYou can also use the `__fold__.experimentalLazyAssets` block to define which theme blocks should load statically upon the first user interaction.\n\nLearn more about fold blocks in the guide [Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks).\n\n> If you notice any side effects, [open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\n#### Reducing the number of menu blocks\n\nIf a menu block doesn't have a submenu, configure it to use `menu-item` blocks as props instead of children.\n\nIn the example below, the main `menu items` (Apparel & Accessories, Home & Decor, and More) can't be modified in their implementation. They must remain as children since they have a trigger to open a `submenu`.\n\n\n\nHowever, the internal `menu-items` (Clothing, Accessories, and Eyeglasses) can be changed from children to props.\n\nPreviously, each `menu-item` was set up as an individual child/block. With the change, the `menu-items` group, declared as props, is treated as a single block, represented by a blue square.\n\nThis approach reduces the number of blocks from 3 to 1, improving store performance.\n\nLearn more about applying both configurations in the [Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu) guide.\n\n#### Adjusting image sizes\n\nThe size of images in your store directly impacts performance. To optimize image rendering, follow the practices outlined in the guide [Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/), focusing on the media types used in your theme.\n\n#### Improving search results\n\nTo avoid performance issues on search results pages, use the `skusFilter` and `simulationBehavior` props. These props control the SKUs returned for each product in the search query, determining whether the displayed search data will be current (`skusFilter`) or retrieved from the cache (`simulationBehavior`).\n\nWe recommend setting `skusFilter` to `FIRST_AVAILABLE` to return only the first available SKU for each product, and `simulationBehavior` to `skip` to display search data from the cache.\n\nLearn more about prop configuration in the [Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result) app documentation.\n\n#### Using lazy loading for sliders\n\nBuild the shelf and carousel blocks of your theme using the [Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-carousel-using-slider-layout) component.\n\nSlider Layout uses lazy loading to automatically load images and product information only when users interact with shelves or carousels, reducing page load time. However, having more products in these components may negatively impact website performance.\n\nLearn more about using Slider Layout in the guides [Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/) and [Building a Carousel using Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-carousel-using-slider-layout/).\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/boosting-performance/vtex-io-documentation-enabling-performance-settings.md)\n\n[Getting started with Lighthouse performance audit« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings//docs/guides/vtex-io-documentation-getting-started-with-lighthouse)[Tracking changes in Lighthouse performance scoreNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings//docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\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-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23instructions)\n\n[Step 1 - (Optional) Testing manual optimizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-1-optional-testing-manual-optimizations)[Step 2 - Applying changes in a production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-2-applying-changes-in-a-production-workspace)[Step 3 - Testing and analyzing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-3-testing-and-analyzing-performance)[Step 4 - Making your changes publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-4-making-your-changes-publicly-available)\n\n[Optimization options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23optimization-options)\n\n[Store settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23store-settings)[Manual optimizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23manual-optimizations)\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/boosting-performance/vtex-io-documentation-enabling-performance-settings.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-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23instructions)\n\n[Step 1 - (Optional) Testing manual optimizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-1-optional-testing-manual-optimizations)[Step 2 - Applying changes in a production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-2-applying-changes-in-a-production-workspace)[Step 3 - Testing and analyzing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-3-testing-and-analyzing-performance)[Step 4 - Making your changes publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-4-making-your-changes-publicly-available)\n\n[Optimization options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23optimization-options)\n\n[Store settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23store-settings)[Manual optimizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings/docs/guides/vtex-io-documentation-enabling-performance-settings%23manual-optimizations)\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_00cf8817
|
[
{
"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 search 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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-api/docs/api-reference/search-api/)\n\nCrossSelling\n\nSearch\n\nOffers\n\nFacets\n\nAutocomplete\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-api/docs/api-reference/search-api/)\n\nCrossSelling\n\nSearch\n\nOffers\n\nFacets\n\nAutocomplete\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-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/search-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PoRemove a seller's SKU Binding« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api/docs/api-reference/sku-bindings-api%23post-/sku-binding/pvt/skuseller/remove/-sellerId-/-sellerSkuId-)[GeGet Product Search of Who Saw Also SawNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api/docs/api-reference/search-api%23get-/api/catalog%5Fsystem/pub/products/crossselling/whosawalsosaw/-productId-)\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_aa0c959f
|
[
{
"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 add client preferences to the cart 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/add-client-preferences-to-the-cart/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/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/add-client-preferences-to-the-cart/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/add-client-preferences-to-the-cart/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/add-client-preferences-to-the-cart/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/add-client-preferences-to-the-cart/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/add-client-preferences-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/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/add-client-preferences-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/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/add-client-preferences-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/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/add-client-preferences-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/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/add-client-preferences-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/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/add-client-preferences-to-the-cart/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/add-client-preferences-to-the-cart/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/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/add-client-preferences-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/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/add-client-preferences-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/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/add-client-preferences-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/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/add-client-preferences-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/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/add-client-preferences-to-the-cart/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/add-client-preferences-to-the-cart/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/checkout-api-overview)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart)\n\nAdding customer preferences to the cart\n\nThe shopping cart gathers information on the products the customer chooses while browsing a store, such as prices, shipping costs, payment methods, delivery methods, etc. This data may include item prices, shipping value, payment, and delivery methods, among others.\n\nThis guide will describe how to add customer preferences information (website locale and newsletter options) to the shopping cart via API.\n\n## Getting shopping cart information\n\nThe first step is to get the `orderFormId` of the shopping cart to which you want to add the customer preferences information. For more information, read the [Getting cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id) guide.\n\n## Adding customer preferences to the shopping cart\n\nTo add customer preferences information to the shopping cart, use the [Add client preferences](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/attachments/clientPreferencesData) endpoint. In this request, you must send the `orderFormId` through the URL address, as shown in the example below:\n\n`https://{accountName}.{environment.com.br}/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a/attachments/clientPreferencesData`\n\nAdditionally, you need to send the request body containing the following customer preferences information:\n\n* `locale`: Defines the website language chosen by the customer (e.g. PT, EN, ES).\n* `optinNewsLetter`: Indicates if the customer subscribed to the store newsletter.\n\nSee a request body example below:\n\n`1\n\n{ \n\n2\n\n \"locale\": \"EN\", \n\n3\n\n \"optinNewsLetter\": true \n\n4\n\n} \n\n`\n\nAfter sending the request, the endpoint will return the response body containing the client preferences information in the shopping cart, as in the example below:\n\n`1\n\n... \n\n2\n\n\"clientPreferencesData\": { \n\n3\n\n \"locale\": \"EN\", \n\n4\n\n \"optinNewsLetter\": true \n\n5\n\n } \n\n6\n\n... \n\n`\n\n> ️ For more information on each field available in the shopping cart, see the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) overview.\n\n## Error code\n\nThe following errors may appear as a message in the response body.\n\n### 400 - Bad Request\n\n* **Message error example (code ORD002)**: `\"Invalid order form\"`. The `orderFormId` information is not valid.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"ORD002\", \n\n5\n\n \"message\": \"Invalid order form\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"5d9f54e6-7db4-46d6-bca9-deeb278b8b98\" \n\n9\n\n} \n\n`\n\n### 404 - Not Found\n\n* **Message error example**: `\"The requested URL was not found on the server\"`: Check if the URL 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\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/GeorgeLimaDev)\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/cart-attachments-section-quick-start-guides/add-customer-preferences-to-the-cart.md)\n\n[Add shipping address and select delivery option« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart//docs/guides/add-shipping-address-and-delivery-option-to-the-cart)[Adding marketing information to the cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart//docs/guides/add-marketing-information-to-the-cart)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/GeorgeLimaDev)\n\nON THIS PAGE\n\n[Getting shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23getting-shopping-cart-information)\n\n[Adding customer preferences to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23adding-customer-preferences-to-the-shopping-cart)\n\n[Error code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23error-code)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23404-not-found)\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/cart-attachments-section-quick-start-guides/add-customer-preferences-to-the-cart.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Getting shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23getting-shopping-cart-information)\n\n[Adding customer preferences to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23adding-customer-preferences-to-the-shopping-cart)\n\n[Error code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23error-code)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23404-not-found)\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_104ef87d
|
[
{
"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 apps vtexventures.personal shopper free 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/vtexventures.personal-shopper-free/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/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/vtexventures.personal-shopper-free/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/vtexventures.personal-shopper-free/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/vtexventures.personal-shopper-free/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/vtexventures.personal-shopper-free/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/vtexventures.personal-shopper-free/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/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/vtexventures.personal-shopper-free/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/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/vtexventures.personal-shopper-free/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/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/vtexventures.personal-shopper-free/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/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/vtexventures.personal-shopper-free/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/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/vtexventures.personal-shopper-free/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/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/vtexventures.personal-shopper-free/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/vtexventures.personal-shopper-free/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/guides/advanced-components)\n\nPersonal Shopper\n\nOfficial extension\n\nVersion: 0.15.0\n\nLatest version: 0.15.0\n\n**Personal Shopper** is a platform that allows businesses to host live shopping sessions in the store, enabling real-time interaction with customers. During these sessions, a personal shopper can showcase products, answer questions, and add products to the customer's cart. This interactive shopping experience is designed to engage customers, increase sales, and build brand loyalty.\n\n> Personal Shopper is designed for sellers who want to show new collections to high-value customers or B2B clients. These customized live sessions are intended to provide a more personalized shopping experience than public [Live Shopping](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-live-shopping-getting-started--3eCHNCIx8XhZOSmX0sQT3U).\n\nThe Personal Shopper app is compatible with desktop and mobile devices.\n\n|  |  |\n| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| Personal Shopper on mobile | Personal Shopper on desktop |\n\nDuring a live in the Personal Shopper app, the personal shopper and the customers have access to various features and functionalities. Here are some of the key features and their respective availability for personal shoppers and customers:\n\n| Feature | Description | Advisor | Customer |\n| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | -------- |\n| Camera and microphone settings | Control the camera and microphone settings to turn them on or off during the call. | ✅ | ✅ |\n| Share live link | Share the live link with others to enable additional participants to join the conversation. | ✅ | ✅ |\n| Screen sharing | Share screens to allow participants to view the entire screen or specific applications. | ✅ | ❌ |\n| Chat | Communicate through text messages to exchange information and facilitate real-time conversation. | ✅ | ✅ |\n| File sharing | Send files during the call to enable the sharing of relevant documents or images. | ✅ | ✅ |\n| Search for specific products and provide recommendations to the customer. | This allows the shopper to immediately add the recommended products to the cart and complete the purchase seamlessly within the same process. | ✅ | ❌ |\n| Satisfaction survey | Complete a survey to provide feedback on the call experience, ensuring service quality and gathering valuable insights for improvement. | ❌ | ✅ |\n| Product highlight and add to cart | When an advisor sends a product, customers can add it to their cart immediately, selecting any variations within the same modal, with a notification confirming it was added. | ❌ | ✅ |\n| Picture in Picture | When the customer clicks the Picture in Picture icon, the sales associate's image appears in a smaller window. This allows the customer to browse the website while keeping the advisor visible. | ❌ | ✅ |\n\nPersonal Shopper is available in the following languages: English, Spanish, Portuguese and Catalán.\n\nTo get started, follow this guide to install the Personal Shopper app in your VTEX environment.\n\n## Before you begin\n\nPersonal Shopper is a paid app with different subscription plans: **Standard** and **Pro**. The subscription cost depends on your chosen plan, with each providing a specific number of monthly live stream minutes.\n\n> For more information about plans and pricing, see the [Personal Shopper page](https://read.calvincode.net/reader?url=https://vtex.com/us-en/personal-shopper/).\n\nFinally, before proceeding with this guide, you must install VTEX IO CLI on your machine. For more information, check the guide [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).\n\n## Installation\n\nTo install the Personal Shopper app, follow the steps below.\n\n> We recommend creating a workspace. Otherwise, it will be installed in the main workspace by default.\n\n### Prerequisites\n\n* It is necessary to have the CLI VTEX. Go to the next documentation for install it: [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### Initial Steps for VTEX IO and VTEX CMS/Headless accounts\n\n1. Open the terminal and log in to your VTEX account using VTEX IO CLI.\n2. Install the Personal Shopper app by running the following command: \n`1 \nvtex install vtexventures.personal-shopper-free \n`\n\n---\n\n### **For VTEX IO**\n\n1. In the `manifest.json` file, add the Personal Assistant app to the list of peer dependencies for the theme: \n`1 \n \"peerDependencies\": { \n2 \n \"vtexventures.personal-shopper-free\": \"0.x\" \n3 \n } \n`\n2. Add the `pa-widget` block to display a call-to-action button in the page. For example:\n* Product Details Page (PDP) (`product.json`):\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [\"pa-widget\"] \n\n4\n\n } \n\n5\n\n} \n\n`\n\n* Home page (`home.json`):\n\n`1\n\n{ \n\n2\n\n \"store.home\": { \n\n3\n\n \"blocks\": [\"pa-widget\"] \n\n4\n\n } \n\n5\n\n} \n\n`\n\n1. Deploy your changes to the Store Theme app by publishing a **major version**. For details, refer to the guide: [Making Your New App Version Publicly Available](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-making-your-new-app-version-publicly-available).\n\n> **Note**: Adding a new peer dependency to the Store Theme app requires deploying a new major version of the app. After making the changes, publish this new major version and install it in a productive workspace (not master) to ensure it works as expected before deploying it to the live environment.\n\n1. In the productive workspace, follow the guide [Migrating CMS Settings After a Major Update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update) to update the content for the new version. \n> Note: Proceed with caution to avoid deleting store content..\n2. Validate the workspace and confirm the configured content. Once ready, promote the workspace to master (it will be automatically deleted after promotion).\n\n---\n\n### **For VTEX CMS/Headless**\n\nNote: Wherever you find {{nameOfTheAccount}} you must replace it with the name of the account/store.\n\n1. Add global script.\n\nLoad the following script in a global place on the page, it must be executed only once. A valid example is in the commonScripts template.\n\n`1\n\n<script \n\n2\n\n type=\"module\" \n\n3\n\n id=\"pa-widget-script\" \n\n4\n\n src=\"https://cdn-personalshopper.nizza.com/widget-script/prod/pa-ws-index.js?account={{nameOfTheAccount}}\" \n\n5\n\n></script> \n\n`\n\n\n\n1. Add widget button on the home or product detail page (PDP).\n\nAdd the web-component **`<pa-widget-legacy></pa-widget-legacy>`** in the home or pdp.\n\n`1\n\n<pa-widget-legacy></pa-widget-legacy> \n\n`\n\n* Home page: \n\n* PDP page: \n\n\n---\n\n### Latest Steps for VTEX IO and VTEX CMS/Headless accounts\n\n### UI Admin\n\n**Configure Personal Assistant Setting**\n\nIn VTEX admin Navigate to: **Personal Shopper > Settings > Personal Shopper Setup > General Settings.**\n\nThe following fields need to be configured:\n\n* **URL Client:** This is the public domain of your store. Example: <https://www.your-store.com/>.\n* **Store Name:** This is the name of your store. It must be configured because it is associated with the emails sent to customers and personal shoppers. Example: Your Store Name.\n\n[PayPal Checkout with Smart Payment Buttons« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.connector-paypal-commerce-platform)[Product AvailabilityNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtex.product-availability)\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[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtexventures.personal-shopper-free%23before-you-begin)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtexventures.personal-shopper-free%23installation)\n\n[Prerequisites](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtexventures.personal-shopper-free%23prerequisites)[Initial Steps for VTEX IO and VTEX CMS/Headless accounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtexventures.personal-shopper-free%23initial-steps-for-vtex-io-and-vtex-cmsheadless-accounts)[For VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtexventures.personal-shopper-free%23for-vtex-io)[For VTEX CMS/Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtexventures.personal-shopper-free%23for-vtex-cmsheadless)[Latest Steps for VTEX IO and VTEX CMS/Headless accounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtexventures.personal-shopper-free%23latest-steps-for-vtex-io-and-vtex-cmsheadless-accounts)[UI Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.personal-shopper-free/docs/apps/vtexventures.personal-shopper-free%23ui-admin)\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_cda628e8
|
[
{
"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 ProductSummaryDescription 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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/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/ProductSummaryDescription/docs/vtex-io-apps)\n\nProduct Summary Description\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\nProduct Summary Description is a block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-summary) responsible for rendering the description of the product.\n\n\n\n## Configuration\n\n1. Import the `vtex.product-summary` app to your theme's dependencies in the `manifest.json`:\n\n`1\n\n dependencies: { \n\n2\n\n \"vtex.product-summary\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-summary-description` block to your store theme as a child of `product-summary.shelf`. For example:\n\n`1\n\n \"product-summary.shelf\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"product-summary-image\", \n\n4\n\n \"product-summary-name\", \n\n5\n\n+ \"product-summary-description\", \n\n6\n\n \"product-summary-attachment-list\", \n\n7\n\n \"product-summary-space\", \n\n8\n\n \"product-summary-column#1\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\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| description |\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/ProductSummaryDescription/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[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryDescription/docs/apps/vtex.product-summary@2.91.0/ProductSummaryDescription%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryDescription/docs/apps/vtex.product-summary@2.91.0/ProductSummaryDescription%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_390cd178
|
[
{
"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 features regionalization 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/features-regionalization/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/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/features-regionalization/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/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/features-regionalization/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/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/features-regionalization/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/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/features-regionalization/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/features-regionalization/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/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/features-regionalization/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/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/features-regionalization/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/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/features-regionalization/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/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/features-regionalization/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/storefront-features-overview)\n\nImplementing regionalization features\n\nThis feature enables customers to set a location using a valid Postal Code.\n\nRegionalization is a feature of [VTEX Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/3qgT47zY08biLP3d5os3DG) that optimizes search results according to the availability of sellers in the customer's region.\n\nRegionalization uses a behavior from VTEX Intelligent Search called [Availability](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/7LMQbWK5nElIkXo0NK8Kux). It searches for products available in the inventory of sellers that serve a particular region.\n\nStores that have more than one registered white-label seller usually have specific inventories for each region. This is the case for supermarkets, for example.\n\nWith the Regionalization feature enabled, if a customer enters their Postal Code while browsing the store (before checkout), only products available in the corresponding region will be displayed in the search results.\n\n---\n\n## Usage\n\n1. Intentionally, a user sets its location using a postal code.\n2. Updates product catalog.\n3. Gets notified if there's a product conflict at Minicart.\n\n---\n\n## Components\n\n* Region Bar \nThe RegionBar is a custom Button, usually used on mobile devices only. It should trigger the RegionModal. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/molecules-region-bar)\n* Open Region Modal \nRegion Modal \nA modal with region configurations. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/organisms-region-modal)\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/implementing-regionalization-features.mdx)\n\n[Displaying content for authenticated users« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)[Implementing search featuresNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/storefront-features-implementing-search-features)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/storefront-features-implementing-regionalization-features%23usage)\n\n[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/storefront-features-implementing-regionalization-features%23components)\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/implementing-regionalization-features.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/features-regionalization/docs/guides/faststore/storefront-features-implementing-regionalization-features%23usage)\n\n[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization/docs/guides/faststore/storefront-features-implementing-regionalization-features%23components)\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_202c4883
|
[
{
"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 curbside pickup 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.curbside-pickup/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/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.curbside-pickup/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.curbside-pickup/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.curbside-pickup/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.curbside-pickup/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.curbside-pickup/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/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.curbside-pickup/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.curbside-pickup/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/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.curbside-pickup/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.curbside-pickup/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.curbside-pickup/docs/vtex-io-apps)\n\nCurbside Pickup\n\nOfficial extension\n\nVersion: 0.3.12\n\nLatest version: 0.3.12\n\n[](#contributors-)\n\nThe Curbside Pickup app allows shoppers and store staff to coordinate curbside pickup orders through email notifications.\n\n\n\n## Configuration\n\n### Step 1 - Installing the Curbside Pickup app\n\nUsing your terminal and [VTEX IO Toolbelt](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/vtex-io-cli-installation-and-command-reference/%23command-reference), log in to the VTEX account you are working on and [install](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/store/installing-an-app) the `vtex.curbside-pickup@0.x` app.\n\n### Step 2 - Defining the app settings\n\nIn your VTEX account's admin, perform the following actions:\n\n1. Access the **Apps** section and then **My Apps**.\n2. Select the **Curbside Pickup** app box.\n3. Enter your [app key and token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/getting-started-authentication%23creating-the-appkey-and-apptoken) in the `App Key` and `App Token` fields.\n\n\n\n1. Access **Inventory & shipping** and then **Pickup points**.\n2. For each of your pickup point store locations, enter the store's email address in the **Address Line 2** field. The Curbside Pickup app will use this email to send the store pickup notifications.\n\n> If the `Address Line 2` field is not available for you, use the `complement` field instead.\n\n1. Access the new admin's **Curbside Pickup** section, immediately below Inventory & shipping.\n2. In the box titled `Almost There`, click on the **PROCEED** button. This will initialize the order notification hook needed by the app and will create the following email templates:\n* `curbside-ready-for-packing` \\- Sent to the store's email address (the one from step 5) when a curbside order is ready for handling.\n* `curbside-package-ready` \\- Sent to the shopper when the order is ready to be picked up.\n* `curbside-at-location` \\- Sent to the store's email address when the shopper has arrived at the pickup location.\n\nOnce the email templates are created, you may customize them as you see fit. Follow the links to the templates from the Curbside Pickup page, or navigate to `Message center > Templates` from your admin dashboard sidebar.\n\n## Modus Operandi\n\nWhen a pickup order has reached the `Ready For Handling` state, the Curbside Pickup adds a comment to the order timeline stating that the curbside pickup process has begun and sends an email to the staff of the physical store where the order will be picked up.\n\nThis email contains a link that the store staff can click on when the order is packed and ready to be picked up.\n\nClicking on the link will add another comment to the order timeline and trigger a second email to be sent to the shopper, notifying them that their order is ready to be picked up.\n\nThis email also contains a link that the shopper can click on once they have arrived at the store.\n\nClicking on the link will add a comment to the order timeline and trigger a third email to be sent to the store staff informing them that the shopper has arrived and they should bring the order out to their car.\n\nThis email, in turn, contains a link that the store staff should click after having handed the order to the shopper.\n\nWhen the store staff clicks on the link stating that the order has been handed off, the order timeline will be updated with a comment to that effect, completing the curbside pickup process and allowing the order to be invoiced as usual.\n\n## Customization\n\nNo CSS Handles are available yet for the app customization.\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.curbside-pickup/docs/apps/vtex.curbside-pickup%23configuration)\n\n[Step 1 - Installing the Curbside Pickup app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/apps/vtex.curbside-pickup%23step-1-installing-the-curbside-pickup-app)[Step 2 - Defining the app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/apps/vtex.curbside-pickup%23step-2-defining-the-app-settings)\n\n[Modus Operandi](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/apps/vtex.curbside-pickup%23modus-operandi)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.curbside-pickup/docs/apps/vtex.curbside-pickup%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_49a739a4
|
[
{
"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 creating an institutional page with content types 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/creating-an-institutional-page-with-content-types-1/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-an-institutional-page-with-content-types-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/creating-an-institutional-page-with-content-types-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/creating-an-institutional-page-with-content-types-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/creating-an-institutional-page-with-content-types-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/creating-an-institutional-page-with-content-types-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/creating-an-institutional-page-with-content-types-1/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-an-institutional-page-with-content-types-1/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-an-institutional-page-with-content-types-1/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-an-institutional-page-with-content-types-1/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-an-institutional-page-with-content-types-1/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-an-institutional-page-with-content-types-1/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-an-institutional-page-with-content-types-1/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-an-institutional-page-with-content-types-1/updates/release-notes)\n\nCreating an institutional page with Content types\n\nContent types are templates that structure your documents. They can be pages, publications, articles, events, products, and any other type of content that you want to insert into your project. You can also use them in the CMS to create an institutional page.\n\nTo create an institutional page, follow these instructions.\n\n## Instructions\n\n1. Define the components of your page. In the example below, we use the `ww.vtex.com` page and its title, partners, highlights, and carousel components.\n\n\n\n1. In the cms folder, go to the `content-types.json` file.\n\n\n\n1. In the `content-type.json` file, create a new content type. To do this, define the following information: \n * `id`: content type ID. It is recommended to have a lowercase pattern with no spaces, like with URLs. \n * `name`: name that will be displayed on the page. \n * `configurationSchemaSets`: extra blocks that will configure the page, such as menu settings and slug blocks, for example. \ncontent-type.json \n`1 \n{ \n2 \n \"id\": \"landing\", \n3 \n \"name\": \"Landing Page\", \n4 \n \"configurationSchemaSets\": [] \n5 \n} \n`\n2. Determine the page sections in the `section.json` file. To define the sections, duplicate an existing one and edit it with the new names and descriptions you want on your page. \nsection.json \n`1 \n{ \n2 \n “name” “Hero”, \n3 \n “schema”: { \n4 \n “title” “Hero”, \n5 \n “description”: “Add a quick promotion with an image/action pair”, \n6 \n “type”: “object”, \n7 \n “properties”: { \n8 \n “title”: { \n9 \n “type”: “string” \n10 \n }, \n11 \n “subtitle”: { \n12 \n “type”: “string” \n13 \n }, \n14 \n “linkText”: { \n15 \n “type”: “string”, \n16 \n “title”: “Link text” \n17 \n }, \n18 \n “link”: { \n19 \n “type”: “string”, \n20 \n “title”: “Link path” \n21 \n }, \n22 \n “ImageSrc”: { \n23 \n “type”: “string”, \n24 \n “title”: “Image”, \n25 \n “widget”: { \n26 \n “ui:widget”: image-uploader \n27 \n }, \n28 \n “Imagealt”: { \n29 \n “Type”: “string”, \n30 \n “title”: “Alt text” \n31 \n } \n32 \n } \n33 \n } \n34 \n } \n35 \n} \n` \n> ️ These fields are the structure of your page. Complete them based on what was defined in step one of this guide.\n3. After defining the sections, save them. If you want to view the draft, go to the repository for testing. 6\\. Go to the store to view the final version of your page.\n\n## Learn More\n\n* [Setting up the VTEX Headless CMS in your FastStore project](https://read.calvincode.net/reader?url=https://www.faststore.dev/tutorials/cms/2%23step-2---syncing-your-changes)\n* [Adding Content Types and Sections to the VTEX Headless CMS](https://read.calvincode.net/reader?url=https://www.faststore.dev/tutorials/cms/3)\n* [Querying the CMS data](https://read.calvincode.net/reader?url=https://www.faststore.dev/tutorials/cms/4)\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/creating-an-institutional-page-with-content-types-1.md)\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/creating-an-institutional-page-with-content-types-1/docs/guides/creating-an-institutional-page-with-content-types-1%23instructions)\n\n[Learn More](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-an-institutional-page-with-content-types-1/docs/guides/creating-an-institutional-page-with-content-types-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/vtex-io/Storefront-Guides/concepts-1/creating-an-institutional-page-with-content-types-1.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/creating-an-institutional-page-with-content-types-1/docs/guides/creating-an-institutional-page-with-content-types-1%23instructions)\n\n[Learn More](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-an-institutional-page-with-content-types-1/docs/guides/creating-an-institutional-page-with-content-types-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_9095cce1
|
[
{
"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 search control fulltextsearchbox 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/search-control-fulltextsearchbox/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/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/search-control-fulltextsearchbox/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/search-control-fulltextsearchbox/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/search-control-fulltextsearchbox/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/search-control-fulltextsearchbox/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/search-control-fulltextsearchbox/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/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/search-control-fulltextsearchbox/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/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[How search parameters work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/how-search-parameters-work)\n\n[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/search-control-fulltextsearchbox)\n\n[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/consult-store-search-terms-information)\n\n[Consult product search information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/consult-product-search-information)\n\n[Get banner list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/get-banner-list-for-a-specific-search)\n\n[Get a list of the possible facets for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)\n\n[Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/vtex-io-documentation-segmenting-the-search-result)\n\n[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/access-control-list)\n\n[Delivery promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/delivery-promise-for-headless-stores)\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/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/search-control-fulltextsearchbox/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/search-control-fulltextsearchbox/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/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/search-control-fulltextsearchbox/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/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[How search parameters work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/how-search-parameters-work)\n\n[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/search-control-fulltextsearchbox)\n\n[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/consult-store-search-terms-information)\n\n[Consult product search information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/consult-product-search-information)\n\n[Get banner list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/get-banner-list-for-a-specific-search)\n\n[Get a list of the possible facets for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)\n\n[Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/vtex-io-documentation-segmenting-the-search-result)\n\n[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/access-control-list)\n\n[Delivery promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/delivery-promise-for-headless-stores)\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/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/search-control-fulltextsearchbox/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/search-control-fulltextsearchbox/docs/guides)\n\nSearch\n\n[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/search-control-fulltextsearchbox)\n\nSearch Control – fulltextSearchBox\n\nThe `<vtex.cmc:fullTextSearchBox />` control is responsible for generating the search box for [VTEX Legacy CMS Portal](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj). This control includes a search input field and a dropdown for restricting searches to specific departments. Below is an example of the control without any applied CSS styling:\n\n\n\n> VTEX offers two search solutions: VTEX Search and VTEX Intelligent Search. This guide specifically covers VTEX Search. For more information on VTEX Intelligent Search, refer to [this track](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb).\n\nSearch functionality is a crucial feature that should be accessible on all store pages. As a best practice, include this control in a [subtemplate](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/subtemplates--tutorials%5F577) within the store's header.\n\n## HTML rendered by the control\n\nThe `fullTextSearchBox` control generates the following HTML structure:\n\n`1\n\n<fieldset class=\"busca\"> \n\n2\n\n <legend>Buscar no site</legend> \n\n3\n\n <label>Buscar</label> \n\n4\n\n <select id=\"ftDept4aceafb578de4c7caf31e06bcc8d45b9\"> \n\n5\n\n <option value=\"\">Todo o site</option> \n\n6\n\n <option value=\"1000000\">Integracao</option> \n\n7\n\n <option value=\"1\">Eletrodomésticos</option> \n\n8\n\n <option value=\"3\">Moda</option> \n\n9\n\n </select> \n\n10\n\n <input type=\"hidden\" id=ftIdx4aceafb578de4c7caf31e06bcc8d45b9 value=\"\" /> \n\n11\n\n <input id=\"ftBox4aceafb578de4c7caf31e06bcc8d45b9\" class=\"fulltext-search-box\" type=\"text\" size=\"20\" accesskey=\"b\" /> \n\n12\n\n <input id=\"ftBtn4aceafb578de4c7caf31e06bcc8d45b9\" type=\"button\" value=\"Buscar\" class=\"btn-buscar\" /> \n\n13\n\n</fieldset> \n\n`\n\n## Autocomplete feature\n\nThe `fullTextSearchBox` control includes a built-in autocomplete feature, which activates when a user types at least three characters in the search field. Customizing the autocomplete requires applying your own CSS. Below is an example of the HTML output for autocomplete:\n\n`1\n\n<ul class=\"ui-autocomplete ui-menu ui-widget ui-widget-content ui-corner-all\" role=\"listbox\" aria-activedescendant=\"ui-active-menuitem\" style=\"z-index: 10; top: -3334px; left: 667.5px; display: none; position: relative; width: 507px;\"> \n\n2\n\n <li class=\"ui-menu-item\" role=\"menuitem\"><a class=\"ui-corner-all\" tabindex=\"-1\">adidas em Modelos</a></li> \n\n3\n\n <li class=\"ui-menu-item\" role=\"menuitem\"><a class=\"ui-corner-all\" tabindex=\"-1\">adidas em Tênis</a></li> \n\n4\n\n <li class=\"ui-menu-item\" role=\"menuitem\"><a class=\"ui-corner-all\" tabindex=\"-1\">adidas em Lançamentos</a></li> \n\n5\n\n <li class=\"ui-menu-item\" role=\"menuitem\"><a class=\"ui-corner-all\" tabindex=\"-1\">adidas em Masculino</a></li> \n\n6\n\n <li class=\"ui-menu-item\" role=\"menuitem\"> \n\n7\n\n <a class=\"ui-corner-all\" tabindex=\"-1\"> \n\n8\n\n <img src=\"http://www.authenticfeet.com.br/arquivos/ids/188460-25-25/Mini-Bola-Brazuca-WC-14-Glider.jpg\" width=\"25\" height=\"25\" alt=\"Mini-Bola-Brazuca-WC-14-Glider\" /> minibola adidas brazuca glider - copa do mundo \n\n9\n\n </a> \n\n10\n\n </li> \n\n11\n\n <li class=\"ui-menu-item\" role=\"menuitem\"> \n\n12\n\n <a class=\"ui-corner-all\" tabindex=\"-1\"> \n\n13\n\n <img src=\"http://www.authenticfeet.com.br/arquivos/ids/189014-25-25/Tenis-adidas-Springblade-Feminino.jpg\" width=\"25\" height=\"25\" alt=\"Tenis-adidas-Springblade-Feminino\" /> \n\n14\n\n tênis adidas springblade feminino \n\n15\n\n </a> \n\n16\n\n </li> \n\n17\n\n <li class=\"ui-menu-item\" role=\"menuitem\"> \n\n18\n\n <a class=\"ui-corner-all\" tabindex=\"-1\"> \n\n19\n\n <img src=\"http://www.authenticfeet.com.br/arquivos/ids/188855-25-25/Tenis-adidas-Dynamic-Fusion-50-Feminino.jpg\" width=\"25\" height=\"25\" alt=\"Tenis-adidas-Dynamic-Fusion-50-Feminino\" /> \n\n20\n\n tênis adidas dynamic fusion 50 feminino \n\n21\n\n </a> \n\n22\n\n </li> \n\n23\n\n</ul> \n\n`\n\n## CSS customization examples\n\nThe `fullTextSearchBox` control allows for extensive customization using CSS. Here are some examples:\n\n**Example 1** \n\n\n\n**Example 2** \n\n\n\n**Example 3** \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/Search/search-control-fulltextsearchbox.md)\n\n[How search parameters work« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox//docs/guides/how-search-parameters-work)[Consult store search terms informationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox//docs/guides/consult-store-search-terms-information)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[HTML rendered by the control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/search-control-fulltextsearchbox%23html-rendered-by-the-control)\n\n[Autocomplete feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/search-control-fulltextsearchbox%23autocomplete-feature)\n\n[CSS customization examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/search-control-fulltextsearchbox%23css-customization-examples)\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/Search/search-control-fulltextsearchbox.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[HTML rendered by the control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/search-control-fulltextsearchbox%23html-rendered-by-the-control)\n\n[Autocomplete feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/search-control-fulltextsearchbox%23autocomplete-feature)\n\n[CSS customization examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox/docs/guides/search-control-fulltextsearchbox%23css-customization-examples)\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_c7496b8c
|
[
{
"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 add to cart button 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-add-to-cart-button/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/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-add-to-cart-button/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-add-to-cart-button/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-add-to-cart-button/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-add-to-cart-button/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-add-to-cart-button/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/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/vtex-add-to-cart-button/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/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/vtex-add-to-cart-button/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/vtex-add-to-cart-button/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/basic-components)\n\nAdd To Cart Button\n\nOfficial extension\n\nVersion: 0.31.0\n\nLatest version: 0.31.0\n\n[](#contributors-)\n\nThe `add-to-cart-button` block is designed to add products to the [Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/) (`minicart.v2`).\n\n\n\n> The **Add to Cart** button is only compatible with stores using Minicart v2\\. For these stores, it will function correctly on the Shelf component and the Product Details page. If you are using [Minicart v1](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/minicart/blob/383d7bbd3295f06d1b5854a0add561a872e1515c/docs/README.md), you should configure the [Buy Button block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton) on the Product Details page and the [Product Summary Buy button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton) on the Shelf component instead.\n\n## Configuration\n\n1. Import the `vtex.add-to-cart-button` app to your theme dependencies in the `manifest.json` file, as follows:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.add-to-cart-button\": \"0.x\" \n\n3\n\n} \n\n`\n\n1. Add the `add-to-cart-button` to another theme block using the product context, such as the `product-summary.shelf`. In the example below, the `add-to-cart-button` is added to the `flex-layout.row` block from the `store.product` template, which uses the product context:\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 \"add-to-cart-button\" \n\n9\n\n ] \n\n10\n\n } \n\n`\n\n| Prop name | Type | Description | Default value |\n| ----------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |\n| onClickBehavior | enum | Controls what happens when users click the button. Possible values are: go-to-product-page, add-to-cart, ensure-sku-selection (if multiple SKUs are available, users will be redirected to the product page to select the desired one. If the product only has 1 SKU available, it will be automatically added to the cart when the button is clicked) and add-to-cart-and-trigger-shipping-modal (opens a modal for ZIP code input if none is provided; otherwise, it adds the item to the cart. See more in [vtex.shipping-option-components](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/shipping-option-components)). | add-to-cart |\n| onClickEventPropagation | enum | Controls whether the 'onClick' event, triggered upon user clicks, should propagate to the parent elements of the page. Possible values are: disabled and enabled. | disabled |\n| isOneClickBuy | boolean | Determines whether the user should be redirected to the checkout page (true) or not (false) when the **Add to Cart** button is clicked. | false |\n| customOneClickBuyLink | string | Defines the link to which users will be redirected when the **Add to Cart** button is clicked, and the isOneClickBuy prop is set to true. | /checkout/#/cart |\n| customToastUrl | string | Defines the link to which users will be redirected when the toast (pop-up notification displayed when adding an item to the minicart) is clicked. | /checkout/#/cart |\n| text | string | Defines a custom text message to be displayed on the **Add to Cart** button. | Add to cart _(automatic translation will be applied following your store default language)_ |\n| unavailableText | string | Defines a custom text message to be displayed on the **Add to Cart** button when a product is unavailable. | Unavailable _(automatic translation will be applied following your store default language)_ |\n| customPixelEventId | string | Defines the id for the event that the button will send upon user interaction. | undefined |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, 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 Handles |\n| ------------------- |\n| buttonText |\n| buttonDataContainer |\n| tooltipLabelText |\n\n[Basic components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/guides/basic-components)[AutocompleteNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.search/Autocomplete)\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/guides/vtex-add-to-cart-button/docs/apps/vtex.add-to-cart-button%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/docs/apps/vtex.add-to-cart-button%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_eb391d49
|
[
{
"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 payment data mercado libre orders 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/get-payment-data-mercado-libre-orders-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-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/get-payment-data-mercado-libre-orders-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/get-payment-data-mercado-libre-orders-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/get-payment-data-mercado-libre-orders-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/get-payment-data-mercado-libre-orders-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/get-payment-data-mercado-libre-orders-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/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-payment-data-mercado-libre-orders-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/actions-orders)\n\n[Fetching marketplace information with the Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/get-marketplace-data-orders-api)\n\n[Fetching payment details from a Mercado Libre order with Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/get-payment-data-mercado-libre-orders-api)\n\n[Formatting order invoicing time via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/formatting-order-invoicing-time)\n\n[Using VTEX Admin filters on orders via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/using-orders-management-filters-in-api)\n\n[Adding a second address for invoicing an order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/adding-a-second-address-to-the-order)\n\nSubscriptions\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-payment-data-mercado-libre-orders-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-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/get-payment-data-mercado-libre-orders-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/get-payment-data-mercado-libre-orders-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/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-payment-data-mercado-libre-orders-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/actions-orders)\n\n[Fetching marketplace information with the Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/get-marketplace-data-orders-api)\n\n[Fetching payment details from a Mercado Libre order with Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/get-payment-data-mercado-libre-orders-api)\n\n[Formatting order invoicing time via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/formatting-order-invoicing-time)\n\n[Using VTEX Admin filters on orders via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/using-orders-management-filters-in-api)\n\n[Adding a second address for invoicing an order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/adding-a-second-address-to-the-order)\n\nSubscriptions\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-payment-data-mercado-libre-orders-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-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/get-payment-data-mercado-libre-orders-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/get-payment-data-mercado-libre-orders-api/docs/guides)\n\nOrders\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/actions-orders)\n\n[Fetching payment details from a Mercado Libre order with Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/get-payment-data-mercado-libre-orders-api)\n\nFetching payment details from a Mercado Libre order with Orders API\n\nWhen [setting up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration) for your ERP middleware or similar integration, you may need additional payment details from orders placed in external marketplaces.\n\nThis article explains where our [native Mercado Libre connector](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tracks/mercado-libre-integration-set-up--2YfvI3Jxe0CGIKoWIGQEIq/51oWBHvVxSs8eAwLQhSbSd) stores this information in the orderForm data structure and how to fetch this data for your integration.\n\n## Understanding customData\n\nCheckout API allows integrators to [create customizable fields in the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order%23creating-apps-and-fields-through-the-configuration-request) through the `customData` object. Their middleware can create extra fields in the orderForm and set the value of each of these fields when placing an order, so that this additional information can be retrieved when fetching order details with Orders API.\n\n## Custom fields created by Mercado Libre connector\n\nOur native Mercado Libre connector leverages this functionality to add custom fields to orders, as seen in the code snippet below. Note: the actual orders data structure is much larger - we are omitting everything else and highlighting only `customData` in this example.\n\n`1\n\n{ \n\n2\n\n ... \n\n3\n\n \"customData\": { \n\n4\n\n \"customApps\": [ \n\n5\n\n { \n\n6\n\n \"fields\": { \n\n7\n\n \"orderIdMarketplace\": \"4113970696\", \n\n8\n\n \"paymentIdMarketplace\": \"12040787637\", \n\n9\n\n \"authorization_code\": \"1234567\", \n\n10\n\n \"currency_id\": \"BRL\", \n\n11\n\n \"first_six_digits\": \"0\", \n\n12\n\n \"installments\": \"1\", \n\n13\n\n \"last_four_digits\": \"0\", \n\n14\n\n \"payment_method_id\": \"hipercard\", \n\n15\n\n \"payment_type\": \"credit_card\" \n\n16\n\n }, \n\n17\n\n \"id\": \"marketplace-integration\", \n\n18\n\n \"major\": 1 \n\n19\n\n } \n\n20\n\n ] \n\n21\n\n }, \n\n22\n\n ... \n\n23\n\n} \n\n`\n\nThe table below lists the `customData` fields created by the Mercado Libre connector.\n\n| Field | Description |\n| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| orderIdMarketplace | Order identifier in Mercado Libre |\n| paymentIdMarketplace | Payment identifiers in Mercado Libre |\n| authorization\\_code | Authorization code for Mercado Libre payments |\n| currency\\_id | [ISO 4127](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/ISO%5F4217) currency code |\n| first\\_six\\_digits | [Issuer Identification Number (IIN)](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/Payment%5Fcard%5Fnumber%23Issuer%5Fidentification%5Fnumber%5F%28IIN%29) of credit cards used in Mercado Libre payments |\n| installments | Number of installments for Mercado Libre order |\n| last\\_four\\_digits | Last four digits of credit cards used in Mercado Libre payments |\n| payment\\_method\\_id | Payment method identifier in Mercado Libre |\n| payment\\_type | Payment type identifier in Mercado Libre |\n\n> The default value returned is `0` if the payment method does not offer any data for `authorization_code`, `first_six_digits`, `last_four_digits`\n\n## Multiple payments\n\nIf there is an order that was payed for with more than one payment method, the data returned by [Mercado Libre's Orders API](https://read.calvincode.net/reader?url=https://developers.mercadolivre.com.br/en%5Fus/manage-sales%23How-can-I-know-if-there-are-two-payments) is split by vertical bars (`|`) in the following fields:\n\n* `paymentIdMarketplace`\n* `authorization_code`\n* `first_six_digits`\n* `last_four_digits`\n* `payment_method_id`\n* `payment_type`\n\n`1\n\n{ \n\n2\n\n ... \n\n3\n\n \"customData\": { \n\n4\n\n \"customApps\": [ \n\n5\n\n { \n\n6\n\n \"fields\": { \n\n7\n\n \"orderIdMarketplace\": \"893431118\", \n\n8\n\n \"paymentIdMarketplace\": \"885920310 | 885920410\", \n\n9\n\n \"authorization_code\": \"008877 | 211118\", \n\n10\n\n \"currency_id\": \"BRL\", \n\n11\n\n \"first_six_digits\": \"402360 | 512106\", \n\n12\n\n \"installments\": \"1\", \n\n13\n\n \"last_four_digits\": \"1001 | 2002\", \n\n14\n\n \"payment_method_id\": \"visa | master\", \n\n15\n\n \"payment_type\": \"credit_card | credit_card\" \n\n16\n\n }, \n\n17\n\n \"id\": \"marketplace-integration\", \n\n18\n\n \"major\": 1 \n\n19\n\n } \n\n20\n\n ] \n\n21\n\n }, \n\n22\n\n ... \n\n23\n\n} \n\n`\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/Orders/actions-orders/get-payment-data-mercado-libre-orders-api.md)\n\n[Fetching marketplace information with the Orders API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api//docs/guides/get-marketplace-data-orders-api)[Formatting order invoicing time via APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api//docs/guides/formatting-order-invoicing-time)\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Understanding customData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/get-payment-data-mercado-libre-orders-api%23understanding-customdata)\n\n[Custom fields created by Mercado Libre connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/get-payment-data-mercado-libre-orders-api%23custom-fields-created-by-mercado-libre-connector)\n\n[Multiple payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/get-payment-data-mercado-libre-orders-api%23multiple-payments)\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/Orders/actions-orders/get-payment-data-mercado-libre-orders-api.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Understanding customData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/get-payment-data-mercado-libre-orders-api%23understanding-customdata)\n\n[Custom fields created by Mercado Libre connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/get-payment-data-mercado-libre-orders-api%23custom-fields-created-by-mercado-libre-connector)\n\n[Multiple payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-payment-data-mercado-libre-orders-api/docs/guides/get-payment-data-mercado-libre-orders-api%23multiple-payments)\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_72d47c3d
|
[
{
"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 add service to the cart 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/add-service-to-the-cart/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/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/add-service-to-the-cart/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/add-service-to-the-cart/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/add-service-to-the-cart/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/add-service-to-the-cart/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/add-service-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/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/add-service-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Simulate a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/simulate-a-shopping-cart)\n\n[Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/create-a-new-cart)\n\n[Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/get-cart-information-by-id)\n\n[Remove all items from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/remove-all-items-from-cart)\n\n[Remove all personal data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/update-cart-items)\n\n[Change the price of an SKU in a cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/get-cart-installments-information)\n\n[Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/add-coupons-to-the-cart)\n\n[Add a service (offering) to a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/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/add-service-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/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/add-service-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/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/add-service-to-the-cart/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/add-service-to-the-cart/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/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/add-service-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Simulate a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/simulate-a-shopping-cart)\n\n[Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/create-a-new-cart)\n\n[Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/get-cart-information-by-id)\n\n[Remove all items from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/remove-all-items-from-cart)\n\n[Remove all personal data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/update-cart-items)\n\n[Change the price of an SKU in a cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/get-cart-installments-information)\n\n[Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/add-coupons-to-the-cart)\n\n[Add a service (offering) to a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/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/add-service-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/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/add-service-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/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/add-service-to-the-cart/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/add-service-to-the-cart/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/checkout-api-overview)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Add a service (offering) to a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/add-service-to-the-cart)\n\nAdd a service (offering) to a shopping cart\n\nA service, also known as an offering, is an item that may come with a product, optionally and with an additional cost. It is used to assign a value of an additional service to an SKU, as a gift packaging.\n\nYou can add a service to a shopping cart by using the [Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api). To do so, follow the sections below.\n\n## Checking if a cart product has a service attached to it\n\nFirst, you must check if a product has a service available attached to it. This way, you know the options of service you can add to the item in the shopping cart.\n\nYou must use the [Cart simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForms/simulation?endpoint=post-/api/checkout/pub/orderForms/simulation) endpoint and send the `skuId`, `seller` and `quantity` in the request body, as the code example below.\n\n`1\n\n{ \"items\": [ \n\n2\n\n { \n\n3\n\n \"id\": \"30\", \n\n4\n\n \"quantity\": 1, \n\n5\n\n \"seller\": \"1\" \n\n6\n\n } \n\n7\n\n ] \n\n8\n\n} \n\n`\n\nIn the response body, you must check if the `offerings` object presents the following information, as in the example below:\n\n`1\n\n \"offerings\": [ \n\n2\n\n { \n\n3\n\n \"type\": \"Removal of additional old appliance\", \n\n4\n\n \"id\": \"1\", \n\n5\n\n \"name\": \"Removal of additional old appliance\", \n\n6\n\n \"allowGiftMessage\": false, \n\n7\n\n \"attachmentOfferings\": [\"Name\", \"Info\"], \n\n8\n\n \"price\": 2999 \n\n9\n\n } \n\n10\n\n ] \n\n`\n\nIf the `offerings` array presents this information, the SKU has a service associated with it. You will use the `id` value in the next step.\n\n> If you have multiple services associated with the product, all of them will be returned in the `offerings` array.\n\n## Adding a service to a product\n\nYou can add a service to an item in the shopping cart by using the checkout [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields).\n\nTo do so, you must add the item to the cart using the [Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/items) endpoint.\n\nThen, you must send the service `id` from the previous step in the desired `item` by using the request body of the `POST` `https://{accountName}.{environment}.com/api/checkout/pub/orderForm/{orderFormId}/items/{itemPosition}/offerings` request:\n\n`1\n\n{ \n\n2\n\n \"id\": \"1\" \n\n3\n\n} \n\n`\n\nThe expected response is the `orderForm` structure with the `offerings` array with the service information inside it, as the code below:\n\n`1\n\n \"offerings\": [ \n\n2\n\n { \n\n3\n\n \"type\": \"Removal of additional old appliance\", \n\n4\n\n \"id\": \"1\", \n\n5\n\n \"name\": \"Removal of additional old appliance\", \n\n6\n\n \"allowGiftMessage\": false, \n\n7\n\n \"attachmentOfferings\": [\"Name\", \"Info\"], \n\n8\n\n \"price\": 2999 \n\n9\n\n } \n\n10\n\n ] \n\n`\n\n### Adding more than one service to a product\n\nIf you need to add more than a service to a specific product, you must add more units of the product that the service is attached to. To do so, you must follow the steps below:\n\n1. Update the product you want to add the service to have `\"quantity\": 1`. Use the [Handle cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23patch-/api/checkout/pub/orderForm/-orderFormId-/items?endpoint=patch-/api/checkout/pub/orderForm/-orderFormId-/items) endpoint with the following request body:\n\n`1\n\n{ \n\n2\n\n \"orderItems\": [ \n\n3\n\n { \n\n4\n\n \"index\": 0, \n\n5\n\n \"quantity\": 1 \n\n6\n\n } \n\n7\n\n ] \n\n8\n\n} \n\n`\n\n1. Attach the `offering` to the `item` in the shopping cart. Use the `POST` `https://{accountName}.{environment}.com/api/checkout/pub/orderForm/{orderFormId}/items/{itemPosition}/offerings` request as the previous section:\n\n`1\n\n{ \n\n2\n\n \"id\": \"1\" \n\n3\n\n} \n\n`\n\n1. Update the `quantity` back to the previous value, sending the `noSplitItem` field as `true` in the [Handle cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23patch-/api/checkout/pub/orderForm/-orderFormId-/items?endpoint=patch-/api/checkout/pub/orderForm/-orderFormId-/items) endpoint in the request body. This field will make sure the items do not split the configuration, making it possible to have the same `quantity` of products and services.\n\n`1\n\n \"orderItems\": [ \n\n2\n\n { \n\n3\n\n \"index\": 0, \n\n4\n\n \"quantity\": 4 \n\n5\n\n } \n\n6\n\n ], \n\n7\n\n \"noSplitItem\": true \n\n`\n\n## Removing a service (offering) from a shopping cart\n\nTo remove a service (offering), you must use the `POST` `https://{accountName}.{environment}.com/api/checkout/pub/orderForm/{orderFormId}/items/{itemPosition}/offerings/{serviceId}/remove` endpoint with the service `id` in the request body:\n\n`1\n\n{ \n\n2\n\n \"id\": \"1\" \n\n3\n\n} \n\n`\n\nThe expected response is the `orderForm` structure with the `offerings` array empty, like the example below:\n\n`1\n\n \"offerings\": [] \n\n`\n\nContributors\n\n1\n\n[](https://github.com/karenkrieger)\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/shopping-cart-section-api-quick-start-guides/add-service-to-the-cart.md)\n\n[Add coupons to the cart« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart//docs/guides/add-coupons-to-the-cart)[Cart AttachmentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart//docs/guides/cart-attachments-section-api-quick-start-guides)\n\nContributors\n\n1\n\n[](https://github.com/karenkrieger)\n\nON THIS PAGE\n\n[Checking if a cart product has a service attached to it](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/add-service-to-the-cart%23checking-if-a-cart-product-has-a-service-attached-to-it)\n\n[Adding a service to a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/add-service-to-the-cart%23adding-a-service-to-a-product)\n\n[Adding more than one service to a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/add-service-to-the-cart%23adding-more-than-one-service-to-a-product)\n\n[Removing a service (offering) from a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/add-service-to-the-cart%23removing-a-service-offering-from-a-shopping-cart)\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/shopping-cart-section-api-quick-start-guides/add-service-to-the-cart.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Checking if a cart product has a service attached to it](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/add-service-to-the-cart%23checking-if-a-cart-product-has-a-service-attached-to-it)\n\n[Adding a service to a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/add-service-to-the-cart%23adding-a-service-to-a-product)\n\n[Adding more than one service to a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/add-service-to-the-cart%23adding-more-than-one-service-to-a-product)\n\n[Removing a service (offering) from a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-service-to-the-cart/docs/guides/add-service-to-the-cart%23removing-a-service-offering-from-a-shopping-cart)\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_b038c0f0
|
[
{
"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 using the fold blocks 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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/store-framework-managing-performance)\n\n[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\n[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-debugging-performance-issues)\n\n[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)\n\n[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n\n[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\n[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\n[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\n[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/store-framework-managing-performance)\n\n[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\n[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-debugging-performance-issues)\n\n[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)\n\n[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n\n[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\n[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\n[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\n[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/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-using-the-fold-blocks/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/store-framework)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/store-framework-managing-performance)\n\n[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\nLazy loading components\n\nIn this guide, you’ll learn how to use the `__fold__` and `__fold__.experimentalLazyAssets` blocks to optimize component loading and improve store performance. Below is an overview of these blocks:\n\n| Block | Description | Instructions |\n| ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |\n| \\_\\_fold\\_\\_ | Determines the loading priority of interface components, and defines which elements load first and which load dynamically as users scroll down the page. | [Using the \\_\\_fold\\_\\_ block](#using-the-fold-block) |\n| \\_\\_fold\\_\\_.experimentalLazyAssets | (Optional) Keeps specified components statically loaded until the user's first interaction, offering additional flexibility in load management. | [(Optional) Using the \\_\\_fold\\_\\_.experimentalLazyAssets block](#optional-using-the-fold-experimentalLazyAssets-block) |\n\nBy implementing these blocks effectively, you can enhance store initial loading time and overall user experience.\n\n## Using the `__fold__` block\n\nAdd the `__fold__` block to any store theme templates you want, such as `store.product` and `store.home`. For example:\n\n`1\n\n\"store.home\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"carousel#home\", \n\n4\n\n+ \"__fold__\", \n\n5\n\n \"shelf#home\", \n\n6\n\n \"info-card#home\", \n\n7\n\n \"rich-text#question\", \n\n8\n\n \"rich-text#link\", \n\n9\n\n \"newsletter\" \n\n10\n\n ] \n\n11\n\n}, \n\n`\n\nIn this configuration:\n\n* Components above `__fold__` (for example, `carousel#home`) will load immediately.\n* Components below `__fold__` (for example, `shelf#home`, `info-card#home`) will load dynamically as the user scrolls.\n\n> Use `__fold__` only on scrollable pages. Non-scrollable pages don’t benefit from this optimization.\n\n### Device-specific configuration\n\nYou can customize scenarios for mobile and desktop modes using `__fold__.mobile` and `__fold__.desktop`:\n\n`1\n\n\"store.home\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"carousel#home\", \n\n4\n\n+ \"__fold__.mobile\", \n\n5\n\n \"shelf#home\", \n\n6\n\n+ \"__fold__.desktop\", \n\n7\n\n \"info-card#home\", \n\n8\n\n \"rich-text#question\", \n\n9\n\n \"rich-text#link\", \n\n10\n\n \"newsletter\" \n\n11\n\n ] \n\n12\n\n}, \n\n`\n\nIn this configuration:\n\n* On mobile, only `carousel#home` loads initially.\n* On desktop, both `carousel#home` and `shelf#home` load initially.\n\n> **SEO considerations:** Google may not index content under the `__fold__` block. Ensure all critical SEO-relevant components are placed above the `__fold__` block.\n\n## (Optional) Using the `__fold__.experimentalLazyAssets` block\n\n> This block is experimental and may cause unexpected effects, such as failing to render an interactive component in the storefront.\n\nAdd the `__fold__.experimentalLazyAssets` above the blocks you want to defer. Consider adding this block to the store homepage for optimal results. For example:\n\n`1\n\n\"store.home\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"carousel\", \n\n4\n\n+ \"__fold__.experimentalLazyAssets\", \n\n5\n\n \"flex-layout.row#homeBrands\", \n\n6\n\n \"flex-layout.row#homeBanner\", \n\n7\n\n \"__fold__\", \n\n8\n\n \"tab-layout#home\", \n\n9\n\n \"tab-layout#home2\", \n\n10\n\n \"carousel#homeFooter\" \n\n11\n\n ] \n\n12\n\n}, \n\n`\n\n> Make sure `__fold__.experimentalLazyAssets` is below interactive components (for example, `carousel`) to avoid rendering or navigation issues.\n\n## Best practices\n\n* **Prioritize above-the-fold content:** Make sure that critical components, such as banners or carousels, are placed above the `__fold__` block so they load quickly and are indexed by search engines.\n* **Optimize for different devices:** Use `__fold__.mobile` and `__fold__.desktop` blocks to adjust the loading sequence based on the device, optimizing the experience for both mobile and desktop users.\n* **Monitor store performance:** Use tools like Google Lighthouse to evaluate the impact of lazy loading and fine-tune your configuration. Learn more in [Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance).\n* **Ensure SEO visibility:** Position essential SEO elements, such as metadata and key textual content, above the `__fold__` block to ensure they are indexed by search engines. Learn more in [SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo).\n* **Use `__fold__.experimentalLazyAssets` carefully:** This block is experimental and may cause rendering or interaction issues. Always test thoroughly before deploying to production.\n* **Lazy load images and product information efficiently:** For scenarios where you need to [lazy load images and product information in a slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings%23manual-optimizations), consider [building a carousel using Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-carousel-using-slider-layout).\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/boosting-performance/vtex-io-documentation-using-the-fold-blocks.md)\n\n[Tracking changes in Lighthouse performance score« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks//docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)[Optimizing image renderingNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks//docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\nSee also\n\n[Enabling performance settingsGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Using the \\_\\_fold\\_\\_ block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-using-the-fold-blocks%23using-the-fold-block)\n\n[Device-specific configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-using-the-fold-blocks%23device-specific-configuration)\n\n[(Optional) Using the \\_\\_fold\\_\\_.experimentalLazyAssets block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-using-the-fold-blocks%23optional-using-the-foldexperimentallazyassets-block)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-using-the-fold-blocks%23best-practices)\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/boosting-performance/vtex-io-documentation-using-the-fold-blocks.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Using the \\_\\_fold\\_\\_ block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-using-the-fold-blocks%23using-the-fold-block)\n\n[Device-specific configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-using-the-fold-blocks%23device-specific-configuration)\n\n[(Optional) Using the \\_\\_fold\\_\\_.experimentalLazyAssets block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-using-the-fold-blocks%23optional-using-the-foldexperimentallazyassets-block)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks/docs/guides/vtex-io-documentation-using-the-fold-blocks%23best-practices)\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_58920237
|
[
{
"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 shippingsimulator 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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/shippingsimulator/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/shippingsimulator/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/shippingsimulator/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/shippingsimulator/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/shippingsimulator/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/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/shippingsimulator/docs/vtex-io-apps)\n\nShipping Simulator\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 `shipping-simulator` block estimates the shipping cost based on a postal code input.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file, as shown 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 `shipping-simulator` 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+ \"shipping-simulator\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n1. Declare the `shipping-simulator` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"shipping-simulator\": { \n\n2\n\n \"props\": { \n\n3\n\n \"skuID\": \"342\" \n\n4\n\n } \n\n5\n\n }, \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| --------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- |\n| pricingMode | enum | Defines how shipping information is displayed when a product includes gifts or attachments. You can choose to group shipping information by type (grouped) or display shipping costs for each item individually (individualItems). | individualItems |\n| seller | String | ID of the product seller. | \\- |\n| shouldUpdateOrderForm | Boolean | Determines whether interacting with the shipping simulator should update the shopper's address in their orderForm (true). This only works if the [orderform optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization) is enabled; otherwise, it has no effect, even if set to true. | true |\n| skuId | String | ID of the current product SKU. | \\- |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, see the guide[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\n| CSS Handles |\n| --------------------------------- |\n| shippingContainer |\n| shippingContainerLoader |\n| shippingCTA |\n| shippingInputLoader |\n| shippingNoMessage |\n| shippingTable |\n| shippingTableBody |\n| shippingTableCell |\n| shippingTableCellDeliveryEstimate |\n| shippingTableCellDeliveryName |\n| shippingTableCellDeliveryPrice |\n| shippingTableHead |\n| shippingTableHeadDeliveryEstimate |\n| shippingTableHeadDeliveryName |\n| shippingTableHeadDeliveryPrice |\n| shippingTableLabel |\n| shippingTableRadioBtn |\n| shippingTableRow |\n| shippingZipcodeLabel |\n| shippingZipcodeLabelLoader |\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/shippingsimulator/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/shippingsimulator/docs/apps/vtex.store-components/shippingsimulator%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/shippingsimulator/docs/apps/vtex.store-components/shippingsimulator%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/shippingsimulator/docs/apps/vtex.store-components/shippingsimulator%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_9e46b0e5
|
[
{
"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 ssltls security protocols and ciphers at 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/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-checkout/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/checkout-security)\n\n[SSL/TLS Security Protocols and Ciphers at Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/checkout-security)\n\n[SSL/TLS Security Protocols and Ciphers at Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-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/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/checkout-api-overview)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/checkout-security)\n\n[SSL/TLS Security Protocols and Ciphers at Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout)\n\nSSL/TLS Security Protocols and Ciphers at Checkout\n\nVTEX performs integrations with external vendors through secure HTTPS connections, using the TLS 1.2 protocol.\n\nFor services performed in the Checkout module, where there is an exchange of data with sellers that are not part of VTEX (external fulfillment), the following ciphers are supported for the external seller, so that the flow of information occurs correctly.\n\n> TLS 1.0 and 1.1 integration protocols are not supported by VTEX.\n\n| Cipher Suite Name (IANA) | Name (OpenSSL) |\n| ---------------------------------------------- | ----------------------------- |\n| TLS\\_ECDHE\\_RSA\\_WITH\\_AES\\_256\\_CBC\\_SHA384 | ECDHE-RSA-AES256-SHA384 |\n| TLS\\_ECDHE\\_RSA\\_WITH\\_AES\\_128\\_CBC\\_SHA256 | ECDHE-RSA-AES128-SHA256 |\n| TLS\\_ECDHE\\_RSA\\_WITH\\_AES\\_256\\_CBC\\_SHA | ECDHE-RSA-AES256-SHA |\n| TLS\\_ECDHE\\_RSA\\_WITH\\_AES\\_128\\_CBC\\_SHA | ECDHE-RSA-AES128-SHA |\n| TLS\\_DHE\\_RSA\\_WITH\\_AES\\_256\\_GCM\\_SHA384 | DHE-RSA-AES256-GCM-SHA384 |\n| TLS\\_DHE\\_RSA\\_WITH\\_AES\\_128\\_GCM\\_SHA256 | DHE-RSA-AES128-GCM-SHA256 |\n| TLS\\_RSA\\_WITH\\_AES\\_256\\_GCM\\_SHA384 | AES256-GCM-SHA384 |\n| TLS\\_RSA\\_WITH\\_AES\\_128\\_GCM\\_SHA256 | AES128-GCM-SHA256 |\n| TLS\\_RSA\\_WITH\\_AES\\_256\\_CBC\\_SHA256 | AES256-SHA256 |\n| TLS\\_RSA\\_WITH\\_AES\\_128\\_CBC\\_SHA256 | AES128-SHA256 |\n| TLS\\_RSA\\_WITH\\_AES\\_256\\_CBC\\_SHA | AES256-SHA |\n| TLS\\_RSA\\_WITH\\_AES\\_128\\_CBC\\_SHA | AES128-SHA |\n| TLS\\_ECDHE\\_ECDSA\\_WITH\\_AES\\_256\\_GCM\\_SHA384 | ECDHE-ECDSA-AES256-GCM-SHA384 |\n| TLS\\_ECDHE\\_ECDSA\\_WITH\\_AES\\_128\\_GCM\\_SHA256 | ECDHE-ECDSA-AES128-GCM-SHA256 |\n| TLS\\_ECDHE\\_ECDSA\\_WITH\\_AES\\_256\\_CBC\\_SHA384 | ECDHE-ECDSA-AES256-SHA384 |\n| TLS\\_ECDHE\\_ECDSA\\_WITH\\_AES\\_128\\_CBC\\_SHA256 | ECDHE-ECDSA-AES128-SHA256 |\n| TLS\\_ECDHE\\_ECDSA\\_WITH\\_AES\\_256\\_CBC\\_SHA | ECDHE-ECDSA-AES256-SHA |\n| TLS\\_ECDHE\\_ECDSA\\_WITH\\_AES\\_128\\_CBC\\_SHA | ECDHE-ECDSA-AES128-SHA |\n| LS\\_DHE\\_DSS\\_WITH\\_AES\\_256\\_CBC\\_SHA256 | DHE-DSS-AES256-SHA256 |\n| TLS\\_DHE\\_DSS\\_WITH\\_AES\\_128\\_CBC\\_SHA256 | DHE-DSS-AES128-SHA256 |\n| TLS\\_DHE\\_DSS\\_WITH\\_AES\\_256\\_CBC\\_SHA | DHE-DSS-AES256-SHA |\n| TLS\\_DHE\\_DSS\\_WITH\\_AES\\_128\\_CBC\\_SHA | DHE-DSS-AES128-SHA |\n| TLS\\_RSA\\_WITH\\_3DES\\_EDE\\_CBC\\_SHA | DES-CBC3-SHA |\n| TLS\\_DHE\\_DSS\\_WITH\\_3DES\\_EDE\\_CBC\\_SHA | EDH-DSS-DES-CBC3-SHA |\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/security/ssltls-security-protocols-and-ciphers-at-checkout.md)\n\n[Security« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout//docs/guides/checkout-security)[Shopping CartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ssltls-security-protocols-and-ciphers-at-checkout//docs/guides/shopping-cart-section-api-quick-start-guides)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\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/security/ssltls-security-protocols-and-ciphers-at-checkout.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_0b4efbc6
|
[
{
"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 jivochat 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.jivochat/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/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.jivochat/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.jivochat/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.jivochat/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.jivochat/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.jivochat/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/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.jivochat/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/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.jivochat/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.jivochat/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/guides/pixel-apps)\n\nJivoChat\n\nOfficial extension\n\nVersion: 1.0.4\n\nLatest version: 1.0.4\n\nThis app provides a native integration for all [JivoChat](https://read.calvincode.net/reader?url=https://www.jivochat.com/?utm%5Fcampaign=direct%26utm%5Fsource=google.com%26%5Fga=2.144978160.551999859.1580832835-1477813135.1580832835) customer comunication functionality.\n\n## Configuration\n\n1. [Install](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/store/installing-an-app) the `vtex.jivochat@1.x` app in the desired account using your terminal. You can also install the app through the VTEX App Store.\n2. In the admin's account, access the **Apps** section and then select the **JivoChat** box\n3. Fill out the form with your **JivoChat's Widget ID** and save your changes.\n\n[Iubenda« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.iubenda)[Kelkoo appNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.jivochat/docs/apps/vtex.kelkoo)\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.jivochat/docs/apps/vtex.jivochat%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_f8c44764
|
[
{
"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 search suggestions 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-search-suggestions/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-suggestions/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-search-suggestions/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-search-suggestions/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-search-suggestions/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-search-suggestions/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-search-suggestions/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-suggestions/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-suggestions/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-suggestions/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-suggestions/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-suggestions/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-suggestions/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-suggestions/updates/release-notes)\n\nSuggestions\n\n`Suggestions` is a component used to suggest search terms similar to the current query.\n\n## Usage\n\nAdd the `search-suggestions` block to the `search-result-layout.desktop` or `search-result-layout.mobile`. For example:\n\n`1\n\n\"search-result-layout.desktop\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#suggestion\", \n\n4\n\n ], \n\n5\n\n \"flex-layout.row#suggestion\": { \n\n6\n\n \"children\": [\"search-suggestions\"] \n\n7\n\n } \n\n8\n\n} \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| ---------- | ------ | ---------------------------------------------------------------------------------------------------------- | ------------- |\n| customPage | string | Defines a custom page to the link of a suggestion. Example: store.search.custom. Defaults to store.search. | |\n\n## 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://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS Handles |\n| --------------------- |\n| suggestionsList |\n| suggestionsListPrefix |\n| suggestionsListLink |\n| suggestionsListItem |\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/basic-components/vtex-search-suggestions.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-suggestions/docs/guides/vtex-search-suggestions%23usage)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-suggestions/docs/guides/vtex-search-suggestions%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-suggestions/docs/guides/vtex-search-suggestions%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/basic-components/vtex-search-suggestions.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/vtex-search-suggestions/docs/guides/vtex-search-suggestions%23usage)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-suggestions/docs/guides/vtex-search-suggestions%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-suggestions/docs/guides/vtex-search-suggestions%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_d1a22939
|
[
{
"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 modal 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.modal-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.modal-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.modal-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.modal-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.modal-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.modal-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.modal-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.modal-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-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.modal-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-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.modal-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.modal-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.modal-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.modal-layout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-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.modal-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-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.modal-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-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.modal-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.modal-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.modal-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.modal-layout/docs/vtex-io-apps)\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/guides/layout-apps)\n\nModal Layout\n\nOfficial extension\n\nVersion: 0.14.2\n\nLatest version: 0.14.2\n\n[](#contributors-)\n\nThe Modal Layout app provides blocks to help you create modals in your store.\n\n\n\n## Configuration\n\n1. Add the Modal Layout app to your theme dependencies in the `manifest.json`:\n\n`1\n\n \"dependencies\": { \n\n2\n\n+ \"vtex.modal-layout\": \"0.x\" \n\n3\n\n } \n\n`\n\nNow, you can use all blocks exported by the `modal-layout` app. See the full list below:\n\n| Block name | Description |\n| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| modal-trigger |  Defines how the modal content will be triggered through its children blocks. |\n| modal-layout |  Defines how the modal content will be rendered through its children blocks. You can declare the modal-header and modal-content blocks, described below, as children to create a modal with a header and footer. |\n| modal-header | Renders a close button and the blocks listed as its children, building a modal header. Note that it does not automatically render a header for your modal. Instead, you should create the modal header as you desire using the children list of this block. |\n| modal-content | Defines how the modal content will be rendered through its children blocks. Preferably, this block should be used along with the modal-header block in order to create a modal with a header and a footer. |\n| modal-actions | Logical block that only renders its child blocks that, in turn, render call-to-action buttons inside the modal, such as a confirmation button. |\n| modal-actions.close | Button that closes the modal when clicked. It is extremely useful when your modal only has a form or a disclaimer box providing information to the users. |\n\n1. Add the `modal-trigger` block in any store template you choose. In the example below, it will be added to the homepage:\n\n`1\n\n{ \n\n2\n\n \"store.home\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"modal-trigger#example\" \n\n5\n\n ] \n\n6\n\n }, \n\n`\n\n1. Declare the `modal-trigger` block using its prop and configure the children blocks. The first child block of `modal-trigger` must be a block you choose to trigger the modal content. Then, a sibling block called `modal-layout` will be needed to effectively define the modal content through its child block list. For example:\n\n`1\n\n{ \n\n2\n\n \"store.home\": { \n\n3\n\n \"children\": [\"modal-trigger#example\"] \n\n4\n\n }, \n\n5\n\n \"modal-trigger#example\": { \n\n6\n\n \"children\": [\"rich-text#example\", \"modal-layout#example\"] \n\n7\n\n }, \n\n8\n\n \"rich-text#example\": { \n\n9\n\n \"props\": { \n\n10\n\n \"text\": \"Click me\" \n\n11\n\n } \n\n12\n\n }, \n\n13\n\n \"modal-layout#example\": { \n\n14\n\n \"children\": [\"rich-text#modal-content\"] \n\n15\n\n }, \n\n16\n\n \"rich-text#modal-content\": { \n\n17\n\n \"props\": { \n\n18\n\n \"text\": \"Hello\" \n\n19\n\n } \n\n20\n\n } \n\n21\n\n} \n\n`\n\nIn the example above, the [Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/) block renders the `Click me` text that will trigger the modal content when clicked. The modal content, in turn, is defined by the `modal-layout` block. Based on the example above, the modal content triggered by the `Click me` Rich Text would be a `Hello` text.\n\n### `modal-trigger` props\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| trigger | enum | Defines whether the modal content should be triggered by user click (click), when the page is fully loaded (load), or when the page is fully loaded, but the modal will appear just once per session (load-session). | click |\n| customPixelEventId | string | Store event ID that triggers the modal-trigger block (hence triggering the opening of modal-layout blocks on the interface as well). | undefined |\n| customPixelEventName | string | Store event name that triggers the modal-trigger block (hence triggering the opening of modal-layout blocks on the interface as well). Some event examples are 'addToCart' and 'removeFromCart'. Note that using this prop will make the associated modal-layout open in **every** event with the specified name if no customPixelEventId is set. | undefined |\n\n### `modal-layout` props\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| scroll | enum | Defines how users should scroll the modal. Possible values are: body (users can scroll the whole modal by normally scrolling the page) and content (users can scroll the modal _content_ when hovering over it). | content |\n| blockClass | string | Unique block ID to be used in [CSS customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization). | undefined |\n| disableEscapeKeyDown | boolean | Defines whether the modal should be closed when pressing the Esc key (true) or not (false). | false |\n| fullScreen | boolean | Defines whether the modal should fill the whole screen (true) or not (false). This prop is responsive, i.e., it adapts to the device breakpoints. | false |\n| backdrop | enum | Defines whether the modal will have a clickable backdrop (clickable) or no backdrop at all (none). This prop is responsive, i.e., it adapts to the device breakpoints. | clickable |\n| customPixelEventId | string | Store event ID that triggers the modal-layout block (hence triggering the closing of modal-layout blocks on the interface as well). | undefined |\n| customPixelEventName | string | Store event name that triggers the modal-layout block (hence triggering the closing of modal-layout blocks on the interface as well). Some event examples are 'addToCart' and 'removeFromCart'. Note that using this prop will make the associated modal-layout close in **every** event with the specified name if no customPixelEventId is set. | undefined |\n\n### `modal-header` props\n\n| Prop name | Type | Description | Default value |\n| --------------- | ------- | --------------------------------------------------------------------------------------------------- | ------------- |\n| showCloseButton | boolean | Defines whether the close icon button should be rendered in the modal header (true) or not (false). | true |\n| iconCloseSize | number | Size (in pixels) of the close icon button in the modal header. | 32 |\n\n### `modal-actions.close` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |\n| label | string | Defines the text to be rendered in the close button. The default value of this prop depends on the store's default language, which is set according to the website [binding](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/what-is-binding--4NcN3NJd0IeYccgWCI8O2W?locale=en). | Cancel, Cancelar, or Cancelar for stores whose default language is, respectively, English, Spanish, or Portuguese. |\n\n## Customization\n\nTo 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://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS handles |\n| -------------------- |\n| modal |\n| backdropContainer |\n| backdrop |\n| closeButtonContainer |\n| closeButton |\n| container |\n| contentContainer |\n| headerContainer |\n| headerContent |\n| paper |\n| topRow |\n| triggerContainer |\n\n[Flex Layout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.flex-layout)[Overlay LayoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.overlay-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.modal-layout/docs/apps/vtex.modal-layout%23configuration)\n\n[modal-trigger props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.modal-layout%23modal-trigger-props)[modal-layout props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.modal-layout%23modal-layout-props)[modal-header props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.modal-layout%23modal-header-props)[modal-actions.close props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.modal-layout%23modal-actionsclose-props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout/docs/apps/vtex.modal-layout%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_27e58499
|
[
{
"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 product summary productsummaryshelf 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-product-summary-productsummaryshelf/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/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-product-summary-productsummaryshelf/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-product-summary-productsummaryshelf/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-product-summary-productsummaryshelf/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-product-summary-productsummaryshelf/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-product-summary-productsummaryshelf/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/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/vtex-product-summary-productsummaryshelf/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/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/vtex-product-summary-productsummaryshelf/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/vtex-product-summary-productsummaryshelf/docs/vtex-io-apps)\n\nProduct Summary Shelf\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 Shelf is the main block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary). It includes the child blocks required to display the Product Summary component in your store.\n\n\n\n) \n\n## Configuration\n\n1. Import the `vtex.product-summary` app to your theme dependencies in the `manifest.json` file:\n\n`1\n\n dependencies: { \n\n2\n\n \"vtex.product-summary\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-summary.shelf` block as a child of the [list-context.product-list block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarylist%23product-list-block):\n\n`1\n\n \"list-context.product-list\": { \n\n2\n\n+ \"blocks\": [\"product-summary.shelf\"] \n\n3\n\n }, \n\n`\n\n1. Declare the `product-summary.shelf` block, passing the desired blocks exported by the Product Summary app to build your Product Summary component. For example:\n\n`1\n\n{ \n\n2\n\n+ \"product-summary.shelf\": { \n\n3\n\n+ \"children\": [ \n\n4\n\n+ \"product-summary-image\", \n\n5\n\n+ \"product-summary-name\", \n\n6\n\n+ \"product-rating-inline\", \n\n7\n\n+ \"product-summary-space\", \n\n8\n\n+ \"product-summary-price\", \n\n9\n\n+ \"product-summary-buy-button\" \n\n10\n\n+ ] \n\n11\n\n+ } \n\n12\n\n} \n\n`\n\n> Remember to define the other Product Summary blocks in your theme, otherwise the component will not be displayed.\n\n| Prop name | Type | Description | Default value |\n| ---------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |\n| priceBehavior | enum | Determines whether the component should fetch the most up-to-date price (async) or (default). Remember to configure the [Search Result](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/content-blocks/vtex.search-result@3.79.1/%23configuration)'s simulationBehavior prop to skip and use the Product Price [product-price-suspense](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/product-price/blob/master/docs/README.md) block to render a loading spinner while the price information is being fetched. | default |\n| trackListName | boolean | Determines whether the component should send the list name to the product page when the product summary is clicked. Disabling it will prevent the productDetail GTM event sent on the PDP to identify from which list the user navigated. | true |\n| sponsoredBadgeLabel | String | The text of the \"Sponsored\" tag, if applicable. | \"store/sponsored-badge.label\" |\n| sponsoredBadgePosition | enum | The position of the \"Sponsored\" tag, if applicable. Possible values are titleTop, containerTopLeft and none. | \"containerTopLeft\" |\n\n## Customization\n\nThe Product Summary Shelf merely establishes the block structure to render the Product Summary component. Therefore, this block does not have CSS Handles for its specific customization.\n\nInstead, you should use its child block Handles.\n\nSee also\n\n[Vtex.product SummaryVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/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[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/apps/vtex.product-summary/ProductSummaryShelf%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf/docs/apps/vtex.product-summary/ProductSummaryShelf%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_d960bab2
|
[
{
"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 getting started 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/getting-started/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/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/getting-started/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/getting-started/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/getting-started/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/getting-started/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/getting-started/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/catalog-overview)\n\n[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/marketplace-overview)\n\n[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/orders-overview)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/checkout-overview)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/payments-overview)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/fulfillment)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/search-overview)\n\n[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/pricing-overview)\n\n[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/promotions-overview)\n\n[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/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/getting-started/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/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/getting-started/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/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/getting-started/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/getting-started/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/catalog-overview)\n\n[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/marketplace-overview)\n\n[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/orders-overview)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/checkout-overview)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/payments-overview)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/fulfillment)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/search-overview)\n\n[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/pricing-overview)\n\n[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/promotions-overview)\n\n[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/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/getting-started/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/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/getting-started/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/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/getting-started/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/getting-started/docs/guides)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started)\n\nGetting started with VTEX Core Commerce APIs\n\nDiscover the features and capabilities of VTEX Core Commerce APIs.\n\nVTEX is a comprehensive headless commerce platform, designed to deliver flexibility and scalability for diverse ecommerce operations. This guide introduces VTEX Core Services and provides essential information to help developers integrate and extend the platform’s features.\n\n> Please note that you are in our Developer Portal. For business-oriented content, visit our [Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/).\n\n## Platform overview\n\nVTEX’s modular architecture ensures security, data privacy, and composability while providing robust developer tools. This architecture facilitates integration with third-party systems and allows extensive customization to meet diverse business needs.\n\nTo learn more about VTEX's platform capabilities, see the [VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview) documentation.\n\n## VTEX REST APIs\n\nVTEX REST APIs provide the foundation for custom integrations, enabling third-party connections and unifying data for a simplified commerce experience.\n\n* [List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/getting-started-list-of-rest-apis)\n* [Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/getting-started-authentication)\n* [Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/getting-started-making-your-first-request)\n\nAt the core of VTEX are microservices, each designed to provide specific ecommerce functionalities and targeted capabilities. The following image offers an overview of VTEX Core Services covered in our API Guides and Reference:\n\n\n\n[ CatalogManage all aspects of product information, including categories, brands, SKUs, and specifications.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview) [ CheckoutAccess and manage checkout cart data to enhance the purchasing experience.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview) [ OrdersReceive, process, and manage every order through the VTEX Orders API.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-overview) [FulfillmentCoordinate store logistics, including warehouses, pickup points, carriers, shipping rates, and inventory updates for each SKU.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment) [ PaymentsAccess payment data and process transactions within the VTEX ecosystem.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-overview) [ PromotionsBoost sales by creating and managing promotions and coupons for your store.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview) [ PricingCreate, read, and edit prices for each SKU, sales channel, or price table.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-overview) [ Account ManagementManage users, roles, hosts, AppKeys, and AppTokens within the VTEX platform.](https://read.calvincode.net/reader?url=https://help.vtex.com/category/account-management--2d48l0t9GweqoGkWCg2IQU) [ SearchSearch and sort products in the catalog using full-text, category, and brand search terms. Retrieve product information to create custom searches and product shelves.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview) [SubscriptionsManage store subscription rules to optimize revenue and reduce bounce rate and churn.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions)\n\nContributors\n\n5\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/PedroAntunesCosta)\n\n[](https://github.com/GeorgeLimaDev)\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/Getting-Started/getting-started/getting-started.md)\n\n[Best practices for avoiding rate limit errors« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started//docs/guides/best-practices-for-avoiding-rate-limit-errors)[CatalogNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started//docs/guides/catalog-overview)\n\nContributors\n\n5\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/PedroAntunesCosta)\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/jumeyermattosarruda)\n\nON THIS PAGE\n\n[Platform overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23platform-overview)\n\n[VTEX REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23vtex-rest-apis)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23catalog)[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23checkout)[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23orders)[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23fulfillment)[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23payments)[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23promotions)[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23pricing)[Account Management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23account-management)[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23search)[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23subscriptions)\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/getting-started/getting-started.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Platform overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23platform-overview)\n\n[VTEX REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23vtex-rest-apis)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23catalog)[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23checkout)[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23orders)[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23fulfillment)[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23payments)[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23promotions)[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23pricing)[Account Management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23account-management)[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23search)[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started/docs/guides/getting-started%23subscriptions)\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_c290fc14
|
[
{
"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 building pages 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-building-pages/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-building-pages/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-building-pages/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-building-pages/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-building-pages/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-building-pages/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-building-pages/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-building-pages/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-building-pages/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/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-building-pages/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/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/store-framework-building-pages/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/store-framework-building-pages/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/store-framework-building-pages/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/store-framework-building-pages/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/store-framework-building-pages/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/store-framework-building-pages/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/store-framework-building-pages/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-building-pages/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-building-pages/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-building-pages/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/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-building-pages/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-building-pages/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-building-pages/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/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-building-pages/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-building-pages/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-building-pages/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-building-pages/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/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-building-pages/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-building-pages/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/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-building-pages/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/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/store-framework-building-pages/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/store-framework-building-pages/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/store-framework-building-pages/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/store-framework-building-pages/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/store-framework-building-pages/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/store-framework-building-pages/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/store-framework-building-pages/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-building-pages/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-building-pages/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-building-pages/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/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-building-pages/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-building-pages/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-building-pages/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/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-building-pages/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-building-pages/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-building-pages/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-building-pages/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-building-pages/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/guides/store-framework)\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/guides/store-framework-building-pages)\n\nBuilding pages\n\nDiscover how to leverage Store Framework to build various types of pages tailored to your business needs.\n\nStore Framework streamlines page creation by offering a set of pre-built components and [development tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience%23developer-tools). These resources simplify building and customizing different page types, such as product details pages, promotional layouts, and custom pages.\n\nThis section covers a range of page-building scenarios, and each guide focuses on practical implementation, ensuring you can effectively develop pages that meet your business needs.\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 [Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3) tutorial.\n\n### Check the builders\n\nCheck if the builders are properly installed in your Store Theme. To use builders, your account must have at least version `vtex.builder-hub@0.293.4` installed. Also, you need to specify them in the app's `manifest.json` file. Learn more in [Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders).\n\nMake sure the [store builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder) is configured, as it enables the development of Store Framework storefronts.\n\n### Learn about VTEX IO apps\n\nFamiliarize yourself with [VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps).\n\n## Essential concepts\n\nTo better understand how to build your store pages, you should understand the concepts of **components** and **templates**.\n\nComponents are building blocks created using the [VTEX IO development platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io) and [React](https://read.calvincode.net/reader?url=https://react.dev/) technology, which are used to create storefronts and admin apps.\n\nLearn more in the [Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components) guide.\n\nA template refers to the structural layout of your site pages. Templates define the components for various pages, such as the home, product, and search results pages, by declaring `json` blocks that render these components.\n\nLearn more in the [Configuring templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringtemplates) guide.\n\n## Guides in this section\n\n[Building a product details pageDiscover how to create a product details page for your store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page)[Building a search results page with multiple layoutsLearn how to create search result pages leveraging our VTEX IO apps.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts)[Creating a Black Friday page from templateExplore our templates to create promotional pages.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template)[Creating a custom search results pageLearn how to customize your search results page and enhance user interaction.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-custom-search-results-page)[Creating a new custom pageUnderstand the process of building a custom page that meets specific business needs.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page)[Customizing the Header and Footer blocks by pageDiscover how to optimize your site’s navigation by customizing header and footer blocks by page.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)[Creating an institutional page with Content typesLearn how to create an institutional page using various content types.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-an-institutional-page-with-content-types-1)\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-building-pages.md)\n\n[Slots« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages//docs/guides/vtex-io-documentation-slots)[Building a Product Details PageNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages//docs/guides/vtex-io-documentation-building-a-product-details-page)\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/store-framework-building-pages/docs/guides/store-framework-building-pages%23before-you-begin)\n\n[Develop your Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/guides/store-framework-building-pages%23develop-your-store-theme)[Check the builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/guides/store-framework-building-pages%23check-the-builders)[Learn about VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/guides/store-framework-building-pages%23learn-about-vtex-io-apps)\n\n[Essential concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/guides/store-framework-building-pages%23essential-concepts)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/guides/store-framework-building-pages%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-building-pages.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/store-framework-building-pages/docs/guides/store-framework-building-pages%23before-you-begin)\n\n[Develop your Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/guides/store-framework-building-pages%23develop-your-store-theme)[Check the builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/guides/store-framework-building-pages%23check-the-builders)[Learn about VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/guides/store-framework-building-pages%23learn-about-vtex-io-apps)\n\n[Essential concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/guides/store-framework-building-pages%23essential-concepts)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages/docs/guides/store-framework-building-pages%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_324cf64a
|
[
{
"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 master 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/master-data/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-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/master-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/master-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/master-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/master-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/master-data/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-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/master-data/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/master-data-v1)\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/master-data/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-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/master-data/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/master-data/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-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/master-data/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/master-data-v1)\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/master-data/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-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/master-data/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/master-data/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/master-data)\n\nMaster Data\n\nMaster Data is a native key-document database with a powerful search engine to enable users to store, search, expand and personalize their data. Master Data is a distributed database solution with low latency access, which enables the implementation of stores all around the world. To enable this level of access and other features, Master Data has some requirements on how it works, which are explained by some of the articles of this section.\n\n## What you will find in this section?\n\nThe table below shows each subsection with a small description of their respective contents.\n\n| Subsection | Description |\n| ----------------------------------------------------- | -------------------------------------------------------- |\n| [How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/master-data-how-it-works) | Fundamentals of Master Data. |\n| [Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/master-data-v2-guides) | Master Data tutorials for different purposes. |\n| [Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/getting-started-1) | Basic how-to guides to get you started with Master Data. |\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/Master-Data/master-data.md)\n\n[Checkout error codes« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data//docs/guides/checkout-error-codes)[Understanding Master DataNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data//docs/guides/understanding-master-data)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[What you will find in this section?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/master-data%23what-you-will-find-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/Master-Data/master-data.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[What you will find in this section?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data/docs/guides/master-data%23what-you-will-find-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_691f4ffc
|
[
{
"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 marketplace apis offer management 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/marketplace-apis-offer-management/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis/)\n\nNotification\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-suggestions/)\n\nMatched Offers\n\nSeller Invite\n\nSeller Commissions\n\nSellers\n\n[Offer Management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/)\n\n[PoCreate Channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23post-/api/sent-offers/channels)\n\n[PoActivate Feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23post-/api/sent-offers/feeds)\n\n[GeList Feeds](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23get-/api/sent-offers/feeds)\n\n[PuUpdate Feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23put-/api/sent-offers/feeds/-feedId-)\n\n[GeGet Feed by feedId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23get-/api/sent-offers/feeds/-feedId-)\n\n[DeDeactivate Feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23delete-/api/sent-offers/feeds/-feedId-)\n\n[PoOpen Interaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions)\n\n[GeGet Interaction Data by interactionId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23get-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-)\n\n[PoClose Interaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/close)\n\n[PoCreate Log](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs)\n\n[GeGet Log Data by logId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23get-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs/-logId-)\n\n[GeSearch Interactions and their Logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23get-/api/sent-offers/search/interactions)\n\n[GeSearch Errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23get-/api/sent-offers/search/errors)\n\n[GeGet Error Code data by errorCodeId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23get-/api/sent-offers/error-codes/-errorCodeId-)\n\nSales Channel Mapping\n\nAffiliates\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis/)\n\nNotification\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-suggestions/)\n\nMatched Offers\n\nSeller Invite\n\nSeller Commissions\n\nSellers\n\n[Offer Management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/)\n\n[PoCreate Channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23post-/api/sent-offers/channels)\n\n[PoActivate Feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23post-/api/sent-offers/feeds)\n\n[GeList Feeds](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23get-/api/sent-offers/feeds)\n\n[PuUpdate Feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23put-/api/sent-offers/feeds/-feedId-)\n\n[GeGet Feed by feedId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23get-/api/sent-offers/feeds/-feedId-)\n\n[DeDeactivate Feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23delete-/api/sent-offers/feeds/-feedId-)\n\n[PoOpen Interaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions)\n\n[GeGet Interaction Data by interactionId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23get-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-)\n\n[PoClose Interaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/close)\n\n[PoCreate Log](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs)\n\n[GeGet Log Data by logId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23get-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs/-logId-)\n\n[GeSearch Interactions and their Logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23get-/api/sent-offers/search/interactions)\n\n[GeSearch Errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23get-/api/sent-offers/search/errors)\n\n[GeGet Error Code data by errorCodeId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management/%23get-/api/sent-offers/error-codes/-errorCodeId-)\n\nSales Channel Mapping\n\nAffiliates\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/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/marketplace-apis-offer-management/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[GeGet Seller data by ID« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis%23get-/seller-register/pvt/sellers/-sellerId-)[PoCreate ChannelNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management/docs/api-reference/marketplace-apis-offer-management%23post-/api/sent-offers/channels)\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_f1541259
|
[
{
"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 4 next steps 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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/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-4-next-steps/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/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-4-next-steps/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/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-4-next-steps/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-4-next-steps/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-4-next-steps/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/guides/faststore)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/guides/faststore/getting-started-overview)\n\n6\\. Next Steps\n\nDiscover additional resources and best practices to optimize your store’s performance and user experience.\n\nYou’ve completed the Getting Started track and have a running, CMS‑integrated storefront. Use the resources below to deepen customization, scale content operations, and get your store ready for production:\n\n[ThemingCustomize your store's appearance and interface with our global tokens for a unique and brand-aligned look.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/guides/faststore/using-themes-overview)[Headless CMSEmpower editors to manage web content with the autonomy to create, edit, and publish web content via the VTEX Admin.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/guides/faststore/headless-cms-overview)[Component CustomizationDiscover how to customize and expand your store's components, shaping its functionality to fit your business requirements.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/guides/faststore/building-sections-overview)[UI componentsEnhance your store's features with these components designed to help you quickly implement and customize features in your store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/guides/faststore/components-index)[Go-liveIntegrate FastStore with VTEX for a seamless customer experience. Connect to VTEX's infrastructure, set up payment gateways, configure shipping options, and launch your store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/guides/faststore/go-live-overview)\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/faststore/docs/getting-started/6-next-steps.mdx)\n\n[Promoting your changes« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes)[GlossaryNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps/docs/guides/faststore/getting-started-glossary)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\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/getting-started/6-next-steps.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_e3ca0289
|
[
{
"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 add payment data to the cart 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/add-payment-data-to-the-cart/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/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/add-payment-data-to-the-cart/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/add-payment-data-to-the-cart/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/add-payment-data-to-the-cart/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/add-payment-data-to-the-cart/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/add-payment-data-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/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/add-payment-data-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/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/add-payment-data-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/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/add-payment-data-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/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/add-payment-data-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/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/add-payment-data-to-the-cart/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/add-payment-data-to-the-cart/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/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/add-payment-data-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/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/add-payment-data-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/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/add-payment-data-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/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/add-payment-data-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/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/add-payment-data-to-the-cart/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/add-payment-data-to-the-cart/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/checkout-api-overview)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/adding-payment-information-to-the-cart)\n\nAdding payment information to the cart\n\nThe shopping cart gathers information on the products the customer chooses while browsing a store, such as prices, shipping costs, payment methods, delivery methods, etc. This data may include item prices, shipping value, payment, and delivery methods, among others.\n\nThis guide will describe how to add payment information to the shopping cart via API.\n\n> The payment information attached to the shopping cart does not determine the final order payment method. However, it allows the platform to update any relevant information that might be affected by the payment method.\n\n## Getting shopping cart information\n\nThe first step is to get the `orderFormId` of the shopping cart to which you want to add the payment information. For more information, read the [Getting cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/get-cart-information-by-id) guide.\n\n## Adding payment information to the shopping cart\n\nTo add payment information to the shopping cart, you need to use the [Add payment data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/attachments/paymentData) endpoint. In this request, you must send the `orderFormId` through the URL address, as in the example below:\n\n`https://{accountName}.{environment.com.br}/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a/attachments/paymentData`\n\nAdditionally, you must send the request body containing the following payment information:\n\n* `paymentSystem`: Payment system ID.\n* `paymentSystemName`: Payment system name.\n* `group`: Payment system group.\n* `installments`: Number of installments.\n* `installmentsInterestRate`: Installment interest rate.\n* `installmentsValue`: Amount of each installment.\n* `value`: Total payment amount.\n* `referenceValue`: Base value used to calculate total order amount with interest.\n* `hasDefaultBillingAddress`: Indicates whether the billing address for this order is the default address.\n\nSee a request body example below:\n\n`1\n\n{ \n\n2\n\n \"payments\": [ \n\n3\n\n { \n\n4\n\n \"paymentSysytem\": 1, \n\n5\n\n \"paymentSystemName\": \"Boleto Bancário\", \n\n6\n\n \"group\": \"bankInvoicePaymentGroup\", \n\n7\n\n \"installments\": 3, \n\n8\n\n \"installmentsInterestRate\": 0, \n\n9\n\n \"installmentsValue\": 100, \n\n10\n\n \"value\": 300, \n\n11\n\n \"referenceValue\": 300, \n\n12\n\n \"hasDefaultBillingAddress\": false \n\n13\n\n } \n\n14\n\n ] \n\n15\n\n} \n\n`\n\nIf you are using a gift card as a payment method, the request body can be similar to this:\n\n`1\n\n{ \n\n2\n\n \"giftCards\": [ \n\n3\n\n { \n\n4\n\n \"redemptionCode\": \"480030010012333619\", \n\n5\n\n \"provider\": \"CartaoPresente\", \n\n6\n\n \"value\": 15289, \n\n7\n\n \"balance\": 100000, \n\n8\n\n \"name\": null, \n\n9\n\n \"caption\": null, \n\n10\n\n \"id\": \"480030010012333619\", \n\n11\n\n \"inUse\": true, \n\n12\n\n \"isSpecialCard\": false, \n\n13\n\n \"groupName\": null \n\n14\n\n } \n\n15\n\n ] \n\n16\n\n} \n\n`\n\nAfter sending the request, the endpoint will return the response body containing the payment information in the shopping cart, as in the example below:\n\n`1\n\n... \n\n2\n\n\"paymentData\": { \n\n3\n\n \"updateStatus\": \"updated\", \n\n4\n\n \"installmentOptions\": [ \n\n5\n\n { \n\n6\n\n \"paymentSystem\": \"1\", \n\n7\n\n \"bin\": null, \n\n8\n\n \"paymentName\": \"Boleto Bancário\", \n\n9\n\n \"paymentGroupName\": \"bankInvoicePaymentGroup\", \n\n10\n\n \"value\": 300, \n\n11\n\n \"installments\": [ \n\n12\n\n { \n\n13\n\n \"count\": 3, \n\n14\n\n \"hasInterestRate\": false, \n\n15\n\n \"interestRate\": 0, \n\n16\n\n \"value\": 300, \n\n17\n\n \"total\": 300, \n\n18\n\n \"sellerMerchantInstallments\": [ \n\n19\n\n { \n\n20\n\n \"id\": \"COSMETICS2\", \n\n21\n\n \"count\": 3, \n\n22\n\n \"hasInterestRate\": false, \n\n23\n\n \"interestRate\": 0, \n\n24\n\n \"value\": 300, \n\n25\n\n \"total\": 300 \n\n26\n\n } \n\n27\n\n ] \n\n28\n\n } \n\n29\n\n ] \n\n30\n\n } \n\n31\n\n... \n\n`\n\n> ️ For more information on the meaning of each field available in the shopping cart, see the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) overview.\n\n## Error codes\n\nThe following errors may appear as a message in the response body.\n\n### 400 - Bad Request\n\n* **Message error example (code ORD002)**: `\"Invalid order form\"`. The `orderFormId` information is not valid.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"ORD002\", \n\n5\n\n \"message\": \"Invalid order form\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"5d9f54e6-7db4-46d6-bca9-deeb278b8b98\" \n\n9\n\n} \n\n`\n\n* **Message error example (code ORD020)**: `\"Invalid payment\"`. The `referenceValue` information has not been sent. \\[block:code\\]\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"ORD020\", \n\n5\n\n \"message\": \"Invalid payment\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"9d14e7af-a63d-4c26-8974-bad734b758da\" \n\n9\n\n} \n\n`\n\n### 404 - Not Found\n\n* **Message error example**: `\"The requested URL was not found on the server\"`: Check if the URL 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\nContributors\n\n3\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/GeorgeLimaDev)\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/cart-attachments-section-quick-start-guides/adding-payment-information-to-the-cart.md)\n\n[Add cart items« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart//docs/guides/add-cart-items)[Adding merchant context information to the cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart//docs/guides/add-merchant-context-information-to-the-cart)\n\nContributors\n\n3\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/GeorgeLimaDev)\n\nON THIS PAGE\n\n[Getting shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23getting-shopping-cart-information)\n\n[Adding payment information to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23adding-payment-information-to-the-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23404-not-found)\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/cart-attachments-section-quick-start-guides/adding-payment-information-to-the-cart.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Getting shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23getting-shopping-cart-information)\n\n[Adding payment information to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23adding-payment-information-to-the-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23404-not-found)\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_d54a4c36
|
[
{
"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 weni by vtex fetching and filtering 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/weni-by-vtex-fetching-and-filtering-logs/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-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/weni-by-vtex-fetching-and-filtering-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/weni-by-vtex-fetching-and-filtering-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/weni-by-vtex-fetching-and-filtering-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/weni-by-vtex-fetching-and-filtering-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/weni-by-vtex-fetching-and-filtering-logs/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/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/weni-by-vtex-fetching-and-filtering-logs/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-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/weni-by-vtex-fetching-and-filtering-logs/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-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/weni-by-vtex-fetching-and-filtering-logs/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\nWeni by VTEX CLI\n\n[Using the Weni by VTEX CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/using-the-weni-by-vtex-cli)\n\n[Weni by VTEX CLI Command Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/weni-by-vtex-cli-command-reference)\n\n[Authenticating with your Weni by VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/authenticating-with-your-weni-by-vtex-account)\n\n[Managing your Weni by VTEX projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/managing-your-weni-by-vtex-projects)\n\n[Understanding the core concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/weni-by-vtex-understanding-the-core-concepts)\n\n[Working with Weni by VTEX agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/working-with-weni-by-vtex-agents)\n\n[Fetching and filtering logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/weni-by-vtex-fetching-and-filtering-logs)\n\n[Using Weni Run to execute tool tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/using-weni-run-to-execute-tool-tests)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/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/weni-by-vtex-fetching-and-filtering-logs/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-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/weni-by-vtex-fetching-and-filtering-logs/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-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/weni-by-vtex-fetching-and-filtering-logs/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\nWeni by VTEX CLI\n\n[Using the Weni by VTEX CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/using-the-weni-by-vtex-cli)\n\n[Weni by VTEX CLI Command Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/weni-by-vtex-cli-command-reference)\n\n[Authenticating with your Weni by VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/authenticating-with-your-weni-by-vtex-account)\n\n[Managing your Weni by VTEX projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/managing-your-weni-by-vtex-projects)\n\n[Understanding the core concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/weni-by-vtex-understanding-the-core-concepts)\n\n[Working with Weni by VTEX agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/working-with-weni-by-vtex-agents)\n\n[Fetching and filtering logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/weni-by-vtex-fetching-and-filtering-logs)\n\n[Using Weni Run to execute tool tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/using-weni-run-to-execute-tool-tests)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides)\n\nWeni by VTEX\n\nWeni by VTEX CLI\n\n[Fetching and filtering logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/weni-by-vtex-fetching-and-filtering-logs)\n\nFetching and filtering agent logs\n\nFetch and filter execution logs.\n\nFetch and filter execution logs for a specific agent tool.\n\n### Usage\n\n`1\n\nweni logs --agent <agent_key> --tool <tool_key> [--start-time ISO8601] [--end-time ISO8601] [--pattern TEXT] \n\n`\n\n#### Options\n\n* `--agent, -a` (required): Agent key in your definition (e.g. `cep_agent`).\n* `--tool, -t` (required): Tool key (e.g. `get_address`).\n* `--start-time, -s` (optional): ISO 8601 datetime. Examples: \n * `2024-01-01T00:00:00` \n * `2024-01-01T00:00:00.000Z`\n* `--end-time, -e` (optional): ISO 8601 datetime, same formats as start.\n* `--pattern, -p` (optional): Simple substring filter. Regex (e.g. `%...%`) is not supported.\n\nSupported datetime formats include:\n\n* `YYYY-MM-DDTHH:MM:SS`\n* `YYYY-MM-DDTHH:MM:SS.sss`\n* With timezone suffix: `Z`, `+00:00`, etc.\n\n#### Pagination\n\nIf more logs are available, you'll be prompted to fetch more. Choose `p` to continue or `q` to stop.\n\n#### Examples\n\n`1\n\n# Basic \n\n2\n\nweni logs -a cep_agent -t get_address \n\n3\n\n \n4\n\n# With time range \n\n5\n\nweni logs -a cep_agent -t get_address -s 2024-01-01T00:00:00 -e 2024-01-01T23:59:59 \n\n6\n\n \n7\n\n# With simple pattern \n\n8\n\nweni logs -a cep_agent -t get_address -p error \n\n`\n\nContributors\n\n1\n\n[](https://github.com/mariananantua)\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/Weni-by-VTEX/CLI/weni-by-vtex-fetching-and-filtering-logs.md)\n\n[Working with Weni by VTEX agents« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs//docs/guides/working-with-weni-by-vtex-agents)[Using Weni Run to execute tool testsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs//docs/guides/using-weni-run-to-execute-tool-tests)\n\nContributors\n\n1\n\n[](https://github.com/mariananantua)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-fetching-and-filtering-logs/docs/guides/weni-by-vtex-fetching-and-filtering-logs%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/Weni-by-VTEX/CLI/weni-by-vtex-fetching-and-filtering-logs.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/weni-by-vtex-fetching-and-filtering-logs/docs/guides/weni-by-vtex-fetching-and-filtering-logs%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=)"
}
] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.