Este método é responsável pela criação da pré-venda
- Endpoints:
- /api/pdvsyncserver/retaguarda/v2/processoonlineprevenda
- Método: POST
- Autenticação: Bearer token
- Permissão: Client
Body da requisição
{
"offline": true,
"cliente": {
"bairro": "string",
"celular": "string",
"cep": "string",
"cidade": "string",
"clienteAlterado": true,
"complemento": "string",
"cpfCnpj": "string",
"dataNascimento": "2024-06-17T21:48:08.019Z",
"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:48:08.019Z",
"dataCadastro": "2024-06-17T21:48:08.019Z",
"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:48:08.019Z",
"dataCadastro": "2024-06-17T21:48:08.019Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0,
"idProfissionalRetaguarda": "string"
},
"codigoPromocional": "string",
"cpfConsumidor": "string",
"data": "2024-06-17T21:48:08.019Z",
"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:48:08.019Z",
"dataCadastro": "2024-06-17T21:48:08.019Z",
"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:48:08.019Z",
"desconto": 0,
"descontoPercentual": 0,
"entrega": {
"dataEntrega": "2024-06-17T21:48:08.019Z",
"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:48:08.019Z",
"dataCadastro": "2024-06-17T21:48:08.019Z",
"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:48:08.019Z",
"dataCadastro": "2024-06-17T21:48:08.019Z",
"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:48:08.019Z",
"dataCadastro": "2024-06-17T21:48:08.019Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"preVendaPagamentoItens": [
{
"dataVencimento": "2024-06-17T21:48:08.019Z",
"idPreVendaPagamento": 0,
"numeroParcela": 0,
"valorParcela": 0,
"dataAtualizacao": "2024-06-17T21:48:08.019Z",
"dataCadastro": "2024-06-17T21:48:08.019Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"preVendaPagamentoTefs": [
{
"bandeira": "string",
"codigoRede": "string",
"dataPreDatado": "2024-06-17T21:48:08.019Z",
"diasEntreParcelas": 0,
"idPreVendaPagamento": 0,
"idTransacaoDigital": "string",
"nsuHost": "string",
"numeroAutorizacao": "string",
"numeroBin": "string",
"numeroParcelas": 0,
"primeiraParcela": "2024-06-17T21:48:08.019Z",
"dataAtualizacao": "2024-06-17T21:48:08.019Z",
"dataCadastro": "2024-06-17T21:48:08.019Z",
"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:48:08.019Z",
"dataCadastro": "2024-06-17T21:48:08.019Z",
"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:48:08.019Z",
"dataCadastro": "2024-06-17T21:48:08.019Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
},
"dataAtualizacao": "2024-06-17T21:48:08.019Z",
"dataCadastro": "2024-06-17T21:48:08.019Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"vendaPagamentoItems": [
{
"vendaPagamentoId": 0,
"numeroParcela": 0,
"valorParcela": 0,
"dataVencimento": "2024-06-17T21:48:08.019Z",
"dataAtualizacao": "2024-06-17T21:48:08.019Z",
"dataCadastro": "2024-06-17T21:48:08.019Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"vendaPagamentoTefs": [
{
"bandeira": "string",
"codigoRede": "string",
"dataPreDatado": "2024-06-17T21:48:08.020Z",
"diasEntreParcelas": 0,
"idVendaPagamento": 0,
"idTransacaoDigital": "string",
"nsuHost": "string",
"numeroAutorizacao": "string",
"numeroBin": "string",
"numeroParcelas": 0,
"primeiraParcela": "2024-06-17T21:48:08.020Z",
"idPagamentoMfe": 0,
"sincronizadoPagamentoMfe": true,
"dataAtualizacao": "2024-06-17T21:48:08.020Z",
"dataCadastro": "2024-06-17T21:48:08.020Z",
"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:48:08.020Z",
"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:48:08.020Z",
"dataCadastro": "2024-06-17T21:48:08.020Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"dataAtualizacao": "2024-06-17T21:48:08.020Z",
"dataCadastro": "2024-06-17T21:48:08.020Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0
}
],
"dataAtualizacao": "2024-06-17T21:48:08.020Z",
"dataCadastro": "2024-06-17T21:48:08.020Z",
"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:48:08.020Z",
"dataCadastro": "2024-06-17T21:48:08.020Z",
"id": 0,
"idRetaguarda": "string",
"situacao": 0,
"idProfissionalRetaguarda": "string"
}
Campo |
Tipo |
Descrição |
Obrigatório |
|---|---|---|---|
| Offline | Booleano | Flag pedido offline | Sim |
| Cliente | Objeto | Cliente relacionado a pré venda para fins de fidelização | Não |
| Cliente.Bairro | String | Bairro do cliente. | Apenas quando o pedido for retira posterior e entrega |
| Cliente.Celular | String | Telefone celular do cliente. | Apenas quando o pedido for retira posterior e entrega |
| Cliente.Cep | String | Cep da residência do cliente. | Apenas quando o pedido for retira posterior e entrega |
| Cliente.Cidade | String | Cidade do cliente | Apenas quando o pedido for retira posterior e entrega |
| Cliente.ClienteAlterado | Booleano | Sinaliza se houve alteração no dado do cliente | Sim |
| Cliente.Complemento | String | Complemento do endereço do cliente | Não |
| Cliente.CpfCnpj | String | CPF ou CNPJ do cliente | Apenas quando o pedido for retira posterior e entrega |
| Cliente.DataNascimento | Datetime | Data de nascimento do cliente | Não |
| Cliente.Email | String | Email do cliente | Apenas quando o pedido for retira posterior e entrega |
| Cliente.Endereco | String | Endereço do cliente | Não |
| Cliente.Enderecos | Lista de Objetos | Lista de Endereços do Cliente (NÃO É O ENDEREÇO PADRÃO DO CLIENTE.) | Não |
| Cliente.Enderecos.Bairro | String | Bairro do cliente | Não |
| Cliente.Enderecos.Celular | String | Telefone celular do cliente | Não |
| Cliente.Enderecos.Cep | String | Cep da residência do cliente | Não |
| Cliente.Enderecos.Cidade | String | Cidade do cliente | Não |
| Cliente.Enderecos.Complemento | String | Complemento do endereço do cliente | Não |
| Cliente.Enderecos.Endereco | String | Endereço do cliente | Não |
| Cliente.Enderecos.Estado | String | Estado do cliente | Não |
| Cliente.Enderecos.Numero | String | Número da residência do cliente | Não |
| Cliente.Enderecos.Tipo | String | Tipo do endereço do cliente (entrega, casa, cobrança) | Não |
| Cliente.Enderecos.TipoId | Inteiro | Tipo do endereço do cliente:
|
Não |
| Cliente.Enderecos.DataAtualizacao | Datetime | Data de Atualização do Endereço | Não |
| Cliente.Enderecos.DataCadastro | Datetime | Data de Criação do Registro do Endereço | Não |
| Cliente.Enderecos.Id | Inteiro | Código de identificação do registro. (campo chave) | Não |
| Cliente.Enderecos.IdRetaguarda | String | Código de identificação do registro na retaguarda | Não |
| Cliente.Enderecos.Situacao | Inteiro | Situação Cadastral do Endereço 1 - Ativo 0 - Inativo |
Não |
| Cliente.Estado | String | Estado do cliente |
Apenas quando o pedido for retira posterior e entrega |
| 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 |
Não |
| Cliente.Nome | String | Nome do cliente | Sim |
| Cliente.Numero | String | Número da residência do cliente | Não |
| Cliente.PessoaFisica | Inteiro | Indica se o cliente é uma pessoa física
|
Sim |
| Cliente.RgInscricao | String | RG do cliente | Não |
| Cliente.Sexo | Inteiro | Gênero do cliente
|
Não |
| Cliente.Telefone | String | Telefone do cliente | Apenas quando o pedido for retira posterior e entrega |
| Cliente.DataAtualizacao | Datetime | Data de Atualização do Cadastro | Sim |
| Cliente.DataCadastro | Datetime | Data de Criação do Cadastro | Sim |
| Cliente.Id | Inteiro | Código de identificação do registro. (campo chave) | Sim |
| Cliente.IdRetaguarda | String | Código de identificação do registro na retaguarda | Sim |
| Cliente.Situacao | Inteiro | Situação Cadastral
|
Sim |
| Cliente.IdProfissionalRetaguarda | String | Código de identificação do registro na retaguarda |
Não |
| CodigoPromocional | String | Código do cupom promocional informado pelo operador no momento da compra | Não |
| CpfConsumidor | String | CPF utilizado apenas para emissão do cupom, não tem relacionamento com tabela de clientes | Não |
| Data | Datetime | Data de gravação do pedido | Sim |
| DescontoPercentualTotal | Decimal | Porcentagem total de desconto | Sim |
| DescontoTotal | Decimal | Desconto no Total do Pedido, não considera os descontos nos itens | Sim |
| IdCanalVendaRetaguarda | String | Código de identificação do registro na retaguarda | Sim |
| IdInquilino | String | Código do inquilino enviado pelo PDV | Sim |
| IdLojaRetaguarda | String | Código de identificação do registro na retaguarda | Sim |
| IdOperadorRetaguarda | String | Código de identificação do registro na retaguarda | Sim |
| MotivoDesconto | Objeto | Motivo do desconto aplicado na venda | Sim |
| MotivoDesconto.DescontoMotorPromocaoAplicado | Booleano | Indica se há desconto aplicado relacionado ao motor | Sim |
| MotivoDesconto.Descricao | String | Descrição do desconto | Não |
| MotivoDesconto.IdPromocaoMotorPromocaoTerceiro | String | Código de identificação do motor de promoção | Não |
| MotivoDesconto.Tipo | Inteiro | Tipo de operação de desconto:
|
Sim |
| MotivoDesconto.TipoDescontoAcrescimo | Inteiro | Tipo do desconto
|
Sim |
| MotivoDesconto.DataAtualizacao | Datetime | Data de Atualização do Registro | Sim |
| MotivoDesconto.DataCadastro | Datetime | Data de Cadastro do Registro | Sim |
| MotivoDesconto.Id | Inteiro | Código Id do Motivo do Desconto (Chave) | Sim |
| MotivoDesconto.IdRetaguarda | String | Código do Motivo do Desconto na Retaguada | Sim |
| MotivoDesconto.Situacao | Inteiro | Situação Cadastral
|
Sim |
| NomeConsumidor | String | Nome do consumidor apenas para emissão do cupom, não tem relacionamento com tabela de clientes | Não |
| 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 | Não |
| NumeroAutorizacao | String | Número da autorização de pagamento | Não |
| NumeroVenda | String | Código da venda criado pelo PDV Omnishop | Sim |
| PreVendaItens | Lista de Objetos | Lista de itens da pré venda | Não |
| PreVendaItens.Acrescimo | Decimal | Valor de acréscimo aplicado ao item da pré venda | Sim |
| PreVendaItens.AcrescimoPercentual | Decimal | Porcentagem do acréscimo aplicado ao item | Sim |
| PreVendaItens.CodigoFilialSaida | String | Código Filial Saída | Não |
| PreVendaItens.CodigoProduto | String | Código Produto | Sim |
| PreVendaItens.DataEntrega | Datetime | Data da entrega do item | Não |
| PreVendaItens.Desconto | Decimal | Valor do desconto aplicado ao item | Sim |
| PreVendaItens.DescontoPercentual | Decimal | Porcentagem do desconto aplicado ao item | Sim |
| PreVendaItens.Entrega | Objeto | Dados de entrega do item | Não |
| PreVendaItens.Entrega.DataEntrega | Datetime | Data da entrega do item | Não |
| PreVendaItens.Entrega.IdLojaEntregaRetaguarda | String | Código de identificação na retaguarda da loja que irá entregar/disponibilizar o produto | Não |
| PreVendaItens.Entrega.LockerMachineCode | String | Identificação do locker no caso de retirada do produto em locker | Não |
| PreVendaItens.Entrega.LockerParcelCode | String | Identificação do locker no caso de retirada do produto em locker | Não |
| PreVendaItens.Entrega.TipoEntrega | Inteiro | Tipo de entrega do item:
|
Não |
| PreVendaItens.Entrega.FretePercentualTotal | Decimal | Valor percentual do Frete | Não |
| PreVendaItens.Entrega.FreteTotal | Decimal | Valor Real do Frete | Não |
| PreVendaItens.Entrega.TipoValorFrete | Inteiro | Tipo do valor do frete:
|
Não |
| PreVendaItens.IdPrecoRetaguarda | String | Código de identificação do preco na retaguarda | Sim |
| PreVendaItens.IdPreVenda | Inteiro | Código da pré venda relacionada ao item da pré venda | Sim |
| PreVendaItens.IdProdutoRetaguarda | String | Código de identificação do produto na retaguarda | Sim |
| PreVendaItens.IdVendedorRetaguarda | String | Código de identificação do vendedor na retaguarda | Sim |
| PreVendaItens.ItensKit | Lista de Objetos | Lista de Itens Contidos no Kit | Não |
| PreVendaItens.ItensKit.IdProdutoRetaguarda | String | Referencia do Id do Kit no retaguarda | Não |
| PreVendaItens.ItensKit.Preco | Decimal | Preço do Produto dentro do Kit | Não |
| PreVendaItens.ItensKit.Quantidade | Decimal | Quantidade de Produtos dentro do Kit | Não |
| PreVendaItens.ItensKit.Sequencial | Inteiro | Numero q indica a posição do item dentro da lista | Não |
| PreVendaItens.MotivoDesconto | Objeto | Desconto relacionado ao item | Não |
| PreVendaItens.MotivoDesconto.DescontoMotorPromocaoAplicado | Booleano | Indica se há desconto aplicado relacionado ao motor | Sim |
| PreVendaItens.MotivoDesconto.Descricao | String | Descrição do desconto | Sim |
| PreVendaItens.MotivoDesconto.IdPromocaoMotorPromocaoTerceiro | String | Código de identificação do motor de promoção | Não |
| PreVendaItens.MotivoDesconto.Tipo | Inteiro | Tipo de operação de desconto:
|
Não |
| PreVendaItens.MotivoDesconto.TipoDescontoAcrescimo | Inteiro | Tipo do desconto:
|
Não |
| PreVendaItens.MotivoDesconto.DataAtualizacao | Datetime | Data de Atualização do Registro | Sim |
| PreVendaItens.MotivoDesconto.DataCadastro | Datetime | Data de Criação do Registro | Sim |
| PreVendaItens.MotivoDesconto.Id | Inteiro | Código de identificação do registro. (campo chave) | Sim |
| PreVendaItens.MotivoDesconto.IdRetaguarda | String | Código de identificação do registro na retaguarda | Sim |
| PreVendaItens.MotivoDesconto.Situacao | Inteiro | Situação Cadastral: 0 - Inativo 1 - Ativo |
Não |
| PreVendaItens.Preco | Decimal | Valor do item | Não |
| PreVendaItens.Quantidade | Decimal | Quantidade do item | Sim |
| PreVendaItens.QuantidadeFaturada | Decimal | Quantidade de itens faturadas | Não |
| PreVendaItens.Frete | Decimal | Valor Real do Frete do Item | Não |
| PreVendaItens.FretePercentual | Decimal | Valor Percentual do Frete do Item | Não |
| PreVendaItens.TipoValorFrete | Inteiro | Tipo do valor do frete do item:
|
Não |
| PreVendaItens.QuantidadeEncomenda | Decimal | Quantidade Encomenda | Não |
| PreVendaItens.IdProdutoEmbalagemRetaguarda | String | Id Retaguarda do Produto Embalagem | Não |
| PreVendaItens.DataAtualizacao | Datetime | Data de atualização do item | Não |
| PreVendaItens.DataCadastro | Datetime | Data que o item foi criado no PDV | Não |
| PreVendaItens.Id | Inteiro | Código de identificação do registro. (campo chave) | Sim |
| PreVendaItens.IdRetaguarda | String | Código Retaguarda do Item da Pré Venda | Sim |
| PreVendaItens.Situacao | Inteiro | Situação Cadastral: 0 - Inativo 1 - Ativo |
Sim |
| PreVendaPagamentos | Lista de Objetos | Lista de pagamentos da pré venda | Não |
| PreVendaPagamentos.IdPagamentoCondicaoRetaguarda | String | Código de indentificação da Condição do pagamento na retaguarda | Não |
| PreVendaPagamentos.IdPagamentoFormaRetaguarda | String | Código de identificação da Forma de pagamento na retaguarda | Não |
| PreVendaPagamentos.IdPagamentoOperadoraRetaguarda | String | Código de identificação da Operadora responsável pelo pagamento na retaguarda | Não |
| PreVendaPagamentos.IdPreVenda | Inteiro | Código de identificação da pré venda relacionada ao item | Sim |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares | Lista de Objetos | Lista de dados complementares ao pagamento | Não |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares.Descricao | String | Descrição do dado complementar | Sim |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdPagamentoDadoComplementarRetaguarda | String | Código de identificação do Dado complementar na retaguarda | Não |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdPreVendaPagamento | Inteiro | Código de identificação da pre venda pagamento relacionada ao dado complementar | Não |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares.DataAtualizacao | Datetime | Data da última atualização do dado complementar | Não |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares.DataCadastro | Datetime | Data de cadastro do dado complementar | Não |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares.Id | Inteiro | Código de identificação do registro. (campo chave) | Sim |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdRetaguarda | String | Código de identificação do registro na retaguarda | Sim |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares.Situacao | Inteiro | Indica se o pagamento está ativo ou cancelado:
|
Sim |
| PreVendaPagamentos.PreVendaPagamentoItens | Lista de Objetos | Lista de itens do pagamento | Não |
| PreVendaPagamentos.PreVendaPagamentoItens.DataVencimento | Datetime | Data de vencimento das parcelas aplicadas ao pagamento | Não |
| PreVendaPagamentos.PreVendaPagamentoItens.IdPreVendaPagamento | Inteiro | Código da pre venda pagamento relacionada ao item do pagamento | Não |
| PreVendaPagamentos.PreVendaPagamentoItens.NumeroParcela | Inteiro | Quantidade de parcelas aplicadas ao pagamento | Não |
| PreVendaPagamentos.PreVendaPagamentoItens.ValorParcela | Decimal | Valor das parcelas aplicadas ao pagamento | Não |
| PreVendaPagamentos.PreVendaPagamentoItens.DataAtualizacao | Datetime | Data da ultima atualização do pagamento item | Não |
| PreVendaPagamentos.PreVendaPagamentoItens.DataCadastro | Datetime | Data de cadastro do pagamento item | Não |
| PreVendaPagamentos.PreVendaPagamentoItens.Id | Inteiro | Código de identificação do registro. (campo chave) | Sim |
| PreVendaPagamentos.PreVendaPagamentoItens.IdRetaguarda | String | Código de identificação do registro na retaguarda | Sim |
| PreVendaPagamentos.PreVendaPagamentoItens.Situacao | Inteiro | Indica se o pagamento item está ativo ou cancelado
|
Sim |
| PreVendaPagamentos.PreVendaPagamentoTefs | Lista de Objetos | Lista de Pagametno Tef | Não |
| PreVendaPagamentos.PreVendaPagamentoTefs.Bandeira | String | Código da bandeira do cartão | Sim |
| PreVendaPagamentos.PreVendaPagamentoTefs.CodigoRede | String | Código da rede do cartão | Sim |
| PreVendaPagamentos.PreVendaPagamentoTefs.DataPreDatado | Datetime | Data do pagamento pré-datado | Não |
| PreVendaPagamentos.PreVendaPagamentoTefs.DiasEntreParcelas | Inteiro | Número de dias entre as datas de vencimento das parcelas | Não |
| PreVendaPagamentos.PreVendaPagamentoTefs.IdPreVendaPagamento | Inteiro | Código da pre venda pagamento relacionada ao item do pagamento Tef | Não |
| PreVendaPagamentos.PreVendaPagamentoTefs.IdTransacaoDigital | String | Código de autorização do pagamento, retornado pelo TPD / TPI | Não |
| PreVendaPagamentos.PreVendaPagamentoTefs.NsuHost | String | Código de autorização do pagamento, retornado pela administradora do cartão | Não |
| PreVendaPagamentos.PreVendaPagamentoTefs.NumeroAutorizacao | String | Código de autorização do pagamento, retornado pelo Sitef | Não |
| PreVendaPagamentos.PreVendaPagamentoTefs.NumeroBin | String | Identificação do cartão (primeiros números do cartão) | Não |
| PreVendaPagamentos.PreVendaPagamentoTefs.NumeroParcelas | Inteiro | Quantidade de parcelas no pagamento | Não |
| PreVendaPagamentos.PreVendaPagamentoTefs.PrimeiraParcela | Datetime | Data da primeira parcela | Não |
| PreVendaPagamentos.PreVendaPagamentoTefs.DataAtualizacao | Datetime | Data da ultima atualização do pagamento Tef | Não |
| PreVendaPagamentos.PreVendaPagamentoTefs.DataCadastro | Datetime | Data de cadastro do pagamento Tef | Não |
| PreVendaPagamentos.PreVendaPagamentoTefs.Id | Inteiro | Código de identificação do registro. (campo chave) | Não |
| PreVendaPagamentos.PreVendaPagamentoTefs.IdRetaguarda | String | Código de identificação do registro na retaguarda | Sim |
| PreVendaPagamentos.PreVendaPagamentoTefs.Situacao | Inteiro | Indica se o pagamento tef está ativo ou cancelado
|
Sim |
| PreVendaPagamentos.ValorLiquido | Decimal | Valor da pré venda incluindo os descontos | Não |
| PreVendaPagamentos.ValorMinimoAceito | Decimal | Valor mínimo que pode ser pago, configurado na forma de pagamento | Sim |
| PreVendaPagamentos.ValorPago | Decimal | Valor registrado no pagamento | Não |
| PreVendaPagamentos.ValorTroco | Decimal | Valor devolvido de troco ao cliente | Não |
| PreVendaPagamentos.PagamentoForma | Objeto | Forma de Pagamento | Não |
| PreVendaPagamentos.PagamentoForma.IdRetaguarda | String | Código de identificação da Forma de pagamento na retaguarda | Não |
| PreVendaPagamentos.PagamentoCondicao | Objeto | Condição de Pagamento | Não |
| PreVendaPagamentos.PagamentoCondicao.IdRetaguarda | String | Código de indentificação da Condição do pagamento na retaguarda | Não |
| PreVendaPagamentos.QuantidadeParcelas | Inteiro | Quantidade de Parcelas pagamento | Sim |
| PreVendaPagamentos.DataAtualizacao | Datetime | Data de atualização do pagamento | Não |
| PreVendaPagamentos.DataCadastro | Datetime | Data de cadastro do pagamento | Não |
| PreVendaPagamentos.Id | Inteiro | Código de identificação do registro. (campo chave) | Sim |
| PreVendaPagamentos.IdRetaguarda | String | Código de identificação do registro na retaguarda | Sim |
| PreVendaPagamentos.Situacao | Inteiro | Indica se o pagamento está ativo ou cancelado
|
Sim |
| VendaPagamentos | Lista de Objetos | Lista de Venda Pagamentos | Não |
| VendaPagamentos.VendaId | Inteiro | Código de Identificação da Venda | Não |
| VendaPagamentos.PagamentoFormaId | Inteiro | Código de Identificação da Forma de Pagamento (campo chave) | Sim |
| VendaPagamentos.PagamentoForma | Objeto | Forma de Pagamento | Não |
| VendaPagamentos.PagamentoForma.IdRetaguarda | String | Código de Identificação da Forma de Pagamento na Retaguarda | Não |
| VendaPagamentos.PagamentoForma.Descricao | String | Descrição da Forma de Pagamento | Não |
| VendaPagamentos.PagamentoCondicaoId | Inteiro | Código de Identificação da Condição de Pagamento (campo chave) | Sim |
| VendaPagamentos.PagamentoCondicao | Objeto | Condição de Pagamento | Não |
| VendaPagamentos.PagamentoCondicao.IdRetaguarda | String | Código de Identificação da Condição de Pagamento na Retaguarda | Não |
| VendaPagamentos.PagamentoCondicao.Descricao | String | Descrição da Condição de Pagamento | Não |
| VendaPagamentos.PagamentoCondicao.DiasEntreParcelas | Inteiro | Dias entre Parcelas | Não |
| VendaPagamentos.PagamentoOperadoraId | Inteiro | Código de Identificação da Operadora de Pagamento (campo chave) | Sim |
| VendaPagamentos.PagamentoOperadora | Objeto | Operadora do Pagamento | Não |
| VendaPagamentos.PagamentoOperadora.IdRetaguarda | String | Código de Identificação da Operadora de Pagamento na Retaguarda | Não |
| VendaPagamentos.PagamentoOperadora.Descricao | String | Descrição da Operadora de Pagamento | Não |
| VendaPagamentos.PagamentoOperadora.CodigoTef | String | Código TEF | Sim |
| VendaPagamentos.ValorPago | Decimal | Valor Pago | Não |
| VendaPagamentos.ValorTroco | Decimal | Valor do Troco | Não |
| VendaPagamentos.ValorLiquido | Decimal | Valor Líquido | Não |
| VendaPagamentos.IdRetaguardaCredito | Inteiro | Código de Identificação de Crédito na Retaguarda | Não |
| VendaPagamentos.CpfCnpjCliente | String | CPF ou CNPJ do Cliente | Não |
| VendaPagamentos.QuantidadeParcelas | Inteiro | Quantidade de Parcelas | Não |
| VendaPagamentos.IdDivida | String | Código de Identificação da Dívida | Não |
| VendaPagamentos.VendaPagamentoDadoComplementars | Lista de Objetos | Dados Complementares da Venda Pagamento | Não |
| VendaPagamentos.VendaPagamentoDadoComplementars.Conteudo | String | Conteúdo do Dado Complementar | Não |
| VendaPagamentos.VendaPagamentoDadoComplementars.Descricao | String | Descrição do Dado Complementar | Não |
| VendaPagamentos.VendaPagamentoDadoComplementars.IdPagamentoDadoComplementar | Inteiro | Código de Identificação do Dado Complementar de Pagamento (Campo Chave) | Não |
| VendaPagamentos.VendaPagamentoDadoComplementars.IdPagamentoDadoComplementarRetaguarda | String | Código de Identificação do Dado Complementar na Retaguarda | Não |
| VendaPagamentos.VendaPagamentoDadoComplementars.IdVendaPagamento | Inteiro | Código de Identificação da Venda Pagamento (Campo Chave) | Sim |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar | Objeto | Dado Complementar | Não |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Descricao | String | Descrição do Pagamento Dado Complementar | Não |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Tipo | Inteiro | Tipo do Pagamento Dado Complementar | Sim |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Obrigatorio | Inteiro | Flag Obrigatório
|
Sim |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Tamanho | Inteiro | Tamanho | Não |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.TipoCampoTef | Inteiro | Tipo Campo TEF | Não |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.DataAtualizacao | Datetime | Data de Atualização do Registro | Não |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.DataCadastro | Datetime | Data de Criação do Registro | Não |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Id | Inteiro | Código de Identificação do Pagamento Dado Complementar (Campo Chave) | Sim |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.IdRetaguarda | String | Código de Identificação do Pagamento Dado Complementar na Retaguarda | Não |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Situacao | Inteiro | Situação Cadastral
|
Não |
| VendaPagamentos.VendaPagamentoDadoComplementars.DataAtualizacao | Datetime | Data de Atualização do Registro | Não |
| VendaPagamentos.VendaPagamentoDadoComplementars.DataCadastro | Datetime | Data de Criação do Registro | Não |
| VendaPagamentos.VendaPagamentoDadoComplementars.Id | Inteiro | Código de Identificação do Dado Complementar (Campo Chave) | Sim |
| VendaPagamentos.VendaPagamentoDadoComplementars.IdRetaguarda | String | Código de Identificação do Dado Complementar na Retaguarda | Não |
| VendaPagamentos.VendaPagamentoDadoComplementars.Situacao | Inteiro | Situação Cadastral
|
Não |
| VendaPagamentos.VendaPagamentoItems | Lista de Objetos | Itens da Venda Pagamento | Não |
| VendaPagamentos.VendaPagamentoItems.VendaPagamentoId | Inteiro | Código de Identificação da Venda Pagamento | Não |
| VendaPagamentos.VendaPagamentoItems.NumeroParcela | Inteiro | Número de Parcelas | Não |
| VendaPagamentos.VendaPagamentoItems.ValorParcela | Decimal | Valor da Parcela | Não |
| VendaPagamentos.VendaPagamentoItems.DataVencimento | Datetime | Data de Vencimento da Parcela | Não |
| VendaPagamentos.VendaPagamentoItems.DataAtualizacao | Datetime | Data de Atualização do Registro | Não |
| VendaPagamentos.VendaPagamentoItems.DataCadastro | Datetime | Data de Cadastro do Registro | Não |
| VendaPagamentos.VendaPagamentoItems.Id | Inteiro | Código de Identificação do Item de Venda Pagamento (Campo Chave) | Sim |
| VendaPagamentos.VendaPagamentoItems.IdRetaguarda | String | Código de Identificação do Item de Venda Pagamento na Retaguarda | Não |
| VendaPagamentos.VendaPagamentoItems.Situacao | Inteiro | Situação Cadastral
|
Não |
| VendaPagamentos.VendaPagamentoTefs | Lista de Objetos | Venda Pagamento Tefs | Não |
| VendaPagamentos.VendaPagamentoTefs.Bandeira | String | Bandeira do Cartão | Não |
| VendaPagamentos.VendaPagamentoTefs.CodigoRede | String | Código da Rede | Não |
| VendaPagamentos.VendaPagamentoTefs.DataPreDatado | Datetime | Data do Pré Datado | Não |
| VendaPagamentos.VendaPagamentoTefs.DiasEntreParcelas | Inteiro | Dias Entre Parcelas | Não |
| VendaPagamentos.VendaPagamentoTefs.IdVendaPagamento | Inteiro | Código de Identificação da Venda Pagamento | Sim |
| VendaPagamentos.VendaPagamentoTefs.IdTransacaoDigital | String | Código de Identificação de Transação Digital | Não |
| VendaPagamentos.VendaPagamentoTefs.NsuHost | String | NSU Host | Não |
| VendaPagamentos.VendaPagamentoTefs.NumeroAutorizacao | String | Número da Autorização | Não |
| VendaPagamentos.VendaPagamentoTefs.NumeroBin | String | Número Bin | Não |
| VendaPagamentos.VendaPagamentoTefs.NumeroParcelas | Inteiro | Número de Parcelas | Não |
| VendaPagamentos.VendaPagamentoTefs.PrimeiraParcela | Datetime | Data da Primeira Parcela | Não |
| VendaPagamentos.VendaPagamentoTefs.IdPagamentoMfe | Inteiro | Código de Identificação do Pagamento Mfe | Não |
| VendaPagamentos.VendaPagamentoTefs.SincronizadoPagamentoMfe | Booleano | Sincronizado Pagamento Nfe | Não |
| VendaPagamentos.VendaPagamentoTefs.DataAtualizacao | Datetime | Data de Atualização do Registro | Não |
| VendaPagamentos.VendaPagamentoTefs.DataCadastro | Datetime | Data de Criação do Registro | Não |
| VendaPagamentos.VendaPagamentoTefs.Id | Inteiro | Código de Identificação da Venda Pagamento Tefs (campo chave) | Sim |
| VendaPagamentos.VendaPagamentoTefs.IdRetaguarda | String | Código de Identificação da Venda Pagamento Tefs na Retaguarda | Não |
| VendaPagamentos.VendaPagamentoTefs.Situacao | Inteiro | Situação Cadastral
|
Não |
| VendaPagamentos.VendaPagamentoTrocas | Lista de Objetos | Trocas da Venda Pagamento | Não |
| VendaPagamentos.VendaPagamentoTrocas.VendaPagamentoId | Inteiro | Código de Identificação da Venda Pagamento (campo chave) | Sim |
| VendaPagamentos.VendaPagamentoTrocas.IdVendaRetaguarda | String | Código de Identificação da Venda na Retaguarda | Não |
| VendaPagamentos.VendaPagamentoTrocas.CpfCnpj | String | Cpf ou Cnpj do Consumidor | Não |
| VendaPagamentos.VendaPagamentoTrocas.Nome | String | Nome do Consumidor | Não |
| VendaPagamentos.VendaPagamentoTrocas.MotivoId | Inteiro | Código de Identificação do Motivo (campo chave) | Sim |
| VendaPagamentos.VendaPagamentoTrocas.Motivo | Objeto | Motivo da Troca | Não |
| VendaPagamentos.VendaPagamentoTrocas.Motivo.IdRetaguarda | String | Código de Identificação do Motivo na Retaguarda | Não |
| VendaPagamentos.VendaPagamentoTrocas.Motivo.Descricao | String | Descrição da Venda Pagamento | Não |
| VendaPagamentos.VendaPagamentoTrocas.DataTroca | Datetime | Data da Troca | Não |
| VendaPagamentos.VendaPagamentoTrocas.ValorTotal | Decimal | Valor Total | Não |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems | Lista de Objetos | Itens de Troca | Não |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems.IdItemRetaguarda | String | Código de Identificação do Item na Retaguarda | Não |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems.TrocaId | Inteiro | Código de Identificação da Troca (Campo chave) | Não |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems.ProdutoId | Inteiro | Código de Identificação do Produto (campo chave) | Sim |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto | Objeto | Produto da Troca | Não |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.Id | Inteiro | Código de Identificação do Produto (campo chave) | Sim |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.IdRetaguarda | String | Código de Identificação do Produto na Retaguarda | Não |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.CodigoProduto | String | Código do Produto | Não |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.Descricao | String | Descrição do Produto | Não |
| VendaPagamentos.TrocaItems.Valor | Decimal | Valor do Produto | Não |
| VendaPagamentos.TrocaItems.Quantidade | Decimal | Quantidade | Não |
| VendaPagamentos.TrocaItems.DataAtualizacao | Datetime | Data de Atualização do Registro | Não |
| VendaPagamentos.TrocaItems.DataCadastro | Datetime | Data de Criação do Registro | Não |
| VendaPagamentos.TrocaItems.Id | Inteiro | Código de Identificação do Item de Troca (campo chave) | Sim |
| VendaPagamentos.TrocaItems.IdRetaguarda | String | Código de Identificação do Item de Troca na Retaguarda | Não |
| VendaPagamentos.TrocaItems.Situacao | Inteiro | Situação Cadastral
|
Não |
| VendaPagamentos.VendaPagamentoTrocas.DataAtualizacao | Datetime | Data de Atualização do Registro | Não |
| VendaPagamentos.VendaPagamentoTrocas.DataCadastro | Datetime | Data de Criação do Registro | Não |
| VendaPagamentos.VendaPagamentoTrocas.Id | Inteiro | Código de Identificação da Venda Pagamento Troca (campo chave) | Sim |
| VendaPagamentos.VendaPagamentoTrocas.IdRetaguarda | String | Código de Identificação da Venda Pagamento Troca na Retaguarda | Não |
| VendaPagamentos.VendaPagamentoTrocas.Situacao | Inteiro | Situação Cadastral
|
Não |
| SerieVenda | String | Número de série da venda | Sim |
| Sincronizado | Inteiro | Indica se a pré venda entá sincronizada com o retaguarda:
|
Sim |
| SistemaOrigem | Inteiro | Código do sistema de origem:
|
Não |
| SituacaoPreVenda | String | Status da pré venda:
|
Sim |
| TerminalOrigem | String | Número do PDV onde foi gerado o pedido (integração omnichannel) | Não |
| TipoCancelamento | Inteiro | Tipo do cancelamento:
|
Não |
| TipoDescontoAcrescimo | Inteiro | Tipo do acréscimo:
|
Não |
| TipoEntrega | Inteiro | Tipo de entrega:
|
Sim |
| TipoPreVenda | Inteiro | Tipo da pré venda:
|
Sim |
| TipoVenda | Inteiro | Tipo da venda:
|
Sim |
| TotalBruto | Decimal | Valor total do Pedido sem os descontos | Sim |
| TotalLiquido | Decimal | Valor liquido do Pedido considerando todos os descontos | Sim |
| FretePercentualTotal | Decimal | Valor percentual do Frete | Não |
| FreteTotal | Decimal | Valor Real do Frete | Não |
| TipoValorFrete | Inteiro | Tipo do valor do frete:
|
Não |
| MultiplosPedidos | Booleano | Indica se existe multiplos pedidos na Prevenda | Não |
| ModalidadeFrete | Inteiro | Modalidade do frete:
|
Não |
| AcrescimoPercentualTotal | Decimal | Acréscimo Percentual Total | Não |
| AcrescimoTotal | Decimal | Acréscimo Total | Não |
| NumeroPdv | Inteiro | Número PDV | Não |
| DataAtualizacao | Datetime | Data de atualização da pré venda | Não |
| DataCadastro | Datetime | Data que a pré venda foi criado no PDV | Não |
| Id | Inteiro | Código de identificação do registro. (campo chave), gerado pelo PDV Omnishop. | Sim |
| IdRetaguarda | String | Código de identificação do registro na retaguarda | Não |
| IdProfissionalRetaguarda | String | Código de identificação do registro na retaguarda | Não |
Em planejamento...
Retornos
Campo |
Tipo |
Descrição |
|---|---|---|
| Success | Booleano | Indica se a requisição foi feita com sucesso |
| Message | String | Mensagem de retorno de erros |
| Data | Objeto | Lista com os créditos retornados |
| Data.IdPedidoRetaguarda | String | Identificador do pedido na retaguarda |
| Data.Cliente | Objeto | Cliente do pedido |
| Data.Cliente.Enderecos | Lista de Objetos | Lista de endereços do cliente |
| Data.Cliente.Enderecos.Id | Inteiro | Identificador do endereço |
| Data.Cliente.Enderecos.IdRetaguarda | String | Identificador do endereço na retaguarda |
| Data.Cliente.Id | Inteiro | Identificador do cliente |
| Data.Cliente.IdRetaguarda | String | Identificador do cliente na retaguarda |
| Errors | Nulo | Lista de erros |
| TotalTime | Inteiro | Tempo da requisição |
| NumberOfRecords | Inteiro | Número de registros |
{
"success": true,
"message": "",
"data": {
"idPedidoRetaguarda": "String",
"cliente": {
"enderecos": [
{
"id": 1,
"idRetaguarda": "String"
}
],
"id": 1,
"idRetaguarda": "String"
}
},
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
Campo |
Tipo |
Descrição |
Obeservação |
|---|---|---|---|
| Success | bool | Indica se a requisição foi feita com sucesso | |
| Message | string | Mensagem de retorno de erros | |
| Data | Objeto | Objeto de retonro | |
| Errors | Lista de objetos | Lista de erros | Somente é retornado na V3 |
| TotalTime | Int | Tempo total da requisição | |
| NumberOfRecords | Int | Número de registros |
{
"success": false,
"message": "string",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas