Listar anotações

Developing

GET

https://api.bestfy.io/public-api/transactions/{financialTransactionId}/notes

Lista todas as anotações internas de um pedido, da mais recente para a mais antiga (createdAt decrescente).

A rota devolve o histórico completo: não há paginação nem filtros. Anotações criadas no painel da Bestfy (source: "DASHBOARD") e pela API (source: "API") vêm na mesma lista.

O campo author é null quando o usuário que escreveu a anotação foi removido da conta — o texto da anotação é preservado.

Request

Path Params

Header Params

Responses

🟢200Anotações listadas

application/json

Bodyapplication/json

🟠400ID da transação malformado

🟠401API Key inválida ou ausente

🟠403API Key revogada

🟠404Transação não encontrada

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://api.bestfy.io/public-api/transactions/{{$string.uuid}}/notes' \
--header 'x-api-key: <api-key>'

Response Example

200 - Anotações listadas

[
  {
    "id": "0199a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
    "financialTransactionId": "019c009b-ae07-2c60-cf14-abc48d02ca1d",
    "authorUserId": "0199a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
    "author": {
      "id": "0199a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
      "name": "Renato"
    },
    "source": "API",
    "content": "Cliente pediu troca para **tamanho M**.\nVer [ticket](https://suporte.example.com/123)",
    "createdAt": "2026-10-06T14:32:10.000Z",
    "updatedAt": "2026-10-06T14:32:10.000Z"
  },
  {
    "id": "0199a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a6c",
    "financialTransactionId": "019c009b-ae07-2c60-cf14-abc48d02ca1d",
    "authorUserId": null,
    "author": null,
    "source": "DASHBOARD",
    "content": "Comprador confirmou o endereço por telefone.",
    "createdAt": "2026-10-05T09:10:00.000Z",
    "updatedAt": "2026-10-05T09:10:00.000Z"
  }
]

Modified at 2026-10-06 15:55:59

Criar anotações

Buscar anotação