API legada/Referência completa/Configurações e notificações

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.

GET/api/v1.0/notificationsAutenticada

Listar 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ório

Id do usuário dono da caixa de entrada (UUID).

pageintegerpadrão: 1

Página, a partir de 1.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250. Fora disso vale 10.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" \
  "$BASE_URL/api/v1.0/notifications?user_id=$USER_ID&items_per_page=20"

Resposta

200Notificações do usuário

json

{
  "notifications": [
    {
      "notification_id": "9c1d2e3f-4a5b-4c6d-8e7f-0a1b2c3d4e5f",
      "user_id": "c1a2b3d4-1111-4222-8333-944455556666",
      "type": "order_shipped",
      "title": "Seu pedido foi enviado",
      "message": "O pedido 1042 saiu para entrega.",
      "status": "unread",
      "timestamp": 1791749793
    }
  ],
  "search": { "page": 1, "items_per_page": 10, "total_items": 1 }
}

Campos da resposta

notificationsarray

Notificações da página. Vazio quando o usuário não tem nenhuma.

notifications[].notification_idstring

Id da notificação.

notifications[].user_idstring

Id do usuário.

notifications[].typestring

Categoria do aviso.

notifications[].titlestring

Título.

notifications[].messagestring

Texto do aviso.

notifications[].statusstring

readunread

Se o usuário já leu.

notifications[].timestampinteger

Criação, em Unix timestamp (segundos, UTC).

searchobject

page, 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}`

Veja também