VTEX

VTEX Headless CMS

The VTEX Headless CMS is a no-code management system for storefront content. That means you can store your content as structured data in a layer decoupled…

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The VTEX Headless CMS is a no-code management system for storefront content.
That means you can store your content as structured data in a layer decoupled from the frontend and
use the VTEX Headless CMS to access and deliver your content to your storefront project.

Notice that the VTEX Headless CMS typically works with FastStore projects only. In this case, you can use this API
to fetch data using SSR (NextJS and Gatsby v4+) or SSG (NextJS).

Servers

  • https://{account}.myvtex.com/
  • https://{workspace}--{account}.myvtex.com/

Server variables

  • accountName: Name of your VTEX account.
  • workspace: Name of your VTEX workspace.

Endpoints 3

Pages

  • GETGet all Content Types/_v/cms/api/:builderId/Gets data from all Content Types.
  • GETGet all CMS pages by Content Type/_v/cms/api/:builderId/:content-type?versionId=e7263fc8-bc68-4052-9e25-dd5a2572d3bb&releaseId=6196c277c6dce15f9709a2a7&filters[{field}]=publishedGets data from all pages of a given Content Type.
  • GETGet CMS page/_v/cms/api/:builderId/:content-type/:document-id/?versionId=e7263fc8-bc68-4052-9e25-dd5a2572d3bb&releaseId=6196c277c6dce15f9709a2a7Gets all data from a given page.

API details

Base URL
https://vtex.local
https://{account}.myvtex.com
https://{workspace}--{account}.myvtex.com
Authentication
None declared in the description
Operations
3 operations on 3 pathsGET 3
Main resources
Pages 3
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 0.31.2
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the VTEX Headless CMS in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the VTEX Headless CMS collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get all Content Types” (GET /_v/cms/api/:builderId/), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the VTEX Headless CMS?

The VTEX Headless CMS is a no-code management system for storefront content. That means you can store your content as structured data in a layer decoupled… It is listed under Other and has 3 endpoints.

Who publishes the VTEX Headless CMS?

It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.

What is the base URL of the VTEX Headless CMS?

Its description lists 3 base URLs: https://vtex.local, https://{account}.myvtex.com, https://{workspace}--{account}.myvtex.com. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the VTEX Headless CMS?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the VTEX Headless CMS have?

3 operations on 3 paths (3 GET). The largest groups are Pages.

Is forking the VTEX Headless CMS free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.