GET
https://www.allpost.com.br/api/v1/plp/lista

Lista PLPs.

Módulo: PLP

Descrição

Retorna uma lista de pedidos com limite máximo de 50 pedidos por pagina.

Parâmetros de Entrada

Exemplo:
https://www.allpost.com.br/api/v1/plp/lista/?status=Finalizado&periodo=2023-01-01T00:00:00TO2023-01-30T23:59:59&filialERP=1

Campo Descrição Tipo Obrigatório
periodo Data inicial e final da data de criação da PLP. Separar com o termo TO. Exemplo: &periodo=2023-01-01TO2023-01-31
Ou filtre por data e hora. Exemplo: &periodo=2023-01-01T10:00:00TO2023-01-01T15:59:59 		string sim
status O campo de status deve ser preenchido obrigatoriamente com uma das seguintes opções: Pendente, Finalizado ou Excluído. string sim
pagina Número da pagina. Iniciado em 1 (um).
Quando acabar a paginação o sistema ira retornar código response HTTP 200 porem com conteúdo vazio []. 		inteiro não
limite Quantidade de pedidos por pagina. Limite máximo de 50 pedidos. inteiro não

Parâmetros de Retorno

Campo Descrição Tipo Tamanho
_id Código do documento string 255
codigoPLP Código da PLP informada na URL integer
filialERP Código da filial informada na URL string 30
idLoja Código da loja no sistema integer
idFilial Código da filial no sistema integer
data Data e hora que a PLP foi criada date
idRecibo A informação do recibo será fornecida somente se a etiqueta for gerada por sistemas de terceiros. string 255
aplicacao Nome da aplicação responsável por gerar a etiqueta padrão. string 100
status Situação da PLP: Pendente, Finalizada ou Excluída string 40
erros Lista de erros a serem corrigidos array|string 255
dataFechamento Data que a PLP foi finalizada date
idTransportadora Código da transportadora integer
idMetodo Código do método de envio integer
transportadora Nome da transportadora string 45
metodoEnvio Nome do método de envio string 40
nomeUsuario Nome do usuário que criou a PLP string 35
idApp Código da aplicação que criou a PLP integer
nomeApp Nome da aplicação que criou a PLP string 100
listaPedidos Lista de pedidos que compõem a PLP
documento Chave do pedido string 255
numeroPedido Seu número de pedido string 100
chaveNF Chave da Nota Fiscal string 44
idEnvio Código da Entrega integer
protocolo Código de rastreio de sistemas terceiros. Exemplo protocolo de rastreio dos Correios string 100
erros Lista erros de integração se houver string 255

Response

[{
	"_id": "",
	"codigoPLP": 0,
	"filialERP": "",
	"idLoja": 0,
	"idFilial": 0,
	"data": "2023-01-01 01:00:08",
	"idRecibo": "",
	"aplicacao": "",
	"status": "",
	"erros": [],
	"dataFechamento": null,
	"idTransportadora": 0,
	"idMetodo": 0,
	"transportadora": "",
	"metodoEnvio": "",
	"nomeUsuario": "",
	"idApp": 0,
	"nomeApp": "",
	"listaPedidos": [{
		"documento": "",
		"numeroPedido": "",
		"chaveNF": "",
		"idEnvio": 0,
		"protocolo": "",
		"erros": ""
	}]
}]