vtex.local

API provider — vtex.local:MasterData-API-

🔑 apikey 20 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

List data entities

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/dataentities

Get data entity structure

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/dataentities/{acronym}

Scroll documents

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/dataentities/{acronym}/scroll

Endpoints (20 total)

GET

/api/dataentities

List data entities

GET

/api/dataentities/{acronym}

Get data entity structure

GET

/api/dataentities/{acronym}/scroll

Scroll documents

GET

/api/dataentities/{acronym}/search

Search documents

GET

/api/dataentities/{acronym}/documents/{id}

Get document

GET

/api/dataentities/{acronym}/documents/{id}/versions

List versions

GET

/api/dataentities/{acronym}/documents/{id}/versions/{versionId}

Get version

GET

/api/dataentities/{acronym}/documents/{id}/{field}/attachments/{file-name}

Retrieve attachment

POST

/api/dataentities/{acronym}/documents

Create new document

POST

/api/dataentities/{acronym}/documents/{id}/clusters

Validate Document by Clusters

POST

/api/dataentities/{acronym}/documents/{id}/{field}/attachments

Save attachment

PUT

/api/dataentities/{acronym}/documents

Create or update entire document