HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.

Accept

Content-Type

[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.

VtexIdclientAutCookie

Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).

X-VTEX-API-AppKey

Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).

X-VTEX-API-AppToken

[VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu) is a task management system for authorized [users](https://help.vtex.com/en/tutorial/how-to-manage-users--tutorials_512) 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](https://developers.vtex.com/docs/api-reference/vtex-do-api#post-/notes)
- `GET` [Get Notes by orderId](https://developers.vtex.com/docs/api-reference/vtex-do-api#get-/notes)
- `GET` [Retrieve Note](https://developers.vtex.com/docs/api-reference/vtex-do-api#get-/notes/-noteId-)

### Task

- `POST` [Create Task](https://developers.vtex.com/docs/api-reference/vtex-do-api#post-/tasks)
- `GET` [List tasks](https://developers.vtex.com/docs/api-reference/vtex-do-api#get-/tasks)
- `GET` [Retrieve Task](https://developers.vtex.com/docs/api-reference/vtex-do-api#get-/tasks/-taskId-)
- `PUT` [Update Task](https://developers.vtex.com/docs/api-reference/vtex-do-api#put-/tasks/-taskId-)
- `POST` [Add Comment on a Task](https://developers.vtex.com/docs/api-reference/vtex-do-api#post-/tasks/-taskId-/comments) 

## 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 [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. Must be used together with `X-VTEX-API-AppToken`. Not necessary when using `VtexIdclientAutCookie`. |
| `X-VTEX-API-AppToken` | Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using `VtexIdclientAutCookie`. |
| `VtexIdclientAutCookie` | [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours. | Authentication header. Not necessary when using `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken`. |

VTEX DO API

Retrieves notes related to a specific order ID.

## Permissions

This endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).

target.id

perPage

page

This parameter is relevant only for accounts using [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus). When sending requests to this endpoint, accounts with the [PII data architecture](https://developers.vtex.com/docs/guides/pii-data-architecture-specifications) can use this parameter to declare the reason for requesting unmasked data. Otherwise, this endpoint will return masked PII data.

reason

Creates a new note in [VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu). Be aware of the following limitations:

- The maximum number of notes for an order is 30.

- The maximum number of characters in a note's description is 2000.

## Permissions

This endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).

Retrieves a given note in [VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu), filtering by note ID.

## Permissions

This endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).

noteId

This endpoint allows you to filter [VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu) tasks. You can choose between the following filtering options:

- **Assignees:** using `assignee.email` and `status`. Example: `https://{{accountName}}.{{environment}}.com.br/api/do/tasks?assignee.email={{person@email.com}}&status={{open}}`. 

- **Targets:** using `targetId` and `status`. Example: `https://{{accountName}}.{{environment}}.com.br/api/do/tasks?target.id={{name}}&status={{open}}`. 

- **Paged tasks:** using `page`, `perPage` and `status`. Example: `https://{{accountName}}.{{environment}}.com.br/api/do/tasks?page={{1}}&perPage={{10}}&status=;{{-Closed}}`. 

- **Context:** using `context`, `page`, `perPage` and `status`. Example: `https://{{accountName}}.{{environment}}.com.br/api/do/tasks?context={{context}}&page={{1}}&perPage={{10}}&status={{-Closed}}`.

## Permissions

This endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).

If you wish to list tasks by assignee, insert the desired assignee's email and status.

assignee.email

If you wish to list tasks by target, insert the desired `targetId` and `status`.

If you wish to list tasks by context, insert the desired context, `page`, `perPage` and `status`.

context

If you wish to list tasks by context, also insert the desired `page`.

If you wish to list tasks by context, also insert the desired `perPage` value.

If you wish to list tasks by context, also insert the desired `status`.

status

Creates a new task in [VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu).

## Permissions

This endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).

Retrieves a given [VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu) task, filtering by task ID.

## Permissions

This endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).

taskId

Updates the status of a [VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu) task, filtering by task ID.

## Permissions

This endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).

Adds a comment to a [VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu) task, filtering by task ID.

## Permissions

This endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).

Name of the VTEX account. Used as part of the URL.

Environment to use. Used as part of the URL.

Retrieves notes related to a specific order ID.

Get notes by order ID

Retrieves a given note in [VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu), filtering by note ID.

Retrieve note

This endpoint allows you to filter [VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu) tasks. You can choose between the following filtering options:

List tasks

Retrieves a given [VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu) task, filtering by task ID.

Retrieve task

Creates a new note in [VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu). Be aware of the following limitations:

Create note

Creates a new task in [VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu).

Create task

Adds a comment to a [VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu) task, filtering by task ID.

Add comment on a task

Updates the status of a [VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu) task, filtering by task ID.