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

Lista pedidos.

Módulo: Pedido

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/pedidos/?dataTipo=dataCriacaoPedido&periodo=2023-01-01T00:00:00TO2023-01-30T23:59:59&pagina=1&limite=100&idStatus=40,50

Campo Descrição Tipo Obrigatório
dataTipo Campo a ser a ser utilizado pelo filtro período: dataCriacaoPedido, dataCotacao, dataFaturamento, dataNotfis, previsaoCotacao, previsaoPedido, dataConhecimento, dataConhecimentoProcessamento, dataEntrega, previsaoEntregaPedido, previsaoEntregaCotacao ou dataAutorizacaoCte
Também será utilizado como campo de ordenação. 		string sim
periodo Data inicial e final do filtro de data. 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
idStatus Filtro de situação do pedido. Utilizar virgula para mais de uma situação. Exemplo: &idStatus=40,50
Para saber mais sobre os códigos dos status realize o GET api/v1/lista/status 		string não
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
cpfCnpj Pesquisa por número de documento do cliente string não
autorizado Informe "sim" para exibir apenas os pedidos que foram auditados e autorizados, "não" para listar aqueles que ainda estão pendentes de autorização, ou deixe em branco para visualizar todos os pedidos, independentemente do status. string não
* canal, plataforma e transportadora Não podem ser utilizados nos parâmetros da URL. Para utilizar esses filtros acesse as configurados do seu aplicativo. string não

* Os pedidos serão retornados utilizando o filtro adicional: canal, plataforma e transportadora. Que pode ser configurado em sua aplicação.

Parâmetros de Retorno

Response

[{
	"_id": "a041e5fb6a3fdb9612b7f43261b0xXXX",
	"data": "2022-10-01 00:00:00",
	"idLoja": 0,
	"nomeLoja": "",
	"numeroPedido": "",
	"tipoPedido": "envio",
	"numeroPedidoEnvioPai": "",
	"idCotacao": "",
	"canal": "",
	"plataforma": "",
	"intermediadorVenda": "",
	"pedidoAuxiliar": "",
	"valorFreteReal": 0,
	"valorFreteCobrado": 0,
	"valorFretePedido": 0,
	"valorFreteDiferencaPedidoCotacao": 0,
	"percentualFreteDiferencaPedidoCotacao": 0,
	"prazoTrocaTransporte": 0,
	"valorTrocaTransporte": 0,
	"idStatus": 30,
	"statusDescricao": "Em trânsito",
	"idFilialCotado": 0,
	"filialERPCotado": "",
	"filialNomeCotado": "",
	"idMetodoEnvioCotado": 0,
	"idTransportadoraCotado": 0,
	"NomeMetodoEnvioCotado": "",
	"NomeTransportadoraCotado": "",
	"acompanhamentoStatus": [{
			"idStatus": 10,
			"statusDescricao": "Criado",
			"data": "2022-10-01 14:34:13"
		},
		{
			"idStatus": 20,
			"statusDescricao": "Faturado",
			"data": "2022-10-01 14:34:13"
		},
		{
			"idStatus": 30,
			"statusDescricao": "Em trânsito",
			"data": "2022-10-01 17:24:38"
		}
	],
	"enderecoEntrega": {
		"nome": "",
		"email": "",
		"cpfCnpj": "",
		"cep": "",
		"uf": "",
		"regiao": "",
		"cidade": "",
		"endereco": "",
		"numero": "",
		"bairro": "",
		"referencia": "",
		"coordenadas": {
			"latitude": 0,
			"longitude": 0
		},
		"telefones": [
			""
		]
	},
	"envio": [{
		"id": 1,
		"idStatus": 30,
		"statusDescricao": "Em trânsito",
		"descricao": "",
		"idTransportadora": 0,
		"nomeTransportadora": "",
		"idMetodoEnvio": 0,
		"nomeMetodoEnvio": "",
		"urlFotoMetodoEnvio": "",
		"peso": 0,
		"altura": 0,
		"largura": 0,
		"profundidade": 0,
		"quantidade": 0,
		"quantidadeVolumes": 0,
		"codigoRastreio": "",
		"plp": 0,
		"urlRastreioExterno": "",
		"mapaDeCarga": "",
		"prazoEntregaPedido": "2022-10-26 03:00:00",
		"prazoEntregaCotacao": "2022-10-27 03:00:00",
		"dataEntrega": null,
		"diferencaPedidoCotacao": 0,
		"diferencaFaturamentoCotacao": 0,
		"diferencaCotadoEntregue": null,
		"diferencaPedidoEntregue": null,
		"prazoTrocaTransporte": 0,
		"valorTrocaTransporte": 0,
		"freteRealTrocaTransporte": 0,
		"dataCotacao": "2022-10-01 03:00:00",
		"prazoCotacaoDiasUteis": 0,
		"observacao": [],
		"conciliacao": {
			"notaFiscal": 0,
			"serie": 0,
			"cnpj": "",
			"chaveNF": "",
			"valorFreteCobrando": 0,
			"serieConhecimento": 0,
			"numeroConhecimento": 0,
			"chaveConhecimento": "",
			"dataConhecimento": "2022-10-11 03:00:00",
			"dataProcessamento": "2022-10-12 02:41:40",
			"peso": 0,
			"pesoCubado": 0,
			"pesoDensidade": 0,
			"despesaAdicional": 0,
			"baseIcms": 0,
			"icms": 0,
			"valorIcms": 0,
			"fretePeso": 0,
			"freteValor": 0,
			"secCat": 0,
			"ITR": 0,
			"valorDespacho": 0,
			"valorPedagio": 0,
			"valorAdame": 0,
			"adValor": 0,
			"gris": 0,
			"tas": 0,
			"taxa": 0,
			"ST": "Não",
			"cnpjTransportadora": "",
			"idTipoConhecimento": "N",
			"tipoConhecimento": "Normal",
			"valorDiferenca": 0,
			"percentualDiferenca": 0,
			"autorizado": "",
			"usuarioAutorizacao": "",
			"idUsuarioAutorizacao": "",
			"comentarioAutorizacao": "",
		},
		"notaFiscal": {
			"cnpjFaturador": "",
			"idFilialCotacao": 0,
			"idFilialEnvio": 0,
			"filialERP": "",
			"filialNomeEnvio": "",
			"cidade": "",
			"uf": "",
			"cep": "",
			"pedidoERP": "",
			"numero": 0,
			"serie": 0,
			"chave": "",
			"data": "2022-10-02 03:00:00",
			"valorTotal": 0,
			"valorTotalProdutos": 0
		},
		"produtos": [{
			"sku": "",
			"titulo": "",
			"categoria": "",
			"peso": 0,
			"altura": 0,
			"largura": 0,
			"profundidade": 0,
			"preco": 0,
			"quantidade": 0,
			"quantidadeVolumes": 0,
			"idSku": "",
			"tituloCadastro": "",
			"categoriaCadastro": "",
			"variacao": "",
			"pesoCadastro": 0,
			"alturaCadastro": 0,
			"larguraCadastro": 0,
			"profundidadeCadastro": 0
		}],
		"ocoren": [{
				"id": 1,
				"data": "2022-10-11 14:34:13",
				"idOcoren": 9999,
				"descricao": "Pedido Criado",
				"informacaoAdicional": "O pedido foi criado no sistema",
				"visivelCliente": true
			},
			{
				"id": 2,
				"data": "2022-10-11 14:34:13",
				"idOcoren": 9998,
				"descricao": "Faturado",
				"informacaoAdicional": "O pedido foi Faturado",
				"visivelCliente": true
			},
			{
				"id": 3,
				"data": "2022-10-11 16:35:00",
				"idOcoren": 0,
				"descricao": "Em trânsito",
				"informacaoAdicional": "CT-e autorizado com 1 volume. Destino: XXX",
				"visivelCliente": true
			}
		],
		"dadosAdicionaisEnvio": null
	}],
	"dadosAdicionaisPedido": null
}]