VTEX Note API

openapi: 3.0.0
info:
  title: VTex Anti-fraud Provider Account Note API
  description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud  Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)"
  version: '1.0'
servers:
- url: https://{providerApiEndpoint}
  description: Anti-fraud provider endpoint URL.
  variables:
    providerApiEndpoint:
      description: Anti-fraud provider endpoint URL.
      default: '{providerApiEndpoint}'
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:\r\n\n\r- The maximum number of notes for an order is 30.\r\n\n\r- 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:
    VtexIdclientAutCookie:
      type: apiKey
      in: header
      name: VtexIdclientAutCookie
      description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'