VTEX DO API

VTEX DO is a task management system for authorized users to process VTEX store orders. The functionality allows you to control notes, and create, update, list, and retrieve tasks.

VTEX DO API Index

Note

• POST Create Note
• GET Get Notes by orderId
• GET Retrieve Note

Task

• POST Create Task
• GET List tasks
• GET Retrieve Task
• PUT Update Task
• POST Add Comment on a Task

Common parameters

Parameter name	Description	Type
{{accountName}}	Name of the VTEX account. Used as part of the URL.	Server variable.
{{environment}}	Environment to use. Used as part of the URL. The default value is vtexcommercestable.	Server variable.
X-VTEX-API-AppKey	Unique identifier of the API key.	Authentication header. Must be used together with X-VTEX-API-AppToken. Not necessary when using VtexIdclientAutCookie.
X-VTEX-API-AppToken	Secret token of the API key.	Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using VtexIdclientAutCookie.
VtexIdclientAutCookie	User token, valid for 24 hours.	Authentication header. Not necessary when using X-VTEX-API-AppKey and X-VTEX-API-AppToken.