canonical: https://jentic.com/apis/vtex.local/vtex-do-api

# VTEX DO API

[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/. The API exposes 8 endpoints secured with apiKey authentication.

## For AI agents

Programmatically create note, get notes by order id. Covers 8 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- Create note
- Get notes by order ID
- Retrieve note
- List tasks
- Update task

## Use cases

### E-Commerce Operations

Use the VTEX DO API to perform e commerce operations programmatically. The API provides 8 endpoints covering core functionality including create note, get notes by order id, retrieve note.

Example prompt: Call POST /notes to create note

### Automated Note Management

Automate note operations by combining multiple VTEX DO API endpoints. Agents can get notes by order id and then retrieve note in a single workflow.

Example prompt: Call GET /notes to get notes by order id, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call VTEX DO API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'create note', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/notes` | Create note |
| GET | `/notes` | Get notes by order ID |
| GET | `/notes/{noteId}` | Retrieve note |
| POST | `/tasks` | Create task |
| GET | `/tasks` | List tasks |
| GET | `/tasks/{taskId}` | Retrieve task |
| PUT | `/tasks/{taskId}` | Update task |
| POST | `/tasks/{taskId}/comments` | Add comment on a task |

## Key resources

- **Note** — Operations related to Note
- **Task** — Operations related to Task

## Why Jentic

- **Setup:** Wiring the VTEX DO API by hand means setting the X-VTEX-API-AppKey and X-VTEX-API-AppToken header pair, building the accountName and environment host from your VTEX region, and managing that yourself. Through Jentic you install once, import the VTEX DO API from the API Directory, store the app key and token once, and your agent calls it.
- **Permission scoping:** The VTEX DO API puts the resource id in the URL path (`/tasks/{taskId}` and `/notes/{noteId}`), so a rule can pin your agent to one task or note. You choose the operations it may call, so you can allow reading and commenting on tasks while a write like updating a task is not included unless you add it.
- **Credential handling:** Your VTEX DO app key and token are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a task' or 'list open notes', and Jentic returns the matching VTEX DO API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — Alternative e commerce API
- **Stripe** — Alternative e commerce API

## FAQ

### What authentication does the VTEX DO API use?

The VTEX DO API uses an API key passed in the `X-VTEX-API-AppKey` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create note with the VTEX DO API?

Yes. Use the POST /notes endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the VTEX DO API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create note through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create note'. Jentic returns the matching VTEX DO API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the VTEX DO API have?

The VTEX DO API exposes 8 endpoints covering note, task operations.

### Can I limit what my agent is allowed to do with the VTEX DO API?

Yes. Because you run Jentic One yourself, your own rules decide which VTEX DO operations and credentials the agent may use. Since the resource id sits in the URL path, such as `/tasks/{taskId}` and `/notes/{noteId}`, you can pin the agent to a single task or note, and you choose the operations it may call. For example, you can allow reading tasks and adding comments while leaving updating a task out unless you add it.