TOTVS Varejo PDV Omni

Árvore de páginas

Versões comparadas

Versão antiga 5

changes.mady.by.user Usuário desconhecido (tp.william.ss)

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Ricardo Augusto de Oliveira Souto

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Informações
Este método é responsável pela criação da pré-venda
  • Endpoint: /api/pdvsyncserver/retaguarda/v2/processoonlineprevenda
  • Método: POST
  • Autenticação: Bearer token
  • Permissão: Client

...

Deck of Cards
idcredito_consulta_get
Card
labelDefinição das propriedades

Campo

Tipo

Descrição

Obrigatório

OfflineBooleanoFlag pedido offlineSim
ClienteObjetoCliente relacionado a pré venda para fins de fidelizaçãoNão
Cliente.BairroStringBairro do cliente. Apenas quando o pedido for retira posterior e entrega
Cliente.CelularStringTelefone celular do cliente. Apenas quando o pedido for retira posterior e entrega
Cliente.CepStringCep da residência do cliente. Apenas quando o pedido for retira posterior e entrega
Cliente.CidadeStringCidade do clienteApenas quando o pedido for retira posterior e entrega
Cliente.ClienteAlteradoBooleanoSinaliza se houve alteração no dado do clienteSim
Cliente.ComplementoString
Cliente.
Complemento do endereço do clienteNão
Cliente.CpfCnpjStringCPF ou CNPJ do clienteApenas quando o pedido for retira posterior e entrega
Cliente.DataNascimentoDatetimeData de nascimento do clienteNão
Cliente.EmailStringEmail do clienteApenas quando o pedido for retira posterior e entrega
Cliente.EnderecoStringEndereço do clienteNão
Cliente.EnderecosLista de ObjetosLista de Endereços do Cliente (NÃO É O ENDEREÇO PADRÃO DO CLIENTE.)Não
Cliente.Enderecos.BairroStringBairro do clienteNão
Cliente.Enderecos.CelularStringTelefone celular do clienteNão
Cliente.Enderecos.CepStringCep da residência do clienteNão
Cliente.Enderecos.CidadeStringCidade do clienteNão
Cliente.Enderecos.ComplementoStringComplemento do endereço do clienteNão
Cliente.Enderecos.EnderecoStringEndereço do clienteNão
Cliente.Enderecos.EstadoStringEstado do clienteNão
Cliente.Enderecos.NumeroStringNúmero da residência do clienteNão
Cliente.Enderecos.TipoStringTipo do endereço do cliente (entrega, casa, cobrança)Não
Cliente.Enderecos.TipoIdInteiro

Tipo do endereço do cliente:

    • 0 - Entrega
    • 1 - Cobrança
    • 2 - Comercial
Não
Cliente.Enderecos.DataAtualizacaoDatetimeData de Atualização do EndereçoNão
Cliente.Enderecos.DataCadastroDatetimeData de Criação do Registro do EndereçoNão
Cliente.Enderecos.IdInteiroCódigo de identificação do registro. (campo chave)Não
Cliente.Enderecos.IdRetaguardaString
Cliente.Enderecos
 Código de identificação do registro na retaguardaNão
Cliente.Enderecos.SituacaoInteiro

Situação Cadastral do Endereço

1 - Ativo

0 - Inativo

Não
Cliente.EstadoString

Estado do cliente

Apenas quando o pedido for retira posterior e entrega
Cliente.EstadoCivilInteiro

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.NomeStringNome do clienteSim
Cliente.NumeroStringNúmero da residência do clienteNão
Cliente.PessoaFisicaInteiro

Indica se o cliente é uma pessoa física

    • 0 - Não
    • 1 - Sim
Sim
Cliente.RgInscricaoStringRG do clienteNão
Cliente.SexoInteiro

Gênero do cliente

    • 0 - Não Informado
    • 1 - Masculino
    • 2 - Feminino
Não
Cliente.TelefoneStringTelefone do clienteApenas quando o pedido for retira posterior e entrega
Cliente.DataAtualizacaoDatetimeData de Atualização do CadastroSim
Cliente.DataCadastroDatetimeData de Criação do CadastroSim
Cliente.IdInteiro
Cliente.IdRetaguarda
Código de identificação do registro. (campo chave)Sim
String
Cliente.
Situacao
IdRetaguarda
InteiroCodigoPromocionalStringCpfConsumidorStringDataDatetimeDescontoPercentualTotalDecimalDescontoTotalDecimalIdCanalVendaRetaguardaStringIdInquilinoStringIdLojaRetaguardaStringIdOperadorRetaguardaStringMotivoDescontoObjetoMotivoDesconto.DescontoMotorPromocaoAplicadoBooleanoMotivoDesconto.DescricaoStringMotivoDesconto.IdPromocaoMotorPromocaoTerceiroStringMotivoDesconto.TipoInteiroMotivoDesconto.TipoDescontoAcrescimoInteiroMotivoDesconto.DataAtualizacaoDatetimeMotivoDesconto.DataCadastroDatetimeMotivoDesconto.IdInteiroMotivoDesconto.IdRetaguardaStringMotivoDesconto.SituacaoInteiroNomeConsumidorStringNumeroStringNumeroAutorizacaoStringNumeroVendaStringPreVendaItensLista de ObjetosPreVendaItens.AcrescimoDecimalPreVendaItens.AcrescimoPercentualDecimalPreVendaItens.CodigoFilialSaidaStringPreVendaItens.CodigoProdutoStringPreVendaItens.DataEntregaDatetimePreVendaItens.DescontoDecimalPreVendaItens.DescontoPercentualDecimalPreVendaItens.EntregaObjetoPreVendaItens.Entrega.DataEntregaDatetimePreVendaItens.Entrega.IdLojaEntregaRetaguardaStringPreVendaItens.Entrega.LockerMachineCodeStringPreVendaItens.Entrega.LockerParcelCodeStringPreVendaItens.Entrega.TipoEntregaInteiroPreVendaItens.Entrega.FretePercentualTotalDecimalPreVendaItens.Entrega.FreteTotalDecimalPreVendaItens.Entrega.TipoValorFreteInteiroPreVendaItens.IdPrecoRetaguardaStringPreVendaItens.IdPreVendaInteiroPreVendaItens.IdProdutoRetaguardaStringPreVendaItens.IdVendedorRetaguardaStringPreVendaItens.ItensKitLista de ObjetosPreVendaItens.ItensKit.IdProdutoRetaguardaStringPreVendaItens.ItensKit.PrecoDecimalPreVendaItens.ItensKit.QuantidadeDecimalPreVendaItens.ItensKit.SequencialInteiroPreVendaItens.MotivoDescontoObjetoPreVendaItens.MotivoDesconto.DescontoMotorPromocaoAplicadoBooleanoPreVendaItens.MotivoDesconto.DescricaoStringPreVendaItens.MotivoDesconto.IdPromocaoMotorPromocaoTerceiroStringPreVendaItens.MotivoDesconto.TipoInteiroPreVendaItens.MotivoDesconto.TipoDescontoAcrescimoInteiroPreVendaItens.MotivoDesconto.DataAtualizacaoDatetimePreVendaItens.MotivoDesconto.DataCadastroDatetimePreVendaItens.MotivoDesconto.IdInteiroPreVendaItens.MotivoDesconto.IdRetaguardaStringPreVendaItens.MotivoDesconto.SituacaoInteiroPreVendaItens.PrecoDecimalPreVendaItens.QuantidadeDecimalPreVendaItens.QuantidadeFaturadaDecimalPreVendaItens.FreteDecimalPreVendaItens.FretePercentualDecimalPreVendaItens.TipoValorFreteInteiroPreVendaItens.QuantidadeEncomendaDecimalPreVendaItens.IdProdutoEmbalagemRetaguardaStringPreVendaItens.DataAtualizacaoDatetimePreVendaItens.DataCadastroDatetimePreVendaItens.IdInteiroPreVendaItens.IdRetaguardaStringPreVendaItens.SituacaoInteiroPreVendaPagamentosLista de ObjetosPreVendaPagamentos.IdPagamentoCondicaoRetaguardaStringPreVendaPagamentos.IdPagamentoFormaRetaguardaStringPreVendaPagamentos.IdPagamentoOperadoraRetaguardaStringPreVendaPagamentos.IdPreVendaInteiroPreVendaPagamentos.PreVendaPagamentoDadosComplementaresLista de ObjetosPreVendaPagamentos.PreVendaPagamentoDadosComplementares.DescricaoStringPreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdPagamentoDadoComplementarRetaguardaStringPreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdPreVendaPagamentoInteiroPreVendaPagamentos.PreVendaPagamentoDadosComplementares.DataAtualizacaoDatetimePreVendaPagamentos.PreVendaPagamentoDadosComplementares.DataCadastroDatetimePreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdInteiroPreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdRetaguardaStringPreVendaPagamentos.PreVendaPagamentoDadosComplementares.SituacaoInteiroPreVendaPagamentos.PreVendaPagamentoItensLista de ObjetosPreVendaPagamentos.PreVendaPagamentoItens.DataVencimentoDatetimePreVendaPagamentos.PreVendaPagamentoItens.IdPreVendaPagamentoInteiroPreVendaPagamentos.PreVendaPagamentoItens.NumeroParcelaInteiroPreVendaPagamentos.PreVendaPagamentoItens.ValorParcelaDecimalPreVendaPagamentos.PreVendaPagamentoItens.DataAtualizacaoDatetimePreVendaPagamentos.PreVendaPagamentoItens.DataCadastroDatetimePreVendaPagamentos.PreVendaPagamentoItens.IdInteiroPreVendaPagamentos.PreVendaPagamentoItens.IdRetaguardaStringPreVendaPagamentos.PreVendaPagamentoItens.SituacaoInteiroPreVendaPagamentos.PreVendaPagamentoTefsLista de ObjetosPreVendaPagamentos.PreVendaPagamentoTefs.BandeiraStringPreVendaPagamentos.PreVendaPagamentoTefs.CodigoRedeStringPreVendaPagamentos.PreVendaPagamentoTefs.DataPreDatadoDatetimePreVendaPagamentos.PreVendaPagamentoTefs.DiasEntreParcelasInteiroPreVendaPagamentos.PreVendaPagamentoTefs.IdPreVendaPagamentoInteiroPreVendaPagamentos.PreVendaPagamentoTefs.IdTransacaoDigitalStringPreVendaPagamentos.PreVendaPagamentoTefs.NsuHostStringPreVendaPagamentos.PreVendaPagamentoTefs.NumeroAutorizacaoStringPreVendaPagamentos.PreVendaPagamentoTefs.NumeroBinStringPreVendaPagamentos.PreVendaPagamentoTefs.NumeroParcelasInteiroPreVendaPagamentos.PreVendaPagamentoTefs.PrimeiraParcelaDatetimePreVendaPagamentos.PreVendaPagamentoTefs.DataAtualizacaoDatetimePreVendaPagamentos.PreVendaPagamentoTefs.DataCadastroDatetimePreVendaPagamentos.PreVendaPagamentoTefs.IdInteiroPreVendaPagamentos.PreVendaPagamentoTefs.IdRetaguardaStringPreVendaPagamentos.PreVendaPagamentoTefs.SituacaoInteiroPreVendaPagamentos.ValorLiquidoDecimalPreVendaPagamentos.ValorMinimoAceitoDecimalPreVendaPagamentos.ValorPagoDecimalPreVendaPagamentos.ValorTrocoDecimalPreVendaPagamentos.PagamentoFormaObjetoPreVendaPagamentos.PagamentoForma.IdRetaguardaStringPreVendaPagamentos.PagamentoCondicaoObjetoPreVendaPagamentos.PagamentoCondicao.IdRetaguardaStringPreVendaPagamentos.QuantidadeParcelasInteiroPreVendaPagamentos.DataAtualizacaoDatetimePreVendaPagamentos.DataCadastroDatetimePreVendaPagamentos.IdInteiroPreVendaPagamentos.IdRetaguardaStringPreVendaPagamentos.SituacaoInteiroVendaPagamentosLista de ObjetosVendaPagamentos.VendaIdInteiroVendaPagamentos.PagamentoFormaIdInteiroVendaPagamentos.PagamentoFormaObjetoVendaPagamentos.PagamentoForma.IdRetaguardaStringVendaPagamentos.PagamentoForma.DescricaoStringVendaPagamentos.PagamentoCondicaoIdInteiroVendaPagamentos.PagamentoCondicaoObjetoVendaPagamentos.PagamentoCondicao.IdRetaguardaStringVendaPagamentos.PagamentoCondicao.DescricaoStringVendaPagamentos.PagamentoCondicao.DiasEntreParcelasInteiroVendaPagamentos.PagamentoOperadoraIdInteiroVendaPagamentos.PagamentoOperadoraObjetoVendaPagamentos.PagamentoOperadora.IdRetaguardaStringVendaPagamentos.PagamentoOperadora.DescricaoStringVendaPagamentos.PagamentoOperadora.CodigoTefStringVendaPagamentos.ValorPagoDecimalVendaPagamentos.ValorTrocoDecimalVendaPagamentos.ValorLiquidoDecimalVendaPagamentos.IdRetaguardaCreditoInteiroVendaPagamentos.CpfCnpjClienteStringVendaPagamentos.QuantidadeParcelasInteiroVendaPagamentos.IdDividaStringVendaPagamentos.VendaPagamentoDadoComplementarsLista de ObjetosVendaPagamentos.VendaPagamentoDadoComplementars.ConteudoStringVendaPagamentos.VendaPagamentoDadoComplementars.DescricaoStringVendaPagamentos.VendaPagamentoDadoComplementars.IdPagamentoDadoComplementarInteiroVendaPagamentos.VendaPagamentoDadoComplementars.IdPagamentoDadoComplementarRetaguardaStringVendaPagamentos.VendaPagamentoDadoComplementars.IdVendaPagamentoInteiroVendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementarObjetoVendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.DescricaoStringVendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.TipoInteiroVendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.ObrigatorioInteiroVendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.TamanhoInteiroVendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.TipoCampoTefInteiroVendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.DataAtualizacaoDatetimeVendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.DataCadastroDatetimeVendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.IdInteiroVendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.IdRetaguardaStringVendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.SituacaoInteiroVendaPagamentos.VendaPagamentoDadoComplementars.DataAtualizacaoDatetimeVendaPagamentos.VendaPagamentoDadoComplementars.DataCadastroDatetimeVendaPagamentos.VendaPagamentoDadoComplementars.IdInteiroVendaPagamentos.VendaPagamentoDadoComplementars.IdRetaguardaStringVendaPagamentos.VendaPagamentoDadoComplementars.SituacaoInteiroVendaPagamentos.VendaPagamentoItemsLista de ObjetosVendaPagamentos.VendaPagamentoItems.VendaPagamentoIdInteiroVendaPagamentos.VendaPagamentoItems.NumeroParcelaInteiroVendaPagamentos.VendaPagamentoItems.ValorParcelaDecimalVendaPagamentos.VendaPagamentoItems.DataVencimentoDatetimeVendaPagamentos.VendaPagamentoItems.DataAtualizacaoDatetimeVendaPagamentos.VendaPagamentoItems.DataCadastroDatetimeVendaPagamentos.VendaPagamentoItems.IdInteiroVendaPagamentos.VendaPagamentoItems.IdRetaguardaStringVendaPagamentos.VendaPagamentoItems.SituacaoInteiroVendaPagamentos.VendaPagamentoTefsLista de ObjetosVendaPagamentos.VendaPagamentoTefs.BandeiraStringVendaPagamentos.VendaPagamentoTefs.CodigoRedeStringVendaPagamentos.VendaPagamentoTefs.DataPreDatadoDatetimeVendaPagamentos.VendaPagamentoTefs.DiasEntreParcelasInteiroVendaPagamentos.VendaPagamentoTefs.IdVendaPagamentoInteiroVendaPagamentos.VendaPagamentoTefs.IdTransacaoDigitalStringVendaPagamentos.VendaPagamentoTefs.NsuHostStringVendaPagamentos.VendaPagamentoTefs.NumeroAutorizacaoStringVendaPagamentos.VendaPagamentoTefs.NumeroBinStringVendaPagamentos.VendaPagamentoTefs.NumeroParcelasInteiroVendaPagamentos.VendaPagamentoTefs.PrimeiraParcelaDatetimeVendaPagamentos.VendaPagamentoTefs.IdPagamentoMfeInteiroVendaPagamentos.VendaPagamentoTefs.SincronizadoPagamentoMfeBooleanoVendaPagamentos.VendaPagamentoTefs.DataAtualizacaoDatetimeVendaPagamentos.VendaPagamentoTefs.DataCadastroDatetimeVendaPagamentos.VendaPagamentoTefs.IdInteiroVendaPagamentos.VendaPagamentoTefs.IdRetaguardaStringVendaPagamentos.VendaPagamentoTefs.SituacaoInteiroVendaPagamentos.VendaPagamentoTrocasLista de ObjetosVendaPagamentos.VendaPagamentoTrocas.VendaPagamentoIdInteiroVendaPagamentos.VendaPagamentoTrocas.IdVendaRetaguardaStringVendaPagamentos.VendaPagamentoTrocas.CpfCnpjStringVendaPagamentos.VendaPagamentoTrocas.NomeStringVendaPagamentos.VendaPagamentoTrocas.MotivoIdInteiroVendaPagamentos.VendaPagamentoTrocas.MotivoObjetoVendaPagamentos.VendaPagamentoTrocas.Motivo.IdRetaguardaStringVendaPagamentos.VendaPagamentoTrocas.Motivo.DescricaoStringVendaPagamentos.VendaPagamentoTrocas.DataTrocaDatetimeVendaPagamentos.VendaPagamentoTrocas.ValorTotalDecimalVendaPagamentos.VendaPagamentoTrocas.TrocaItemsLista de ObjetosVendaPagamentos.VendaPagamentoTrocas.TrocaItems.IdItemRetaguardaStringVendaPagamentos.VendaPagamentoTrocas.TrocaItems.TrocaIdInteiroVendaPagamentos.VendaPagamentoTrocas.TrocaItems.ProdutoIdInteiroVendaPagamentos.VendaPagamentoTrocas.TrocaItems.ProdutoObjetoVendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.IdInteiroVendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.IdRetaguardaStringVendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.CodigoProdutoStringVendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.DescricaoStringVendaPagamentos.TrocaItems.ValorDecimalVendaPagamentos.TrocaItems.QuantidadeDecimalVendaPagamentos.TrocaItems.DataAtualizacaoDatetimeVendaPagamentos.TrocaItems.DataCadastroDatetimeVendaPagamentos.TrocaItems.IdInteiroVendaPagamentos.TrocaItems.IdRetaguardaStringVendaPagamentos.TrocaItems.SituacaoInteiroVendaPagamentos.VendaPagamentoTrocas.DataAtualizacaoDatetimeVendaPagamentos.VendaPagamentoTrocas.DataCadastroDatetimeVendaPagamentos.VendaPagamentoTrocas.IdInteiroVendaPagamentos.VendaPagamentoTrocas.IdRetaguardaStringVendaPagamentos.VendaPagamentoTrocas.SituacaoInteiroSerieVendaStringSincronizadoInteiroSistemaOrigemInteiroSituacaoPreVendaStringTerminalOrigemStringTipoCancelamentoInteiroTipoDescontoAcrescimoInteiroTipoEntregaInteiroTipoPreVendaInteiroTipoVendaInteiroTotalBrutoDecimalTotalLiquidoDecimalFretePercentualTotalDecimalFreteTotalDecimalTipoValorFreteInteiroMultiplosPedidosBooleanoModalidadeFreteInteiroAcrescimoPercentualTotalDecimalAcrescimoTotalDecimalNumeroPdvInteiroDataAtualizacaoDatetimeDataCadastroDatetimeIdInteiroIdRetaguardaString
StringCódigo de identificação do registro na retaguardaSim
Cliente.SituacaoInteiro

Situação Cadastral

  • 0 - Inativo
  • 1 - Ativo
Sim
Cliente.IdProfissionalRetaguardaString

Código de identificação do registro na retaguarda

Não
CodigoPromocionalStringCódigo do cupom promocional informado pelo operador no momento da compraNão
CpfConsumidorStringCPF utilizado apenas para emissão do cupom, não tem relacionamento com tabela de clientesNão
DataDatetimeData de gravação do pedidoSim
DescontoPercentualTotalDecimalPorcentagem total de descontoSim
DescontoTotalDecimalDesconto no Total do Pedido, não considera os descontos nos itensSim
IdCanalVendaRetaguardaStringCódigo de identificação do registro na retaguardaSim
IdInquilinoStringCódigo do inquilino enviado pelo PDVSim
IdLojaRetaguardaStringCódigo de identificação do registro na retaguardaSim
IdOperadorRetaguardaStringCódigo de identificação do registro na retaguardaSim
MotivoDescontoObjetoMotivo do desconto aplicado na vendaSim
MotivoDesconto.DescontoMotorPromocaoAplicadoBooleanoIndica se há desconto aplicado relacionado ao motorSim
MotivoDesconto.DescricaoStringDescrição do descontoNão
MotivoDesconto.IdPromocaoMotorPromocaoTerceiroStringCódigo de identificação do motor de promoçãoNão
MotivoDesconto.TipoInteiro

Tipo de operação de desconto:

    • 0 - AcrescimoDesconto
    • 1 - TrocaDevolucao
    • 2 - AlteracaoFormaPagamento
    • 3 - AusenciaFuncionario
    • 4 - ClassificacaoDia
    • 5 - CancelamentoVenda
    • 6 - Sangria
    • 7 - Suprimento
    • 8 - DevolucaoPedidoOMS
Sim
MotivoDesconto.TipoDescontoAcrescimoInteiro

Tipo do desconto

    • 0 - Manual
    • 1 - Motor
    • 2 - Fidelidade
    • 3 - PromocaoSMS
    • 4 - CampanhaPromocional
    • 5 - MotorTerceiro
    • 6 - PrecoPromocional
    • 7 - LogisticaReversa
Sim
MotivoDesconto.DataAtualizacaoDatetimeData de Atualização do RegistroSim
MotivoDesconto.DataCadastroDatetimeData de Cadastro do RegistroSim
MotivoDesconto.IdInteiroCódigo Id do Motivo do Desconto (Chave)Sim
MotivoDesconto.IdRetaguardaStringCódigo do Motivo do Desconto na RetaguadaSim
MotivoDesconto.SituacaoInteiro

Situação Cadastral

  • 0 - Inativo
  • 1 - Ativo
Sim
NomeConsumidorStringNome do consumidor apenas para emissão do cupom, não tem relacionamento com tabela de clientesNão
NumeroString 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 caixaNão
NumeroAutorizacaoStringNúmero da autorização de pagamentoNão
NumeroVendaStringCódigo da venda criado pelo PDV OmnishopSim
PreVendaItensLista de ObjetosLista de itens da pré vendaNão
PreVendaItens.AcrescimoDecimalValor de acréscimo aplicado ao item da pré vendaSim
PreVendaItens.AcrescimoPercentualDecimalPorcentagem do acréscimo aplicado ao itemSim
PreVendaItens.CodigoFilialSaidaStringCódigo Filial SaídaNão
PreVendaItens.CodigoProdutoStringCódigo ProdutoSim
PreVendaItens.DataEntregaDatetimeData da entrega do itemNão
PreVendaItens.DescontoDecimalValor do desconto aplicado ao itemSim
PreVendaItens.DescontoPercentualDecimalPorcentagem do desconto aplicado ao itemSim
PreVendaItens.EntregaObjetoDados de entrega do itemNão
PreVendaItens.Entrega.DataEntregaDatetimeData da entrega do itemNão
PreVendaItens.Entrega.IdLojaEntregaRetaguardaStringCódigo de identificação na retaguarda da loja que irá entregar/disponibilizar o produtoNão
PreVendaItens.Entrega.LockerMachineCodeStringIdentificação do locker no caso de retirada do produto em lockerNão
PreVendaItens.Entrega.LockerParcelCodeStringIdentificação do locker no caso de retirada do produto em lockerNão
PreVendaItens.Entrega.TipoEntregaInteiro

Tipo de entrega do item:

  • 0 - Retira
  • 1 - Retira posterior
  • 2 - Entrega Final
Não
PreVendaItens.Entrega.FretePercentualTotalDecimalValor percentual do FreteNão
PreVendaItens.Entrega.FreteTotalDecimalValor Real do FreteNão
PreVendaItens.Entrega.TipoValorFreteInteiro

Tipo do valor do frete:

    • 0 - Percentual
    • 1 - Real
Não
PreVendaItens.IdPrecoRetaguardaString Código de identificação do preco na retaguardaSim
PreVendaItens.IdPreVendaInteiroCódigo da pré venda relacionada ao item da pré vendaSim
PreVendaItens.IdProdutoRetaguardaStringCódigo de identificação do produto na retaguardaSim
PreVendaItens.IdVendedorRetaguardaStringCódigo de identificação do vendedor na retaguardaSim
PreVendaItens.ItensKitLista de ObjetosLista de Itens Contidos no KitNão
PreVendaItens.ItensKit.IdProdutoRetaguardaStringReferencia do Id do Kit no retaguardaNão
PreVendaItens.ItensKit.PrecoDecimalPreço do Produto dentro do KitNão
PreVendaItens.ItensKit.QuantidadeDecimalQuantidade de Produtos dentro do KitNão
PreVendaItens.ItensKit.SequencialInteiroNumero q indica a posição do item dentro da listaNão
PreVendaItens.MotivoDescontoObjetoDesconto relacionado ao itemNão
PreVendaItens.MotivoDesconto.DescontoMotorPromocaoAplicadoBooleanoIndica se há desconto aplicado relacionado ao motorSim
PreVendaItens.MotivoDesconto.DescricaoStringDescrição do descontoSim
PreVendaItens.MotivoDesconto.IdPromocaoMotorPromocaoTerceiroStringCódigo de identificação do motor de promoçãoNão
PreVendaItens.MotivoDesconto.TipoInteiro

Tipo de operação de desconto:

    • 0 - AcrescimoDesconto
    • 1 - TrocaDevolucao
    • 2 - AlteracaoFormaPagamento
    • 3 - AusenciaFuncionario
    • 4 - ClassificacaoDia
    • 5 - CancelamentoVenda
    • 6 - Sangria
    • 7 - Suprimento
    • 8 - DevolucaoPedidoOMS
Sim
PreVendaItens.MotivoDesconto.TipoDescontoAcrescimoInteiro

Tipo do desconto:

    • 0 - Manual
    • 1 - Motor
    • 2 - Fidelidade
    • 3 - PromocaoSMS
    • 4 - CampanhaPromocional
    • 5 - MotorTerceiro
    • 6 - PrecoPromocional
    • 7 - LogisticaReversa
Sim
PreVendaItens.MotivoDesconto.DataAtualizacaoDatetimeData de Atualização do RegistroSim
PreVendaItens.MotivoDesconto.DataCadastroDatetimeData de Criação do RegistroSim
PreVendaItens.MotivoDesconto.IdInteiroCódigo de identificação do registro. (campo chave)Sim
PreVendaItens.MotivoDesconto.IdRetaguardaStringCódigo de identificação do registro na retaguardaSim
PreVendaItens.MotivoDesconto.SituacaoInteiro

Situação Cadastral:

0 - Inativo

1 - Ativo

Não
PreVendaItens.PrecoDecimalValor do itemNão
PreVendaItens.QuantidadeDecimalQuantidade do itemSim
PreVendaItens.QuantidadeFaturadaDecimalQuantidade de itens faturadasNão
PreVendaItens.FreteDecimalValor Real do Frete do ItemNão
PreVendaItens.FretePercentualDecimalValor Percentual do Frete do ItemNão
PreVendaItens.TipoValorFreteInteiro

Tipo do valor do frete do item:

    • 0 - Percentual
    • 1 - Real
Não
PreVendaItens.QuantidadeEncomendaDecimalQuantidade EncomendaNão
PreVendaItens.IdProdutoEmbalagemRetaguardaStringId Retaguarda do Produto EmbalagemNão
PreVendaItens.DataAtualizacaoDatetimeData de atualização do itemNão
PreVendaItens.DataCadastroDatetimeData que o item foi criado no PDVNão
PreVendaItens.IdInteiroCódigo de identificação do registro. (campo chave)Sim
PreVendaItens.IdRetaguardaStringCódigo Retaguarda do Item da Pré VendaSim
PreVendaItens.SituacaoInteiro

Situação Cadastral:

0 - Inativo

1 - Ativo

Sim
PreVendaPagamentosLista de ObjetosLista de pagamentos da pré vendaNão
PreVendaPagamentos.IdPagamentoCondicaoRetaguardaStringCódigo de indentificação da Condição do pagamento na retaguardaNão
PreVendaPagamentos.IdPagamentoFormaRetaguardaStringCódigo de identificação da Forma de pagamento na retaguardaNão
PreVendaPagamentos.IdPagamentoOperadoraRetaguardaStringCódigo de identificação da Operadora responsável pelo pagamento na retaguardaNão
PreVendaPagamentos.IdPreVendaInteiroCódigo de identificação da pré venda relacionada ao itemSim
PreVendaPagamentos.PreVendaPagamentoDadosComplementaresLista de Objetos Lista de dados complementares ao pagamentoNão
PreVendaPagamentos.PreVendaPagamentoDadosComplementares.DescricaoStringDescrição do dado complementarSim
PreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdPagamentoDadoComplementarRetaguardaStringCódigo de identificação do Dado complementar na retaguardaNão
PreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdPreVendaPagamentoInteiroCódigo de identificação da pre venda pagamento relacionada ao dado complementarNão
PreVendaPagamentos.PreVendaPagamentoDadosComplementares.DataAtualizacaoDatetimeData da última atualização do dado complementarNão
PreVendaPagamentos.PreVendaPagamentoDadosComplementares.DataCadastroDatetimeData de cadastro do dado complementarNão
PreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdInteiroCódigo de identificação do registro. (campo chave)Sim
PreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdRetaguardaStringCódigo de identificação do registro na retaguardaSim
PreVendaPagamentos.PreVendaPagamentoDadosComplementares.SituacaoInteiro

Indica se o pagamento está ativo ou cancelado:

    • 0 - Cancelado
    • 1 - Ativo
Sim
PreVendaPagamentos.PreVendaPagamentoItensLista de ObjetosLista de itens do pagamentoNão
PreVendaPagamentos.PreVendaPagamentoItens.DataVencimentoDatetimeData de vencimento das parcelas aplicadas ao pagamentoNão
PreVendaPagamentos.PreVendaPagamentoItens.IdPreVendaPagamentoInteiroCódigo da pre venda pagamento relacionada ao item do pagamentoNão
PreVendaPagamentos.PreVendaPagamentoItens.NumeroParcelaInteiroQuantidade de parcelas aplicadas ao pagamentoNão
PreVendaPagamentos.PreVendaPagamentoItens.ValorParcelaDecimalValor das parcelas aplicadas ao pagamentoNão
PreVendaPagamentos.PreVendaPagamentoItens.DataAtualizacaoDatetimeData da ultima atualização do pagamento itemNão
PreVendaPagamentos.PreVendaPagamentoItens.DataCadastroDatetimeData de cadastro do pagamento itemNão
PreVendaPagamentos.PreVendaPagamentoItens.IdInteiroCódigo de identificação do registro. (campo chave)Sim
PreVendaPagamentos.PreVendaPagamentoItens.IdRetaguardaStringCódigo de identificação do registro na retaguardaSim
PreVendaPagamentos.PreVendaPagamentoItens.SituacaoInteiro

Indica se o pagamento item está ativo ou cancelado

    • 0 - Cancelado
    • 1 - Ativo
Sim
PreVendaPagamentos.PreVendaPagamentoTefsLista de ObjetosLista de Pagametno TefNão
PreVendaPagamentos.PreVendaPagamentoTefs.BandeiraStringCódigo da bandeira do cartãoSim
PreVendaPagamentos.PreVendaPagamentoTefs.CodigoRedeStringCódigo da rede do cartãoSim
PreVendaPagamentos.PreVendaPagamentoTefs.DataPreDatadoDatetimeData do pagamento pré-datadoNão
PreVendaPagamentos.PreVendaPagamentoTefs.DiasEntreParcelasInteiroNúmero de dias entre as datas de vencimento das parcelasNão
PreVendaPagamentos.PreVendaPagamentoTefs.IdPreVendaPagamentoInteiroCódigo da pre venda pagamento relacionada ao item do pagamento TefNão
PreVendaPagamentos.PreVendaPagamentoTefs.IdTransacaoDigitalStringCódigo de autorização do pagamento, retornado pelo TPD / TPINão
PreVendaPagamentos.PreVendaPagamentoTefs.NsuHostStringCódigo de autorização do pagamento, retornado pela administradora do cartãoNão
PreVendaPagamentos.PreVendaPagamentoTefs.NumeroAutorizacaoStringCódigo de autorização do pagamento, retornado pelo SitefNão
PreVendaPagamentos.PreVendaPagamentoTefs.NumeroBinStringIdentificação do cartão (primeiros números do cartão)Não
PreVendaPagamentos.PreVendaPagamentoTefs.NumeroParcelasInteiroQuantidade de parcelas no pagamentoNão
PreVendaPagamentos.PreVendaPagamentoTefs.PrimeiraParcelaDatetimeData da primeira parcelaNão
PreVendaPagamentos.PreVendaPagamentoTefs.DataAtualizacaoDatetimeData da ultima atualização do pagamento TefNão
PreVendaPagamentos.PreVendaPagamentoTefs.DataCadastroDatetimeData de cadastro do pagamento TefNão
PreVendaPagamentos.PreVendaPagamentoTefs.IdInteiroCódigo de identificação do registro. (campo chave)Não
PreVendaPagamentos.PreVendaPagamentoTefs.IdRetaguardaStringCódigo de identificação do registro na retaguardaSim
PreVendaPagamentos.PreVendaPagamentoTefs.SituacaoInteiro

Indica se o pagamento tef está ativo ou cancelado

    • 0 - Cancelado
    • 1 - Ativo
Sim
PreVendaPagamentos.ValorLiquidoDecimalValor da pré venda incluindo os descontosNão
PreVendaPagamentos.ValorMinimoAceitoDecimalValor mínimo que pode ser pago, configurado na forma de pagamentoSim
PreVendaPagamentos.ValorPagoDecimalValor registrado no pagamentoNão
PreVendaPagamentos.ValorTrocoDecimalValor devolvido de troco ao clienteNão
PreVendaPagamentos.PagamentoFormaObjetoForma de PagamentoNão
PreVendaPagamentos.PagamentoForma.IdRetaguardaStringCódigo de identificação da Forma de pagamento na retaguardaNão
PreVendaPagamentos.PagamentoCondicaoObjetoCondição de PagamentoNão
PreVendaPagamentos.PagamentoCondicao.IdRetaguardaStringCódigo de indentificação da Condição do pagamento na retaguardaNão
PreVendaPagamentos.QuantidadeParcelasInteiroQuantidade de Parcelas pagamentoSim
PreVendaPagamentos.DataAtualizacaoDatetimeData de atualização do pagamentoNão
PreVendaPagamentos.DataCadastroDatetimeData de cadastro do pagamentoNão
PreVendaPagamentos.IdInteiroCódigo de identificação do registro. (campo chave)Sim
PreVendaPagamentos.IdRetaguardaStringCódigo de identificação do registro na retaguardaSim
PreVendaPagamentos.SituacaoInteiro

Indica se o pagamento está ativo ou cancelado

    • 0 - Cancelado
    • 1 - Ativo
Sim
VendaPagamentosLista de ObjetosLista de Venda PagamentosNão
VendaPagamentos.VendaIdInteiroCódigo de Identificação da VendaNão
VendaPagamentos.PagamentoFormaIdInteiroCódigo de Identificação da Forma de Pagamento (campo chave)Sim
VendaPagamentos.PagamentoFormaObjetoForma de PagamentoNão
VendaPagamentos.PagamentoForma.IdRetaguardaStringCódigo de Identificação da Forma de Pagamento na RetaguardaNão
VendaPagamentos.PagamentoForma.DescricaoStringDescrição da Forma de PagamentoNão
VendaPagamentos.PagamentoCondicaoIdInteiroCódigo de Identificação da Condição de Pagamento (campo chave)Sim
VendaPagamentos.PagamentoCondicaoObjetoCondição de PagamentoNão
VendaPagamentos.PagamentoCondicao.IdRetaguardaStringCódigo de Identificação da Condição de Pagamento na RetaguardaNão
VendaPagamentos.PagamentoCondicao.DescricaoStringDescrição da Condição de PagamentoNão
VendaPagamentos.PagamentoCondicao.DiasEntreParcelasInteiroDias entre ParcelasNão
VendaPagamentos.PagamentoOperadoraIdInteiroCódigo de Identificação da Operadora de Pagamento (campo chave)Sim
VendaPagamentos.PagamentoOperadoraObjetoOperadora do PagamentoNão
VendaPagamentos.PagamentoOperadora.IdRetaguardaStringCódigo de Identificação da Operadora de Pagamento na RetaguardaNão
VendaPagamentos.PagamentoOperadora.DescricaoStringDescrição da Operadora de PagamentoNão
VendaPagamentos.PagamentoOperadora.CodigoTefStringCódigo TEFSim
VendaPagamentos.ValorPagoDecimalValor PagoNão
VendaPagamentos.ValorTrocoDecimalValor do TrocoNão
VendaPagamentos.ValorLiquidoDecimalValor LíquidoNão
VendaPagamentos.IdRetaguardaCreditoInteiroCódigo de Identificação de Crédito na RetaguardaNão
VendaPagamentos.CpfCnpjClienteStringCPF ou CNPJ do ClienteNão
VendaPagamentos.QuantidadeParcelasInteiroQuantidade de ParcelasNão
VendaPagamentos.IdDividaStringCódigo de Identificação da DívidaNão
VendaPagamentos.VendaPagamentoDadoComplementarsLista de ObjetosDados Complementares da Venda PagamentoNão
VendaPagamentos.VendaPagamentoDadoComplementars.ConteudoStringConteúdo do Dado ComplementarNão
VendaPagamentos.VendaPagamentoDadoComplementars.DescricaoStringDescrição do Dado ComplementarNão
VendaPagamentos.VendaPagamentoDadoComplementars.IdPagamentoDadoComplementarInteiroCódigo de Identificação do Dado Complementar de Pagamento (Campo Chave)Não
VendaPagamentos.VendaPagamentoDadoComplementars.IdPagamentoDadoComplementarRetaguardaStringCódigo de Identificação do Dado Complementar na RetaguardaNão
VendaPagamentos.VendaPagamentoDadoComplementars.IdVendaPagamentoInteiroCódigo de Identificação da Venda Pagamento (Campo Chave)Sim
VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementarObjetoDado ComplementarNão
VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.DescricaoStringDescrição do Pagamento Dado ComplementarNão
VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.TipoInteiroTipo do Pagamento Dado ComplementarSim
VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.ObrigatorioInteiro

Flag Obrigatório

  • 1 - Sim
  • 0 - Não
Sim
VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.TamanhoInteiroTamanhoNão
VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.TipoCampoTefInteiroTipo Campo TEFNão
VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.DataAtualizacaoDatetimeData de Atualização do RegistroNão
VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.DataCadastroDatetimeData de Criação do RegistroNão
VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.IdInteiroCódigo de Identificação do Pagamento Dado Complementar (Campo Chave)Sim
VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.IdRetaguardaStringCódigo de Identificação do Pagamento Dado Complementar na RetaguardaNão
VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.SituacaoInteiro

Situação Cadastral

  • 1 - Ativo
  • 0 - Cancelado
Não
VendaPagamentos.VendaPagamentoDadoComplementars.DataAtualizacaoDatetimeData de Atualização do RegistroNão
VendaPagamentos.VendaPagamentoDadoComplementars.DataCadastroDatetimeData de Criação do RegistroNão
VendaPagamentos.VendaPagamentoDadoComplementars.IdInteiroCódigo de Identificação do Dado Complementar (Campo Chave)Sim
VendaPagamentos.VendaPagamentoDadoComplementars.IdRetaguardaStringCódigo de Identificação do Dado Complementar na RetaguardaNão
VendaPagamentos.VendaPagamentoDadoComplementars.SituacaoInteiro

Situação Cadastral

  • 1 - Ativo
  • 0 - Cancelado
Não
VendaPagamentos.VendaPagamentoItemsLista de ObjetosItens da Venda PagamentoNão
VendaPagamentos.VendaPagamentoItems.VendaPagamentoIdInteiroCódigo de Identificação da Venda PagamentoNão
VendaPagamentos.VendaPagamentoItems.NumeroParcelaInteiroNúmero de ParcelasNão
VendaPagamentos.VendaPagamentoItems.ValorParcelaDecimalValor da ParcelaNão
VendaPagamentos.VendaPagamentoItems.DataVencimentoDatetimeData de Vencimento da ParcelaNão
VendaPagamentos.VendaPagamentoItems.DataAtualizacaoDatetimeData de Atualização do RegistroNão
VendaPagamentos.VendaPagamentoItems.DataCadastroDatetimeData de Cadastro do RegistroNão
VendaPagamentos.VendaPagamentoItems.IdInteiroCódigo de Identificação do Item de Venda Pagamento (Campo Chave)Sim
VendaPagamentos.VendaPagamentoItems.IdRetaguardaStringCódigo de Identificação do Item de Venda Pagamento na RetaguardaNão
VendaPagamentos.VendaPagamentoItems.SituacaoInteiro

Situação Cadastral

  • 1 - Ativo
  • 0 - Cancelado
Não
VendaPagamentos.VendaPagamentoTefsLista de ObjetosVenda Pagamento TefsNão
VendaPagamentos.VendaPagamentoTefs.BandeiraStringBandeira do CartãoNão
VendaPagamentos.VendaPagamentoTefs.CodigoRedeStringCódigo da RedeNão
VendaPagamentos.VendaPagamentoTefs.DataPreDatadoDatetimeData do Pré DatadoNão
VendaPagamentos.VendaPagamentoTefs.DiasEntreParcelasInteiroDias Entre ParcelasNão
VendaPagamentos.VendaPagamentoTefs.IdVendaPagamentoInteiroCódigo de Identificação da Venda PagamentoSim
VendaPagamentos.VendaPagamentoTefs.IdTransacaoDigitalStringCódigo de Identificação de Transação DigitalNão
VendaPagamentos.VendaPagamentoTefs.NsuHostStringNSU HostNão
VendaPagamentos.VendaPagamentoTefs.NumeroAutorizacaoStringNúmero da AutorizaçãoNão
VendaPagamentos.VendaPagamentoTefs.NumeroBinStringNúmero BinNão
VendaPagamentos.VendaPagamentoTefs.NumeroParcelasInteiroNúmero de ParcelasNão
VendaPagamentos.VendaPagamentoTefs.PrimeiraParcelaDatetimeData da Primeira ParcelaNão
VendaPagamentos.VendaPagamentoTefs.IdPagamentoMfeInteiroCódigo de Identificação do Pagamento MfeNão
VendaPagamentos.VendaPagamentoTefs.SincronizadoPagamentoMfeBooleanoSincronizado Pagamento NfeNão
VendaPagamentos.VendaPagamentoTefs.DataAtualizacaoDatetimeData de Atualização do RegistroNão
VendaPagamentos.VendaPagamentoTefs.DataCadastroDatetimeData de Criação do RegistroNão
VendaPagamentos.VendaPagamentoTefs.IdInteiroCódigo de Identificação da Venda Pagamento Tefs (campo chave)Sim
VendaPagamentos.VendaPagamentoTefs.IdRetaguardaStringCódigo de Identificação da Venda Pagamento Tefs na RetaguardaNão
VendaPagamentos.VendaPagamentoTefs.SituacaoInteiro

Situação Cadastral

  • 1 - Ativo
  • 0 - Cancelado
Não
VendaPagamentos.VendaPagamentoTrocasLista de ObjetosTrocas da Venda PagamentoNão
VendaPagamentos.VendaPagamentoTrocas.VendaPagamentoIdInteiroCódigo de Identificação da Venda Pagamento (campo chave)Sim
VendaPagamentos.VendaPagamentoTrocas.IdVendaRetaguardaStringCódigo de Identificação da Venda na RetaguardaNão
VendaPagamentos.VendaPagamentoTrocas.CpfCnpjStringCpf ou Cnpj do ConsumidorNão
VendaPagamentos.VendaPagamentoTrocas.NomeStringNome do ConsumidorNão
VendaPagamentos.VendaPagamentoTrocas.MotivoIdInteiroCódigo de Identificação do Motivo (campo chave)Sim
VendaPagamentos.VendaPagamentoTrocas.MotivoObjetoMotivo da TrocaNão
VendaPagamentos.VendaPagamentoTrocas.Motivo.IdRetaguardaStringCódigo de Identificação do Motivo na RetaguardaNão
VendaPagamentos.VendaPagamentoTrocas.Motivo.DescricaoStringDescrição da Venda PagamentoNão
VendaPagamentos.VendaPagamentoTrocas.DataTrocaDatetimeData da TrocaNão
VendaPagamentos.VendaPagamentoTrocas.ValorTotalDecimalValor TotalNão
VendaPagamentos.VendaPagamentoTrocas.TrocaItemsLista de ObjetosItens de TrocaNão
VendaPagamentos.VendaPagamentoTrocas.TrocaItems.IdItemRetaguardaStringCódigo de Identificação do Item na RetaguardaNão
VendaPagamentos.VendaPagamentoTrocas.TrocaItems.TrocaIdInteiroCódigo de Identificação da Troca (Campo chave)Não
VendaPagamentos.VendaPagamentoTrocas.TrocaItems.ProdutoIdInteiroCódigo de Identificação do Produto (campo chave)Sim
VendaPagamentos.VendaPagamentoTrocas.TrocaItems.ProdutoObjetoProduto da TrocaNão
VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.IdInteiroCódigo de Identificação do Produto (campo chave)Sim
VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.IdRetaguardaStringCódigo de Identificação do Produto na RetaguardaNão
VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.CodigoProdutoStringCódigo do ProdutoNão
VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.DescricaoStringDescrição do ProdutoNão
VendaPagamentos.TrocaItems.ValorDecimalValor do ProdutoNão
VendaPagamentos.TrocaItems.QuantidadeDecimalQuantidadeNão
VendaPagamentos.TrocaItems.DataAtualizacaoDatetimeData de Atualização do RegistroNão
VendaPagamentos.TrocaItems.DataCadastroDatetimeData de Criação do RegistroNão
VendaPagamentos.TrocaItems.IdInteiroCódigo de Identificação do Item de Troca (campo chave)Sim
VendaPagamentos.TrocaItems.IdRetaguardaStringCódigo de Identificação do Item de Troca na RetaguardaNão
VendaPagamentos.TrocaItems.SituacaoInteiro

Situação Cadastral

  • 1 - Ativo
  • 0 - Cancelado
Não
VendaPagamentos.VendaPagamentoTrocas.DataAtualizacaoDatetimeData de Atualização do RegistroNão
VendaPagamentos.VendaPagamentoTrocas.DataCadastroDatetimeData de Criação do RegistroNão
VendaPagamentos.VendaPagamentoTrocas.IdInteiroCódigo de Identificação da Venda Pagamento Troca (campo chave)Sim
VendaPagamentos.VendaPagamentoTrocas.IdRetaguardaStringCódigo de Identificação da Venda Pagamento Troca na RetaguardaNão
VendaPagamentos.VendaPagamentoTrocas.SituacaoInteiro

Situação Cadastral

  • 1 - Ativo
  • 0 - Cancelado
Não
SerieVendaStringNúmero de série da vendaSim
SincronizadoInteiro

Indica se a pré venda entá sincronizada com o retaguarda:

    • 0 - Não
    • 1 - Sim
Sim
SistemaOrigemInteiro

Código do sistema de origem:

    • 0 - Não Informado
    • 1 - Loja física
    • 2 - Mesa Interativa
    • 3 - Terminal
    • 4 - e-Commerce
    • 5 - Click e Collect
    • 6 - Omni
Não
SituacaoPreVendaString

Status da pré venda:

    • DISPONIVEL
    • ATENDIMENTO
    • FATURADO PARCIALMENTE
    • RESGATADA
    • RECEBIDO
    • CANCELADA
Sim
TerminalOrigemStringNúmero do PDV onde foi gerado o pedido (integração omnichannel)Não
TipoCancelamentoInteiro

Tipo do cancelamento:

    • 0 - Automático
    • 1 - Manual
Não
TipoDescontoAcrescimoInteiro

Tipo do acréscimo:

    • 0 - Percentual
    • 1 - Valor
    • 2 - Preço Final
Não
TipoEntregaInteiro

Tipo de entrega:

    • 0 - Retira
    • 1 - Retira posterior
    • 2 - Entrega
Sim
TipoPreVendaInteiro

Tipo da pré venda:

    • 0 - Pré Venda
    • 1 - Pedido
    • 2 - Orçamento
Sim
TipoVendaInteiro

Tipo da venda:

    • 1 - Produto
    • 2 - Serviço
    • 3 - Cartão presente
    • 4 - Pedido
Sim
TotalBrutoDecimalValor total do Pedido sem os descontosSim
TotalLiquidoDecimalValor liquido do Pedido considerando todos os descontosSim
FretePercentualTotalDecimalValor percentual do FreteNão
FreteTotalDecimalValor Real do FreteNão
TipoValorFreteInteiro

Tipo do valor do frete:

    • 0 - Percentual
    • 1 - Real
Não
MultiplosPedidosBooleanoIndica se existe multiplos pedidos na PrevendaNão
ModalidadeFreteInteiro

Modalidade do frete:

    • 0 - CIF - Contratação do Frete por conta do Remetente
    • 1 - FOB - Contratação do Frete por conta do Destinatário
    • 2 - Contratação do Frete por conta de Terceiros
    • 3 - Transporte Próprio por conta do Remetente
    • 4 - Transporte Próprio por conta do Destinatário
    • 9 - Gratuito - Sem Ocorrência de Transporte
Não
AcrescimoPercentualTotalDecimalAcréscimo Percentual TotalNão
AcrescimoTotalDecimalAcréscimo TotalNão
NumeroPdvInteiroNúmero PDVNão
DataAtualizacaoDatetimeData de atualização da pré vendaNão
DataCadastroDatetimeData que a pré venda foi criado no PDVNão
IdInteiroCódigo de identificação do registro. (campo chave), gerado pelo PDV Omnishop.Sim
IdRetaguardaStringCódigo de identificação do registro na retaguardaNão
IdProfissionalRetaguardaStringCódigo de identificação do registro na retaguardaNão
Card
labelBody

{
    "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"
}

Retornos

Deck of Cards
idcredito_consulta_get
Card
label200 - OK

Campo

Tipo

Descrição

SuccessBooleanoIndica se a requisição foi feita com sucesso
MessageStringMensagem de retorno de erros
DataObjetoLista com os créditos retornados
Data.IdPedidoRetaguardaStringIdentificador do pedido na retaguarda
Data.ClienteObjetoCliente do pedido
Data.Cliente.EnderecosLista de ObjetosLista de endereços do cliente
Data.Cliente.Enderecos.IdInteiroIdentificador do endereço
Data.Cliente.Enderecos.IdRetaguardaStringIdentificador do endereço na retaguarda
Data.Cliente.IdInteiroIdentificador do cliente
Data.Cliente.IdRetaguardaStringIdentificador do cliente na retaguarda
ErrorsNuloLista de erros
TotalTimeInteiroTempo da requisição
NumberOfRecordsInteiroNú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
}

Card
label400 - Bad Request

Campo

Tipo

Descrição

Obeservação

SuccessboolIndica se a requisição foi feita com sucesso
MessagestringMensagem de retorno de erros
DataObjetoObjeto de retonro
ErrorsLista de objetosLista de errosSomente é retornado na V3
TotalTimeIntTempo total da requisição
NumberOfRecordsIntNúmero de registros


{
    "success": false,
    "message": "string",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}