VTEX Developer Portal

Concepts

Explore the Concepts section to learn more about the core aspects of the VTEX IO platform.

Configure your app's billing options to distribute your application in the VTEX ecosystem. Define an app’s distribution on the platform and structure its pricing data, allowing the application usage to be public and, in some scenarios, even charged.

Learn how to use builders. A VTEX IO abstraction that works as an API service responsible for processing and interpreting a directory in your app.

Declare dependencies in your app's manifest file to specify which VTEX IO apps your app relies on to properly work.

An Edition App consists of a bundle of settings, policies, back-end and front-end apps encapsulated and exported by a Sponsor Account.

Interface is what links a block to a React component.

The manifest.json file is the first communication point with VTEX IO, holding important metadata about an app, such as its name, version, vendor, description, dependencies, etc.

Declare peer dependencies in your app's manifest file to specify which VTEX IO apps that must not be automatically installed in an account your app relies on to properly work.

Policies are a set of permissions granted to a resource (VRN) or a role that allows or forbids them to execute a given set of actions in an account, such as performing a request to the platform.

Roles are uniquely identifiable names given to request sources.

A route maps a URL pattern and an HTTP request method to an action. It's, therefore, a way of setting the application expected behavior for client requests to specific endpoints. Check this concept to find out how VTEX IO handles routing.

Slots composition is a new way to declare a React component in your store theme code.

A Sponsor Account is a VTEX account responsible for the development and release of the Edition App installed in its child accounts.

VTEX Toolbelt is a command-line interface that gives you access to every feature of the VTEX platform.

A VTEX Resource Name (VRN) is how the VTEX IO platform expresses the resource path called in a request.

Workspaces are work spaces isolated from one another.

Updated 3 days ago


Concepts


Explore the Concepts section to learn more about the core aspects of the VTEX IO platform.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.