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 e contemplados por um range de datas específicas, obtendo o retorno de dados completos, 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);listaPedidosIds- Lista com IDs dos pedidos desejados no retorno. Se este campo for informado, os filtros de data serão ignorados. (max: 50), (lista separada por "," ex.: 1,2,3);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.camposAdicionais- Campo opcional que define quais dados extras devem ser retornados em conjunto com os dados do pedido ao selecionar um ou mais valores.
Response body:
[
{
"pedidoId": 0,
"situacaoPedidoId": 0,
"tipoRastreamentoPedido": "SemRastreamento",
"transacaoId": 0,
"data": "2024-10-01T18:53:24.846Z",
"dataPagamento": "2024-10-01T18:53:24.846Z",
"dataUltimaAtualizacao": "2024-10-01T18:53:24.846Z",
"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-10-01T18:53:24.846Z",
"razaoSocial": "string",
"cnpj": "string",
"inscricaoEstadual": "string",
"responsavel": "string",
"dataCriacao": "2024-10-01T18:53:24.846Z",
"dataAtualizacao": "2024-10-01T18:53:24.846Z",
"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,
"prazoHorasEnvio": 0,
"prazoEnvioTexto": "string",
"retiradaLojaId": 0,
"centrosDistribuicao": [
{
"freteContratoId": 0,
"freteContrato": "string",
"valorFreteEmpresa": 0,
"valorFreteCliente": 0,
"peso": 0,
"pesoCobrado": 0,
"volume": 0,
"volumeCobrado": 0,
"prazoEnvio": 0,
"prazoHorasEnvio": 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-10-01T18:53:24.847Z",
"retiradaPeriodo": "string",
"nome": "string",
"documento": "string",
"codigoRetirada": "string"
},
"agendamento": {
"de": "2024-10-01T18:53:24.847Z",
"ate": "2024-10-01T18:53:24.847Z"
},
"informacoesAdicionais": [
{
"chave": "string",
"valor": "string"
}
]
},
"itens": [
{
"produtoVarianteId": 0,
"sku": "string",
"ean": "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,
"prazoHorasEnvio": 0,
"prazoEnvioTexto": "string",
"centroDistribuicaoId": 0
}
],
"dadosProdutoEvento": {
"tipoPresenteRecebimento": "None",
"eventoId": 0,
"texto": "string"
},
"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,
"imagens": [
{
"nomeArquivo": "string",
"url": "string"
}
],
"categorias": [
{
"categoria": "string",
"hierarquia": "string",
"categoriaPrincipal": true
}
]
}
],
"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-10-01T18:53:24.847Z",
"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-10-01T18:53:24.847Z",
"dataUltimoStatus": "2024-10-01T18:53:24.847Z",
"adquirente": "string",
"tid": "string"
}
],
"informacoesAdicionais": [
{
"chave": "string",
"valor": "string"
}
]
}
],
"observacao": [
{
"observacao": "string",
"usuario": "string",
"data": "2024-10-01T18:53:24.847Z",
"publica": true
}
],
"valorCreditoFidelidade": 0,
"valido": true,
"valorSubTotalSemDescontos": 0,
"pedidoSplit": [
0
],
"usuarioMasterId": 0,
"metadados": [
{
"chave": "string",
"valor": "string"
}
],
"transacaoPaiId": 0,
"detalhesContaCorrente": [
{
"contaCorrenteId": 0,
"tipoContaCorrenteId": 0,
"descricaoTipoConta": "string",
"valor": 0,
"referencias": [
"string"
]
}
],
"pedidoPai": 0
}
pedidoId (integer, optional): Número do pedido ,
situacaoPedidoId (integer, optional): Id da situação atual do pedido ,
tipoRastreamentoPedido (string, optional): Tipo do rastreamento do pedido = ['SemRastreamento', 'Pedido', 'ProdutoVariante']stringEnum:"SemRastreamento", "Pedido", "ProdutoVariante",
transacaoId (integer, optional): Id da transação do pedido ,
data (string, optional): Data do pedido ,
dataPagamento (string, optional): Data de pagamento do pedido ,
dataUltimaAtualizacao (string, optional): Data da última atualização de status do pedido ,
valorFrete (number, optional): Valor do frete do pedido ,
valorTotalPedido (number, optional): Valor total do pedido ,
valorDesconto (number, optional): Valor do desconto do pedido ,
valorDebitoCC (number, optional): Valor do desconto aplicado na conta corrente ,
cupomDesconto (string, optional): Número do cupom de desconto do pedido ,
marketPlacePedidoId (string, optional): Número interno do pedido do marketplace ,
marketPlacePedidoSiteId (string, optional): Número site do pedido do marketplace ,
canalId (integer, optional): Id do canal de venda do pedido ,
canalNome (string, optional): Nome do canal cadastrado no FOC ,
canalOrigem (string, optional): Nome do canal de venda do pedido ,
retiradaLojaId (integer, optional): Id do local de retirada do pedido ,
isPedidoEvento (boolean, optional): Se é um pedido de algum evento ,
usuario (NovoContratoGet.Usuario, optional): Dados do cliente ,
pedidoEndereco (Array[NovoContratoGet.PedidoEndereco], optional): Dados dos endereços do pedido ,
frete (NovoContratoGet.PedidoFrete, optional): Dados do frete do pedido ,
itens (Array[NovoContratoGet.PedidoProduto], optional): Produtos do pedido ,
assinatura (Array[NovoContratoGet.PedidoAssinatura], optional): Dados da assinatura do pedido ,
pagamento (Array[NovoContratoGet.PedidoPagamento], optional): Dados de pagamento do pedido ,
observacao (Array[NovoContratoGet.PedidoObservacao], optional): Dados de obervações do pedido ,
valorCreditoFidelidade (number, optional): Valor do Credito de Fidelidade ,
valido (boolean, optional): Informa se o pedido foi validado ,
valorSubTotalSemDescontos (number, optional): Valor do pedido sem considerar descontos. Irá retornar apenas se o cliente utilizar a API de dados externos ,
pedidoSplit (Array[integer], optional): Ids dos pedidos que fazem parte do Split de pedido ,
usuarioMasterId (integer, optional),
metadados (Array[NovoContratoGet.PedidoMetadado], optional): Metadados que fazem parte do pedido ,
transacaoPaiId (integer, optional): Id da Transação Pai do pedido
}NovoContratoGet.Usuario {
usuarioId (integer, optional): Id do cliente ,
grupoInformacaoCadastral (Array[NovoContratoGet.UsuarioGrupoInformacaoCadastral], optional): Dados do grupo cadastral ,
tipoPessoa (string, optional): Tipo de cliente = ['Fisica', 'Juridica']stringEnum:"Fisica", "Juridica",
origemContato (string, optional): Origem do cliente = ['Google', 'Bing', 'Jornal', 'PatrocinioEsportivo', 'RecomendacaoAlguem', 'Revista', 'SiteInternet', 'Televisao', 'Outro', 'UsuarioImportadoViaAdmin', 'PayPalExpress']stringEnum:"Google", "Bing", "Jornal", "PatrocinioEsportivo", "RecomendacaoAlguem", "Revista", "SiteInternet", "Televisao", "Outro", "UsuarioImportadoViaAdmin", "PayPalExpress",
tipoSexo (string, optional): Sexo do cliente = ['Undefined', 'Masculino', 'Feminino']stringEnum:"Undefined", "Masculino", "Feminino",
nome (string, optional): Nome do cliente ,
cpf (string, optional): Número CPF do cliente ,
email (string, optional): E-mail do cliente ,
rg (string, optional): RG do cliente ,
telefoneResidencial (string, optional): Número do telefone principal do cliente ,
telefoneCelular (string, optional): Número do telefone secudário do cliente ,
telefoneComercial (string, optional): Número do telefone comercial do cliente ,
dataNascimento (string, optional): Data de nascimento do cliente ,
razaoSocial (string, optional): Razão social da empresa ,
cnpj (string, optional): Número CNPJ da empresa ,
inscricaoEstadual (string, optional): Inscrição estadual da empresa ,
responsavel (string, optional): Responsável pelo pedido ,
dataCriacao (string, optional): Data de cadastro do cliente ,
dataAtualizacao (string, optional): Data de atualização de cadastro do cliente ,
revendedor (boolean, optional): Se o cliente é um revendedor ,
listaInformacaoCadastral (Array[NovoContratoGet.UsuarioGrupoInformacaoCadastral], optional): Dados do grupo cadastral
}NovoContratoGet.PedidoEndereco {
tipo (string, optional): Tipo do endereço do pedido = ['Entrega', 'Cobranca']stringEnum:"Entrega", "Cobranca",
nome (string, optional): Nome do endereço ,
endereco (string, optional): Endereço do pedido ,
numero (string, optional): Número do endereço do pedido ,
complemento (string, optional): Complemento do endereço do pedido ,
referencia (string, optional): Referência do endereço do pedido ,
cep (string, optional): CEP do endereço do pedido ,
tipoLogradouro (string, optional): Tipo do logradouro endereço do pedido ,
logradouro (string, optional): Logradouro do endereço do pedido ,
bairro (string, optional): Bairro do endereço do pedido ,
cidade (string, optional): Cidade do endereço do pedido ,
estado (string, optional): Estado do endereço do pedido ,
pais (string, optional): País endereço do pedido
}NovoContratoGet.PedidoFrete {
freteContratoId (integer, optional): Id do contrato do frete do pedido ,
freteContrato (string, optional): Nome do Frete ,
referenciaConector (string, optional): Referencia do Conector ,
valorFreteEmpresa (number, optional): Valor do frete do pedido para a empresa ,
valorFreteCliente (number, optional): Valor do frete do pedido para o cliente ,
peso (number, optional): Peso do frete do pedido ,
pesoCobrado (number, optional): Peso cobrado do frete do pedido ,
volume (number, optional): Volume do frete do pedido ,
volumeCobrado (number, optional): Volume cobrado do frete do pedido ,
prazoEnvio (integer, optional): Número do prazo em dias de envio do pedido ,
prazoHorasEnvio (integer, optional): Número do prazo em horas de envio do pedido ,
prazoEnvioTexto (string, optional): Descrição do prazo de envio do pedido ,
retiradaLojaId (integer, optional): Id da retirada da loja ,
centrosDistribuicao (Array[NovoContratoGet.PedidoFreteCentroDistribuicao], optional): Dados dos centros de distribuições do pedido ,
servico (NovoContratoGet.PedidoFreteServico, optional): Dados do serviço de frete do pedido (Quando utilizado Intelipost/Axado) ,
retiradaAgendada (NovoContratoGet.PedidoFreteRetiradaAgendada, optional): Dados da retirada agendada do pedido ,
agendamento (NovoContratoGet.PedidoFreteAgendamento, optional): Dados da entrega selecionado pelo cliente ,
informacoesAdicionais (Array[NovoContratoGet.PedidoFreteInformacoesAdicionais], optional): Dados das informaçãoes adicionais do frete
}NovoContratoGet.PedidoProduto {
produtoVarianteId (integer, optional): Id do produto variante do pedido ,
sku (string, optional): SKU do produto do pedido ,
ean (string, optional): EAN do produto do pedido ,
nome (string, optional): Nome do produto do pedido ,
quantidade (integer, optional): Quantidade do produto do pedido ,
precoCusto (number, optional): Preço de custo do produto do pedido ,
precoVenda (number, optional): Preço de vendo do produto do pedido ,
isBrinde (boolean, optional): Se o produto é brinde ,
valorAliquota (number, optional): Valor da alíquota do produto ,
isMarketPlace (boolean, optional): Se é um produto de marketplace ,
precoPor (number, optional): "PrecoPor" do produto do pedido ,
desconto (number, optional): "Desconto" do produto do pedido ,
totais (NovoContratoGet.PedidoProdutoPrecoTotais, optional): Preços calculado (preço base * quantidade) ,
ajustes (Array[NovoContratoGet.PedidoProdutoAjuste], optional): Dados de ajustes de preço do produto ,
centroDistribuicao (Array[NovoContratoGet.PedidoProdutoCentroDistribuicao], optional): Dados de centro de distribuição do produto ,
valoresAdicionais (Array[NovoContratoGet.PedidoProdutoValoresAdicionais], optional): Dados de valores adicionais do produto ,
atributos (Array[NovoContratoGet.PedidoProdutoAtributo], optional): Dados de atributos do produto ,
embalagens (Array[NovoContratoGet.PedidoProdutoEmbalagem], optional): Dados de embalagem do produto ,
personalizacoes (Array[NovoContratoGet.PedidoProdutoPersonalizacao], optional): Dados de personalização do produto ,
frete (Array[NovoContratoGet.PedidoProdutoFrete], optional): Dados de frete do produto (Obsoleto: Utilizar o frete do pedido.) ,
dadosProdutoEvento (NovoContratoGet.DadosEventoPedidoProdutoAPI, optional): Dados de evento do produto ,
formulas (Array[NovoContratoGet.PedidoProdutoFormula], optional): Dados de fórmulas de aliquotas do produto ,
seller (NovoContratoGet.PedidoProdutoSeller, optional): Dados do seller do produto ,
metadados (Array[NovoContratoGet.PedidoProdutoMetadado], optional): Dados dos metadados do produto ,
situacaoPedidoProdutoId (integer, optional): Dados da situacao do produto ,
imagens (Array[NovoContratoGet.PedidoProdutoImagem], optional): Dados da imagem do produto ,
categorias (Array[NovoContratoGet.PedidoProdutoCategoria], optional): Dados da categoria do produto
}NovoContratoGet.PedidoAssinatura {
assinaturaId (integer, optional): Número interno da assinatura ,
grupoAssinaturaId (integer, optional): Id do grupo de assinatura do pedido ,
tipoPeriodo (string, optional): Tipo de período da assinatura do pedido ,
tempoPeriodo (integer, optional): Tempo do período da assinatura do pedido ,
percentualDesconto (integer, optional): Percentual de desconto da assinatura do pedido
}NovoContratoGet.PedidoPagamento {
formaPagamentoId (integer, optional): Id da forma de pagamento do pedido ,
numeroParcelas (integer, optional): Número de parcelas da forma de pagamento do pedido ,
valorParcela (number, optional): Valor das parcelas da forma de pagamento do pedido ,
valorDesconto (number, optional): Valor de desconto da forma de pagamento do pedido ,
valorJuros (number, optional): Valor do juros da forma de pagamento do poedido ,
valorTotal (number, optional): Valor total da forma de pagamento do pedido ,
boleto (NovoContratoGet.PedidoPagamentoBoleto, optional): Dados do boleto ,
pix (NovoContratoGet.PedidoPagamentoPix, optional): Dados do Pix ,
cartaoCredito (Array[NovoContratoGet.PedidoPagamentoCartaoCredito], optional): Dados do cartão de crédito ,
pagamentoStatus (Array[NovoContratoGet.PedidoPagamentoStatus], optional): Dados do status de pagamento ,
informacoesAdicionais (Array[NovoContratoGet.PedidoPagamentoInformacoesAdicionais], optional): Dados das informaçãoes adicionais da forma de pagemento
}NovoContratoGet.PedidoObservacao {
observacao (string, optional): Observação do pedido ,
usuario (string, optional): Usuário da observação do pedido ,
data (string, optional): Data da observação do pedido ,
publica (boolean, optional): Informa se a informação é publica (se vai ser visualizada pelo cliente) ou privada (visualizada apenas pelo logista)
}NovoContratoGet.PedidoMetadado {
chave (string, optional): Chave do metadado do pedido ,
valor (string, optional): Valor do metadado do pedido
}NovoContratoGet.UsuarioGrupoInformacaoCadastral {
chave (string, optional): Nome do campo do cadastro ,
valor (string, optional): Valor inserido pelo cliente
}NovoContratoGet.PedidoFreteCentroDistribuicao {
freteContratoId (integer, optional): Id do contrato do frete do pedido ,
freteContrato (string, optional): Nome do Frete ,
valorFreteEmpresa (number, optional): Valor do frete do pedido para a empresa ,
valorFreteCliente (number, optional): Valor do frete do pedido para o cliente ,
peso (number, optional): Peso do frete do pedido ,
pesoCobrado (number, optional): Peso cobrado do frete do pedido ,
volume (number, optional): Volume do frete do pedido ,
volumeCobrado (number, optional): Volume cobrado do frete do pedido ,
prazoEnvio (integer, optional): Número do prazo de envio do pedido ,
prazoHorasEnvio (integer, optional): Número do prazo em horas de envio do pedido ,
prazoEnvioTexto (string, optional): Descrição do prazo de envio do pedido ,
centroDistribuicaoId (integer, optional): Id do centro de distribuição do pedido ,
cotacoesFilhas (Array[NovoContratoGet.PedidoFreteCotacaoFilha], optional): Lista de cotações filhas
}NovoContratoGet.PedidoFreteServico {
servicoId (integer, optional): Id do serviço do frete do pedido ,
nome (string, optional): Nome do serviço do frete do pedido ,
transportadora (string, optional): Nome da transportadora do pedido ,
prazo (integer, optional): Prazo de entrega do pedido ,
servicoNome (string, optional): Nome do serviço de frete do pedido ,
preco (number, optional): Valor do serviço de entrega do pedido ,
servicoTransporte (integer, optional): Nome do serviço de transporte do pedido ,
codigo (integer, optional): Código do serviço do frete do pedido ,
servicoMeta (string, optional): Informação de serviço meta do frete do pedido ,
custo (number, optional): Custo do serviço de entrega do pedido ,
token (string, optional): Toekn fornecido pelo serviço de entrega
}NovoContratoGet.PedidoFreteRetiradaAgendada {
lojaId (integer, optional): Id da loja de retirada do pedido ,
retiradaData (string, optional): Data da retirado do pedido ,
retiradaPeriodo (string, optional): Periódo da retirada do pedido ,
nome (string, optional): Nome de quem retirou o pedido ,
documento (string, optional): Documento de quem retirou o pedido ,
codigoRetirada (string, optional): Código de retirada do pedido
}NovoContratoGet.PedidoFreteAgendamento {
de (string, optional): Inicio do período selecionado pelo cliente ,
ate (string, optional): Fim do período selecionado pelo cliente
}NovoContratoGet.PedidoFreteInformacoesAdicionais {
chave (string, optional): Nome da informação adicional ,
valor (string, optional): Descrição da informação adicional
}NovoContratoGet.PedidoProdutoPrecoTotais {
precoCusto (number, optional): Preço de custo calculado. ,
precoVenda (number, optional): Preço de venda calculado. ,
precoPor (number, optional): Preço por calculado. ,
desconto (number, optional): Desconto calculado
}NovoContratoGet.PedidoProdutoAjuste {
tipo (string, optional): Tipo de ajuste do valor do produto = ['Frete', 'Pricing', 'Atacarejo', 'Personalizacao', 'Embalagem', 'Promocao', 'PromocaoFrete', 'ContaCorrente', 'FormaPagamento', 'PromocaoProduto', 'TipoFreteProduto', 'Formula']stringEnum:"Frete", "Pricing", "Atacarejo", "Personalizacao", "Embalagem", "Promocao", "PromocaoFrete", "ContaCorrente", "FormaPagamento", "PromocaoProduto", "TipoFreteProduto", "Formula",
valor (number, optional): Valor do ajuste do produto ,
observacao (string, optional): Observação do ajuste do valor do produto ,
nome (string, optional): Nome do ajuste
}NovoContratoGet.PedidoProdutoCentroDistribuicao {
centroDistribuicaoId (integer, optional): Id do centro de distribuição do produto ,
quantidade (integer, optional): Quantidade de produto que sairão deste centro de sistribuição ,
situacaoProdutoId (integer, optional): Id da situação do produto ,
valorFreteEmpresa (number, optional): Valor do frete pago pela loja ,
valorFreteCliente (number, optional): valor do frete pago pelo cliente
}NovoContratoGet.PedidoProdutoValoresAdicionais {
tipo (string, optional): Tipo de valor adicinal do produto = ['Acrescimo', 'Decrescimo']stringEnum:"Acrescimo", "Decrescimo",
origem (string, optional): Origem do valor adicinal do produto ,
texto (string, optional): Descrição do valor adicional do produto ,
valor (number, optional): Valor adicional do produto
}NovoContratoGet.PedidoProdutoAtributo {
produtoVarianteAtributoValor (string, optional): Descrição do atributo do produto ,
produtoVarianteAtributoNome (string, optional): Nome do atributo do produto
}NovoContratoGet.PedidoProdutoEmbalagem {
tipoEmbalagemId (integer, optional): Id do tipo de embalagem ,
nomeTipoEmbalagem (string, optional): Nome do tipo de embalagem do produto ,
mensagem (string, optional): Mensagem na embalagem do produto ,
valor (number, optional): Valor da embalagem do produto ,
descricao (string, optional)
}NovoContratoGet.PedidoProdutoPersonalizacao {
nomePersonalizacao (string, optional): Nome da personaliza~ção do produto ,
valorPersonalizacao (string, optional): Texto da personalização do produto ,
valor (number, optional): Valor da personalização do produto
}NovoContratoGet.PedidoProdutoFrete {
quantidade (integer, optional): Quantidade de itens do frete do produto ,
freteContratoId (integer, optional): Id do contrato do frete do pedido ,
freteContrato (string, optional): Nome do Frete ,
valorFreteEmpresa (number, optional): Valor do frete do pedido para a empresa ,
valorFreteCliente (number, optional): Valor do frete do pedido para o cliente ,
peso (number, optional): Peso do frete do pedido ,
pesoCobrado (number, optional): Peso cobrado do frete do pedido ,
volume (number, optional): Volume do frete do pedido ,
volumeCobrado (number, optional): Volume cobrado do frete do pedido ,
prazoEnvio (integer, optional): Número do prazo em dias de envio do pedido ,
prazoHorasEnvio (integer, optional): Número do prazo em horas de envio do pedido ,
prazoEnvioTexto (string, optional): Descrição do prazo de envio do pedido ,
centroDistribuicaoId (integer, optional): Id do centro de distribuição
}NovoContratoGet.DadosEventoPedidoProdutoAPI {
tipoPresenteRecebimento (string, optional): Tipo de recebimento do presente = ['None', 'Pendente', 'ReceberProduto', 'ReceberCredito']stringEnum:"None", "Pendente", "ReceberProduto", "ReceberCredito"
}NovoContratoGet.PedidoProdutoFormula {
chaveAjuste (string, optional),
valor (number, optional),
nome (string, optional),
expressao (string, optional),
expressaoInterpretada (string, optional),
endPoint (string, optional)
}NovoContratoGet.PedidoProdutoSeller {
sellerId (integer, optional),
sellerNome (string, optional),
sellerPedidoId (integer, optional)
}NovoContratoGet.PedidoProdutoMetadado {
chave (string, optional): Chave do metadado do produto ,
valor (string, optional): Valor do metadado do produto
}NovoContratoGet.PedidoProdutoImagem {
nomeArquivo (string, optional): Nome da imagem ,
url (string, optional): Url da imagem
}NovoContratoGet.PedidoProdutoCategoria {
categoria (string, optional): Nome da categoria ,
hierarquia (string, optional): Hierarquia da categoria ,
categoriaPrincipal (string, optional): Informa se a categoria é ou não vinculada como principal no produto
}NovoContratoGet.PedidoPagamentoBoleto {
urlBoleto (string, optional): Url do boleto de pagamento ,
codigoDeBarras (string, optional): Número do código de barras do boleto
}NovoContratoGet.PedidoPagamentoPix {
qrCode (string, optional): Código do QrCode ,
qrCodeExpiracao (string, optional): Data de expiração do QrCode ,
qrCodeUrl (string, optional): Url do QrCode ,
qrCodeUrlPagamento (string, optional): Url de pagamento do QrCode
}NovoContratoGet.PedidoPagamentoCartaoCredito {
numeroCartao (string, optional): Número criptografado do cartão de crédito ,
nomeTitular (string, optional): Nome do titular criptografado do cartão de crédito ,
dataValidade (string, optional): Dado de validade do cartão de crédito ,
codigoSeguranca (string, optional): Código de segurança criptografado do cartão de crédito ,
documentoCartaoCredito (string, optional): Documento criptografado do cartão de crédito ,
token (string, optional): Token do cartão crédito ,
info (string, optional): Informações adicionais ,
bandeira (string, optional): Bandeira do cartão
}NovoContratoGet.PedidoPagamentoStatus {
numeroAutorizacao (string, optional): Número de autorização de pagamento ,
numeroComprovanteVenda (string, optional): Número do comprovante de autorização de pagamento ,
dataAtualizacao (string, optional): Data da última atualização do status ,
dataUltimoStatus (string, optional): Data do último status ,
adquirente (string, optional): Adquirente da autorização do pagamento ,
tid (string, optional): Auth da autorização do pagamento
}NovoContratoGet.PedidoPagamentoInformacoesAdicionais {
chave (string, optional): Nome da informação adicional ,
valor (string, optional): Descrição da informação adicional
}NovoContratoGet.PedidoFreteCotacaoFilha {
centroDistribuicaoId (integer, optional),
freteContrato (string, optional),
valor (number, optional),
volume (number, optional),
tabelaFreteId (integer, optional)
}
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 6 days ago