vtex.local

VTEX DO is a task management system for authorized users to process orders. It is possible to control notes, and create, update, list, and retrieve tasks.

🔑 apikey 8 endpoints
📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (10 total)

lever-sdk ✓ Official
npm install lever-sdk
ads-js ✓ Official
npm install ads-js
npm install vtex-node-sdk
physical-payments-sdk ✓ Official
# Maven: see https://github.com/vtex-apps/physical-payments-sdk
dotnet add package VTEX-SDK-dotnet
composer require vtex-sdk
composer require vtex-sdk-php
composer require vtex-api
# See https://github.com/ksetoue/vtex-kotlin-sdk
vtex.js ✓ Official
# See https://github.com/vtex/vtex.js
curl examples
Get Notes by orderId
curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/notes
List tasks
curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/tasks
Retrieve Note
curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/notes/{noteId}
Endpoints (8 total)
GET
/notes
Get Notes by orderId
GET
/tasks
List tasks
GET
/notes/{noteId}
Retrieve Note
GET
/tasks/{taskId}
Retrieve Task
POST
/notes
Create Note
POST
/tasks
Create Task
POST
/tasks/{taskId}/comments
Add Comment on a Task
PUT
/tasks/{taskId}
Update Task
At a glance
Total SDKs10
Languages6
Endpoints8
Authapikey
https://vtex.local