vtex.local

This documentation goes in detail how to interact with Session Manager's API. For a more top-level approach, check the design documentation.

🔑 apikey 4 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 Segment

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

Get Session

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

Endpoints (4 total)

GET

/segments

Get Segment

GET

/sessions

Get Session

POST

/sessions

Create new session

PATCH

/sessions

Edit session