VTEX Task API

openapi: 3.2.0
info:
  title: VTEX Do Task API
  description: 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.
  contact: {}
  version: '1.0'
servers:
- url: https://{accountName}.{environment}.com.br/api/do
  description: VTEX server URL.
  variables:
    accountName:
      description: Name of the VTEX account. Used as part of the URL.
      default: apiexamples
    environment:
      description: Environment to use. Used as part of the URL.
      enum:
      - vtexcommercestable
      default: vtexcommercestable
security:
- appKey: []
  appToken: []
tags:
- name: Task
paths:
  /tasks:
    post:
      tags:
      - Task
      summary: VTex Create Task
      description: Creates a new task in VTEX DO.
      operationId: NewTask
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          example: application/json
      - name: Accept
        in: header
        description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          example: application/json
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewTaskRequest'
            example:
              target:
              - id: 633730670642-01
                type: order
                url: https://recorrenciaqa.vtexcommercebeta.com.br/admin/checkout/orders/633730670642-01
              domain: oms
              context: Marketplace
              name: pricing
              priority: Critical
              surrogateKey: 505224-0
              description: Ajudar na doc API para lancar no postman
              dueDate: '2016-03-01'
              assignee:
                id: null
                name: null
                email: frederico.santos@vtex.com.br
              followers:
              - id: null
                name: null
                email: alan.dantas@vtex.com.br
              parentTaskId: null
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema: {}
              example: {}
      deprecated: false
    get:
      tags:
      - Task
      summary: VTex List tasks
      description: "This endpoint allows you to filter tasks. You can choose between the following filtering options: \n\n- **Assignees:** using `assignee.email` and `status`. Example: `https://{{accountName}}.{{environment}}.com.br/api/do/tasks?assignee.email={{person@email.com}}&status={{open}}`. \n\n- **Targets:** using `targetId` and `status`. Example: `https://{{accountName}}.{{environment}}.com.br/api/do/tasks?target.id={{name}}&status={{open}}`. \n\n- **Paged tasks:** using `page`, `perPage` and `status`. Example: `https://{{accountName}}.{{environment}}.com.br/api/do/tasks?page={{1}}&perPage={{10}}&status=;{{-Closed}}`. \n\n- **Context:** using `context`, `page`, `perPage` and `status`. Example: `https://{{accountName}}.{{environment}}.com.br/api/do/tasks?context={{context}}&page={{1}}&perPage={{10}}&status={{-Closed}}`."
      operationId: Listtasksbyassignee
      parameters:
      - name: assignee.email
        in: query
        description: If you wish to list tasks by assignee, insert the desired assignee's email and status.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: '{{assigneeEmail}}'
      - name: target.id
        in: query
        description: If you wish to list tasks by target, insert the desired `targetId` and `status`.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: '{{targetId}}'
      - name: context
        in: query
        description: If you wish to list tasks by context, insert the desired context, `page`, `perPage` and `status`.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: '{{context}}'
      - name: page
        in: query
        description: If you wish to list tasks by context, also insert the desired `page`.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: '{{page}}'
      - name: perPage
        in: query
        description: If you wish to list tasks by context, also insert the desired `perPage` value.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: '{{desired number per page}}'
      - name: status
        in: query
        description: If you wish to list tasks by context, also insert the desired `status`.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: open
      - name: Accept
        in: header
        description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          example: application/json
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          example: application/json
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema: {}
              example: {}
      deprecated: false
  /tasks/{taskId}:
    get:
      tags:
      - Task
      summary: VTex Retrieve Task
      description: Retrieves a given task, filtering by `taskId`.
      operationId: GetTask
      parameters:
      - name: Accept
        in: header
        description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          example: application/json
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          example: application/json
      - name: taskId
        in: path
        description: Task ID.
        required: true
        style: simple
        schema:
          type: string
          example: 123456abc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema: {}
              example: {}
      deprecated: false
    put:
      tags:
      - Task
      summary: VTex Update Task
      description: Updates a given task's status, for example, filtering by `taskId`.
      operationId: EditTask
      parameters:
      - name: Accept
        in: header
        description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          example: application/json
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          example: application/json
      - name: taskId
        in: path
        description: Task ID.
        required: true
        style: simple
        schema:
          type: string
          example: 123456abc
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditTaskRequest'
            example:
              status: InProgress
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema: {}
              example: {}
      deprecated: false
  /tasks/{taskId}/comments:
    post:
      tags:
      - Task
      summary: VTex Add Comment on a Task
      description: Adds a comment to a given task, filtering by `taskId`.
      operationId: AddComment
      parameters:
      - name: Accept
        in: header
        description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          example: application/json
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          example: application/json
      - name: taskId
        in: path
        description: Task ID.
        required: true
        style: simple
        schema:
          type: string
          example: 123456abc
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddCommentRequest'
            example:
              text: write your comment here
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema: {}
              example: {}
      deprecated: false
components:
  schemas:
    EditTaskRequest:
      title: EditTaskRequest
      required:
      - status
      type: object
      properties:
        status:
          type: string
      example:
        status: InProgress
    Target:
      title: Target
      required:
      - id
      - type
      - url
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        url:
          type: string
      example:
        id: v964735bdev-01
        type: order
        url: https://basedevmkp.vtexcommercebeta.com.br/admin/checkout/#/orders/v964741bdev-01
    Follower:
      title: Follower
      required:
      - id
      - name
      - email
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        email:
          type: string
      example:
        id: null
        name: null
        email: alan.dantas@vtex.com.br
    Assignee:
      title: Assignee
      required:
      - id
      - name
      - email
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        email:
          type: string
      example:
        id: null
        name: null
        email: frederico.santos@vtex.com.br
    NewTaskRequest:
      title: NewTaskRequest
      required:
      - target
      - domain
      - context
      - name
      - priority
      - surrogateKey
      - description
      - dueDate
      - assignee
      - followers
      - parentTaskId
      type: object
      properties:
        target:
          type: array
          items:
            $ref: '#/components/schemas/Target'
          description: ''
        domain:
          type: string
        context:
          type: string
        name:
          type: string
        priority:
          type: string
        surrogateKey:
          type: string
        description:
          type: string
        dueDate:
          type: string
        assignee:
          $ref: '#/components/schemas/Assignee'
        followers:
          type: array
          items:
            $ref: '#/components/schemas/Follower'
          description: ''
        parentTaskId:
          type:
          - string
          - 'null'
      example:
        target:
        - id: 633730670642-01
          type: order
          url: https://recorrenciaqa.vtexcommercebeta.com.br/admin/checkout/orders/633730670642-01
        domain: oms
        context: Marketplace
        name: pricing
        priority: Critical
        surrogateKey: 505224-0
        description: Ajudar na doc API para lancar no postman
        dueDate: '2016-03-01'
        assignee:
          id: null
          name: null
          email: frederico.santos@vtex.com.br
        followers:
        - id: null
          name: null
          email: alan.dantas@vtex.com.br
        parentTaskId: null
    AddCommentRequest:
      title: AddCommentRequest
      required:
      - text
      type: object
      properties:
        text:
          type: string
      example:
        text: escreva seu comentário
  securitySchemes:
    appKey:
      type: apiKey
      in: header
      name: X-VTEX-API-AppKey
    appToken:
      type: apiKey
      in: header
      name: X-VTEX-API-AppToken