Buscar anotação

Developing

GET

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

Devolve uma anotação específica de um pedido.

A anotação precisa pertencer ao pedido informado: um noteId que existe, mas está em outro pedido, responde 404 igual a um id inexistente. Isso é proposital — a API não revela a existência de anotações fora do pedido consultado.

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

Request

Path Params

Header Params

Responses

🟢200Anotação encontrada

application/json

Bodyapplication/json

🟠400ID da transação malformado

🟠401API Key inválida ou ausente

🟠403API Key revogada

🟠404Transação não encontrada

🟠404Anotação não encontrada

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Anotação encontrada

{
  "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"
}

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

Listar anotações

Editar anotação