GET api/v1/chat/{idPedido}/elegivel

GET

https://www.allpost.com.br/api/v1/chat/{idPedido}/elegivel

Verifica se o pedido/transportadora está elegível para chat com a transportadora

Módulo: Transportadora

Descrição

Verifica se um pedido/transportadora está elegível para receber mensagens de chat com a transportadora.
Deve ser consultado ANTES de liberar a caixa de mensagem na tela de atendimento, evitando que o atendente digite uma mensagem que não será entregue.
Exemplo:
- https://www.allpost.com.br/api/v1/chat/665f1c2a3fdb9612b7f43261/elegivel

Além do id interno do pedido, é possível identificar o pedido pelo número do pedido, número do pedido no canal ou chave da NF-e, informando o parâmetro chave na querystring (ver "Parâmetros de Path").

Um pedido é considerado elegível (elegivel: true) quando a transportadora do envio está liberada para chat nesta loja e o chat não está finalizado.
Quando não elegível (elegivel: false), o campo motivo descreve o motivo (ex.: "Transportadora não liberada para chat nesta loja." ou "Chat finalizado.").
Nos dois casos, desde que o pedido exista e pertença à loja autenticada, o retorno é HTTP 200 (é uma consulta de validação; leia o campo elegivel).
As consultas são isoladas por loja: somente pedidos pertencentes à loja autenticada pelo token são avaliados.

Códigos de retorno:
- 200: sucesso (pedido existe e pertence à loja; leia elegivel).
- 401: token ausente, expirado ou inválido.
- 403: o pedido não pertence à loja autenticada.
- 404: pedido não encontrado.

Parâmetros de Path

Campo	Descrição	Tipo	Obrigatório
idPedido	Identificador do pedido no allPost. Por padrão é o id interno do pedido; combinado com o parâmetro `chave` (querystring) pode ser também o número do pedido, o número do pedido no canal ou a chave da NF-e.	string	sim
chave	Querystring opcional que define como o valor de `idPedido` deve ser interpretado. Quando ausente, usa o id interno do pedido. Valores aceitos: `id`/`documento` (id interno, padrão), `pedido`/`numeropedido` (número do pedido), `numeropedidocanal` (número do pedido no canal — exige `canal`), `chavenf`/`chavenfe` (chave da NF-e).	string	não
canal	Querystring obrigatória apenas quando `chave=numeropedidocanal`. Identifica o canal de venda do pedido.	string	não

Exemplos:
- por número do pedido: api/v1/chat/PED-10023/elegivel?chave=pedido
- por número do pedido no canal: api/v1/chat/12345/elegivel?chave=numeropedidocanal&canal=mercadolivre
- por chave da NF-e: api/v1/chat/32000000000000000000000000000000000000000000/elegivel?chave=chavenf

Parâmetros de Retorno

Campo	Descrição	Tipo
elegivel	Indica se o pedido/transportadora está elegível para chat (true) ou não (false).	boolean
idPedido	Identificador do pedido no allPost.	string
numeroPedido	Número do pedido na loja.	string
tipoPedido	Tipo do pedido: envio ou reversa.	string
idTransportadora	Identificador da transportadora do envio.	inteiro
nomeTransportadora	Nome da transportadora do envio.	string
chatSituacao	Situação atual do chat: aberto, finalizado ou sem_conversa (quando ainda não há conversa).	string
motivo	Presente apenas quando elegivel é false. Descreve o motivo da inelegibilidade (ex.: transportadora não liberada, chat finalizado).	string

Response

// Pedido elegivel para chat:
{
    "elegivel": true,
    "idPedido": "665f1c2a3fdb9612b7f43261",
    "numeroPedido": "PED-10023",
    "tipoPedido": "reversa",
    "idTransportadora": 12,
    "nomeTransportadora": "Correios",
    "chatSituacao": "aberto"
}

// Pedido NAO elegivel (transportadora nao liberada ou chat finalizado):
{
    "elegivel": false,
    "idPedido": "665f1c2a3fdb9612b7f43261",
    "numeroPedido": "PED-10023",
    "tipoPedido": "reversa",
    "idTransportadora": 12,
    "nomeTransportadora": "Correios",
    "chatSituacao": "finalizado",
    "motivo": "Chat finalizado."
}