Consultando uma listagem de pedidos
Recomendamos a inscrição nos tópicos de pedido do nosso Webhook para uma melhor performance da integração.
Para realizar a consulta de uma listagem de pedidos, ordenados por data decrescente, dentro de um range de datas específicas, utilize o endpoint Retorna uma lista de pedido na ordem decrescente dentro do limite de datas passadas.
Parâmetros para consulta:
dataInicial- Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss);dataFinal- Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss);enumTipoFiltroData- Tipo de filtro da data (Ordenação "desc" - padrão: DataPedido);situacoesPedido- Lista de situações que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as situações;formasPagamento- Lista de formas de pagamento que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as formas de pagamento;pagina- Página da lista (padrão: 1);quantidadeRegistros- Quantidade de registros que deverão retornar (max: 50);email- Deverá retornar apenas pedidos realizados pelo usuário com o e-mail passado;valido- Deverá retornar apenas pedidos válidos, inválidos ou todos (caso não seja informado).sku- Deverá retornar apenas pedidos que o produto de determinado sku foi comprado.apenasAssinaturas- Quando passado o valor true, deverá retornar apenas pedidos de assinatura. Quando falso, deverá retornar todos os pedidos.direcaoOrdenacao- Define se a ordenação dos pedidos deverá ser feita de forma ascendente ou descendente. Caso o campo não seja preenchido, o comportamento padrão é a ordenação de forma descendente.
Response body:
[
{
"pedidoId": 0,
"situacaoPedidoId": 0,
"tipoRastreamentoPedido": "SemRastreamento",
"transacaoId": 0,
"data": "2024-03-05T12:53:55.329Z",
"dataPagamento": "2024-03-05T12:53:55.329Z",
"dataUltimaAtualizacao": "2024-03-05T12:53:55.329Z",
"valorFrete": 0,
"valorTotalPedido": 0,
"valorDesconto": 0,
"valorDebitoCC": 0,
"cupomDesconto": "string",
"marketPlacePedidoId": "string",
"marketPlacePedidoSiteId": "string",
"canalId": 0,
"canalNome": "string",
"canalOrigem": "string",
"retiradaLojaId": 0,
"isPedidoEvento": true,
"usuario": {
"usuarioId": 0,
"grupoInformacaoCadastral": [
{
"chave": "string",
"valor": "string"
}
],
"tipoPessoa": "Fisica",
"origemContato": "Google",
"tipoSexo": "Undefined",
"nome": "string",
"cpf": "string",
"email": "string",
"rg": "string",
"telefoneResidencial": "string",
"telefoneCelular": "string",
"telefoneComercial": "string",
"dataNascimento": "2024-03-05T12:53:55.329Z",
"razaoSocial": "string",
"cnpj": "string",
"inscricaoEstadual": "string",
"responsavel": "string",
"dataCriacao": "2024-03-05T12:53:55.329Z",
"dataAtualizacao": "2024-03-05T12:53:55.329Z",
"revendedor": true,
"listaInformacaoCadastral": [
{
"chave": "string",
"valor": "string"
}
]
},
"pedidoEndereco": [
{
"tipo": "Entrega",
"nome": "string",
"endereco": "string",
"numero": "string",
"complemento": "string",
"referencia": "string",
"cep": "string",
"tipoLogradouro": "string",
"logradouro": "string",
"bairro": "string",
"cidade": "string",
"estado": "string",
"pais": "string"
}
],
"frete": {
"freteContratoId": 0,
"freteContrato": "string",
"referenciaConector": "string",
"valorFreteEmpresa": 0,
"valorFreteCliente": 0,
"peso": 0,
"pesoCobrado": 0,
"volume": 0,
"volumeCobrado": 0,
"prazoEnvio": 0,
"prazoEnvioTexto": "string",
"retiradaLojaId": 0,
"centrosDistribuicao": [
{
"freteContratoId": 0,
"freteContrato": "string",
"valorFreteEmpresa": 0,
"valorFreteCliente": 0,
"peso": 0,
"pesoCobrado": 0,
"volume": 0,
"volumeCobrado": 0,
"prazoEnvio": 0,
"prazoEnvioTexto": "string",
"centroDistribuicaoId": 0,
"cotacoesFilhas": [
{
"centroDistribuicaoId": 0,
"freteContrato": "string",
"valor": 0,
"volume": 0,
"tabelaFreteId": 0
}
]
}
],
"servico": {
"servicoId": 0,
"nome": "string",
"transportadora": "string",
"prazo": 0,
"servicoNome": "string",
"preco": 0,
"servicoTransporte": 0,
"codigo": 0,
"servicoMeta": "string",
"custo": 0,
"token": "string"
},
"retiradaAgendada": {
"lojaId": 0,
"retiradaData": "2024-03-05T12:53:55.329Z",
"retiradaPeriodo": "string",
"nome": "string",
"documento": "string",
"codigoRetirada": "string"
},
"agendamento": {
"de": "2024-03-05T12:53:55.329Z",
"ate": "2024-03-05T12:53:55.329Z"
},
"informacoesAdicionais": [
{
"chave": "string",
"valor": "string"
}
]
},
"itens": [
{
"produtoVarianteId": 0,
"sku": "string",
"nome": "string",
"quantidade": 0,
"precoCusto": 0,
"precoVenda": 0,
"isBrinde": true,
"valorAliquota": 0,
"isMarketPlace": true,
"precoPor": 0,
"desconto": 0,
"totais": {
"precoCusto": 0,
"precoVenda": 0,
"precoPor": 0,
"desconto": 0
},
"ajustes": [
{
"tipo": "Frete",
"valor": 0,
"observacao": "string",
"nome": "string"
}
],
"centroDistribuicao": [
{
"centroDistribuicaoId": 0,
"quantidade": 0,
"situacaoProdutoId": 0,
"valorFreteEmpresa": 0,
"valorFreteCliente": 0
}
],
"valoresAdicionais": [
{
"tipo": "Acrescimo",
"origem": "string",
"texto": "string",
"valor": 0
}
],
"atributos": [
{
"produtoVarianteAtributoValor": "string",
"produtoVarianteAtributoNome": "string"
}
],
"embalagens": [
{
"tipoEmbalagemId": 0,
"nomeTipoEmbalagem": "string",
"mensagem": "string",
"valor": 0,
"descricao": "string"
}
],
"personalizacoes": [
{
"nomePersonalizacao": "string",
"valorPersonalizacao": "string",
"valor": 0
}
],
"frete": [
{
"quantidade": 0,
"freteContratoId": 0,
"freteContrato": "string",
"valorFreteEmpresa": 0,
"valorFreteCliente": 0,
"peso": 0,
"pesoCobrado": 0,
"volume": 0,
"volumeCobrado": 0,
"prazoEnvio": 0,
"prazoEnvioTexto": "string",
"centroDistribuicaoId": 0
}
],
"dadosProdutoEvento": {
"tipoPresenteRecebimento": "None"
},
"formulas": [
{
"chaveAjuste": "string",
"valor": 0,
"nome": "string",
"expressao": "string",
"expressaoInterpretada": "string",
"endPoint": "string"
}
],
"seller": {
"sellerId": 0,
"sellerNome": "string",
"sellerPedidoId": 0
},
"metadados": [
{
"chave": "string",
"valor": "string"
}
],
"situacaoPedidoProdutoId": 0
}
],
"assinatura": [
{
"assinaturaId": 0,
"grupoAssinaturaId": 0,
"tipoPeriodo": "string",
"tempoPeriodo": 0,
"percentualDesconto": 0
}
],
"pagamento": [
{
"formaPagamentoId": 0,
"numeroParcelas": 0,
"valorParcela": 0,
"valorDesconto": 0,
"valorJuros": 0,
"valorTotal": 0,
"boleto": {
"urlBoleto": "string",
"codigoDeBarras": "string"
},
"pix": {
"qrCode": "string",
"qrCodeExpiracao": "2024-03-05T12:53:55.329Z",
"qrCodeUrl": "string",
"qrCodeUrlPagamento": "string"
},
"cartaoCredito": [
{
"numeroCartao": "string",
"nomeTitular": "string",
"dataValidade": "string",
"codigoSeguranca": "string",
"documentoCartaoCredito": "string",
"token": "string",
"info": "string",
"bandeira": "string"
}
],
"pagamentoStatus": [
{
"numeroAutorizacao": "string",
"numeroComprovanteVenda": "string",
"dataAtualizacao": "2024-03-05T12:53:55.329Z",
"dataUltimoStatus": "2024-03-05T12:53:55.329Z",
"adquirente": "string",
"tid": "string"
}
],
"informacoesAdicionais": [
{
"chave": "string",
"valor": "string"
}
]
}
],
"observacao": [
{
"observacao": "string",
"usuario": "string",
"data": "2024-03-05T12:53:55.329Z",
"publica": true
}
],
"valorCreditoFidelidade": 0,
"valido": true,
"valorSubTotalSemDescontos": 0,
"pedidoSplit": [
0
],
"usuarioMasterId": 0,
"metadados": [
{
"chave": "string",
"valor": "string"
}
],
"transacaoPaiId": 0
}
]
Response Headers
Dentro do response headers, temos o campo "x-total-count", que irá retornar a contagem total de pedidos que atendem o filtro realizado, dessa forma o integrador poderá saber quantas paginas existem na consulta realizada.
Atenção!
O retorno de consulta de pedidos possui limite de 10.000 registros. Para não exceder ao limite de registros, faça consultas com intervalos e períodos menores, de acordo com a volumetria de pedidos de sua loja.
Updated 2 months ago