vtex.local

ATTENTION: This version isn't compliant with data entities of old version (e.g. CL and AD). It's possible to use this configuration only to new data entities. Welcome! VTEX Master Data is an easy-to-use, secure, fast, scalable and extensible repository. On it you can create your own

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

Scroll documents

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

Search documents

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

Get indices

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

Endpoints (26 total)

GET

/api/dataentities/{dataEntityName}/scroll

Scroll documents

GET

/api/dataentities/{dataEntityName}/search

Search documents

GET

/api/dataentities/{dataEntityName}/indices

Get indices

GET

/api/dataentities/{dataEntityName}/schemas

Get schemas

GET

/api/dataentities/{dataEntityName}/documents/{id}

Get document

GET

/api/dataentities/{dataEntityName}/indices/{index_name}

Get index by name

GET

/api/dataentities/{dataEntityName}/schemas/{schemaName}

Get schema by name

GET

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

List versions

GET

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

Get version

POST

/api/dataentities/Client/documents

Create new customer profile

POST

/api/dataentities/Address/documents

Create new customer address

POST

/api/dataentities/{dataEntityName}/documents

Create new document