API Reference

VTEX Platform OverviewComposability
VTEX Composable Components

Learn about the components VTEX offers to build a composable store.

Various components are available in a VTEX store to fulfill the multiple types of digital commerce businesses. This guide details each component of the platform and explains their composable features.

{"base64":"  ","img":{"width":1758,"height":944,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","orientation":1,"length":311305,"url":""}}

In the tables below, each component is classified by type.

  • Built-in type means that the component comes installed out-of-the-box with the VTEX store.
  • Plug-and-play type means that the component does not come installed, but it can be installed with a few steps and, after configuration in some cases, it will be ready to use.
  • If a component is neither Built-in nor Plug-and-play, it may require a more complex configuration or a development stage.

The specific set of components used in a store will vary according to each scenario and business model. See the Store architecture guide for more details about store implementation in specific scenarios.

If you want to experiment with composability and simulate building a store architecture, see the details in the Interactive Marchitecture tool guide.

Commerce Platform

VTEX Commerce Platform provides a set of core commerce features out-of-the-box for Digital Commerce, Experience Management, Order Management, and Marketplace Management that help merchants start their operations smoothly and efficiently.

Digital Commerce

CatalogIn the Catalog, merchants can manage the category tree (departments, categories, and subcategories), brands, products, SKUs, and specifications. Merchants can use this module natively through the Admin or Catalog API, import the data from a spreadsheet, or integrate it with an external back office tool. For more details, see ERP and PIM/CPQ in Integrations.Built-in
PriceIn the Prices module, merchants can manage price details for the store's SKUs. Merchants can use this module natively through the Admin or Pricing API, import the data from a spreadsheet, or integrate it with an external back office tool. For more details, see ERP and PIM/CPQ in Integrations.

There are options to use only fixed prices or modify them for different contexts including trade policies, customer groups, and promotions.

There is also the option to use the Pricing Hub, where merchants store the prices in an external platform integrated with VTEX, so they are accessed via Checkout.
PromotionsThe Promotions module manages discounts on store customers' shopping carts. It is also responsible for dealing with taxes. Discounts can be applied in many ways including specific products, target audiences, bundles, shipping, or coupons. Merchants can use this module natively through the Admin or Promotions & Taxes API.Built-in
CheckoutThe Checkout module is responsible for the shopping cart. It coordinates data from Catalog, Price, Promotions, Logistics, and Payments to complete the purchase process and place orders. There are many customization options such as optimization of shipping options, geolocation shipping calculation, abandoned cart, UI customization, and others.

With the Checkout API, it is possible to develop custom solutions with VTEX IO or headless implementation.
Payment GatewayThe Payments module configures the payment conditions and deals with the transactions. Within this module is our Payment Gateway, which transmits the payment data using connectors from various payment providers. The VTEX Payment Gateway is mandatory, but the merchant can choose the providers for payment processing. For more details, see Payments in Integrations.

Besides having the basic payment functionalities, merchants can add anti-fraud providers, Customer Credit, digital wallets, and gift cards to the payment experience.
Channel ManagementVTEX supports Unified Commerce Strategies to deal with different sales channels. Merchants can sell through multiple channels including directly from their website, physical stores, Sales App, and more. This strategy allows all the data (order processing, payment transactions, etc.) to be shared between channels and accessible from the Admin. Besides that, order processing and fulfillment can be mixed between channels. For instance, an ecommerce sale can have the option to pick up specific items in the physical store, or a physical store sale can be delivered to the customer’s address.

Among the available sales channel options, we support Marketplace Strategies, which allows merchants to sell products on marketplaces, or for their store to become a marketplace and sell products from sellers.
B2B OrganizationsB2B Organizations is a VTEX IO app from the B2B Suite. It enables merchants to group B2B (Business-to-Business) users into organizations and apply specific custom payment methods, product selections, and prices for customers of the same organization. Each organization is further segmented into one or more cost centers, with their shipping addresses, which will be available for cost center users at checkout.Plug-and-play
B2B Quotes & CartsB2B Quotes & Carts is a VTEX IO app from the B2B Suite. It allows B2B users to create quotes and saved carts, which are then shared with the other members of their organization. This enables price negotiations between them and the store’s sales representatives, and order approval flows within their organization.Plug-and-play

Experience Management

Headless CMSHeadless CMS is part of our FastStore toolkit. It allows merchants to store content in a decoupled data layer and deliver it as structured data to a VTEX store with FastStore via an API.Requires implementation
Intelligent SearchIntelligent Search is a native VTEX platform search solution, working regardless of the channel (website, mobile app, conversational, etc.). Its features include autocomplete, filters, synonyms, and relevance rules. To add Intelligent Search to a store, install the Search app.

Besides Intelligent Search, it is possible to integrate third-party search solutions into a VTEX store. For more details, see Search & Personalization in Integrations.
Storefront ApplicationVTEX has alternatives for storefront applications. For website frontend implementation, we have Store Framework and FastStore. Merchants can also build a complete custom solution, e.g., a custom mobile app, using our APIs.Requires implementation
PWA ApplicationProgressive Web Application (PWA) is natively available for every VTEX IO store. Merchants can configure a push notification to install the store’s PWA on the customer’s device. For more details, see Enabling PWA push notifications in your store.Built-in

Distributed Order Management

Inventory ManagementInventory management is a page in the Admin where merchants can view SKU (Stock Keeping Unit) inventory data and define SKU quantities in warehouses.

Also, merchants can import inventory data from spreadsheets or through the Logistics API, which allows integration with external tools. For more details, see ERP, OMS/WMS, and PIM/CPQ in Integrations.
LogisticsThe Logistics module is responsible for managing the transportation and storage of merchandise, and shipping orders to customers. The main set of configurations in Logistics is the Shipping strategy, which comprises shipping policies, warehouses, and loading docks.

Merchants can make all the configurations in the Admin or through the Logistics API, which allows integrations with external tools. For more details, see ERP, OMS/WMS, and PIM/CPQ in Integrations.

Also, merchants can choose the carriers in the shipping policy. For more details, see Carriers in Integrations.
Shipping NetworkVTEX Shipping Network is an add-on that offers the option of connecting carriers to create an integrated delivery network. It gathers order tracking data directly from carriers, keeping merchants and their customers up to date. Its Admin dashboards show a managerial view of the shipping costs and the revenue from the shipping rates.

⚠️ This feature is only available in Brazil.
Plug-and-play, upon subscription / additional costs

Marketplace Management

Seller ManagementSeller Management is a VTEX Admin page where marketplace operators can add sellers, input their information, and manage their status. The page features metrics that allow marketplaces to assess their operation. It supports both VTEX sellers with a VTEX account, and external sellers integrated with VTEX. For more details, see Third-party Sellers in Integrations.Built-in
Offer Quality & ManagementThe Offer Management module allows sellers to track the sending and syncing of their offers on all sales channels integrated with the store in the Admin. At VTEX, an offer is a SKU from a seller that has been sent to a sales channel with price and inventory information configured.

It allows tracking offers sent to the following channels: Mercado Libre, Netshoes, and VTEX marketplaces. Other marketplaces can add support to Offer Management in their connectors by using the Offer Management API and following the Offer Management integration guide.

Offer Quality Filters is an Admin page where marketplaces add and manage the requirement groups applied to the received SKU cataloging process. Marketplaces can create and apply mandatory and optional requirements on this page to filter the sellers’ offers.
Seller PortalSeller Portal is an edition of the VTEX platform for VTEX or third-party sellers to connect and sell their products on marketplaces. The portal provides sellers with the essential capabilities for ecommerce operations like catalog, prices, logistics, and order management. It also has a dashboard that shows sales performance and allows integration with ERP.

We also have the Seller Portal Edition App, which allows VTEX marketplaces to create a customized Seller Portal.
Marketplaces and IntegrationsMarketplaces and Integrations, previously known as Marketplace Network, is a page in the Admin with a catalog of companies interested in partnerships. This page allows registration, search, and contact between marketplaces and sellers to sign commercial agreements. There are both VTEX and external marketplaces available.

VTEX marketplaces are VTEX customers that choose to make their environment available for sellers to sell products. After a merchant configures their VTEX store to become a marketplace, it will be available for sellers to connect at the Marketplaces and Integrations page.

External marketplaces are marketplace stores that are not VTEX customers and, after developing a connector to integrate with VTEX, they become available for sellers to connect at the Marketplaces and Integrations page. For more details, see Third-Party Marketplaces in Integrations.

Platform interaction

There are two ways for merchants to interact with a VTEX store: VTEX Admin and Developer Tooling. Learn more about their components in the following sections.

VTEX Admin

A panel to manage the entire digital commerce experience in one place with a complete feature set out-of-the-box. The Admin has pages with dashboards, settings, and detailed information from our core modules. For instance, in the Admin, merchants can manage catalog, prices, and inventory, add payment options, view transactions, order status, customer data, sales performance, and more. Adding new features in the Admin to the store is also possible through the Extensions Hub.


Dashboards is a section in the Admin that centralizes the dashboard pages, which display analytical data for the store’s unified commerce. Three dashboards are available:

  • Overview: Shows key metrics that impact the store revenue. It has charts about the evolution of sales, conversion rate, and sales funnel.

Releases is a FastStore feature that allows the efficient management of changes to a store. A release is a change or a group of changes that can be published together. This feature includes two pages:

  • Releases: This page lists all existing releases. It allows several actions including creation, scheduling, publishing, and deleting releases.
  • Calendar: This page shows a calendar of releases per month, week, or day. It allows merchants to see the releases on their publication date or time, access their details, and create new releases.
Built-in, after installing FastStore
User & Account ManagementThe Account page allows merchants to view and manage their VTEX account details, such as the company’s logo, trading name, legal name, and the stores in the account.

On the Users page, merchants can view and manage Admin users. When creating or editing users, merchants can choose their roles, which define what a user can access.
Extensions Hub

At VTEX, extensions are tools designed to expand VTEX’s stores out-of-the-box capabilities. Extensions include VTEX IO apps, payment connectors, marketplace integrations, and others. The Extensions Hub is a section of the Admin that centralizes the management of extensions. It has the following pages:

  • App Store: A page where merchants can find and acquire apps, giving additional functionalities to their stores. Some apps are free, and others are paid. There are apps developed by VTEX and by implementation partners.
  • App Management: This page shows the installed apps in the account and allows merchants to install, configure, uninstall, and delete apps.

Developer Tooling

Various tools to create new features for the VTEX platform. Development can be done by the merchant’s tech team or by partner agencies. There are many ways to build new features at VTEX including apps and storefront features using VTEX IO, custom behaviors with data in Master Data, and integrations using our APIs, which extend VTEX’s out-of-the-box capabilities.

VTEX IO Storefront Platform

VTEX has the following technologies for storefront development:

  • Store Framework: A technology framework for storefront implementation focused on the composable commerce model. It allows the combination of different VTEX IO apps to build a storefront. With this technology, the store's implementation is based on pre-built components, also known as blocks, and component customization is made for specific business needs. This framework is based on React, TypeScript, Node.js, and GraphQL.
  • FastStore: Our newer storefront technology to create stores focused on performance and stability. It is an open-source toolkit based on React and the Jamstack architecture. It has many features that enhance the development experience including a starting template, headless technology, Admin UI panels for management, and integration with GitHub.
APIsVTEX is an API-first platform with 750+ endpoints. VTEX REST APIs allow interaction with over 70 microservices to build custom solutions, such as integrations and VTEX IO apps. Using our APIs requires Authentication with keys or tokens for users and integrations. IO apps can use the APIs through clients. See our API guides for details on how to use our APIs for specific scenarios.Built-in
Master Data ManagementMaster Data is a VTEX highly customizable database platform. It allows merchants to store, search, expand, and customize data. There are two versions available: v1 and v2. The main differences are that v1 has a graphical interface and v2 uses JSON schemas for structuring data. Master Data’s API enables integration with external systems and applications, such as IO apps.

Master Data has a trigger mechanism that allows custom behaviors with data interaction. For instance, merchants can configure to send an email or an HTTP request when a customer's data changes.
VTEX IO App PlatformVTEX IO is a development platform with high-performance management, scalability, and robust security. It offers the tools to develop, manage, install, and deploy apps, allowing the creation of custom solutions that extend the VTEX platform capabilities. Many app types are available for different scenarios, including storefront themes and components, Admin apps, and backend services.

VTEX offers a wide range of readily available apps that merchants can install and developers can use as dependencies.

Developers can make their apps publicly available in the App Store, enabling merchants to install these apps on their stores.

See our Developer Experience guide and Extensions and apps overview for more details about developing and using IO apps.


Integrations allow external providers to integrate their solutions with VTEX stores by leveraging VTEX APIs. Many integrations are readily available from our partner ecosystem, which merchants only need to install and configure before using. It is also possible to develop new integrations following our integration guides or to request this service from our partners.

For more information about how integrations work, see our Backend integrations overview and the Integration Guides section in our Developer Portal.

The types of integrations available at VTEX are:

ERPERP (Enterprise Resource Planning) is the main back office software, responsible for managing the essential parts of the operation related to Catalog, Pricing, Logistics, and Orders.

Some parts of the operation that an ERP deals with can be delegated to other software types: A WMS can manage Logistics, a PIM can manage Catalog, and a CPQ can manage Pricing. See the details about integration with these software types below in this table.

An ERP integrates with VTEX to exchange data and give commands. These integrations are implemented using the APIs from each module (Catalog, Pricing, Logistics, and Orders). The integration is done in two phases, an initial setup for importing product-related data, and a middleware setup for configuring the order processing.

Merchants can choose which ERP to use with VTEX, and what parts of the operation they want to integrate. Some ERPs in the market already have an integration implemented with VTEX, so merchants only need to configure through the UI. Otherwise, the integration must be developed by the merchant technical team or an implementation partner.

For details about implementing ERP integrations, see ERP integration in our Backend integrations overview and our Back office integration guide.
Plug-and-play if the ERP integration is implemented. Requires implementation otherwise.

OMS (Order Management System) is a tool to handle order processing. VTEX has its own OMS, but merchants can integrate external software, usually an ERP, with the Orders API to receive order events and handle order processing. There are two types of order integrations for receiving order events:

  • Feed: the external software reads a queue of order events.
  • Hook: the external software receives automatic notifications about order updates.

After receiving an event, the external software handles the order with various possible actions and returns the result to VTEX’s OMS. It is possible to change, cancel, invoice, and track an order during handling.

For details about implementing integrations with our OMS, see Middleware configuration, Order integration, and Order Processing in our Backend integrations overview, Feed v3, Set up order integration, and Setup order processing guides.

WMS (Warehouse Management System) is a back office software responsible for inventory and logistics management of the operation. At VTEX, integrations with this software send inventory data (warehouses and SKU amounts). For more details, see Inventory in our Backend integrations overview, and our Import inventory guide.

Plug-and-play if the OMS/WMS integration is implemented. Requires implementation otherwise.
PIM/CPQPIM (Product Information Manager) is a back office software that deals with catalog and product data. At VTEX, PIM integrations can send information about the category tree, brands, products, SKUs, and specifications using the Catalog API. For more details, see Catalog architecture and Importing products in our Backend integrations overview, Set up catalog, and Import products guides.

CPQ (Configure Price Quote) is a back office software that deals with product prices. At VTEX, CPQ integrations can send information about the product prices using the Pricing API. For more details, see Prices in our Backend integrations overview, and our Import prices guide.
Plug-and-play if the PIM/CPQ integration is implemented. Requires implementation otherwise.
CRMCRM (Customer Relationship Management) is software that helps track information and interactions between a company and its customers. At VTEX, customer data is usually stored in Master Data v1. CRM integrations can send customer data (name, email, address, ID number, etc.) to VTEX using the Master Data v1 API. For more details, see Customer data in our Backend integrations overview, and our Import customer data guide.

For more details, see Customer data in our Backend integrations overview, and our Import customer data guide.
Plug-and-play if the CRM integration is implemented. Requires implementation otherwise.
Third-Party MarketplacesVTEX sellers can offer their products on VTEX and third-party/external marketplaces. See the list of external marketplaces available at Marketplace strategies at VTEX.

For marketplaces not integrated with VTEX but want to offer products from VTEX sellers, a custom connector can be developed for this integration. VTEX provides a set of APIs and instructions to facilitate the process. For more information, see our External Marketplace integration guide.
Plug-and-play if the marketplace integration is implemented. Requires implementation otherwise.
Search & PersonalizationBy default, VTEX offers Intelligent Search as a search engine, but merchants can use other search solutions instead. Our Search Protocol enables third-party search solutions to integrate with VTEX. Stores can easily switch between search providers without changes in the storefront.

At its core, the Search Protocol is a set of definitions and GraphQL schemas that allows IO apps to serve ecommerce search results that can be used by the VTEX Store Framework.

For plug-and-play implementation of pre-integrated solutions, you can find search provider apps on the App Store.
Plug-and-play if the search integration is implemented. Requires implementation otherwise.
Marketing & AnalyticsMarketing & Analytics integrations are provided as VTEX IO apps. Marketing integrations allow stores to connect with marketing platforms and attract customers. Analytics integrations collect and process customer session data. Check out the available apps for Marketing and affiliate programs and Reviews, ratings, and Analytics on the App Store.

If the integration is not implemented, a Pixel app can be developed. This type of app runs scripts on all pages of a store website and natively integrates the store with a third-party solution, such as sales tracking, user support, and marketing services.
Plug-and-play if the marketing/analytics app is implemented. Requires implementation otherwise.
PaymentsPayment integrations allow payment providers to operate at VTEX stores. If the payment provider is integrated, the merchant must have a contract with the provider and configure the payment options through the VTEX Admin. See the details in the Payments section of our VTEX modules overview. Find the providers supported by VTEX in the List of Payment Providers by Country.

If a payment provider is not integrated, the payment company or an implementation partner can develop an integration, also called a connector, following our Payment Provider Protocol. The connector implementation must have the endpoints described in the Payment Provider Protocol API and will be called by the VTEX’s Payment Gateway. The protocol is flexible enough to support the implementation of various payment methods, conditions, and purchase flows. For more details, see Integrating a new payment provider.
Plug-and-play if the payment provider is implemented. Requires implementation otherwise.
CarriersCarriers are companies that deliver orders to customers. The standard way to add carriers to VTEX is by creating shipping policies in the Logistics module. Another option is to use the VTEX Shipping Network add-on, which supports over 20 carrier partners. Also, there are dedicated carrier apps in the App Store.

⚠️ VTEX Shipping Network is only available in Brazil.
Third-party SellersFor sellers not integrated with VTEX but want to sell their products on a VTEX marketplace, a custom connector can be developed for this integration. VTEX provides a set of APIs and instructions to facilitate the process. For more information, see our External Seller integration guide.Requires implementation


Add-ons are additional solutions offered by VTEX to meet specific business needs. They can be purchased separately through a subscription agreement. You can find more details on Add-on products. Some add-ons available at VTEX are:

Sales AppVTEX Sales App is our main solution for Unified Commerce operations. It includes a mobile app that enables sales associates from physical stores to serve customers and complete the entire sales process from helping to choose the right products to payment and delivery.Plug-and-play, upon subscription / additional costs
Live ShoppingThe Live Shopping app enables an interactive ecommerce experience that combines live streaming and online shopping. Its key features include real-time interaction, personalized content, and data analytics for performance tracking. Events with Live Shopping lead to increased engagement, add-to-cart ratio, and conversion rates.Plug-and-play, upon subscription / additional costs
Personal ShopperVTEX Personal Shopper is an app used by sales associates that brings the physical store shopping experience to the digital environment. It offers one-to-one video chats with customers, enabling product demonstration, real-time answers to queries, and direct addition of products to the cart.Plug-and-play, upon subscription / additional costs
Assisted Sales (SuiteShare)Assisted Sales (SuiteShare), previously known as Conversational Commerce, is a marketing platform for WhatsApp, helping to attract more clients, capture customer data, and integrate with sales tools. The platform allows for organizing customer support, integrating with major CRMs, and measuring results. The solution is based on the official WhatsApp API.Plug-and-play, upon subscription / additional costs
Pick and Pack

VTEX Pick and Pack helps merchants manage the order fulfillment process, including picking, packing, and delivery, from physical stores and warehouses to customers' addresses or pickup points. It provides real-time tracking, route optimization, and data analytics to improve efficiency and performance. The solution consists of:

  • Fulfillment: Admin app for store operators to manage orders in the store or warehouse.
  • Last Mile: Admin app for store operators to instruct drivers on the delivery, and access proof of collecting and delivering.
  • Mobile Applications: Applications for mobile devices used by pickers and drivers in the fulfillment.
Plug-and-play, upon subscription / additional costs
VTEX ShieldVTEX Shield offers additional, customizable protection layers for stores prioritizing platform resilience and the security standards guaranteed by VTEX's existing security certifications and practices.Plug-and-play, upon subscription / additional costs
Ad NetworkVTEX Ad Network connects VTEX stores with brands interested in advertising their products. This connection allows advertisers and merchants to boost their business.Plug-and-play, upon subscription / additional costs
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Suggest edits (Github)
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page