API Reference

VTEX Platform OverviewComposability
Interactive Marchitecture tool

Learn how to use the Interactive Marchitecture tool and simulate a composable VTEX store architecture.

The Interactive Marchitecture tool allows you to simulate the store architecture interactively by choosing which services and add-ons will be used, along with third-party providers for integrations. For reference, see types of architectures for specific scenarios in our Store architecture guide.

{"base64":"  ","img":{"width":1694,"height":864,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":173121,"url":""}}

When you open the Interactive Marchitecture tool, you first have to choose the desired region to plan the store architecture. The region selection defines the available partners for third-party integrations.

The tool displays all the services, add-ons, and integrations described in the VTEX Composable Components guide. You can identify each component type by its color:

  • Services: Hot pink boxes.
  • Add-ons: Light pink boxes.
  • Integrations: Dark blue boxes.
  • Platform interaction tools: Light blue boxes.

You can enable and disable services, add-ons, User Admin functionalities, and Developer Tooling by clicking on them. If you click twice on an add-on, it opens a pop-up with a video explaining that add-on.

When you click on one type of integration, e.g., carriers, it opens a pop-up with the available partners for that type of integration and the selected region and you can choose up to four partners. Then, you can click on the X in the top-right corner to close the pop-up.

{"base64":"  ","img":{"width":779,"height":525,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":57219,"url":""}}

Pop-up containing available carriers for the LATAM region

{"base64":"  ","img":{"width":174,"height":142,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":7444,"url":""}}

Selected carriers in the architecture planning

After selecting all the desired options for your store planning, you should have something like the picture below.

{"base64":"  ","img":{"width":1663,"height":861,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":230579,"url":""}}

If you want to reset your architecture planning, click on the 🔃 refresh button on the top right corner or refresh the page in your browser.

Photo of the contributor
+ 1 contributors
Was this helpful?
Suggest edits (Github)
Photo of the contributor
+ 1 contributors
On this page