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

Retorna eventos da fila.

Módulo: Fila de Eventos

Descrição

Retorna evento da fila.

Para que o sistema allPost possa adicionar os eventos na fila:
1 - acesse sua conta de desenvolvedor
2 - clique em sua aplicação
3 - clique na loja que deseja configurar
4 - clique no ícone modulo de comunicação (editar modulo: webhook ou fila)
5 - em tipo de comunicação: selecione a opção fila
6 - em eventos selecione o deseja adicionar na fila
7 - clique em confirmar

Após o GET - api/v1/fila o documento irá para o final da fila e será removido somente após a execução do DELETE - api/v1/fila/{idDocumento}

Você também pode optar em receber os eventos por Webhook ou pesquisar os eventos na fila.

Para ocoren do pedido:
  • "idOcoren": 1 e 2 - "situacao": "entregue"
  • "idOcoren": 99 - "situacao": "criado"
  • "idOcoren": 99 - "situacao": "postado"
  • "idOcoren": 99 - "situacao": "em transito"
  • "idOcoren": 99 - "situacao": "saiu para entrega"
  • "idOcoren": 3 até 92 - "situacao": "ocorrencia" - "mensagem": "mensagem da ocorência"

Parâmetros de Retorno

Campo Descrição Tipo Tamanho
documento Código do documento para utilização do método delete string 255
tipo Tipo do JSON. Exemplo: Rastreio, prazoAdicional, etc string 255
dados informações do webhook object
Rastreio Para ocoren do pedido
idPedido código único interno do allPost string 255
numeroPedido código do pedido da integradora string 255
idOcoren código do ocoren da versão 3.1 integer
situacao descrição do ocoren string 255
mensagem informação adicional da ocorrência string 255
data data e hora da ocorrencia timestamp
prazoAdicional Para alteração nos prazos adicionais
maior maior prazo filial, método e percentual desconto acréscimo object
prazoFilial maior prazo entre as filiais ativas integer
prazoMetodo maior prazo entre os métodos de envio ativo integer
perAdicionalDesconto maior percentual entre as filiais ativas numeric
menor menor prazo filial, método e percentual desconto acréscimo object
prazoFilial menor prazo entre as filiais ativas integer
prazoMetodo menor prazo entre os métodos de envio ativo integer
perAdicionalDesconto menor percentual entre as filiais ativas numeric
data data da criação do evento timestamp
Aplicativo Para desinstalação de aplicativo
codigo código da loja string
situacao situação do evento string
mensagem mensagem detalhada do evento string
idApp código da sua aplicação string
nomeApp nome da sua aplicação string
data data do processamento string

Response

Para ocoren do pedido:
{
	"documento": "",
	"tipo": "Rastreio",
	"dados": {
		"idPedido": "",
		"numeroPedido": "",
		"idOcoren": 99,
		"situacao": "saiu para entrega",
		"mensagem": "Transportadora saiu para entregar o produto",
		"data": "2022-08-11 09:53:00"
	}
}

Para alteração nos prazos adicionais:
{
	"documento": "",
	"tipo": "prazoAdicional",
	"dados": {
		"maior": {
			"prazoFilial": 2,
			"prazoMetodo": 0,
			"perAdicionalDesconto": 12
		},
		"menor": {
			"prazoFilial": 1,
			"prazoMetodo": 0,
			"perAdicionalDesconto": 12
		},
		"data": "2022-08-11 09:53:00"
	}
}

Para desinstalação de aplicativo:
{
	"documento": "",
	"tipo": "Aplicativo",
	"dados": {
		"codigo": "",
		"situacao": "delete",
		"mensagem": "A aplicação foi desinstalada",
		"idApp": 0,
		"nomeApp": "",
		"data": "2022-08-11 09:53:00"
	}
}

Para manutenção método envio:
{
	"documento": "",
	"tipo": "metodoEnvio",
	"dados": {
		"codigo": "",
		"situacao": "novo|altera|delete",
		"idTransportadora": 0,
		"idMetodoEnvio": 0,
		"nomeTransportadora": "",
		"nomeMetodoEnvio": "",
		"data": "2022-08-11 09:53:00"
	}
}