Notificações
Lista, em páginas, as notificações da caixa de entrada de um usuário.
Uma notificação é um aviso na caixa de entrada de um usuário da loja ("seu pedido foi enviado", "novo comentário"). Esta rota é só de leitura e serve para um aplicativo mostrar o sino de avisos. Aceita qualquer usuário autenticado.
/api/v1.0/notificationsAutenticadaListar as notificações de um usuário
Devolve as notificações do usuário informado em user_id, em páginas.
Parâmetros de consulta
user_idstringobrigatórioId do usuário dono da caixa de entrada (UUID).
pageintegerpadrão: 1Página, a partir de 1.
items_per_pageintegerpadrão: 10Itens por página, de 1 a 250. Fora disso vale 10.
Exemplo de requisição
Resposta
200Notificações do usuário
Campos da resposta
notificationsarrayNotificações da página. Vazio quando o usuário não tem nenhuma.
notifications[].notification_idstringId da notificação.
notifications[].user_idstringId do usuário.
notifications[].typestringCategoria do aviso.
notifications[].titlestringTítulo.
notifications[].messagestringTexto do aviso.
notifications[].statusstringreadunreadSe o usuário já leu.
notifications[].timestampintegerCriação, em Unix timestamp (segundos, UTC).
searchobjectpage, items_per_page e total_items.Erros
| Status | Quando | Corpo |
|---|---|---|
| 400 | Falta user_id | {"message":"user_id is required","status":400} |
| 401 | Sem credenciais | {"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401} |