vtex.local

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

3 endpoints

📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (10 total)

lever-sdk ✓ Official

npm install lever-sdk

GitHub integration →

ads-js ✓ Official

npm install ads-js

GitHub integration →

vtex-node-sdk

npm install vtex-node-sdk

GitHub integration →

physical-payments-sdk ✓ Official

# Maven: see https://github.com/vtex-apps/physical-payments-sdk

GitHub integration →

VTEX-SDK-dotnet

dotnet add package VTEX-SDK-dotnet

GitHub integration →

vtex-sdk

composer require vtex-sdk

GitHub integration →

vtex-sdk-php

composer require vtex-sdk-php

GitHub integration →

vtex-api

composer require vtex-api

GitHub integration →

vtex-kotlin-sdk

# See https://github.com/ksetoue/vtex-kotlin-sdk

GitHub integration →

vtex.js ✓ Official

# See https://github.com/vtex/vtex.js

GitHub integration →

curl examples

Get all Content Types

curl \
  https://vtex.local/_v/cms/api/{builderId}/

Get all CMS pages by Content Type

curl \
  https://vtex.local/_v/cms/api/{builderId}/{content-type}

Get CMS page

curl \
  https://vtex.local/_v/cms/api/{builderId}/{content-type}/{document-id}/

Endpoints (3 total)

GET

/_v/cms/api/{builderId}/

Get all Content Types

GET

/_v/cms/api/{builderId}/{content-type}

Get all CMS pages by Content Type

GET

/_v/cms/api/{builderId}/{content-type}/{document-id}/

Get CMS page