Os parâmetros para a requisição estão abaixo:
Campo |
Tipo |
Descrição |
Obrigatório |
---|---|---|---|
IdInquilino | string | Identificador do Inquilino | Sim |
IdPedidoRetaguarda | string | Identificador do pedido na retaguarda |
Sim |
{
"success": true,
"message": "string",
"data": {
"offline": true,
"cliente": {
"bairro": "string",
"celular": "string",
"cep": "string",
"cidade": "string",
"clienteAlterado": true,
"complemento": "string",
"cpfCnpj": "string",
"dataNascimento": "2024-06-17T21:15:15.380Z",
"email": "string",
"endereco": "string",
"enderecos": [
{
"bairro": "string",
"celular": "string",
"cep": "string",
"cidade": "string",
"complemento": "string",
"endereco": "string",
"estado": "string",
"numero": "string",
"tipo": "string",
"tipoId": 0,
"dataAtualizacao": "2024-06-17T21:15:15.380Z",
"dataCadastro": "2024-06-17T21:15:15.380Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"estado": "string",
"estadoCivil": 0,
"nome": "string",
"numero": "string",
"pessoaFisica": 0,
"rgInscricao": "string",
"sexo": 0,
"telefone": "string",
"dataAtualizacao": "2024-06-17T21:15:15.380Z",
"dataCadastro": "2024-06-17T21:15:15.380Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0,
"idProfissionalRetaguarda": "string"
},
"codigoPromocional": "string",
"cpfConsumidor": "string",
"data": "2024-06-17T21:15:15.380Z",
"descontoPercentualTotal": 0,
"descontoTotal": 0,
"idCanalVendaRetaguarda": "string",
"idInquilino": "string",
"idLojaRetaguarda": "string",
"idOperadorRetaguarda": "string",
"motivoDesconto": {
"descontoMotorPromocaoAplicado": true,
"descricao": "string",
"idPromocaoMotorPromocaoTerceiro": "string",
"tipo": 0,
"tipoDescontoAcrescimo": 0,
"dataAtualizacao": "2024-06-17T21:15:15.380Z",
"dataCadastro": "2024-06-17T21:15:15.380Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
},
"nomeConsumidor": "string",
"numero": "string",
"numeroAutorizacao": "string",
"numeroVenda": "string",
"preVendaItens": [
{
"acrescimo": 0,
"acrescimoPercentual": 0,
"codigoFilialSaida": "string",
"codigoProduto": "string",
"dataEntrega": "2024-06-17T21:15:15.380Z",
"desconto": 0,
"descontoPercentual": 0,
"entrega": {
"dataEntrega": "2024-06-17T21:15:15.380Z",
"idLojaEntregaRetaguarda": "string",
"lockerMachineCode": "string",
"lockerParcelCode": "string",
"tipoEntrega": 0,
"fretePercentualTotal": 0,
"freteTotal": 0,
"tipoValorFrete": 0
},
"idPrecoRetaguarda": "string",
"idPreVenda": 0,
"idProdutoRetaguarda": "string",
"idVendedorRetaguarda": "string",
"itensKit": [
{
"idProdutoRetaguarda": "string",
"preco": 0,
"quantidade": 0,
"sequencial": 0
}
],
"motivoDesconto": {
"descontoMotorPromocaoAplicado": true,
"descricao": "string",
"idPromocaoMotorPromocaoTerceiro": "string",
"tipo": 0,
"tipoDescontoAcrescimo": 0,
"dataAtualizacao": "2024-06-17T21:15:15.380Z",
"dataCadastro": "2024-06-17T21:15:15.380Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
},
"preco": 0,
"quantidade": 0,
"quantidadeFaturada": 0,
"frete": 0,
"fretePercentual": 0,
"tipoValorFrete": 0,
"quantidadeEncomenda": 0,
"idProdutoEmbalagemRetaguarda": "string",
"dataAtualizacao": "2024-06-17T21:15:15.380Z",
"dataCadastro": "2024-06-17T21:15:15.380Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"preVendaPagamentos": [
{
"idPagamentoCondicaoRetaguarda": "string",
"idPagamentoFormaRetaguarda": "string",
"idPagamentoOperadoraRetaguarda": "string",
"idPreVenda": 0,
"preVendaPagamentoDadosComplementares": [
{
"descricao": "string",
"idPagamentoDadoComplementarRetaguarda": "string",
"idPreVendaPagamento": 0,
"dataAtualizacao": "2024-06-17T21:15:15.380Z",
"dataCadastro": "2024-06-17T21:15:15.380Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"preVendaPagamentoItens": [
{
"dataVencimento": "2024-06-17T21:15:15.380Z",
"idPreVendaPagamento": 0,
"numeroParcela": 0,
"valorParcela": 0,
"dataAtualizacao": "2024-06-17T21:15:15.380Z",
"dataCadastro": "2024-06-17T21:15:15.380Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"preVendaPagamentoTefs": [
{
"bandeira": "string",
"codigoRede": "string",
"dataPreDatado": "2024-06-17T21:15:15.380Z",
"diasEntreParcelas": 0,
"idPreVendaPagamento": 0,
"idTransacaoDigital": "string",
"nsuHost": "string",
"numeroAutorizacao": "string",
"numeroBin": "string",
"numeroParcelas": 0,
"primeiraParcela": "2024-06-17T21:15:15.380Z",
"dataAtualizacao": "2024-06-17T21:15:15.380Z",
"dataCadastro": "2024-06-17T21:15:15.380Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"valorLiquido": 0,
"valorMinimoAceito": 0,
"valorPago": 0,
"valorTroco": 0,
"pagamentoForma": {
"idRetaguarda": "string"
},
"pagamentoCondicao": {
"idRetaguarda": "string"
},
"quantidadeParcelas": 0,
"dataAtualizacao": "2024-06-17T21:15:15.380Z",
"dataCadastro": "2024-06-17T21:15:15.380Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"vendaPagamentos": [
{
"vendaId": 0,
"pagamentoFormaId": 0,
"pagamentoForma": {
"idRetaguarda": "string",
"descricao": "string"
},
"pagamentoCondicaoId": 0,
"pagamentoCondicao": {
"idRetaguarda": "string",
"descricao": "string",
"diasEntreParcelas": 0
},
"pagamentoOperadoraId": 0,
"pagamentoOperadora": {
"idRetaguarda": "string",
"descricao": "string",
"codigoTef": "string"
},
"valorPago": 0,
"valorTroco": 0,
"valorLiquido": 0,
"idRetaguardaCredito": 0,
"cpfCnpjCliente": "string",
"quantidadeParcelas": 0,
"idDivida": "string",
"vendaPagamentoDadoComplementars": [
{
"conteudo": "string",
"descricao": "string",
"idPagamentoDadoComplementar": 0,
"idPagamentoDadoComplementarRetaguarda": "string",
"idVendaPagamento": 0,
"pagamentoDadoComplementar": {
"descricao": "string",
"tipo": 0,
"obrigatorio": 0,
"tamanho": 0,
"tipoCampoTef": 0,
"dataAtualizacao": "2024-06-17T21:15:15.380Z",
"dataCadastro": "2024-06-17T21:15:15.380Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
},
"dataAtualizacao": "2024-06-17T21:15:15.380Z",
"dataCadastro": "2024-06-17T21:15:15.380Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"vendaPagamentoItems": [
{
"vendaPagamentoId": 0,
"numeroParcela": 0,
"valorParcela": 0,
"dataVencimento": "2024-06-17T21:15:15.380Z",
"dataAtualizacao": "2024-06-17T21:15:15.380Z",
"dataCadastro": "2024-06-17T21:15:15.380Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"vendaPagamentoTefs": [
{
"bandeira": "string",
"codigoRede": "string",
"dataPreDatado": "2024-06-17T21:15:15.380Z",
"diasEntreParcelas": 0,
"idVendaPagamento": 0,
"idTransacaoDigital": "string",
"nsuHost": "string",
"numeroAutorizacao": "string",
"numeroBin": "string",
"numeroParcelas": 0,
"primeiraParcela": "2024-06-17T21:15:15.380Z",
"idPagamentoMfe": 0,
"sincronizadoPagamentoMfe": true,
"dataAtualizacao": "2024-06-17T21:15:15.380Z",
"dataCadastro": "2024-06-17T21:15:15.380Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"vendaPagamentoTrocas": [
{
"vendaPagamentoId": 0,
"idVendaRetaguarda": "string",
"cpfCnpj": "string",
"nome": "string",
"motivoId": 0,
"motivo": {
"idRetaguarda": "string",
"descricao": "string"
},
"dataTroca": "2024-06-17T21:15:15.380Z",
"valorTotal": 0,
"trocaItems": [
{
"idItemRetaguarda": "string",
"trocaId": 0,
"produtoId": 0,
"produto": {
"id": 0,
"idRetaguarda": "string",
"codigoProduto": "string",
"descricao": "string"
},
"valor": 0,
"quantidade": 0,
"dataAtualizacao": "2024-06-17T21:15:15.380Z",
"dataCadastro": "2024-06-17T21:15:15.380Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"dataAtualizacao": "2024-06-17T21:15:15.380Z",
"dataCadastro": "2024-06-17T21:15:15.380Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"dataAtualizacao": "2024-06-17T21:15:15.381Z",
"dataCadastro": "2024-06-17T21:15:15.381Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"serieVenda": "string",
"sincronizado": 0,
"sistemaOrigem": 0,
"situacaoPreVenda": "string",
"terminalOrigem": "string",
"tipoCancelamento": 0,
"tipoDescontoAcrescimo": 0,
"tipoEntrega": 0,
"tipoPreVenda": 0,
"tipoVenda": 0,
"totalBruto": 0,
"totalLiquido": 0,
"fretePercentualTotal": 0,
"freteTotal": 0,
"tipoValorFrete": 0,
"multiplosPedidos": true,
"modalidadeFrete": 0,
"acrescimoPercentualTotal": 0,
"acrescimoTotal": 0,
"numeroPDV": 0,
"dataAtualizacao": "2024-06-17T21:15:15.381Z",
"dataCadastro": "2024-06-17T21:15:15.381Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0,
"idProfissionalRetaguarda": "string"
},
"errors": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"totalTime": 0,
"numberOfRecords": 0
}
Campo |
Tipo |
Descrição |
Observações |
---|---|---|---|
Success | Booleano | Indica se a requisição foi feita com sucesso | |
Message | String | Mensagem de retorno de erros | |
Data | Objeto | Lista com as pré vendas retornadas | |
Data.Offline | Booleano | Flag pedido offline | |
Data.Cliente | Objeto | Cliente relacionado a pré venda para fins de fidelização | |
Data.Cliente.Bairro | String | Bairro do cliente. | |
Data.Cliente.Celular | String | Telefone celular do cliente. | |
Data.Cliente.Cep | String | Cep da residência do cliente. | |
Data.Cliente.Cidade | String | Cidade do cliente | |
Data.Cliente.ClienteAlterado | Booleano | Sinaliza se houve alteração no dado do cliente | |
Data.Cliente.Complemento | String | Complemento do endereço do cliente | |
Data.Cliente.CpfCnpj | String | CPF ou CNPJ do cliente | |
Data.Cliente.DataNascimento | Data/Hora | Data de nascimento do cliente | |
Data.Cliente.Email | String | E-mail do cliente | |
Data.Cliente.Endereco | String | Endereço do cliente | |
Data.Cliente.Enderecos | Lista de Objetos | Lista de Endereços do Cliente (NÃO É O ENDEREÇO PADRÃO DO CLIENTE.) | |
Data.Cliente.Enderecos.Bairro | String | Bairro do cliente | |
Data.Cliente.Enderecos.Celular | String | Telefone celular do cliente | |
Data.Cliente.Enderecos.Cep | String | Cep da residência do cliente | |
Data.Cliente.Enderecos.Cidade | String | Cidade do cliente | |
Data.Cliente.Enderecos.Complemento | String | Complemento do endereço do cliente | |
Data.Cliente.Enderecos.Endereco | String | Endereço do cliente | |
Data.Cliente.Enderecos.Estado | String | Estado do cliente | |
Data.Cliente.Enderecos.Numero | String | Número da residência do cliente | |
Data.Cliente.Enderecos.Tipo | String | Tipo do endereço do cliente (entrega, casa, cobrança) | |
Data.Cliente.Enderecos.TipoId | Inteiro | Tipo do endereço do cliente:
|
|
Data.Cliente.Enderecos.DataAtualizacao | Data/Hora | Data de Atualização do Endereço | |
Data.Cliente.Enderecos.DataCadastro | Data/Hora | Data de Criação do Registro do Endereço | |
Data.Cliente.Enderecos.Id | Inteiro | Código de identificação do registro. (campo chave) | |
Data.Cliente.Enderecos.IdRetaguarda | String | Código de identificação do registro na retaguarda | |
Data.Cliente.Enderecos.Situacao | Inteiro | Situação Cadastral do Endereço 1 - Ativo 0 - Inativo |
|
Data.Cliente.Estado | String | Estado do cliente | |
Data.Cliente.EstadoCivil | Inteiro | Estado civil do cliente 0 - Não informado 1 - Casado(a) 2 - Solteiro(a) 3 - Viúvo(a) 4 - Separado(a) 5 - Divorciado(a) 6 - Outros |
|
Data.Cliente.Nome | String | Nome do cliente | |
Data.Cliente.Numero | String | Número da residência do cliente | |
Data.Cliente.PessoaFisica | Inteiro | Indica se o cliente é uma pessoa física
|
|
Data.Cliente.RgInscricao | String | RG do cliente | |
Data.Cliente.Sexo | Inteiro | Gênero do cliente
|
|
Data.Cliente.Telefone | String | Telefone do cliente | |
Data.Cliente.DataAtualizacao | Data/Hora | Data de Atualização do Cadastro | |
Data.Cliente.DataCadastro | Data/Hora | Data de Criação do Cadastro | |
Data.Cliente.Id | Inteiro | Código de identificação do registro. (campo chave) | |
Data.Cliente.IdRetaguarda | String | Código de identificação do registro na retaguarda | |
Data.Cliente.Situacao | Inteiro | Situação Cadastral
|
|
Data.Cliente.IdProfissionalRetaguarda | String | Código de identificação do registro na retaguarda |
|
Data.CodigoPromocional | String | Código do cupom promocional informado pelo operador no momento da compra | |
Data.CpfConsumidor | String | CPF utilizado apenas para emissão do cupom, não tem relacionamento com tabela de clientes | |
Data.Data | Data/Hora | Data de gravação do pedido | |
Data.DescontoPercentualTotal | Decimal | Porcentagem total de desconto | |
Data.DescontoTotal | Decimal | Desconto no Total do Pedido, não considera os descontos nos itens | |
Data.IdCanalVendaRetaguarda | String | Código de identificação do registro na retaguarda | |
Data.IdInquilino | String | Código do inquilino enviado pelo PDV | |
Data.IdLojaRetaguarda | String | Código de identificação do registro na retaguarda | |
Data.IdOperadorRetaguarda | String | Código de identificação do registro na retaguarda | |
Data.MotivoDesconto | Objeto | Motivo do desconto aplicado na venda | |
Data.MotivoDesconto.DescontoMotorPromocaoAplicado | Booleano | Indica se há desconto aplicado relacionado ao motor | |
Data.MotivoDesconto.Descricao | String | Descrição do desconto | |
Data.MotivoDesconto.IdPromocaoMotorPromocaoTerceiro | String | Código de identificação do motor de promoção | |
Data.MotivoDesconto.Tipo | Inteiro | Tipo de operação de desconto:
|
|
Data.MotivoDesconto.TipoDescontoAcrescimo | Inteiro | Tipo do desconto
|
|
Data.MotivoDesconto.DataAtualizacao | Data/Hora | Data de Atualização do Registro | |
Data.MotivoDesconto.DataCadastro | Data/Hora | Data de Cadastro do Registro | |
Data.MotivoDesconto.Id | Inteiro | Código Id do Motivo do Desconto (Chave) | |
Data.MotivoDesconto.IdRetaguarda | String | Código do Motivo do Desconto na Retaguada | |
Data.MotivoDesconto.Situacao | Inteiro | Situação Cadastral
|
|
Data.NomeConsumidor | String | Nome do consumidor apenas para emissão do cupom, não tem relacionamento com tabela de clientes | |
Data.Numero | String | Campo texto que pode ser informado pelo atendente no momento que realiza o Pedido ou de forma automático no PDV, é utilizado para pesquisar o Pedido no caixa | |
Data.NumeroAutorizacao | String | Número da autorização de pagamento | |
Data.NumeroVenda | String | Código da venda criado pelo PDV Omnishop | |
Data.PreVendaItens | Lista de Objetos | Lista de itens da pré venda | |
Data.PreVendaItens.Acrescimo | Decimal | Valor de acréscimo aplicado ao item da pré venda | |
Data.PreVendaItens.AcrescimoPercentual | Decimal | Porcentagem do acréscimo aplicado ao item | |
Data.PreVendaItens.CodigoFilialSaida | String | Código Filial Saída | |
Data.PreVendaItens.CodigoProduto | String | Código Produto | |
Data.PreVendaItens.DataEntrega | Data/Hora | Data da entrega do item | |
Data.PreVendaItens.Desconto | Decimal | Valor do desconto aplicado ao item | |
Data.PreVendaItens.DescontoPercentual | Decimal | Porcentagem do desconto aplicado ao item | |
Data.PreVendaItens.Entrega | Objeto | Dados de entrega do item | |
Data.PreVendaItens.Entrega.DataEntrega | Data/Hora | Data da entrega do item | |
Data.PreVendaItens.Entrega.IdLojaEntregaRetaguarda | String | Código de identificação na retaguarda da loja que irá entregar/disponibilizar o produto | |
Data.PreVendaItens.Entrega.LockerMachineCode | String | Identificação do locker no caso de retirada do produto em locker | |
Data.PreVendaItens.Entrega.LockerParcelCode | String | Identificação do locker no caso de retirada do produto em locker | |
Data.PreVendaItens.Entrega.TipoEntrega | Inteiro | Tipo de entrega do item:
|
|
Data.PreVendaItens.Entrega.FretePercentualTotal | Decimal | Valor percentual do Frete | |
Data.PreVendaItens.Entrega.FreteTotal | Decimal | Valor Real do Frete | |
Data.PreVendaItens.Entrega.TipoValorFrete | Inteiro | Tipo do valor do frete:
|
|
Data.PreVendaItens.IdPrecoRetaguarda | String | Código de identificação do preco na retaguarda | |
Data.PreVendaItens.IdPreVenda | Inteiro | Código da pré venda relacionada ao item da pré venda | |
Data.PreVendaItens.IdProdutoRetaguarda | String | Código de identificação do produto na retaguarda | |
Data.PreVendaItens.IdVendedorRetaguarda | String | Código de identificação do vendedor na retaguarda | |
Data.PreVendaItens.ItensKit | Lista de Objetos | Lista de Itens Contidos no Kit | |
Data.PreVendaItens.ItensKit.IdProdutoRetaguarda | String | Referencia do Id do Kit no retaguarda | |
Data.PreVendaItens.ItensKit.Preco | Decimal | Preço do Produto dentro do Kit | |
Data.PreVendaItens.ItensKit.Quantidade | Decimal | Quantidade de Produtos dentro do Kit | |
Data.PreVendaItens.ItensKit.Sequencial | Inteiro | Numero q indica a posição do item dentro da lista | |
Data.PreVendaItens.MotivoDesconto | Objeto | Desconto relacionado ao item | |
Data.PreVendaItens.MotivoDesconto.DescontoMotorPromocaoAplicado | Booleano | Indica se há desconto aplicado relacionado ao motor | |
Data.PreVendaItens.MotivoDesconto.Descricao | String | Descrição do desconto | |
Data.PreVendaItens.MotivoDesconto.IdPromocaoMotorPromocaoTerceiro | String | Código de identificação do motor de promoção | |
Data.PreVendaItens.MotivoDesconto.Tipo | Inteiro | Tipo de operação de desconto:
|
|
Data.PreVendaItens.MotivoDesconto.TipoDescontoAcrescimo | Inteiro | Tipo do desconto:
|
|
Data.PreVendaItens.MotivoDesconto.DataAtualizacao | Data/Hora | Data de Atualização do Registro | |
Data.PreVendaItens.MotivoDesconto.DataCadastro | Data/Hora | Data de Criação do Registro | |
Data.PreVendaItens.MotivoDesconto.Id | Inteiro | Código de identificação do registro. (campo chave) | |
Data.PreVendaItens.MotivoDesconto.IdRetaguarda | String | Código de identificação do registro na retaguarda | |
Data.PreVendaItens.MotivoDesconto.Situacao | Inteiro | Situação Cadastral:
|
|
Data.PreVendaItens.Preco | Decimal | Valor do item | |
Data.PreVendaItens.Quantidade | Decimal | Quantidade do item | |
Data.PreVendaItens.QuantidadeFaturada | Decimal | Quantidade de itens faturadas | |
Data.PreVendaItens.Frete | Decimal | Valor Real do Frete do Item | |
Data.PreVendaItens.FretePercentual | Decimal | Valor Percentual do Frete do Item | |
Data.PreVendaItens.TipoValorFrete | Inteiro | Tipo do valor do frete do item:
|
|
Data.PreVendaItens.QuantidadeEncomenda | Decimal | Quantidade Encomenda | |
Data.PreVendaItens.IdProdutoEmbalagemRetaguarda | String | Id Retaguarda do Produto Embalagem | |
Data.PreVendaItens.DataAtualizacao | Data/Hora | Data de atualização do item | |
Data.PreVendaItens.DataCadastro | Data/Hora | Data que o item foi criado no PDV | |
Data.PreVendaItens.Id | Inteiro | Código de identificação do registro. (campo chave) | |
Data.PreVendaItens.IdRetaguarda | String | Código Retaguarda do Item da Pré Venda | |
Data.PreVendaItens.Situacao | Inteiro | Situação Cadastral:
|
|
Data.PreVendaPagamentos | Lista de Objetos | Lista de pagamentos da pré venda | |
Data.PreVendaPagamentos.IdPagamentoCondicaoRetaguarda | String | Código de indentificação da Condição do pagamento na retaguarda | |
Data.PreVendaPagamentos.IdPagamentoFormaRetaguarda | String | Código de identificação da Forma de pagamento na retaguarda | |
Data.PreVendaPagamentos.IdPagamentoOperadoraRetaguarda | String | Código de identificação da Operadora responsável pelo pagamento na retaguarda | |
Data.PreVendaPagamentos.IdPreVenda | Inteiro | Código de identificação da pré venda relacionada ao item | |
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementares | Lista de Objetos | Lista de dados complementares ao pagamento | |
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementares.Descricao | String | Descrição do dado complementar | |
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdPagamentoDadoComplementarRetaguarda | String | Código de identificação do Dado complementar na retaguarda | |
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdPreVendaPagamento | Inteiro | Código de identificação da pre venda pagamento relacionada ao dado complementar | |
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementares.DataAtualizacao | Data/Hora | Data da última atualização do dado complementar | |
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementares.DataCadastro | Data/Hora | Data de cadastro do dado complementar | |
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementares.Id | Inteiro | Código de identificação do registro. (campo chave) | |
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdRetaguarda | String | Código de identificação do registro na retaguarda | |
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementares.Situacao | Inteiro | Indica se o pagamento está ativo ou cancelado:
|
|
Data.PreVendaPagamentos.PreVendaPagamentoItens | Lista de Objetos | Lista de itens do pagamento | |
Data.PreVendaPagamentos.PreVendaPagamentoItens.DataVencimento | Data/Hora | Data de vencimento das parcelas aplicadas ao pagamento | |
Data.PreVendaPagamentos.PreVendaPagamentoItens.IdPreVendaPagamento | Inteiro | Código da pre venda pagamento relacionada ao item do pagamento | |
Data.PreVendaPagamentos.PreVendaPagamentoItens.NumeroParcela | Inteiro | Quantidade de parcelas aplicadas ao pagamento | |
Data.PreVendaPagamentos.PreVendaPagamentoItens.ValorParcela | Decimal | Valor das parcelas aplicadas ao pagamento | |
Data.PreVendaPagamentos.PreVendaPagamentoItens.DataAtualizacao | Data/Hora | Data da ultima atualização do pagamento item | |
Data.PreVendaPagamentos.PreVendaPagamentoItens.DataCadastro | Data/Hora | Data de cadastro do pagamento item | |
Data.PreVendaPagamentos.PreVendaPagamentoItens.Id | Inteiro | Código de identificação do registro. (campo chave) | |
Data.PreVendaPagamentos.PreVendaPagamentoItens.IdRetaguarda | String | Código de identificação do registro na retaguarda | |
Data.PreVendaPagamentos.PreVendaPagamentoItens.Situacao | Inteiro | Indica se o pagamento item está ativo ou cancelado
|
|
Data.PreVendaPagamentos.PreVendaPagamentoTefs | Lista de Objetos | Lista de Pagamento Tef | |
Data.PreVendaPagamentos.PreVendaPagamentoTefs.Bandeira | String | Código da bandeira do cartão | |
Data.PreVendaPagamentos.PreVendaPagamentoTefs.CodigoRede | String | Código da rede do cartão | |
Data.PreVendaPagamentos.PreVendaPagamentoTefs.DataPreDatado | Data/Hora | Data do pagamento pré-datado | |
Data.PreVendaPagamentos.PreVendaPagamentoTefs.DiasEntreParcelas | Inteiro | Número de dias entre as datas de vencimento das parcelas | |
Data.PreVendaPagamentos.PreVendaPagamentoTefs.IdPreVendaPagamento | Inteiro | Código da pre venda pagamento relacionada ao item do pagamento Tef | |
Data.PreVendaPagamentos.PreVendaPagamentoTefs.IdTransacaoDigital | String | Código de autorização do pagamento, retornado pelo TPD / TPI | |
Data.PreVendaPagamentos.PreVendaPagamentoTefs.NsuHost | String | Código de autorização do pagamento, retornado pela administradora do cartão | |
Data.PreVendaPagamentos.PreVendaPagamentoTefs.NumeroAutorizacao | String | Código de autorização do pagamento, retornado pelo Sitef | |
Data.PreVendaPagamentos.PreVendaPagamentoTefs.NumeroBin | String | Identificação do cartão (primeiros números do cartão) | |
Data.PreVendaPagamentos.PreVendaPagamentoTefs.NumeroParcelas | Inteiro | Quantidade de parcelas no pagamento | |
Data.PreVendaPagamentos.PreVendaPagamentoTefs.PrimeiraParcela | Data/Hora | Data da primeira parcela | |
Data.PreVendaPagamentos.PreVendaPagamentoTefs.DataAtualizacao | Data/Hora | Data da ultima atualização do pagamento Tef | |
Data.PreVendaPagamentos.PreVendaPagamentoTefs.DataCadastro | Data/Hora | Data de cadastro do pagamento Tef | |
Data.PreVendaPagamentos.PreVendaPagamentoTefs.Id | Inteiro | Código de identificação do registro. (campo chave) | |
Data.PreVendaPagamentos.PreVendaPagamentoTefs.IdRetaguarda | String | Código de identificação do registro na retaguarda | |
Data.PreVendaPagamentos.PreVendaPagamentoTefs.Situacao | Inteiro | Indica se o pagamento tef está ativo ou cancelado
|
|
Data.PreVendaPagamentos.ValorLiquido | Decimal | Valor da pré venda incluindo os descontos | |
Data.PreVendaPagamentos.ValorMinimoAceito | Decimal | Valor mínimo que pode ser pago, configurado na forma de pagamento | |
Data.PreVendaPagamentos.ValorPago | Decimal | Valor registrado no pagamento | |
Data.PreVendaPagamentos.ValorTroco | Decimal | Valor devolvido de troco ao cliente | |
Data.PreVendaPagamentos.PagamentoForma | Objeto | Forma de Pagamento | |
Data.PreVendaPagamentos.PagamentoForma.IdRetaguarda | String | Código de identificação da Forma de pagamento na retaguarda | |
Data.PreVendaPagamentos.PagamentoCondicao | Objeto | Condição de Pagamento | |
Data.PreVendaPagamentos.PagamentoCondicao.IdRetaguarda | String | Código de indentificação da Condição do pagamento na retaguarda | |
Data.PreVendaPagamentos.QuantidadeParcelas | Inteiro | Quantidade de Parcelas pagamento | |
Data.PreVendaPagamentos.DataAtualizacao | Data/Hora | Data de atualização do pagamento | |
Data.PreVendaPagamentos.DataCadastro | Data/Hora | Data de cadastro do pagamento | |
Data.PreVendaPagamentos.Id | Inteiro | Código de identificação do registro. (campo chave) | |
Data.PreVendaPagamentos.IdRetaguarda | String | Código de identificação do registro na retaguarda | |
Data.PreVendaPagamentos.Situacao | Inteiro | Indica se o pagamento está ativo ou cancelado
|
|
Data.VendaPagamentos | Lista de Objetos | Lista de Venda Pagamentos | |
Data.VendaPagamentos.VendaId | Inteiro | Código de Identificação da Venda | |
Data.VendaPagamentos.PagamentoFormaId | Inteiro | Código de Identificação da Forma de Pagamento (campo chave) | |
Data.VendaPagamentos.PagamentoForma | Objeto | Forma de Pagamento | |
Data.VendaPagamentos.PagamentoForma.IdRetaguarda | String | Código de Identificação da Forma de Pagamento na Retaguarda | |
Data.VendaPagamentos.PagamentoForma.Descricao | String | Descrição da Forma de Pagamento | |
Data.VendaPagamentos.PagamentoCondicaoId | Inteiro | Código de Identificação da Condição de Pagamento (campo chave) | |
Data.VendaPagamentos.PagamentoCondicao | Objeto | Condição de Pagamento | |
Data.VendaPagamentos.PagamentoCondicao.IdRetaguarda | String | Código de Identificação da Condição de Pagamento na Retaguarda | |
Data.VendaPagamentos.PagamentoCondicao.Descricao | String | Descrição da Condição de Pagamento | |
Data.VendaPagamentos.PagamentoCondicao.DiasEntreParcelas | Inteiro | Dias entre Parcelas | |
Data.VendaPagamentos.PagamentoOperadoraId | Inteiro | Código de Identificação da Operadora de Pagamento (campo chave) | |
Data.VendaPagamentos.PagamentoOperadora | Objeto | Operadora do Pagamento | |
Data.VendaPagamentos.PagamentoOperadora.IdRetaguarda | String | Código de Identificação da Operadora de Pagamento na Retaguarda | |
Data.VendaPagamentos.PagamentoOperadora.Descricao | String | Descrição da Operadora de Pagamento | |
Data.VendaPagamentos.PagamentoOperadora.CodigoTef | String | Código TEF | |
Data.VendaPagamentos.ValorPago | Decimal | Valor Pago | |
Data.VendaPagamentos.ValorTroco | Decimal | Valor do Troco | |
Data.VendaPagamentos.ValorLiquido | Decimal | Valor Líquido | |
Data.VendaPagamentos.IdRetaguardaCredito | Inteiro | Código de Identificação de Crédito na Retaguarda | |
Data.VendaPagamentos.CpfCnpjCliente | String | CPF ou CNPJ do Cliente | |
Data.VendaPagamentos.QuantidadeParcelas | Inteiro | Quantidade de Parcelas | |
Data.VendaPagamentos.IdDivida | String | Código de Identificação da Dívida | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars | Lista de Objetos | Dados Complementares da Venda Pagamento | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.Conteudo | String | Conteúdo do Dado Complementar | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.Descricao | String | Descrição do Dado Complementar | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.IdPagamentoDadoComplementar | Inteiro | Código de Identificação do Dado Complementar de Pagamento (Campo Chave) | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.IdPagamentoDadoComplementarRetaguarda | String | Código de Identificação do Dado Complementar na Retaguarda | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.IdVendaPagamento | Inteiro | Código de Identificação da Venda Pagamento (Campo Chave) | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar | Objeto | Dado Complementar | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Descricao | String | Descrição do Pagamento Dado Complementar | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Tipo | Inteiro | Tipo do Pagamento Dado Complementar | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Obrigatorio | Inteiro | Flag Obrigatório
|
|
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Tamanho | Inteiro | Tamanho | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.TipoCampoTef | Inteiro | Tipo Campo TEF | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.DataAtualizacao | Data/Hora | Data de Atualização do Registro | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.DataCadastro | Data/Hora | Data de Criação do Registro | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Id | Inteiro | Código de Identificação do Pagamento Dado Complementar (Campo Chave) | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.IdRetaguarda | String | Código de Identificação do Pagamento Dado Complementar na Retaguarda | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Situacao | Inteiro | Situação Cadastral
|
|
Data.VendaPagamentos.VendaPagamentoDadoComplementars.DataAtualizacao | Data/Hora | Data de Atualização do Registro | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.DataCadastro | Data/Hora | Data de Criação do Registro | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.Id | Inteiro | Código de Identificação do Dado Complementar (Campo Chave) | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.IdRetaguarda | String | Código de Identificação do Dado Complementar na Retaguarda | |
Data.VendaPagamentos.VendaPagamentoDadoComplementars.Situacao | Inteiro | Situação Cadastral
|
|
Data.VendaPagamentos.VendaPagamentoItems | Lista de Objetos | Itens da Venda Pagamento | |
Data.VendaPagamentos.VendaPagamentoItems.VendaPagamentoId | Inteiro | Código de Identificação da Venda Pagamento | |
Data.VendaPagamentos.VendaPagamentoItems.NumeroParcela | Inteiro | Número de Parcelas | |
Data.VendaPagamentos.VendaPagamentoItems.ValorParcela | Decimal | Valor da Parcela | |
Data.VendaPagamentos.VendaPagamentoItems.DataVencimento | Data/Hora | Data de Vencimento da Parcela | |
Data.VendaPagamentos.VendaPagamentoItems.DataAtualizacao | Data/Hora | Data de Atualização do Registro | |
Data.VendaPagamentos.VendaPagamentoItems.DataCadastro | Data/Hora | Data de Cadastro do Registro | |
Data.VendaPagamentos.VendaPagamentoItems.Id | Inteiro | Código de Identificação do Item de Venda Pagamento (Campo Chave) | |
Data.VendaPagamentos.VendaPagamentoItems.IdRetaguarda | String | Código de Identificação do Item de Venda Pagamento na Retaguarda | |
Data.VendaPagamentos.VendaPagamentoItems.Situacao | Inteiro | Situação Cadastral
|
|
Data.VendaPagamentos.VendaPagamentoTefs | Lista de Objetos | Venda Pagamento Tefs | |
Data.VendaPagamentos.VendaPagamentoTefs.Bandeira | String | Bandeira do Cartão | |
Data.VendaPagamentos.VendaPagamentoTefs.CodigoRede | String | Código da Rede | |
Data.VendaPagamentos.VendaPagamentoTefs.DataPreDatado | Data/Hora | Data do Pré Datado | |
Data.VendaPagamentos.VendaPagamentoTefs.DiasEntreParcelas | Inteiro | Dias Entre Parcelas | |
Data.VendaPagamentos.VendaPagamentoTefs.IdVendaPagamento | Inteiro | Código de Identificação da Venda Pagamento | |
Data.VendaPagamentos.VendaPagamentoTefs.IdTransacaoDigital | String | Código de Identificação de Transação Digital | |
Data.VendaPagamentos.VendaPagamentoTefs.NsuHost | String | NSU Host | |
Data.VendaPagamentos.VendaPagamentoTefs.NumeroAutorizacao | String | Número da Autorização | |
Data.VendaPagamentos.VendaPagamentoTefs.NumeroBin | String | Número Bin | |
Data.VendaPagamentos.VendaPagamentoTefs.NumeroParcelas | Inteiro | Número de Parcelas | |
Data.VendaPagamentos.VendaPagamentoTefs.PrimeiraParcela | Data/Hora | Data da Primeira Parcela | |
Data.VendaPagamentos.VendaPagamentoTefs.IdPagamentoMfe | Inteiro | Código de Identificação do Pagamento Mfe | |
Data.VendaPagamentos.VendaPagamentoTefs.SincronizadoPagamentoMfe | Booleano | Sincronizado Pagamento Nfe | |
Data.VendaPagamentos.VendaPagamentoTefs.DataAtualizacao | Data/Hora | Data de Atualização do Registro | |
Data.VendaPagamentos.VendaPagamentoTefs.DataCadastro | Data/Hora | Data de Criação do Registro | |
Data.VendaPagamentos.VendaPagamentoTefs.Id | Inteiro | Código de Identificação da Venda Pagamento Tefs (campo chave) | |
Data.VendaPagamentos.VendaPagamentoTefs.IdRetaguarda | String | Código de Identificação da Venda Pagamento Tefs na Retaguarda | |
Data.VendaPagamentos.VendaPagamentoTefs.Situacao | Inteiro | Situação Cadastral
|
|
Data.VendaPagamentos.VendaPagamentoTrocas | Lista de Objetos | Trocas da Venda Pagamento | |
Data.VendaPagamentos.VendaPagamentoTrocas.VendaPagamentoId | Inteiro | Código de Identificação da Venda Pagamento (campo chave) | |
Data.VendaPagamentos.VendaPagamentoTrocas.IdVendaRetaguarda | String | Código de Identificação da Venda na Retaguarda | |
Data.VendaPagamentos.VendaPagamentoTrocas.CpfCnpj | String | Cpf ou Cnpj do Consumidor | |
Data.VendaPagamentos.VendaPagamentoTrocas.Nome | String | Nome do Consumidor | |
Data.VendaPagamentos.VendaPagamentoTrocas.MotivoId | Inteiro | Código de Identificação do Motivo (campo chave) | |
Data.VendaPagamentos.VendaPagamentoTrocas.Motivo | Objeto | Motivo da Troca | |
Data.VendaPagamentos.VendaPagamentoTrocas.Motivo.IdRetaguarda | String | Código de Identificação do Motivo na Retaguarda | |
Data.VendaPagamentos.VendaPagamentoTrocas.Motivo.Descricao | String | Descrição da Venda Pagamento | |
Data.VendaPagamentos.VendaPagamentoTrocas.DataTroca | Data/Hora | Data da Troca | |
Data.VendaPagamentos.VendaPagamentoTrocas.ValorTotal | Decimal | Valor Total | |
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItems | Lista de Objetos | Itens de Troca | |
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItems.IdItemRetaguarda | String | Código de Identificação do Item na Retaguarda | |
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItems.TrocaId | Inteiro | Código de Identificação da Troca (Campo chave) | |
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItems.ProdutoId | Inteiro | Código de Identificação do Produto (campo chave) | |
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto | Objeto | Produto da Troca | |
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.Id | Inteiro | Código de Identificação do Produto (campo chave) | |
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.IdRetaguarda | String | Código de Identificação do Produto na Retaguarda | |
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.CodigoProduto | String | Código do Produto | |
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.Descricao | String | Descrição do Produto | |
Data.VendaPagamentos.TrocaItems.Valor | Decimal | Valor do Produto | |
Data.VendaPagamentos.TrocaItems.Quantidade | Decimal | Quantidade | |
Data.VendaPagamentos.TrocaItems.DataAtualizacao | Data/Hora | Data de Atualização do Registro | |
Data.VendaPagamentos.TrocaItems.DataCadastro | Data/Hora | Data de Criação do Registro | |
Data.VendaPagamentos.TrocaItems.Id | Inteiro | Código de Identificação do Item de Troca (campo chave) | |
Data.VendaPagamentos.TrocaItems.IdRetaguarda | String | Código de Identificação do Item de Troca na Retaguarda | |
Data.VendaPagamentos.TrocaItems.Situacao | Inteiro | Situação Cadastral
|
|
Data.VendaPagamentos.VendaPagamentoTrocas.DataAtualizacao | Data/Hora | Data de Atualização do Registro | |
Data.VendaPagamentos.VendaPagamentoTrocas.DataCadastro | Data/Hora | Data de Criação do Registro | |
Data.VendaPagamentos.VendaPagamentoTrocas.Id | Inteiro | Código de Identificação da Venda Pagamento Troca (campo chave) | |
Data.VendaPagamentos.VendaPagamentoTrocas.IdRetaguarda | String | Código de Identificação da Venda Pagamento Troca na Retaguarda | |
Data.VendaPagamentos.VendaPagamentoTrocas.Situacao | Inteiro | Situação Cadastral
|
|
Data.SerieVenda | String | Número de série da venda | |
Data.Sincronizado | Inteiro | Indica se a pré venda entá sincronizada com o retaguarda:
|
|
Data.SistemaOrigem | Inteiro | Código do sistema de origem:
|
|
Data.SituacaoPreVenda | String | Status da pré venda:
|
|
Data.TerminalOrigem | String | Número do PDV onde foi gerado o pedido (integração omnichannel) | |
Data.TipoCancelamento | Inteiro | Tipo do cancelamento:
|
|
Data.TipoDescontoAcrescimo | Inteiro | Tipo do acréscimo:
|
|
Data.TipoEntrega | Inteiro | Tipo de entrega:
|
|
Data.TipoPreVenda | Inteiro | Tipo da pré venda:
|
|
Data.TipoVenda | Inteiro | Tipo da venda:
|
|
Data.TotalBruto | Decimal | Valor total do Pedido sem os descontos | |
Data.TotalLiquido | Decimal | Valor liquido do Pedido considerando todos os descontos | |
Data.FretePercentualTotal | Decimal | Valor percentual do Frete | |
Data.FreteTotal | Decimal | Valor Real do Frete | |
Data.TipoValorFrete | Inteiro | Tipo do valor do frete:
|
|
Data.MultiplosPedidos | Booleano | Indica se existe multiplos pedidos na Prevenda | |
Data.ModalidadeFrete | Inteiro | Modalidade do frete:
|
|
Data.AcrescimoPercentualTotal | Decimal | Acréscimo Percentual Total | |
Data.AcrescimoTotal | Decimal | Acréscimo Total | |
Data.NumeroPdv | Inteiro | Número PDV | |
Data.DataAtualizacao | Data/Hora | Data de atualização da pré venda | |
Data.DataCadastro | Data/Hora | Data que a pré venda foi criado no PDV | |
Data.Id | Inteiro | Código de identificação do registro. (campo chave), gerado pelo PDV Omnishop. | |
Data.IdRetaguarda | String | Código de identificação do registro na retaguarda | |
Data.Situacao | Inteiro | Situação Cadastral:
|
|
Data.IdProfissionalRetaguarda | String | Código de identificação do registro na retaguarda |
|
Errors | Objeto | Lista de erros | Somente na V3 |
TotalTime | Inteiro | Tempo da requisição | |
NumberOfRecords | Inteiro | Número de registros |
{
"success": false,
"message": "String",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
Campo |
Tipo |
Descrição |
Observação |
---|---|---|---|
Success | bool | Indica se a requisição foi feita com sucesso | |
Message | string | Mensagem de retorno de erros | |
Data | Object | Lista com as pré vendas retornadas | |
Errors | Lista de object | Lista de erros | Somente na V3 |
TotalTime | Int | Tempo da requisição | |
NumberOfRecords | Int | Número de registros |