VTEX Do API
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.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
Endpoints 8
Note
- GETGet Notes by orderId
/notes?target.id=1172452900788-01&perPage=20&page=3&reason=data-validationRetrieves notes related to a specific orderId. - POSTCreate Note
/notesThis endpoint creates a new note in VTEX DO. Be aware of the following limitations: The maximum number of notes for an order is 30. The maximum number of… - GETRetrieve Note
/notes/:noteId?reason=data-validationRetrieves a given note in VTEX DO, filtering by noteId.
Task
- GETList tasks
/tasks?assignee.email={{assigneeEmail}}&target.id={{targetId}}&context={{context}}&page={{page}}&perPage={{desired number per page}}&status=openThis endpoint allows you to filter tasks. You can choose between the following filtering options: Assignees: using assignee.email and status. Example:… - POSTCreate Task
/tasksCreates a new task in VTEX DO. - GETRetrieve Task
/tasks/:taskIdRetrieves a given task, filtering by taskId. - PUTUpdate Task
/tasks/:taskIdUpdates a given task's status, for example, filtering by taskId. - POSTAdd Comment on a Task
/tasks/:taskId/commentsAdds a comment to a given task, filtering by taskId.
API details
- Base URL
https://vtex.localhttps://{accountName}.{environment}.com.br/api/do- Authentication
- An API key in the X-VTEX-API-AppKey header
An API key in the X-VTEX-API-AppToken header - Operations
- 8 operations on 5 pathsGET 4POST 3PUT 1
- Main resources
- Task 5Note 3
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
1.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the VTEX Do API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the VTEX Do API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-VTEX-API-AppKey header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get Notes by orderId” (GET /notes?target.id=1172452900788-01&perPage=20&page=3&reason=data-validation), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the VTEX Do API?
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. It is listed under Other and has 8 endpoints.
Who publishes the VTEX Do API?
It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.
What is the base URL of the VTEX Do API?
Its description lists 2 base URLs: https://vtex.local, https://{accountName}.{environment}.com.br/api/do. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the VTEX Do API?
It accepts 2 methods: an API key in the X-VTEX-API-AppKey header; an API key in the X-VTEX-API-AppToken header.
How many endpoints does the VTEX Do API have?
8 operations on 5 paths (4 GET, 3 POST, 1 PUT). The largest groups are Task, Note.
Is forking the VTEX Do API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.