GET
https://www.allpost.com.br/api/v1/chats

Lista chats da loja por período, situação e transportadora (paginado, resumo com última mensagem)

Módulo: Transportadora

Descrição

Lista os chats da loja autenticada, filtrados por período de atividade (última mensagem), situação e/ou transportadora. Retorna um resumo paginado sem o conteúdo completo das mensagens — apenas a quantidade e a última mensagem de cada conversa.

Exemplo:
- https://www.allpost.com.br/api/v1/chats
- https://www.allpost.com.br/api/v1/chats?dataInicio=2026-07-01&dataFim=2026-07-11&situacao=aberto&idTransportadora=227&pagina=1&limite=50

Todos os parâmetros de filtro são opcionais. Sem informar período, retorna os chats com atividade nos últimos 30 dias.
Ordenado por dataUltimaMensagem (mais recente primeiro).

Códigos de retorno:
- 200: sucesso (lista paginada).
- 400: parâmetro inválido (ex.: situação diferente de "aberto"/"finalizado").
- 401: token ausente, expirado ou inválido.

Parâmetros de Path

Parâmetro Tipo Obrigatório Descrição
dataInicio string (YYYY-MM-DD) Não Início do período (filtra por dataUltimaMensagem). Default: -30 dias.
dataFim string (YYYY-MM-DD) Não Fim do período (filtra por dataUltimaMensagem). Default: hoje.
situacao string Não Filtra por situação do chat: "aberto" ou "finalizado".
idTransportadora inteiro Não Filtra por transportadora.
pagina inteiro Não Página atual (default: 1).
limite inteiro Não Registros por página (1–200, default: 50).

Parâmetros de Retorno

Campo Tipo Descrição
pagina inteiro Página retornada.
limite inteiro Limite por página usado.
total inteiro Total de chats que atendem ao filtro.
chats[] array Lista de chats (resumo).
chats[].idChat string Identificador do chat (_id).
chats[].idPedido string Identificador do pedido associado.
chats[].tipoPedido string "envio" ou "reversa".
chats[].idTransportadora inteiro ID da transportadora.
chats[].nomeTransportadora string Nome da transportadora.
chats[].situacao string "aberto" ou "finalizado".
chats[].subSituacao string "aguardandoRespostaLoja" ou "aguardandoRespostaTransportadora".
chats[].data string ISO 8601 Data de criação do chat.
chats[].dataUltimaMensagem string ISO 8601 Data da última mensagem (atividade).
chats[].qtdMensagens inteiro Quantidade total de mensagens na conversa.
chats[].ultimaMensagem object|null Última mensagem (resumo) ou null se vazio.
chats[].ultimaMensagem.mensagem string Texto da última mensagem.
chats[].ultimaMensagem.origem string "loja" ou "transportadora".
chats[].ultimaMensagem.data string ISO 8601 Data da última mensagem.

Response

{
  "pagina": 1,
  "limite": 50,
  "total": 12,
  "chats": [
    {
      "idChat": "f293c216c942b8e9962763c4a6a1a709",
      "idPedido": "68d490b6ad49dd4e97ebc22ff1556882",
      "tipoPedido": "reversa",
      "idTransportadora": 227,
      "nomeTransportadora": "J&T Express",
      "situacao": "aberto",
      "subSituacao": "aguardandoRespostaTransportadora",
      "data": "2026-07-09T10:00:00",
      "dataUltimaMensagem": "2026-07-11T14:30:00",
      "qtdMensagens": 5,
      "ultimaMensagem": {
        "mensagem": "Segue comprovante em anexo",
        "origem": "loja",
        "data": "2026-07-11T14:30:00"
      }
    }
  ]
}