VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Mensagens e notificações

GETNotificações do seller

Lista as notificações internas do usuário do seller, com filtro de não lidas.

As notificações são os avisos que a plataforma grava para o usuário (por exemplo, nova mensagem) e que aparecem no sino do painel. Esta rota só lê; não há rota de seller para marcar como lida.

GET/api/v1/vendor/notificationsSeller

Lista as notificações do usuário

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller. Veja Tokens.

Parâmetros de consulta

limitintegerpadrão: 50
Itens por chamada, de 1 a 200. Fora da faixa volta para 50.
offsetintegerpadrão: 0
Quantos itens pular. Negativo vira 0.
unread_onlybooleanpadrão: false
Com true, devolve só as não lidas. Qualquer outro valor é ignorado.

Exemplo de requisição

bash
curl -X GET "$BASE_URL/api/v1/vendor/notifications?limit=50&unread_only=true" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Notificações
json
{
  "notifications": [
    {
      "id": "e6a1b2c3-4d5e-4f60-8a7b-9c0d1e2f3a4b",
      "user_id": "0fd409fb-9869-4c50-a18c-a810a19abeed",
      "event_type": "message.created",
      "title": "Nova mensagem de Maria Souza",
      "body": "Quando meu pedido chega?",
      "link": "/vendor/messages",
      "metadata": {
        "thread_id": "7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60"
      },
      "created_at": "2026-10-10T14:32:11Z"
    }
  ],
  "total": 1
}

Campos da resposta

notificationsarray

Notificações do usuário que chamou (não do seller inteiro).

iduuid
Id da notificação.
user_iduuid
Usuário dono.
event_typestring
Tipo do evento que a originou, por exemplo message.created.
titlestring
Título.
bodystring
Texto. Ausente quando vazio.
linkstring
Caminho do painel para abrir. Ausente quando vazio.
metadataobject
Dados extras do evento. Ausente quando vazio.
read_atstring
Quando foi lida. Ausente se não lida.
created_atstring
Criação (RFC 3339, UTC).
totalinteger
Total que atende ao filtro, antes de limit e offset.

Erros

StatusQuandoCorpo de exemplo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
500Falha ao consultar.{"error":"list notifications failed","detail":"..."}
Lista vazia não é erro

Se a plataforma não tem a caixa de notificações ligada, a resposta é {"notifications":[],"total":0}. As notificações pertencem ao usuário; dois usuários da equipe do mesmo seller veem listas diferentes.

Veja também

  • Visão geral de mensagens
  • Listar conversas
Anterior
Estado da conversa
Próxima
Lives (Live Commerce)
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também