VTEX Note API

openapi: 3.2.0
info:
  title: VTEX Do Note 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: Note
paths:
  /notes:
    post:
      tags:
      - Note
      summary: VTex Create Note
      description: '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.'
      operationId: NewNote
      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
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - target
              - domain
              - description
              properties:
                target:
                  type: object
                  description: Target.
                  properties:
                    id:
                      type: string
                      description: Target ID.
                      example: v964735bdev-01
                    type:
                      type: string
                      description: Target type.
                      example: order
                    url:
                      type: string
                      description: Target URL.
                      example: https://basedevmkp.vtexcommercebeta.com.br/admin/checkout/#/orders/v964741bdev-01
                domain:
                  type: string
                  description: Note domain.
                  example: oms
                description:
                  type: string
                  description: 'Note description. Maximum number of characters: 2000.'
                  example: Order ID in the marketplace is 786-09.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema: {}
              example:
                id: A08CDB2519AC4FA49EB6099CF72C3642
                domain: oms
                owner: c97ef6c8491a439f927cf9918644329f
                target:
                  id: v964735bdev-01
                  type: order
                  url: https://basedevmkp.vtexcommercebeta.com.br/admin/checkout/#/orders/v964741bdev-01
                description: The order's ID in the marketplace is 786-09
                creationDate: '2022-01-11T15:49:17.8785392Z'
                lastUpdate: '2022-01-11T15:49:17.8785392Z'
                createdBy:
                  id: fb542e51-5488-4c34-8d17-ed8fcf597a94
                  name: pedro.costa@vtex.com.br
                  email: pedro.costa@vtex.com.br
                  key: null
      deprecated: false
    get:
      tags:
      - Note
      summary: VTex Get Notes by orderId
      description: Retrieves notes related to a specific `orderId`.
      operationId: GetNotesbyorderId
      parameters:
      - name: target.id
        in: query
        description: ID of the order.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: ID of the order.
          example: 1172452900788-01
      - name: perPage
        in: query
        description: 'Number of notes per page. Maximum: 30.'
        required: false
        style: form
        explode: true
        schema:
          type: integer
          description: 'Number of notes per page. Maximum: 30.'
          example: 20
      - name: page
        in: query
        description: Number of the page to be retrieved.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          description: Number of the page to be retrieved.
          example: 3
      - 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
      - $ref: '#/components/parameters/reason'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema: {}
              example: {}
      deprecated: false
  /notes/{noteId}:
    get:
      tags:
      - Note
      summary: VTex Retrieve Note
      description: Retrieves a given note in VTEX DO, filtering by `noteId`.
      operationId: GetNote
      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: noteId
        in: path
        description: Note's ID.
        required: true
        style: simple
        schema:
          type: string
          example: 654321cba
          description: Note's ID.
      - $ref: '#/components/parameters/reason'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema: {}
              example: {}
      deprecated: false
components:
  parameters:
    reason:
      name: reason
      in: query
      description: This parameter is relevant only for PII-compliant accounts. When sending requests to this endpoint, PII-compliant accounts can use this parameter to declare the reason for requesting unmasked data. Otherwise, this endpoint will return masked PII data.
      required: false
      style: form
      schema:
        type: string
        example: data-validation
  securitySchemes:
    appKey:
      type: apiKey
      in: header
      name: X-VTEX-API-AppKey
    appToken:
      type: apiKey
      in: header
      name: X-VTEX-API-AppToken