{
  "opencollection": "1.0.0",
  "info": {
    "name": "VTex Anti-fraud Provider Account Note API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Note",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VTex Get Notes by orderId",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/notes",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "target.id",
                "value": "",
                "type": "query",
                "description": "ID of the order."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "Number of notes per page. Maximum: 30."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Number of the page to be retrieved."
              },
              {
                "name": "reason",
                "value": "",
                "type": "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."
              }
            ]
          },
          "docs": "Retrieves notes related to a specific `orderId`."
        },
        {
          "info": {
            "name": "VTex Create Note",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/notes",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "VTex Retrieve Note",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/notes/:noteId",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "noteId",
                "value": "",
                "type": "path",
                "description": "Note's ID."
              },
              {
                "name": "reason",
                "value": "",
                "type": "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."
              }
            ]
          },
          "docs": "Retrieves a given note in VTEX DO, filtering by `noteId`."
        }
      ]
    }
  ],
  "bundled": true
}