vtex.local – VTEX-Do-API

Tools (10)

Extracted live via the executor SDK.

• note.getNote

  Retrieves a given note in VTEX DO, filtering by noteId.

• note.getNotesbyorderId

  Retrieves notes related to a specific orderId.

• note.newNote

  This 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 characters in a note's description is 2000.

• task.addComment

  Adds a comment to a given task, filtering by taskId.

• task.editTask

  Updates a given task's status, for example, filtering by taskId.

• task.getTask

  Retrieves a given task, filtering by taskId.

• task.listtasksbyassignee

  This endpoint allows you to filter 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}}.

• task.newTask

  Creates a new task in VTEX DO.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools