01. DADOS GERAIS
| Linha de Produto: | TOTVS Varejo Lojas |
|---|---|
| Segmento: | Varejo |
| Módulo: | SigaLoja (Controle de Loja) |
| Função: | OrcamentoApi.tlpp |
| Ticket: | Não há. |
| Story: | DVARLOJ1-11348 |
02. SITUAÇÃO/REQUISITO
Disponibilizar mecanismos para consultar o Orçamento completo criado na retaguarda do SIGALOJA.
03. SOLUÇÃO
Foi disponibilizada API no seguinte caminho: http://{urlRest}/api/retail/v1/orcamento
Com esta API será possível efetuar a consulta de orçamentos.
Parâmetros de entrada (Request):
| Parâmetro | Tipo | Obrigatório | Objetivo |
| IdInquilino | String | S | Inquilino responsável pelo orçamento. |
| IdPedidoRetaguarda | String | S | Código do Orçamento no Protheus |
Exemplo:
{
"IdInquilino": "D PR 02 ",
"IdPedidoRetaguarda": "01000082"
}
Valores de retorno:
Campo | Tipo | Descrição |
|---|---|---|
| TotalTime | Inteiro | Tempo da requisição |
| Success | Booleano | Indica se a requisição foi feita com sucesso |
| NumberOfRecords | Inteiro | Número de registros |
| Message | String | Mensagem de retorno de erros |
| Errors | Objeto | Lista de erros |
| VendaPagamentos.VendaPagamentoTrocas.VendaPagamentoId | Inteiro | Código de Identificação da Venda Pagamento (campo chave) |
| VendaPagamentos.VendaPagamentoTrocas.ValorTotal | Decimal | Valor Total |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems.TrocaId | Inteiro | Código de Identificação da Troca (Campo chave) |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems.ProdutoId | Inteiro | Código de Identificação do Produto (campo chave) |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.IdRetaguarda | String | Código de Identificação do Produto na Retaguarda |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.Id | Inteiro | Código de Identificação do Produto (campo chave) |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.Descricao | String | Descrição do Produto |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.CodigoProduto | String | Código do Produto |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto | Objeto | Produto da Troca |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems.IdItemRetaguarda | String | Código de Identificação do Item na Retaguarda |
| VendaPagamentos.VendaPagamentoTrocas.TrocaItems | Lista de Objetos | Itens de Troca |
| VendaPagamentos.VendaPagamentoTrocas.Situacao | Inteiro | Situação Cadastral 1 - Ativo 0 - Cancelado |
| VendaPagamentos.VendaPagamentoTrocas.Nome | String | Nome do Consumidor |
| VendaPagamentos.VendaPagamentoTrocas.MotivoId | Inteiro | Código de Identificação do Motivo (campo chave) |
| VendaPagamentos.VendaPagamentoTrocas.Motivo.IdRetaguarda | String | Código de Identificação do Motivo na Retaguarda |
| VendaPagamentos.VendaPagamentoTrocas.Motivo.Descricao | String | Descrição da Venda Pagamento |
| VendaPagamentos.VendaPagamentoTrocas.Motivo | Objeto | Motivo da Troca |
| VendaPagamentos.VendaPagamentoTrocas.IdVendaRetaguarda | String | Código de Identificação da Venda na Retaguarda |
| VendaPagamentos.VendaPagamentoTrocas.IdRetaguarda | String | Código de Identificação da Venda Pagamento Troca na Retaguarda |
| VendaPagamentos.VendaPagamentoTrocas.Id | Inteiro | Código de Identificação da Venda Pagamento Troca (campo chave) |
| VendaPagamentos.VendaPagamentoTrocas.DataTroca | Data/Hora | Data da Troca |
| VendaPagamentos.VendaPagamentoTrocas.DataCadastro | Data/Hora | Data de Criação do Registro |
| VendaPagamentos.VendaPagamentoTrocas.DataAtualizacao | Data/Hora | Data de Atualização do Registro |
| VendaPagamentos.VendaPagamentoTrocas.CpfCnpj | String | Cpf ou Cnpj do Consumidor |
| VendaPagamentos.VendaPagamentoTrocas | Lista de Objetos | Trocas da Venda Pagamento |
| VendaPagamentos.VendaPagamentoTefs.Situacao | Inteiro | Situação Cadastral 1 - Ativo 0 - Cancelado |
| VendaPagamentos.VendaPagamentoTefs.SincronizadoPagamentoMfe | Booleano | Sincronizado Pagamento Nfe |
| VendaPagamentos.VendaPagamentoTefs.PrimeiraParcela | Data/Hora | Data da Primeira Parcela |
| VendaPagamentos.VendaPagamentoTefs.NumeroParcelas | Inteiro | Número de Parcelas |
| VendaPagamentos.VendaPagamentoTefs.NumeroBin | String | Número Bin |
| VendaPagamentos.VendaPagamentoTefs.NumeroAutorizacao | String | Número da Autorização |
| VendaPagamentos.VendaPagamentoTefs.NsuHost | String | NSU Host |
| VendaPagamentos.VendaPagamentoTefs.IdVendaPagamento | Inteiro | Código de Identificação da Venda Pagamento |
| VendaPagamentos.VendaPagamentoTefs.IdTransacaoDigital | String | Código de Identificação de Transação Digital |
| VendaPagamentos.VendaPagamentoTefs.IdRetaguarda | String | Código de Identificação da Venda Pagamento Tefs na Retaguarda |
| VendaPagamentos.VendaPagamentoTefs.IdPagamentoMfe | Inteiro | Código de Identificação do Pagamento Mfe |
| VendaPagamentos.VendaPagamentoTefs.Id | Inteiro | Código de Identificação da Venda Pagamento Tefs (campo chave) |
| VendaPagamentos.VendaPagamentoTefs.DiasEntreParcelas | Inteiro | Dias Entre Parcelas |
| VendaPagamentos.VendaPagamentoTefs.DataPreDatado | Data/Hora | Data do Pré Datado |
| VendaPagamentos.VendaPagamentoTefs.DataCadastro | Data/Hora | Data de Criação do Registro |
| VendaPagamentos.VendaPagamentoTefs.DataAtualizacao | Data/Hora | Data de Atualização do Registro |
| VendaPagamentos.VendaPagamentoTefs.CodigoRede | String | Código da Rede |
| VendaPagamentos.VendaPagamentoTefs.Bandeira | String | Bandeira do Cartão |
| VendaPagamentos.VendaPagamentoTefs | Lista de Objetos | Venda Pagamento Tefs |
| VendaPagamentos.VendaPagamentoItems.VendaPagamentoId | Inteiro | Código de Identificação da Venda Pagamento |
| VendaPagamentos.VendaPagamentoItems.ValorParcela | Decimal | Valor da Parcela |
| VendaPagamentos.VendaPagamentoItems.Situacao | Inteiro | Situação Cadastral 1 - Ativo 0 - Cancelado |
| VendaPagamentos.VendaPagamentoItems.NumeroParcela | Inteiro | Número de Parcelas |
| VendaPagamentos.VendaPagamentoItems.IdRetaguarda | String | Código de Identificação do Item de Venda Pagamento na Retaguarda |
| VendaPagamentos.VendaPagamentoItems.Id | Inteiro | Código de Identificação do Item de Venda Pagamento (Campo Chave) |
| VendaPagamentos.VendaPagamentoItems.DataVencimento | Data/Hora | Data de Vencimento da Parcela |
| VendaPagamentos.VendaPagamentoItems.DataCadastro | Data/Hora | Data de Cadastro do Registro |
| VendaPagamentos.VendaPagamentoItems.DataAtualizacao | Data/Hora | Data de Atualização do Registro |
| VendaPagamentos.VendaPagamentoItems | Lista de Objetos | Itens da Venda Pagamento |
| VendaPagamentos.VendaPagamentoDadoComplementars.Situacao | Inteiro | Situação Cadastral 1 - Ativo 0 - Cancelado |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.TipoCampoTef | Inteiro | Tipo Campo TEF |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Tipo | Inteiro | Tipo do Pagamento Dado Complementar |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Tamanho | Inteiro | Tamanho |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Situacao | Inteiro | Situação Cadastral 1 - Ativo 0 - Cancelado |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Obrigatorio | Inteiro | Flag Obrigatório 1 - Sim 0 - Não |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.IdRetaguarda | String | Código de Identificação do Pagamento Dado Complementar na Retaguarda |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Id | Inteiro | Código de Identificação do Pagamento Dado Complementar (Campo Chave) |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.Descricao | String | Descrição do Pagamento Dado Complementar |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.DataCadastro | Data/Hora | Data de Criação do Registro |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.DataAtualizacao | Data/Hora | Data de Atualização do Registro |
| VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar | Objeto | Dado Complementar |
| VendaPagamentos.VendaPagamentoDadoComplementars.IdVendaPagamento | Inteiro | Código de Identificação da Venda Pagamento (Campo Chave) |
| VendaPagamentos.VendaPagamentoDadoComplementars.IdRetaguarda | String | Código de Identificação do Dado Complementar na Retaguarda |
| VendaPagamentos.VendaPagamentoDadoComplementars.IdPagamentoDadoComplementarRetaguarda | String | Código de Identificação do Dado Complementar na Retaguarda |
| VendaPagamentos.VendaPagamentoDadoComplementars.IdPagamentoDadoComplementar | Inteiro | Código de Identificação do Dado Complementar de Pagamento (Campo Chave) |
| VendaPagamentos.VendaPagamentoDadoComplementars.Id | Inteiro | Código de Identificação do Dado Complementar (Campo Chave) |
| VendaPagamentos.VendaPagamentoDadoComplementars.Descricao | String | Descrição do Dado Complementar |
| VendaPagamentos.VendaPagamentoDadoComplementars.DataCadastro | Data/Hora | Data de Criação do Registro |
| VendaPagamentos.VendaPagamentoDadoComplementars.DataAtualizacao | Data/Hora | Data de Atualização do Registro |
| VendaPagamentos.VendaPagamentoDadoComplementars.Conteudo | String | Conteúdo do Dado Complementar |
| VendaPagamentos.VendaPagamentoDadoComplementars | Lista de Objetos | Dados Complementares da Venda Pagamento |
| VendaPagamentos.VendaId | Inteiro | Código de Identificação da Venda |
| VendaPagamentos.ValorTroco | Decimal | Valor do Troco |
| VendaPagamentos.ValorPago | Decimal | Valor Pago |
| VendaPagamentos.ValorLiquido | Decimal | Valor Líquido |
| VendaPagamentos.TrocaItems.Valor | Decimal | Valor do Produto |
| VendaPagamentos.TrocaItems.Situacao | Inteiro | Situação Cadastral 1 - Ativo 0 - Cancelado |
| VendaPagamentos.TrocaItems.Quantidade | Decimal | Quantidade |
| VendaPagamentos.TrocaItems.IdRetaguarda | String | Código de Identificação do Item de Troca na Retaguarda |
| VendaPagamentos.TrocaItems.Id | Inteiro | Código de Identificação do Item de Troca (campo chave) |
| VendaPagamentos.TrocaItems.DataCadastro | Data/Hora | Data de Criação do Registro |
| VendaPagamentos.TrocaItems.DataAtualizacao | Data/Hora | Data de Atualização do Registro |
| VendaPagamentos.QuantidadeParcelas | Inteiro | Quantidade de Parcelas |
| VendaPagamentos.PagamentoOperadoraId | Inteiro | Código de Identificação da Operadora de Pagamento (campo chave) |
| VendaPagamentos.PagamentoOperadora.IdRetaguarda | String | Código de Identificação da Operadora de Pagamento na Retaguarda |
| VendaPagamentos.PagamentoOperadora.Descricao | String | Descrição da Operadora de Pagamento |
| VendaPagamentos.PagamentoOperadora.CodigoTef | String | Código TEF |
| VendaPagamentos.PagamentoOperadora | Objeto | Operadora do Pagamento |
| VendaPagamentos.PagamentoFormaId | Inteiro | Código de Identificação da Forma de Pagamento (campo chave) |
| VendaPagamentos.PagamentoForma.IdRetaguarda | String | Código de Identificação da Forma de Pagamento na Retaguarda |
| VendaPagamentos.PagamentoForma.Descricao | String | Descrição da Forma de Pagamento |
| VendaPagamentos.PagamentoForma | Objeto | Forma de Pagamento |
| VendaPagamentos.PagamentoCondicaoId | Inteiro | Código de Identificação da Condição de Pagamento (campo chave) |
| VendaPagamentos.PagamentoCondicao.IdRetaguarda | String | Código de Identificação da Condição de Pagamento na Retaguarda |
| VendaPagamentos.PagamentoCondicao.DiasEntreParcelas | Inteiro | Dias entre Parcelas |
| VendaPagamentos.PagamentoCondicao.Descricao | String | Descrição da Condição de Pagamento |
| VendaPagamentos.PagamentoCondicao | Objeto | Condição de Pagamento |
| VendaPagamentos.IdRetaguardaCredito | Inteiro | Código de Identificação de Crédito na Retaguarda |
| VendaPagamentos.IdDivida | String | Código de Identificação da Dívida |
| VendaPagamentos.CpfCnpjCliente | String | CPF ou CNPJ do Cliente |
| VendaPagamentos | Lista de Objetos | Lista de Venda Pagamentos |
| TotalLiquido | Decimal | Valor liquido do Pedido considerando todos os descontos |
| TotalBruto | Decimal | Valor total do Pedido sem os descontos |
| TipoVenda | Inteiro | Tipo da venda: 1 - Produto 2 - Serviço 3 - Cartão presente 4 - Pedido |
| TipoValorFrete | Inteiro | Tipo do valor do frete: 0 - Percentual 1 - Real |
| TipoPreVenda | Inteiro | Tipo da pré venda: 0 - Pré Venda 1 - Pedido 2 - Orçamento |
| TipoEntrega | Inteiro | Tipo de entrega: 0 - Retira 1 - Retira posterior 2 - Entrega |
| TipoDescontoAcrescimo | Inteiro | Tipo do acréscimo: 0 - Percentual 1 - Valor 2 - Preço Final |
| TipoCancelamento | Inteiro | Tipo do cancelamento: 0 - Automático 1 - Manual |
| TerminalOrigem | String | Número do PDV onde foi gerado o pedido (integração omnichannel) |
| SituacaoPreVenda | String | Status da pré venda: 1 - DISPONIVEL 2 - ATENDIMENTO 3 - FATURADO PARCIALMENTE 4 - RESGATADA 5 - RECEBIDO 6 -CANCELADA |
| Situacao | Inteiro | Situação Cadastral: 1 - Ativo 0 - Inativo |
| SistemaOrigem | Inteiro | 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 |
| Sincronizado | Inteiro | Indica se a pré venda entá sincronizada com o retaguarda: 0 - Não 1 - Sim |
| SerieVenda | String | Número de série da venda |
| PreVendaPagamentos.ValorTroco | Decimal | Valor devolvido de troco ao cliente |
| PreVendaPagamentos.ValorPago | Decimal | Valor registrado no pagamento |
| PreVendaPagamentos.ValorMinimoAceito | Decimal | Valor mínimo que pode ser pago, configurado na forma de pagamento |
| PreVendaPagamentos.ValorLiquido | Decimal | Valor da pré venda incluindo os descontos |
| PreVendaPagamentos.Situacao | Inteiro | Indica se o pagamento está ativo ou cancelado 0 - Cancelado 1 - Ativo |
| PreVendaPagamentos.QuantidadeParcelas | Inteiro | Quantidade de Parcelas pagamento |
| PreVendaPagamentos.PreVendaPagamentoTefs.Situacao | Inteiro | Indica se o pagamento tef está ativo ou cancelado 0 - Cancelado 1 - Ativo |
| PreVendaPagamentos.PreVendaPagamentoTefs.PrimeiraParcela | Data/Hora | Data da primeira parcela |
| PreVendaPagamentos.PreVendaPagamentoTefs.NumeroParcelas | Inteiro | Quantidade de parcelas no pagamento |
| PreVendaPagamentos.PreVendaPagamentoTefs.NumeroBin | String | Identificação do cartão (primeiros números do cartão) |
| PreVendaPagamentos.PreVendaPagamentoTefs.NumeroAutorizacao | String | Código de autorização do pagamento, retornado pelo Sitef |
| PreVendaPagamentos.PreVendaPagamentoTefs.NsuHost | String | Código de autorização do pagamento, retornado pela administradora do cartão |
| PreVendaPagamentos.PreVendaPagamentoTefs.IdTransacaoDigital | String | Código de autorização do pagamento, retornado pelo TPD / TPI |
| PreVendaPagamentos.PreVendaPagamentoTefs.IdRetaguarda | String | Código de identificação do registro na retaguarda |
| PreVendaPagamentos.PreVendaPagamentoTefs.IdPreVendaPagamento | Inteiro | Código da pre venda pagamento relacionada ao item do pagamento Tef |
| PreVendaPagamentos.PreVendaPagamentoTefs.Id | Inteiro | Código de identificação do registro. (campo chave) |
| PreVendaPagamentos.PreVendaPagamentoTefs.DiasEntreParcelas | Inteiro | Número de dias entre as datas de vencimento das parcelas |
| PreVendaPagamentos.PreVendaPagamentoTefs.DataPreDatado | Data/Hora | Data do pagamento pré-datado |
| PreVendaPagamentos.PreVendaPagamentoTefs.DataCadastro | Data/Hora | Data de cadastro do pagamento Tef |
| PreVendaPagamentos.PreVendaPagamentoTefs.DataAtualizacao | Data/Hora | Data da ultima atualização do pagamento Tef |
| PreVendaPagamentos.PreVendaPagamentoTefs.CodigoRede | String | Código da rede do cartão |
| PreVendaPagamentos.PreVendaPagamentoTefs.Bandeira | String | Código da bandeira do cartão |
| PreVendaPagamentos.PreVendaPagamentoTefs | Lista de Objetos | Lista de Pagamento Tef |
| PreVendaPagamentos.PreVendaPagamentoItens.ValorParcela | Decimal | Valor das parcelas aplicadas ao pagamento |
| PreVendaPagamentos.PreVendaPagamentoItens.Situacao | Inteiro | Indica se o pagamento item está ativo ou cancelado 0 - Cancelado 1 - Ativo |
| PreVendaPagamentos.PreVendaPagamentoItens.NumeroParcela | Inteiro | Quantidade de parcelas aplicadas ao pagamento |
| PreVendaPagamentos.PreVendaPagamentoItens.IdRetaguarda | String | Código de identificação do registro na retaguarda |
| PreVendaPagamentos.PreVendaPagamentoItens.IdPreVendaPagamento | Inteiro | Código da pre venda pagamento relacionada ao item do pagamento |
| PreVendaPagamentos.PreVendaPagamentoItens.Id | Inteiro | Código de identificação do registro. (campo chave) |
| PreVendaPagamentos.PreVendaPagamentoItens.DataVencimento | Data/Hora | Data de vencimento das parcelas aplicadas ao pagamento |
| PreVendaPagamentos.PreVendaPagamentoItens.DataCadastro | Data/Hora | Data de cadastro do pagamento item |
| PreVendaPagamentos.PreVendaPagamentoItens.DataAtualizacao | Data/Hora | Data da ultima atualização do pagamento item |
| PreVendaPagamentos.PreVendaPagamentoItens | Lista de Objetos | Lista de itens do pagamento |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares.Situacao | Inteiro | Indica se o pagamento está ativo ou cancelado: 0 - Cancelado 1 - Ativo |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdRetaguarda | String | Código de identificação do registro na retaguarda |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdPreVendaPagamento | Inteiro | Código de identificação da pre venda pagamento relacionada ao dado complementar |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdPagamentoDadoComplementarRetaguarda | String | Código de identificação do Dado complementar na retaguarda |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares.Id | Inteiro | Código de identificação do registro. (campo chave) |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares.Descricao | String | Descrição do dado complementar |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares.DataCadastro | Data/Hora | Data de cadastro do dado complementar |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares.DataAtualizacao | Data/Hora | Data da última atualização do dado complementar |
| PreVendaPagamentos.PreVendaPagamentoDadosComplementares | Lista de Objetos | Lista de dados complementares ao pagamento |
| PreVendaPagamentos.PagamentoForma.IdRetaguarda | String | Código de identificação da Forma de pagamento na retaguarda |
| PreVendaPagamentos.PagamentoForma | Objeto | Forma de Pagamento |
| PreVendaPagamentos.PagamentoCondicao.IdRetaguarda | String | Código de identificação da Condição do pagamento na retaguarda |
| PreVendaPagamentos.PagamentoCondicao | Objeto | Condição de Pagamento |
| PreVendaPagamentos.IdRetaguarda | String | Código de identificação do registro na retaguarda |
| PreVendaPagamentos.IdPreVenda | Inteiro | Código de identificação da pré venda relacionada ao item |
| PreVendaPagamentos.IdPagamentoOperadoraRetaguarda | String | Código de identificação da Operadora responsável pelo pagamento na retaguarda |
| PreVendaPagamentos.IdPagamentoFormaRetaguarda | String | Código de identificação da Forma de pagamento na retaguarda |
| PreVendaPagamentos.IdPagamentoCondicaoRetaguarda | String | Código de identificação da Condição do pagamento na retaguarda |
| PreVendaPagamentos.Id | Inteiro | Código de identificação do registro. (campo chave) |
| PreVendaPagamentos.DataCadastro | Data/Hora | Data de cadastro do pagamento |
| PreVendaPagamentos.DataAtualizacao | Data/Hora | Data de atualização do pagamento |
| PreVendaPagamentos | Lista de Objetos | Lista de pagamentos da pré venda |
| PreVendaItens.TipoValorFrete | Inteiro | Tipo do valor do frete do item: 0 - Percentual 1 - Real |
| PreVendaItens.Situacao | Inteiro | Situação Cadastral: 0 - Inativo 1 - Ativo |
| PreVendaItens.QuantidadeFaturada | Decimal | Quantidade de itens faturadas |
| PreVendaItens.QuantidadeEncomenda | Decimal | Quantidade Encomenda |
| PreVendaItens.Quantidade | Decimal | Quantidade do item |
| PreVendaItens.Preco | Decimal | Valor do item |
| PreVendaItens.MotivoDesconto.TipoDescontoAcrescimo | Inteiro | Tipo do desconto: 0 - Manual 1 - Motor 2 - Fidelidade 3 - PromocaoSMS 4 - CampanhaPromocional 5 - MotorTerceiro 6 - PrecoPromocional 7 - LogisticaReversa |
| PreVendaItens.MotivoDesconto.Tipo | Inteiro | Tipo de operação de desconto: 0 - AcrescimoDesconto 1 - TrocaDevolucao 2 - AlteracaoFormaPagamento 3 - AusenciaFuncionario 4 - ClassificacaoDia 5 - CancelamentoVenda 6 - Sangria 7 - Suprimento 8 - DevolucaoPedidoOMS |
| PreVendaItens.MotivoDesconto.Situacao | Inteiro | Situação Cadastral: 0 - Inativo 1 - Ativo |
| PreVendaItens.MotivoDesconto.IdRetaguarda | String | Código de identificação do registro na retaguarda |
| PreVendaItens.MotivoDesconto.IdPromocaoMotorPromocaoTerceiro | String | Código de identificação do motor de promoção |
| PreVendaItens.MotivoDesconto.Id | Inteiro | Código de identificação do registro. (campo chave) |
| PreVendaItens.MotivoDesconto.Descricao | String | Descrição do desconto |
| PreVendaItens.MotivoDesconto.DescontoMotorPromocaoAplicado | Booleano | Indica se há desconto aplicado relacionado ao motor |
| PreVendaItens.MotivoDesconto.DataCadastro | Data/Hora | Data de Criação do Registro |
| PreVendaItens.MotivoDesconto.DataAtualizacao | Data/Hora | Data de Atualização do Registro |
| PreVendaItens.MotivoDesconto | Objeto | Desconto relacionado ao item |
| PreVendaItens.ItensKit.Sequencial | Inteiro | Numero q indica a posição do item dentro da lista |
| PreVendaItens.ItensKit.Quantidade | Decimal | Quantidade de Produtos dentro do Kit |
| PreVendaItens.ItensKit.Preco | Decimal | Preço do Produto dentro do Kit |
| PreVendaItens.ItensKit.IdProdutoRetaguarda | String | Referencia do Id do Kit no retaguarda |
| PreVendaItens.ItensKit | Lista de Objetos | Lista de Itens Contidos no Kit |
| PreVendaItens.IdVendedorRetaguarda | String | Código de identificação do vendedor na retaguarda |
| PreVendaItens.IdRetaguarda | String | Código Retaguarda do Item da Pré Venda |
| PreVendaItens.IdProdutoRetaguarda | String | Código de identificação do produto na retaguarda |
| PreVendaItens.IdProdutoEmbalagemRetaguarda | String | Id Retaguarda do Produto Embalagem |
| PreVendaItens.IdPreVenda | Inteiro | Código da pré venda relacionada ao item da pré venda |
| PreVendaItens.IdPrecoRetaguarda | String | Código de identificação do preco na retaguarda |
| PreVendaItens.Id | Inteiro | Código de identificação do registro. (campo chave) |
| PreVendaItens.FretePercentual | Decimal | Valor Percentual do Frete do Item |
| PreVendaItens.Frete | Decimal | Valor Real do Frete do Item |
| PreVendaItens.Entrega.TipoValorFrete | Inteiro | Tipo do valor do frete: 0 - Percentual 1 - Real |
| PreVendaItens.Entrega.TipoEntrega | Inteiro | Tipo de entrega do item: 0 - Retira 1 - Retira posterior 2 - Entrega Final |
| PreVendaItens.Entrega.LockerParcelCode | String | Identificação do locker no caso de retirada do produto em locker |
| PreVendaItens.Entrega.LockerMachineCode | String | Identificação do locker no caso de retirada do produto em locker |
| PreVendaItens.Entrega.IdLojaEntregaRetaguarda | String | Código de identificação na retaguarda da loja que irá entregar/disponibilizar o produto |
| PreVendaItens.Entrega.FreteTotal | Decimal | Valor Real do Frete |
| PreVendaItens.Entrega.FretePercentualTotal | Decimal | Valor percentual do Frete |
| PreVendaItens.Entrega.DataEntrega | Data/Hora | Data da entrega do item |
| PreVendaItens.Entrega | Objeto | Dados de entrega do item |
| PreVendaItens.DescontoPercentual | Decimal | Porcentagem do desconto aplicado ao item |
| PreVendaItens.Desconto | Decimal | Valor do desconto aplicado ao item |
| PreVendaItens.DataEntrega | Data/Hora | Data da entrega do item |
| PreVendaItens.DataCadastro | Data/Hora | Data que o item foi criado no PDV |
| PreVendaItens.DataAtualizacao | Data/Hora | Data de atualização do item |
| PreVendaItens.CodigoProduto | String | Código Produto |
| PreVendaItens.CodigoFilialSaida | String | Código Filial Saída |
| PreVendaItens.AcrescimoPercentual | Decimal | Porcentagem do acréscimo aplicado ao item |
| PreVendaItens.Acrescimo | Decimal | Valor de acréscimo aplicado ao item da pré venda |
| PreVendaItens | Lista de Objetos | Lista de itens da pré venda |
| Offline | Booleano | Flag pedido offline |
| NumeroVenda | String | Código da venda criado pelo PDV Omnishop |
| NumeroPdv | Inteiro | Número PDV |
| NumeroAutorizacao | String | Número da autorização de pagamento |
| 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 |
| NomeConsumidor | String | Nome do consumidor apenas para emissão do cupom, não tem relacionamento com tabela de clientes |
| MultiplosPedidos | Booleano | Indica se existe multiplos pedidos na Prevenda |
| MotivoDesconto.TipoDescontoAcrescimo | Inteiro | Tipo do desconto 0 - Manual 1 - Motor 2 - Fidelidade 3 - PromocaoSMS 4 - CampanhaPromocional 5 - MotorTerceiro 6 - PrecoPromocional 7 - LogisticaReversa |
| MotivoDesconto.Tipo | Inteiro | Tipo de operação de desconto: 0 - AcrescimoDesconto 1 - TrocaDevolucao 2 - AlteracaoFormaPagamento 3 - AusenciaFuncionario 4 - ClassificacaoDia 5 - CancelamentoVenda 6 - Sangria 7 - Suprimento 8 - DevolucaoPedidoOMS |
| MotivoDesconto.Situacao | Inteiro | Situação Cadastral 0 - Inativo 1 - Ativo |
| MotivoDesconto.IdRetaguarda | String | Código do Motivo do Desconto na Retaguada |
| MotivoDesconto.IdPromocaoMotorPromocaoTerceiro | String | Código de identificação do motor de promoção |
| MotivoDesconto.Id | Inteiro | Código Id do Motivo do Desconto (Chave) |
| MotivoDesconto.Descricao | String | Descrição do desconto |
| MotivoDesconto.DescontoMotorPromocaoAplicado | Booleano | Indica se há desconto aplicado relacionado ao motor |
| MotivoDesconto.DataCadastro | Data/Hora | Data de Cadastro do Registro |
| MotivoDesconto.DataAtualizacao | Data/Hora | Data de Atualização do Registro |
| MotivoDesconto | Objeto | Motivo do desconto aplicado na venda |
| ModalidadeFrete | Inteiro | 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 |
| IdRetaguarda | String | Código de identificação do registro na retaguarda |
| IdProfissionalRetaguarda | String | Código de identificação do registro na retaguarda |
| IdOperadorRetaguarda | String | Código de identificação do registro na retaguarda |
| IdLojaRetaguarda | String | Código de identificação do registro na retaguarda |
| IdInquilino | String | Código do inquilino enviado pelo PDV |
| IdCanalVendaRetaguarda | String | Código de identificação do registro na retaguarda |
| Id | Inteiro | Código de identificação do registro. (campo chave), gerado pelo PDV Omnishop. |
| FreteTotal | Decimal | Valor Real do Frete |
| FretePercentualTotal | Decimal | Valor percentual do Frete |
| DescontoTotal | Decimal | Desconto no Total do Pedido, não considera os descontos nos itens |
| DescontoPercentualTotal | Decimal | Porcentagem total de desconto |
| DataCadastro | Data/Hora | Data que a pré venda foi criado no PDV |
| DataAtualizacao | Data/Hora | Data de atualização da pré venda |
| Data | Data/Hora | Data de gravação do pedido |
| CpfConsumidor | String | CPF utilizado apenas para emissão do cupom, não tem relacionamento com tabela de clientes |
| CodigoPromocional | String | Código do cupom promocional informado pelo operador no momento da compra |
| Cliente.Telefone | String | Telefone do cliente |
| Cliente.Situacao | Inteiro | Situação Cadastral 0 - Inativo 1 - Ativo |
| Cliente.Sexo | Inteiro | Gênero do cliente 0 - Não Informado 1 - Masculino 2 - Feminino |
| Cliente.RgInscricao | String | RG do cliente |
| Cliente.PessoaFisica | Inteiro | Indica se o cliente é uma pessoa física 0 - Não 1 - Sim |
| Cliente.Numero | String | Número da residência do cliente |
| Cliente.Nome | String | Nome do cliente |
| Cliente.IdRetaguarda | String | Código de identificação do registro na retaguarda |
| Cliente.IdProfissionalRetaguarda | String | Código de identificação do registro na retaguarda |
| Cliente.Id | Inteiro | Código de identificação do registro. (campo chave) |
| 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 |
| Cliente.Estado | String | Estado do cliente |
| Cliente.Enderecos.TipoId | Inteiro | Tipo do endereço do cliente: 0 - Entrega 1 - Cobrança 2 - Comercial |
| Cliente.Enderecos.Tipo | String | Tipo do endereço do cliente (entrega, casa, cobrança) |
| Cliente.Enderecos.Situacao | Inteiro | Situação Cadastral do Endereço 1 - Ativo 0 - Inativo |
| Cliente.Enderecos.Numero | String | Número da residência do cliente |
| Cliente.Enderecos.IdRetaguarda | String | Código de identificação do registro na retaguarda |
| Cliente.Enderecos.Id | Inteiro | Código de identificação do registro. (campo chave) |
| Cliente.Enderecos.Estado | String | Estado do cliente |
| Cliente.Enderecos.Endereco | String | Endereço do cliente |
| Cliente.Enderecos.DataCadastro | Data/Hora | Data de Criação do Registro do Endereço |
| Cliente.Enderecos.DataAtualizacao | Data/Hora | Data de Atualização do Endereço |
| Cliente.Enderecos.Complemento | String | Complemento do endereço do cliente |
| Cliente.Enderecos.Cidade | String | Cidade do cliente |
| Cliente.Enderecos.Cep | String | Cep da residência do cliente |
| Cliente.Enderecos.Celular | String | Telefone celular do cliente |
| Cliente.Enderecos.Bairro | String | Bairro do cliente |
| Cliente.Enderecos | Lista de Objetos | Lista de Endereços do Cliente (NÃO É O ENDEREÇO PADRÃO DO CLIENTE.) |
| Cliente.Endereco | String | Endereço do cliente |
| Cliente.Email | String | E-mail do cliente |
| Cliente.DataNascimento | Data/Hora | Data de nascimento do cliente |
| Cliente.DataCadastro | Data/Hora | Data de Criação do Cadastro |
| Cliente.DataAtualizacao | Data/Hora | Data de Atualização do Cadastro |
| Cliente.CpfCnpj | String | CPF ou CNPJ do cliente |
| Cliente.Complemento | String | Complemento do endereço do cliente |
| Cliente.ClienteAlterado | Booleano | Sinaliza se houve alteração no dado do cliente |
| Cliente.Cidade | String | Cidade do cliente |
| Cliente.Cep | String | Cep da residência do cliente. |
| Cliente.Celular | String | Telefone celular do cliente. |
| Cliente.Bairro | String | Bairro do cliente. |
| Cliente | Objeto | Cliente relacionado a pré venda para fins de fidelização |
| AcrescimoTotal | Decimal | Acréscimo Total |
| AcrescimoPercentualTotal | Decimal | Acréscimo Percentual Total |
| Data | Objeto | Lista com as pré vendas retornadas |
Exemplo:
{
"success": true,
"message": "",
"data": {
"data": "2024-06-17T21:15:15.380Z",
"idOperadorRetaguarda": "",
"tipoEntrega": 2,
"idRetaguarda": "01000083",
"codigoPromocional": "",
"totalBruto": 97.34,
"idLojaRetaguarda": "01",
"tipoValorFrete": 0,
"acrescimoPercentualTotal": 0,
"idInquilino": "107",
"totalLiquido": 97.34,
"numeroVenda": "01000083",
"dataAtualizacao": "2024-09-16T09:25:21",
"dataCadastro": "2024-09-16T09:25:21",
"descontoTotal": 0,
"situacao": 0,
"motivoDesconto": {
"descontoMotorPromocaoAplicado": false,
"idPromocaoMotorPromocaoTerceiro": "",
"tipo": 0,
"tipoDescontoAcrescimo": 0,
"dataAtualizacao": "2024-09-16T12:25:21Z",
"dataCadastro": "2024-09-16T12:25:21Z",
"id": 0,
"idRetaguarda": "",
"situacao": 0
},
"cpfConsumidor": "",
"numeroPdv": 0,
"tipoDescontoAcrescimo": 0,
"numeroAutorizacao": "",
"situacaoPreVenda": "DISPONIVEL",
"nomeConsumidor": "",
"preVendaItens": [
{
"acrescimo": 0,
"acrescimoPercentual": 0,
"codigoFilialSaida": "01",
"codigoProduto": "130379 ",
"dataEntrega": "2024-09-16T12:25:21Z",
"desconto": 0,
"descontoPercentual": 0,
"entrega": {
"dataEntrega": "2024-09-16T12:25:21Z",
"idLojaEntregaRetaguarda": "01",
"lockerMachineCode": "",
"lockerParcelCode": "",
"tipoEntrega": 0,
"fretePercentualTotal": 0,
"freteTotal": 0,
"tipoValorFrete": 0
},
"idPrecoRetaguarda": "",
"idPreVenda": 0,
"idProdutoRetaguarda": "130379 ",
"idVendedorRetaguarda": "000001",
"itensKit": [
{
"idProdutoRetaguarda": "130379 ",
"preco": 0,
"quantidade": 0,
"sequencial": 0
}
],
"motivoDesconto": {
"descontoMotorPromocaoAplicado": false,
"idPromocaoMotorPromocaoTerceiro": "",
"tipo": 0,
"tipoDescontoAcrescimo": 0,
"dataAtualizacao": "2024-09-16T12:25:21Z",
"dataCadastro": "2024-09-16T12:25:21Z",
"id": 0,
"idRetaguarda": "",
"situacao": 0
},
"preco": 97.34,
"quantidade": 1,
"quantidadeFaturada": 1,
"frete": 0,
"fretePercentual": 0,
"tipoValorFrete": 0,
"quantidadeEncomenda": 1,
"idProdutoEmbalagemRetaguarda": "",
"dataAtualizacao": "2024-09-16T12:25:21Z",
"dataCadastro": "2024-09-16T12:25:21Z",
"id": 1,
"idRetaguarda": "130379 ",
"situacao": 0
}
],
"cliente": {
"bairro": "",
"celular": "",
"cep": "",
"cidade": "SAO PAULO",
"clienteAlterado": true,
"complemento": "",
"cpfCnpj": "",
"dataNascimento": " ",
"email": "",
"rgInscricao": "",
"sexo": null,
"endereco": "R...",
"enderecos": [
{
"bairro": "",
"celular": "",
"cep": "",
"cidade": "SAO PAULO",
"complemento": "",
"endereco": "R...",
"numero": "",
"tipo": "0",
"tipoId": 0,
"dataAtualizacao": "2024-09-16T12:25:21Z",
"dataCadastro": "1899-12-30T12:25:21Z",
"id": 0,
"idRetaguarda": "00000101",
"situacao": 1
}
]
},
"acrescimoTotal": 0,
"tipoPreVenda": 0,
"multiplosPedidos": true,
"id": 0,
"preVendaPagamentos": [
{
"preVendaPagamentoDadosComplementares": [],
"preVendaPagamentoItens": [],
"preVendaPagamentoTefs": [],
"idPagamentoCondicaoRetaguarda": "001",
"idPagamentoFormaRetaguarda": "R$",
"idPagamentoOperadoraRetaguarda": "",
"idPreVenda": "01000083",
"valorLiquido": 97.34,
"valorMinimoAceito": 0,
"valorPago": 97.34,
"valorTroco": 0,
"pagamentoForma": {
"idRetaguarda": "R$"
},
"pagamentoCondicao": {
"idRetaguarda": "001"
},
"quantidadeParcelas": 1,
"dataAtualizacao": "2024-09-16T12:25:21Z",
"dataCadastro": "2024-09-16T12:25:21Z",
"id": 0,
"idRetaguarda": "01000083",
"situacao": 0
}
],
"vendaPagamentos": null,
"fretePercentualTotal": 0,
"sistemaOrigem": 0,
"tipoCancelamento": 0,
"serieVenda": "",
"tipoVenda": 0,
"modalidadeFrete": 0,
"descontoPercentualTotal": 0,
"numero": "000083",
"idCanalVendaRetaguarda": "",
"offline": true,
"freteTotal": 0,
"terminalOrigem": "",
"sincronizado": 0,
"errors": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
},
"totalTime": "09:25:21",
"numberOfRecords": 1
},
"hasNext": false
}
04. DEMAIS INFORMAÇÕES
Não há.
05. ASSUNTOS RELACIONADOS
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas