TOTVS Varejo PDV Omni

Árvore de páginas

Versões comparadas

Versão antiga 16

changes.mady.by.user Camila dos Santos da Silva

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Paulo Roberto Cantoni

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

idVendedorRetaguarda

Informações

Este método é responsável pela consulta detalhada da pré-venda online

  • Endpoints: /
    • api/pdvsyncserver/retaguarda/V2/processoonlineprevenda/{IdInquilino}/{idPedidoRetaguarda}
    • api/pdvsyncserver/retaguarda/V3/processoonlineprevenda/{IdInquilino}/{idPedidoRetaguarda}
  • Método: GET
  • Autenticação: Bearer token
  • Permissão: Client

Os parâmetros para a requisição estão abaixo:

, API utilizada pelo PDVOmni para consultar o pedido de venda.

O fluxo para atualização ocorre seguindo os passos abaixo:
1. PDVOmni -> 2. PDVSync -> 3. Retaguarda -> 4. PDVSync -> 5. PDVOmni.

  • O PDVOmni faz a requisição na API GET ProcessoOnlinePreVenda onde são enviados os parâmetros conforme está descrito em Detalhes da Requisição.
  • Ocorre a requisição na API de consulta no retaguarda. (Definições para criação abaixo).
  • O Retaguarda processa a requisição e devolve a consulta para o PDVSync.
  • O PDVSync recebe o retorno da retaguarda e devolve para o PDVOmni.
  • O PDVOmni recebe o retorno do PDVSync.
  • Endpoints: /api/pdvsyncserver/retaguarda/V2/processoonlineprevenda/{IdInquilino}/{idPedidoRetaguarda}
  • Método: GET
  • Autenticação: Bearer token
  • Permissão: Client


Os parâmetros para a requisição estão abaixo:


Deck of Cards
idParâmetros
Card
labelV3.1(V2)
Column
width50%
Deck of Cards
idParâmetros
Card
labelV3.1(V2)
Column
width50%

Campo

Tipo

Descrição

Obrigatório

Campo

Tipo

Descrição

Obrigatório

IdInquilinostringIdentificador do InquilinoSim
IdPedidoRetaguardastring

Identificador do pedido na retaguarda

Sim

Retornos

Deck of Cards
idcredito_consulta_get

Situação Cadastral do Endereço

1 - Ativo

Card
label200 - OK
Column
width50%


{
    "success": true,
    "message": "string",
    "data": {
        "offline": true,
        "cliente": {
            "bairro": "string",
            "celular": "string",
            "cep": "string",
            "cidade": "string",
            "clienteAlterado": true,
            "complemento": "string",
            "cpfCnpj": "string",
            "dataNascimento": "2024-06-17T21:15:15.380Z",
            "email": "string",
            "endereco": "string",
            "enderecos": [
                {
                    "bairro": "string",
                    "celular": "string",
                    "cep": "string",
                    "cidade": "string",
                    "complemento": "string",
                    "endereco": "string",
                    "estado": "string",
                    "numero": "string",
                    "tipo": "string",
                    "tipoId": 0,
                    "dataAtualizacao": "2024-06-17T21:15:15.380Z",
                    "dataCadastro": "2024-06-17T21:15:15.380Z",
                    "id": 0,
                    "idRetaguarda": "string",
                    "situacao": 0
                }
            ],
            "estado": "string",
            "estadoCivil": 0,
            "nome": "string",
            "numero": "string",
            "pessoaFisica": 0,
            "rgInscricao": "string",
            "sexo": 0,
            "telefone": "string",
            "dataAtualizacao": "2024-06-17T21:15:15.380Z",
            "dataCadastro": "2024-06-17T21:15:15.380Z",
            "id": 0,
            "idRetaguarda": "string",
            "situacao": 0,
            "idProfissionalRetaguarda": "string",

        },
        "codigoPromocionalobservacaoAdicionalValor": "string",
[
                    "cpfConsumidor": "string",
{
                    "data": "2024-06-17T21:15:15.380Z",
        "descontoPercentualTotalid": 0,
                    "descontoTotal": 0,
        "idCanalVendaRetaguardaidRetaguarda": "string",
        "idInquilino": "string",
            "idLojaRetaguarda": "string",
        "idOperadorRetaguardaidOperacao": "string",
        "motivoDesconto": {
            "descontoMotorPromocaoAplicado": true,
            "descricaoidRetaguardaObservacaoAdicionalCampo": "string",
                "idPromocaoMotorPromocaoTerceiro": "string",
            "tipovalor": 0"string",
            "tipoDescontoAcrescimo": 0,
                "dataAtualizacaodataCadastro": "20242025-0611-17T21:1514:1529.380Z393Z",
                            "dataCadastrodataAtualizacao": "20242025-0611-17T21:1514:1529.380Z393Z",
            "id": 0,
                "idRetaguardasituacao": "string",0
            "situacao": 0
       }
          ]
    },
        "nomeConsumidor": "string"},
        "numerocodigoPromocional": "string",
        "numeroAutorizacaocpfConsumidor": "string",
        "numeroVendadata": "string2024-06-17T21:15:15.380Z",
        "preVendaItensdescontoPercentualTotal": [
            {
        0,
        "acrescimodescontoTotal": 0,
                "acrescimoPercentualidCanalVendaRetaguarda": 0"string",
                "codigoFilialSaidaidInquilino": "string",
                "codigoProdutoidLojaRetaguarda": "string",
                "dataEntregaidOperadorRetaguarda": "2024-06-17T21:15:15.380Zstring",
        "motivoDesconto": {
            "descontodescontoMotorPromocaoAplicado": 0true,
                "descontoPercentualdescricao": 0"string",
            "idPromocaoMotorPromocaoTerceiro": "string",
            "entregatipo": {0,
            "tipoDescontoAcrescimo": 0,
            "dataEntregadataAtualizacao": "2024-06-17T21:15:15.380Z",
                    "idLojaEntregaRetaguardadataCadastro": "string2024-06-17T21:15:15.380Z",
                    "lockerMachineCodeid": "string"0,
                    "lockerParcelCodeidRetaguarda": "string",
                    "tipoEntregasituacao": 0,
          },
          "fretePercentualTotalnomeConsumidor": 0"string",
                    "freteTotalnumero": 0"string",
                    "tipoValorFretenumeroAutorizacao": 0"string",
        "numeroVenda": "string",
        "preVendaItens": [
            },{
                "idPrecoRetaguardaacrescimo": "string"0,
                "idPreVendaacrescimoPercentual": 0,
                "idProdutoRetaguardacodigoFilialSaida": "string",
                "idVendedorRetaguardacodigoProduto": "string",
                "dataEntrega"itensKit: ": [2024-06-17T21:15:15.380Z",
                    {
        "desconto": 0,
                "idProdutoRetaguardadescontoPercentual": "string"0,
                        "precoentrega": 0,{
                        "dataEntrega"quantidade": 0,
    : "2024-06-17T21:15:15.380Z",
                    "sequencialidLojaEntregaRetaguarda": 0"string",
                    }
"lockerMachineCode": "string",
                    ]"lockerParcelCode": "string",
                    "motivoDescontotipoEntrega": {0,
                    "descontoMotorPromocaoAplicadofretePercentualTotal": true0,
                    "descricaofreteTotal": "string"0,
                    "idPromocaoMotorPromocaoTerceirotipoValorFrete": "string",
    0
                },
                "tipoidPrecoRetaguarda": 0"string",
                    "tipoDescontoAcrescimoidPreVenda": 0,
                    "dataAtualizacaoidProdutoRetaguarda": "2024-06-17T21:15:15.380Zstring",
                    "dataCadastroidVendedorRetaguarda": "2024-06-17T21:15:15.380Zstring",
                    "ididRetaguardaProdutoLote": 0"string",
                    "idRetaguardaidentificacaoProdutoLote": "string",
                    "situacaoitensKit": 0[
                },
    {
                        "idProdutoRetaguarda": "string",
                        "preco": 0,
                        "quantidade": 0,
                        "quantidadeFaturadasequencial": 0
                    }
                ],
                "motivoDesconto": {
                    "fretedescontoMotorPromocaoAplicado": 0true,
                    "fretePercentualdescricao": 0"string",
                    "tipoValorFreteidPromocaoMotorPromocaoTerceiro": 0"string",
                    "quantidadeEncomendatipo": 0,
                    "idProdutoEmbalagemRetaguardatipoDescontoAcrescimo": "string"0,
                    "dataAtualizacao": "2024-06-17T21:15:15.380Z",
                    "dataCadastro": "2024-06-17T21:15:15.380Z",
                    "id": 0,
                    "idRetaguarda": "string",
                    "situacao": 0
                },
        ],
        "preVendaPagamentosprodutoEmbalagem": [{
                  {  "descricao": "CB REGRESSIVO 25 - CB 2025",
                    "idPagamentoCondicaoRetaguardacodigoBarras": "string4569",
                    "idPagamentoFormaRetaguardaquantidadeValorAtacado": "string"2.1,
                    "idPagamentoOperadoraRetaguardaunidadeMedida": "stringUN",
                    "idPreVendaquantidade": 01,
                    "preVendaPagamentoDadosComplementaressituacao": [1
                },
        {
        "preco": 0,
                "descricaoquantidade": "string"0,
                "quantidadeFaturada": 0,
                "idPagamentoDadoComplementarRetaguardafrete": "string"0,
                        "idPreVendaPagamentofretePercentual": 0,
                        "tipoValorFrete": 0,
                "quantidadeEncomenda": 0,
                "idProdutoEmbalagemRetaguarda": "string",
                "dataAtualizacao": "2024-06-17T21:15:15.380Z",
                        "dataCadastro": "2024-06-17T21:15:15.380Z",
                        "id": 0,
                        "idRetaguarda": "string",
                        "situacao": 0
                    }
                ],
                "preVendaPagamentoItenspreVendaPagamentos": [
                    {
                        "dataVencimentoidPagamentoCondicaoRetaguarda": "2024-06-17T21:15:15.380Zstring",
                        "idPreVendaPagamentoidPagamentoFormaRetaguarda": 0"string",
                        "numeroParcela": 0"idPagamentoOperadoraRetaguarda": "string",
                "idPreVenda": 0,
                "preVendaPagamentoDadosComplementares": [
                    {
                        "descricao": "string",
                        "idPagamentoDadoComplementarRetaguarda": "string",
                        "valorParcelaidPreVendaPagamento": 0,
                        "dataAtualizacao": "2024-06-17T21:15:15.380Z",
                        "dataCadastro": "2024-06-17T21:15:15.380Z",
                        "id": 0,
                        "idRetaguarda": "string",
                        "situacao": 0
                    }
                ],
                "preVendaPagamentoTefspreVendaPagamentoItens": [
                    {
                        "bandeiradataVencimento": "string2024-06-17T21:15:15.380Z",
                        "codigoRedeidPreVendaPagamento": "string"0,
                        "dataPreDatadonumeroParcela": 0,
                        "valorParcela": 0,
                        "dataAtualizacao": "2024-06-17T21:15:15.380Z",
                        "diasEntreParcelas": 0dataCadastro": "2024-06-17T21:15:15.380Z",
                        "idPreVendaPagamentoid": 0,
                        "idTransacaoDigitalidRetaguarda": "string",
                        "nsuHostsituacao": "string",0
                    }
        "numeroAutorizacao": "string",
        ],
                "numeroBinpreVendaPagamentoTefs": "string",[
                        "numeroParcelas": 0,{
                        "primeiraParcelabandeira": "2024-06-17T21:15:15.380Zstring",
                        "dataAtualizacaocodigoRede": "2024-06-17T21:15:15.380Zstring",
                        "dataCadastrodataPreDatado": "2024-06-17T21:15:15.380Z",
                        "iddiasEntreParcelas": 0,
                        "idRetaguardaidPreVendaPagamento": "string"0,
                        "situacaoidTransacaoDigital": 0"string",
                    }
      "nsuHost": "string",
          ],
                "valorLiquidonumeroAutorizacao": 0"string",
                        "valorMinimoAceitonumeroBin": 0"string",
                "valorPago": 0,
                "valorTroconumeroParcelas": 0,
                "pagamentoForma": {
                    "idRetaguardaprimeiraParcela": "string"
      2024-06-17T21:15:15.380Z",
          },
                "pagamentoCondicao": {
                    "idRetaguarda": "string"
                },
                "quantidadeParcelas": 0,
                "dataAtualizacao": dataAtualizacao": "2024-06-17T21:15:15.380Z",
                        "dataCadastro": "2024-06-17T21:15:15.380Z",
                        "id": 0,
                        "idRetaguarda": "string",
                        "situacao": 0
                    }
                ],
                "vendaPagamentosvalorLiquido": [0,
                {"valorMinimoAceito": 0,
                "vendaIdvalorPago": 0,
                "pagamentoFormaIdvalorTroco": 0,
                "pagamentoForma": {
                    "idRetaguarda": "string",
                },
      "descricao          "pagamentoCondicao": {
                    "idRetaguarda": "string"
                },
                "pagamentoCondicaoIdquantidadeParcelas": 0,
                "pagamentoCondicao": {
    dataAtualizacao": "2024-06-17T21:15:15.380Z",
                "idRetaguardadataCadastro": "string2024-06-17T21:15:15.380Z",
                "id": 0,
                "descricaoidRetaguarda": "string",
                    "diasEntreParcelassituacao": 0
                },
        ],
        "pagamentoOperadoraIdvendaPagamentos": 0,[
                "pagamentoOperadora": {
                    "idRetaguardavendaId": "string"0,
                    "descricaopagamentoFormaId": "string"0,
                    "codigoTefpagamentoForma": "string"{
                    }"idRetaguarda": "string",
                    "valorPagodescricao": 0"string"
                },
                "valorTrocopagamentoCondicaoId": 0,
                "valorLiquidopagamentoCondicao": 0,{
                    "idRetaguardaCreditoidRetaguarda": 0"string",
                    "cpfCnpjClientedescricao": "string",
                    "quantidadeParcelasdiasEntreParcelas": 0,
                "idDivida": "string"},
                "vendaPagamentoDadoComplementarspagamentoOperadoraId": [0,
                    "pagamentoOperadora": {
                        "conteudoidRetaguarda": "string",
                        "descricao": "string",
                        "idPagamentoDadoComplementarcodigoTef": 0,
"string"
                },
                "idPagamentoDadoComplementarRetaguardavalorPago": "string"0,
                        "idVendaPagamentovalorTroco": 0,
                        "pagamentoDadoComplementar": {
"valorLiquido": 0,
                "idRetaguardaCredito": 0,
                "descricaocpfCnpjCliente": "string",
                            "tipoquantidadeParcelas": 0,
                            "obrigatorioidDivida": 0"string",
                            "tamanhovendaPagamentoDadoComplementars": 0,[
                            "tipoCampoTef": 0,
    {
                        "dataAtualizacaoconteudo": "2024-06-17T21:15:15.380Zstring",
                            "dataCadastrodescricao": "2024-06-17T21:15:15.380Zstring",
                            "ididPagamentoDadoComplementar": 0,
                            "idRetaguardaidPagamentoDadoComplementarRetaguarda": "string",
                            "situacaoidVendaPagamento": 0,
                        },
"pagamentoDadoComplementar": {
                            "dataAtualizacaodescricao": "2024-06-17T21:15:15.380Zstring",
                            "dataCadastrotipo": "2024-06-17T21:15:15.380Z"0,
                            "idobrigatorio": 0,
                            "idRetaguardatamanho": "string"0,
                            "situacaotipoCampoTef": 0,
                    }
            "dataAtualizacao": "2024-06-17T21:15:15.380Z",
            ],
                "dataCadastro"vendaPagamentoItems: ": [
                    {
2024-06-17T21:15:15.380Z",
                            "vendaPagamentoIdid": 0,
                            "numeroParcelaidRetaguarda": 0"string",
                            "valorParcelasituacao": 0,
                        "dataVencimento": "2024-06-17T21:15:15.380Z"},
                        "dataAtualizacao": "2024-06-17T21:15:15.380Z",
                        "dataCadastro": "2024-06-17T21:15:15.380Z",
                        "id": 0,
                        "idRetaguarda": "string",
                        "situacao": 0
                    }
                ],
                "vendaPagamentoTefsvendaPagamentoItems": [
                    {
                        "bandeiravendaPagamentoId": "string"0,
                        "numeroParcela": 0,
                        "codigoRedevalorParcela": "string"0,
                        "dataPreDatadodataVencimento": "2024-06-17T21:15:15.380Z",
                        "dataAtualizacao"diasEntreParcelas: ": 02024-06-17T21:15:15.380Z",
                        "idVendaPagamento": 0dataCadastro": "2024-06-17T21:15:15.380Z",
                        "idTransacaoDigitalid": "string"0,
                        "nsuHostidRetaguarda": "string",
                        "numeroAutorizacaosituacao": "string",
0
                    }
        "numeroBin": "string",
        ],
                  "numeroParcelasvendaPagamentoTefs": 0,[
                        "primeiraParcela": "2024-06-17T21:15:15.380Z",{
                        "idPagamentoMfebandeira": 0"string",
                        "sincronizadoPagamentoMfecodigoRede": true"string",
                        "dataAtualizacaodataPreDatado": "2024-06-17T21:15:15.380Z",
                        "dataCadastrodiasEntreParcelas": "2024-06-17T21:15:15.380Z"0,
                        "ididVendaPagamento": 0,
                        "idRetaguardaidTransacaoDigital": "string",
                        "situacaonsuHost": 0"string",
                    }
        "numeroAutorizacao": "string",
        ],
                "vendaPagamentoTrocasnumeroBin": ["string",
                    {    "numeroParcelas": 0,
                        "vendaPagamentoIdprimeiraParcela": 0"2024-06-17T21:15:15.380Z",
                        "idVendaRetaguardaidPagamentoMfe": "string"0,
                        "cpfCnpjsincronizadoPagamentoMfe": "string"true,
                        "nomedataAtualizacao": "string2024-06-17T21:15:15.380Z",
                        "dataCadastro"motivoId": 0: "2024-06-17T21:15:15.380Z",
                        "motivoid": {0,
                            "idRetaguarda": "string",
                            "descricaosituacao": "string"0
                    }
      },
          ],
                "dataTrocavendaPagamentoTrocas": "2024-06-17T21:15:15.380Z",[
                        "valorTotal": 0,{
                        "trocaItemsvendaPagamentoId": [0,
                            {
        "idVendaRetaguarda": "string",
                        "idItemRetaguardacpfCnpj": "string",
                                "trocaIdnome": 0"string",
                                "produtoIdmotivoId": 0,
                                "produtomotivo": {
                                    "ididRetaguarda": 0"string",
                                    "idRetaguardadescricao": "string",
                        },
                        "codigoProdutodataTroca": "string2024-06-17T21:15:15.380Z",
                        "valorTotal": 0,
                        "descricaotrocaItems": "string"[
                                },{
                                "valoridItemRetaguarda": 0"string",
                                "quantidadetrocaId": 0,
                                "dataAtualizacaoprodutoId": "2024-06-17T21:15:15.380Z"0,
                                "dataCadastroproduto": "2024-06-17T21:15:15.380Z",{
                                    "id": 0,
                                    "idRetaguarda": "string",
                                    "situacaocodigoProduto": 0
"string",
                                    }
"descricao": "string"
                            ]    },
                                "dataAtualizacaovalor": "2024-06-17T21:15:15.380Z",
0,
                                "quantidade": 0,
                                "dataCadastrodataAtualizacao": "2024-06-17T21:15:15.380Z",
                                "dataCadastro": "2024-06-17T21:15:15.380Z",
                                "id": 0,
                                "idRetaguarda": "string",
                                "situacao": 0
                            }
                        ],
                        "dataAtualizacao": "2024-06-17T21:15:15.381Z380Z",
                        "dataCadastro": "2024-06-17T21:15:15.381Z380Z",
                        "id": 0,
                        "idRetaguarda": "string",
                        "situacao": 0
                    }
                ],
                "serieVendadataAtualizacao": "string2024-06-17T21:15:15.381Z",
        "sincronizado": 0,
        "sistemaOrigem": 0dataCadastro": "2024-06-17T21:15:15.381Z",
                "id": 0,
                "idRetaguarda": "string",
                "situacao": 0
            }
        ],
        "serieVenda": "string",
        "sincronizado": 0,
        "sistemaOrigem": 0,
        "situacaoPreVenda": "string",
        "terminalOrigem": "string",
        "tipoCancelamento": 0,
        "tipoDescontoAcrescimo": 0,
        "tipoEntrega": 0,
        "tipoPreVenda": 0,
        "tipoVenda": 0,
        "totalBruto": 0,
        "totalLiquido": 0,
        "fretePercentualTotal": 0,
        "freteTotal": 0,
        "tipoValorFrete": 0,
        "multiplosPedidos": true,
        "modalidadeFrete": 0,
        "acrescimoPercentualTotal": 0,
        "acrescimoTotal": 0,
        "numeroPDV": 0,
        "dataAtualizacao": "2024-06-17T21:15:15.381Z",
        "dataCadastro": "2024-06-17T21:15:15.381Z",
        "id": 0,
        "idRetaguarda": "string",
        "situacao": 0,
        "idProfissionalRetaguarda": "string",

    },
    "recebimentoAntecipado": false
    },
    "errors": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
    },
    "totalTime": 0,
    "numberOfRecords": 0
}": "string"
    },
    "totalTime": 0,
    "numberOfRecords": 0
}



Data.Cliente.Enderecos
Column
width50%

Campo

Tipo

Descrição

Observações

SuccessBooleanoIndica se a requisição foi feita com sucesso
MessageStringMensagem de retorno de erros
DataObjetoLista com as pré vendas retornadas
Data.OfflineBooleanoFlag pedido offline
Data.ClienteObjetoCliente relacionado a pré venda para fins de fidelização
Data.Cliente.BairroStringBairro do cliente. 
Data.Cliente.CelularStringTelefone celular do cliente. 
Data.Cliente.CepStringCep da residência do cliente. 
Data.Cliente.CidadeStringCidade do cliente
Data.Cliente.ClienteAlteradoBooleanoSinaliza se houve alteração no dado do cliente
Data.Cliente.ComplementoStringComplemento do endereço do cliente
Data.Cliente.CpfCnpjStringCPF ou CNPJ do clienteMax 14 posiçoes
Data.Cliente.DataNascimentoData/HoraData de nascimento do cliente
Data.Cliente.EmailStringE-mail do cliente
Data.Cliente.EnderecoStringEndereço do cliente
Data.Cliente.EnderecosLista de ObjetosLista de Endereços do Cliente (NÃO É O ENDEREÇO PADRÃO DO CLIENTE.)
Data.Cliente.Enderecos.BairroStringBairro do cliente
Data.Cliente.Enderecos.CelularStringTelefone celular do cliente
Data.Cliente.Enderecos.CepStringCep da residência do cliente
Data.Cliente.Enderecos.CidadeStringCidade do cliente
Data.Cliente.Enderecos.ComplementoStringComplemento do endereço do cliente
Data.Cliente.Enderecos.EnderecoStringEndereço do cliente
Data.Cliente.Enderecos.EstadoStringEstado do cliente
Data.Cliente.Enderecos.NumeroStringNúmero da residência do cliente
Data.Cliente.Enderecos.TipoStringTipo do endereço do cliente (entrega, casa, cobrança)
Data.Cliente.Enderecos.TipoIdInteiro

Tipo do endereço do cliente:

    • 0 - Entrega
    • 1 - Cobrança
    • 2 - Comercial


Data.Cliente.Enderecos.DataAtualizacaoData/HoraData de Atualização do Endereço
Data.Cliente.Enderecos.DataCadastroData/HoraData de Criação do Registro do Endereço
Data.Cliente.Enderecos.IdInteiroCódigo de identificação do registro. (campo chave)
Data.Cliente.Enderecos.IdRetaguardaString Código de identificação do registro na retaguarda
Data.Cliente.Enderecos.SituacaoInteiro

Situação Cadastral do Endereço

1 - Ativo

0 - Inativo


Data.Cliente.EstadoStringEstado do cliente
Data.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


Data.Cliente.NomeStringNome do cliente
Data.Cliente.NumeroStringNúmero da residência do cliente
Data.Cliente.PessoaFisicaInteiro

Indica se o cliente é uma pessoa física

    • 0 - Não
    • 1 - Sim


Data.Cliente.RgInscricaoStringRG do cliente
Data.Cliente.SexoInteiro

Gênero do cliente

    • 0 - Não Informado
    • 1 - Masculino
    • 2 - Feminino


Data.Cliente.TelefoneStringTelefone do cliente
Data.Cliente.DataAtualizacaoData/HoraData de Atualização do Cadastro
Data.Cliente.DataCadastroData/HoraData de Criação do Cadastro
Data.Cliente.IdInteiroCódigo de identificação do registro. (campo chave)
Dat/a.Cliente.IdRetaguardaStringCódigo de identificação do registro na retaguarda
Data.Cliente.SituacaoInteiro

Situação Cadastral

  • 0 - Inativo
  • 1 - Ativo


Data.Cliente.IdProfissionalRetaguardaString

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


Data.Cliente.ObservacaoAdicionalValorLista de Objetos

Observação Adicional Valor


Data.Cliente.ObservacaoAdicionalValor
Column
width50%

Campo

Tipo

Descrição

Observações

SuccessBooleanoIndica se a requisição foi feita com sucessoMessageStringMensagem de retorno de errosDataObjetoLista com as pré vendas retornadasData.OfflineBooleanoFlag pedido offlineData.ClienteObjetoCliente relacionado a pré venda para fins de fidelizaçãoData.Cliente.BairroStringBairro do cliente. Data.Cliente.CelularStringTelefone celular do cliente. Data.Cliente.CepStringCep da residência do cliente. Data.Cliente.CidadeStringCidade do clienteData.Cliente.ClienteAlteradoBooleanoSinaliza se houve alteração no dado do clienteData.Cliente.ComplementoStringComplemento do endereço do clienteData.Cliente.CpfCnpjStringCPF ou CNPJ do clienteData.Cliente.DataNascimentoData/HoraData de nascimento do clienteData.Cliente.EmailStringE-mail do clienteData.Cliente.EnderecoStringEndereço do clienteData.Cliente.EnderecosLista de ObjetosLista de Endereços do Cliente (NÃO É O ENDEREÇO PADRÃO DO CLIENTE.)Data.Cliente.Enderecos.BairroStringBairro do clienteData.Cliente.Enderecos.CelularStringTelefone celular do clienteData.Cliente.Enderecos.CepStringCep da residência do clienteData.Cliente.Enderecos.CidadeStringCidade do clienteData.Cliente.Enderecos.ComplementoStringComplemento do endereço do clienteData.Cliente.Enderecos.EnderecoStringEndereço do clienteData.Cliente.Enderecos.EstadoStringEstado do clienteData.Cliente.Enderecos.NumeroStringNúmero da residência do clienteData.Cliente.Enderecos.TipoStringTipo do endereço do cliente (entrega, casa, cobrança)Data.Cliente.Enderecos.TipoIdInteiro

Tipo do endereço do cliente:

    • 0 - Entrega
    • 1 - Cobrança
    • 2 - Comercial
Data.Cliente.Enderecos.DataAtualizacaoData/HoraData de Atualização do EndereçoData.Cliente.Enderecos.DataCadastroData/HoraData de Criação do Registro do Endereço
.IdInteiro

Código de identificação do registro

. (campo chave)


Data.Cliente.
Enderecos
ObservacaoAdicionalValor.IdRetaguardaString
 

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


Data.Cliente.
Enderecos
ObservacaoAdicionalValor.
Situacao
IdOperacao
Inteiro
String

Código da Operação

0 - Inativo


Data.Cliente.
Estado
ObservacaoAdicionalValor.IdRetaguardaObservacaoAdicionalCampoString
Estado do cliente

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


Data.Cliente.ObservacaoAdicionalValor.
EstadoCivil
Valor
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

String

Valor Adicional


Data.Cliente.ObservacaoAdicionalValor.DataCadastroDatetime

Data que o item foi criado no PDV


Data.Cliente.ObservacaoAdicionalValor.DataAtualizacaoDatetime

Data de atualização do item


Data.Cliente.ObservacaoAdicionalValor.SituacaoInteiro

Situação:

  • 0 - Inativo
  • 1 - Ativo

Data.CodigoPromocionalStringCódigo do cupom promocional informado pelo operador no momento da compra
Data.CpfConsumidorStringCPF utilizado apenas para emissão do cupom, não tem relacionamento com tabela de clientes
Data.DataData/HoraData de gravação do pedido
Data.DescontoPercentualTotalDecimalPorcentagem total de desconto
Data.DescontoTotalDecimalDesconto no Total do Pedido, não considera os descontos nos itens
Data.IdCanalVendaRetaguardaStringCódigo de identificação do registro na retaguarda
Data.IdInquilinoStringCódigo do inquilino enviado pelo PDV
Data.IdLojaRetaguardaStringCódigo de identificação do registro na retaguarda
Data.IdOperadorRetaguarda
Data.Cliente.NomeStringNome do clienteData.Cliente.NumeroStringNúmero da residência do clienteData.Cliente.PessoaFisicaInteiro

Indica se o cliente é uma pessoa física

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

Gênero do cliente

    • 0 - Não Informado
    • 1 - Masculino
    • 2 - Feminino
Data.Cliente.TelefoneStringTelefone do clienteData.Cliente.DataAtualizacaoData/HoraData de Atualização do CadastroData.Cliente.DataCadastroData/HoraData de Criação do CadastroData.Cliente.IdInteiroCódigo de identificação do registro. (campo chave)Data.Cliente.IdRetaguarda
StringCódigo de identificação do registro na retaguarda
Data.
Cliente.Situacao
MotivoDesconto
Inteiro
ObjetoMotivo do desconto aplicado na venda

Situação Cadastral

  • 0 - Inativo
1 - Ativo

Data.
Cliente
MotivoDesconto.
IdProfissionalRetaguarda
DescontoMotorPromocaoAplicado
String
BooleanoIndica se há desconto aplicado relacionado ao motor
Código de identificação do registro na retaguarda

Data.
CodigoPromocional
MotivoDesconto.DescricaoString
Código do cupom promocional informado pelo operador no momento da compra
Descrição do desconto
Data.MotivoDesconto.
CpfConsumidor
IdPromocaoMotorPromocaoTerceiroString
CPF utilizado apenas para emissão do cupom, não tem relacionamento com tabela de clientesData.DataData/HoraData de gravação do pedidoData.DescontoPercentualTotalDecimalPorcentagem total de descontoData.DescontoTotalDecimalDesconto no Total do Pedido, não considera os descontos nos itensData.IdCanalVendaRetaguardaStringCódigo de identificação do registro na retaguardaData.IdInquilinoStringCódigo do inquilino enviado pelo PDVData.IdLojaRetaguardaStringCódigo de identificação do registro na retaguardaData.IdOperadorRetaguardaStringCódigo de identificação do registro na retaguardaData.MotivoDescontoObjetoMotivo do desconto aplicado na vendaData.MotivoDesconto.DescontoMotorPromocaoAplicadoBooleanoIndica se há desconto aplicado relacionado ao motorData.MotivoDesconto.DescricaoStringDescrição do descontoData.MotivoDesconto.IdPromocaoMotorPromocaoTerceiroStringCódigo de identificação do motor de promoçãoData.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
Data.MotivoDesconto.TipoDescontoAcrescimoInteiro

Tipo do desconto

    • 0 - Manual
    • 1 - Motor
    • 2 - Fidelidade
    • 3 - PromocaoSMS
    • 4 - CampanhaPromocional
    • 5 - MotorTerceiro
    • 6 - PrecoPromocional
    • 7 - LogisticaReversa
Data.MotivoDesconto.DataAtualizacaoData/HoraData de Atualização do RegistroData.MotivoDesconto.DataCadastroData/HoraData de Cadastro do RegistroData.MotivoDesconto.IdInteiroCódigo Id do Motivo do Desconto (Chave)Data.MotivoDesconto.IdRetaguardaStringCódigo do Motivo do Desconto na RetaguadaData.MotivoDesconto.SituacaoInteiro

Situação Cadastral

  • 0 - Inativo
  • 1 - Ativo
Data.NomeConsumidorStringNome do consumidor apenas para emissão do cupom, não tem relacionamento com tabela de clientesData.NumeroStringCampo 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
Código de identificação do motor de promoção
Data.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


Data.MotivoDesconto.TipoDescontoAcrescimoInteiro

Tipo do desconto

    • 0 - Manual
    • 1 - Motor
    • 2 - Fidelidade
    • 3 - PromocaoSMS
    • 4 - CampanhaPromocional
    • 5 - MotorTerceiro
    • 6 - PrecoPromocional
    • 7 - LogisticaReversa


Data.MotivoDesconto.DataAtualizacaoData/HoraData de Atualização do Registro
Data.MotivoDesconto.DataCadastroData/HoraData de Cadastro do Registro
Data.MotivoDesconto.IdInteiroCódigo Id do Motivo do Desconto (Chave)
Data.MotivoDesconto.IdRetaguardaStringCódigo do Motivo do Desconto na Retaguada
Data.MotivoDesconto.SituacaoInteiro

Situação Cadastral

  • 0 - Inativo
  • 1 - Ativo


Data.NomeConsumidorStringNome do consumidor apenas para emissão do cupom, não tem relacionamento com tabela de clientes
Data.NumeroStringCampo texto que pode ser informado pelo atendente no momento que realiza o Pedido ou de forma automático no PDV, é utilizado para pesquisar o Pedido no caixa
Data.NumeroAutorizacaoStringNúmero da autorização de pagamento
Data.NumeroVendaStringCódigo da venda criado pelo PDV Omnishop
Data.PreVendaItensLista de ObjetosLista de itens da pré venda
Data.PreVendaItens.AcrescimoDecimalValor de acréscimo aplicado ao item da pré venda
Data.PreVendaItens.AcrescimoPercentualDecimalPorcentagem do acréscimo aplicado ao item
Data.PreVendaItens.CodigoFilialSaidaStringCódigo Filial Saída
Data.PreVendaItens.CodigoProdutoStringCódigo Produto
Data.PreVendaItens.DataEntregaData/HoraData da entrega do item
Data.PreVendaItens.DescontoDecimalValor do desconto aplicado ao item
Data.PreVendaItens.DescontoPercentualDecimalPorcentagem do desconto aplicado ao item
Data.PreVendaItens.EntregaObjetoDados de entrega do item
Data.PreVendaItens.Entrega.DataEntregaData/HoraData da entrega do item
Data.PreVendaItens.Entrega.IdLojaEntregaRetaguardaStringCódigo de identificação na retaguarda da loja que irá entregar/disponibilizar o produto
Data.PreVendaItens.Entrega.LockerMachineCodeStringIdentificação do locker no caso de retirada do produto em locker
Data.PreVendaItens.Entrega.LockerParcelCodeStringIdentificação do locker no caso de retirada do produto em locker
Data.PreVendaItens.Entrega.TipoEntregaInteiro

Tipo de entrega do item:

  • 0 - Retira
  • 1 - Retira posterior
  • 2 - Entrega Final


Data.PreVendaItens.Entrega.FretePercentualTotalDecimalValor percentual do Frete
Data.PreVendaItens.Entrega.FreteTotalDecimalValor Real do Frete
Data.PreVendaItens.Entrega.TipoValorFreteInteiro

Tipo do valor do frete:

    • 0 - Percentual
    • 1 - Real


Data.PreVendaItens.IdPrecoRetaguardaStringCódigo de identificação do preco na retaguarda
Data.PreVendaItens.IdPreVendaInteiroCódigo da pré venda relacionada ao item da pré venda
Data.PreVendaItens.IdProdutoRetaguardaStringCódigo de identificação do produto na retaguarda
Data.PreVendaItens.IdVendedorRetaguardaStringCódigo de identificação do vendedor na retaguarda
Data.PreVendaItens.idRetaguardaProdutoLoteStringCódigo de identificação do Lote do Produto na retaguarda
Data.PreVendaItens.identificacaoProdutoLoteStringCódigo de identificação do Lote do Produto
Data.PreVendaItens.ProdutoEmbalagemObjetoObjeto Produto Embalagem
Data.PreVendaItens.ProdutoEmbalagem.DescricaoStringDescrição da embalagem do produto
Data.PreVendaItens.ProdutoEmbalagem.CodigoBarrasStringCodigo de barras da embalagem do Produto
Data.PreVendaItens.ProdutoEmbalagem.QuantidadeValorAtacadoDecimalIdentifica a quantidade de valor no atacado
Data.PreVendaItens.ProdutoEmbalagem.UnidadeMedidaStringIndica a unidade de medida relacionada à embalagem
Data.PreVendaItens.ProdutoEmbalagem.QuantidadeInteiroIndica a quantidade de itens na embalagem
Data.PreVendaItens.ProdutoEmbalagem.SituacaoInteiro

Situação Cadastral

  • 0 - Inativo
  • 1 - Ativo
Data.NumeroAutorizacaoStringNúmero da autorização de pagamentoData.NumeroVendaStringCódigo da venda criado pelo PDV OmnishopData.PreVendaItensLista de ObjetosLista de itens da pré vendaData.PreVendaItens.AcrescimoDecimalValor de acréscimo aplicado ao item da pré vendaData.PreVendaItens.AcrescimoPercentualDecimalPorcentagem do acréscimo aplicado ao itemData.PreVendaItens.CodigoFilialSaidaStringCódigo Filial SaídaData.PreVendaItens.CodigoProdutoStringCódigo ProdutoData.PreVendaItens.DataEntregaData/HoraData da entrega do itemData.PreVendaItens.DescontoDecimalValor do desconto aplicado ao itemData.PreVendaItens.DescontoPercentualDecimalPorcentagem do desconto aplicado ao itemData.PreVendaItens.EntregaObjetoDados de entrega do itemData.PreVendaItens.Entrega.DataEntregaData/HoraData da entrega do itemData.PreVendaItens.Entrega.IdLojaEntregaRetaguardaStringCódigo de identificação na retaguarda da loja que irá entregar/disponibilizar o produtoData.PreVendaItens.Entrega.LockerMachineCodeStringIdentificação do locker no caso de retirada do produto em lockerData.PreVendaItens.Entrega.LockerParcelCodeStringIdentificação do locker no caso de retirada do produto em lockerData.PreVendaItens.Entrega.TipoEntregaInteiro

Tipo de entrega do item:

  • 0 - Retira
  • 1 - Retira posterior
  • 2 - Entrega Final
Data.PreVendaItens.Entrega.FretePercentualTotalDecimalValor percentual do FreteData.PreVendaItens.Entrega.FreteTotalDecimalValor Real do FreteData.PreVendaItens.Entrega.TipoValorFreteInteiro

Tipo do valor do frete:

    • 0 - Percentual
    • 1 - Real
Data.PreVendaItens.IdPrecoRetaguardaStringCódigo de identificação do preco na retaguardaData.PreVendaItens.IdPreVendaInteiroCódigo da pré venda relacionada ao item da pré vendaData.PreVendaItens.IdProdutoRetaguardaStringCódigo de identificação do produto na retaguardaData.PreVendaItens.IdVendedorRetaguardaStringCódigo de identificação do vendedor na retaguarda

Data.PreVendaItens.ItensKitLista de ObjetosLista de Itens Contidos no Kit
Data.PreVendaItens.ItensKit.IdProdutoRetaguardaStringReferencia do Id do Kit no retaguarda
Data.PreVendaItens.ItensKit.PrecoDecimalPreço do Produto dentro do Kit
Data.PreVendaItens.ItensKit.QuantidadeDecimalQuantidade de Produtos dentro do Kit
Data.PreVendaItens.ItensKit.SequencialInteiroNumero q indica a posição do item dentro da lista
Data.PreVendaItens.MotivoDescontoObjetoDesconto relacionado ao item
Data.PreVendaItens.MotivoDesconto.DescontoMotorPromocaoAplicadoBooleanoIndica se há desconto aplicado relacionado ao motor
Data.PreVendaItens.MotivoDesconto.DescricaoStringDescrição do desconto
Data.PreVendaItens.MotivoDesconto.IdPromocaoMotorPromocaoTerceiroStringCódigo de identificação do motor de promoção
Data.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


Data.PreVendaItens.MotivoDesconto.TipoDescontoAcrescimoInteiro

Tipo do desconto:

    • 0 - Manual
    • 1 - Motor
    • 2 - Fidelidade
    • 3 - PromocaoSMS
    • 4 - CampanhaPromocional
    • 5 - MotorTerceiro
    • 6 - PrecoPromocional
    • 7 - LogisticaReversa


Data.PreVendaItens.MotivoDesconto.DataAtualizacaoData/HoraData de Atualização do Registro
Data.PreVendaItens.MotivoDesconto.DataCadastroData/HoraData de Criação do Registro
Data.PreVendaItens.MotivoDesconto.IdInteiroCódigo de identificação do registro. (campo chave)
Data.PreVendaItens.MotivoDesconto.IdRetaguardaStringCódigo de identificação do registro na retaguarda
Data.PreVendaItens.MotivoDesconto.SituacaoInteiro

Situação Cadastral:

  • 0 - Inativo
  • 1 - Ativo


Data.PreVendaItens.PrecoDecimalValor do item
Data.PreVendaItens.QuantidadeDecimalQuantidade do item
Data.PreVendaItens.QuantidadeFaturadaDecimalQuantidade de itens faturadas
Data.PreVendaItens.FreteDecimalValor Real do Frete do Item
Data.PreVendaItens.FretePercentualDecimalValor Percentual do Frete do Item
Data.PreVendaItens.TipoValorFreteInteiro

Tipo do valor do frete do item:

    • 0 - Percentual
    • 1 - Real


Data.PreVendaItens.QuantidadeEncomendaDecimalQuantidade Encomenda
Data.PreVendaItens.IdProdutoEmbalagemRetaguardaStringId Retaguarda do Produto Embalagem
Data.PreVendaItens.DataAtualizacaoData/HoraData de atualização do item
Data.PreVendaItens.DataCadastroData/HoraData que o item foi criado no PDV
Data.PreVendaItens.IdInteiroCódigo de identificação do registro. (campo chave)
Data.PreVendaItens.IdRetaguardaStringCódigo Retaguarda do Item da Pré Venda
Data.PreVendaItens.SituacaoInteiro

Situação Cadastral:

  • 0 - Inativo
  • 1 - Ativo


Data.PreVendaPagamentosLista de ObjetosLista de pagamentos da pré venda
Data.PreVendaPagamentos.IdPagamentoCondicaoRetaguardaStringCódigo de indentificação da Condição do pagamento na retaguarda
Data.PreVendaPagamentos.IdPagamentoFormaRetaguardaStringCódigo de identificação da Forma de pagamento na retaguarda
Data.PreVendaPagamentos.IdPagamentoOperadoraRetaguardaStringCódigo de identificação da Operadora responsável pelo pagamento na retaguarda
Data.PreVendaPagamentos.IdPreVendaInteiroCódigo de identificação da pré venda relacionada ao item
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementaresLista de ObjetosLista de dados complementares ao pagamento
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementares.DescricaoStringDescrição do dado complementar
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdPagamentoDadoComplementarRetaguardaStringCódigo de identificação do Dado complementar na retaguarda
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdPreVendaPagamentoInteiroCódigo de identificação da pre venda pagamento relacionada ao dado complementar
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementares.DataAtualizacaoData/HoraData da última atualização do dado complementar
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementares.DataCadastroData/HoraData de cadastro do dado complementar
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdInteiroCódigo de identificação do registro. (campo chave)
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementares.IdRetaguardaStringCódigo de identificação do registro na retaguarda
Data.PreVendaPagamentos.PreVendaPagamentoDadosComplementares.SituacaoInteiro

Indica se o pagamento está ativo ou cancelado:

    • 0 - Cancelado
    • 1 - Ativo


Data.PreVendaPagamentos.PreVendaPagamentoItensLista de ObjetosLista de itens do pagamento
Data.PreVendaPagamentos.PreVendaPagamentoItens.DataVencimentoData/HoraData de vencimento das parcelas aplicadas ao pagamento
Data.PreVendaPagamentos.PreVendaPagamentoItens.IdPreVendaPagamentoInteiroCódigo da pre venda pagamento relacionada ao item do pagamento
Data.PreVendaPagamentos.PreVendaPagamentoItens.NumeroParcelaInteiroQuantidade de parcelas aplicadas ao pagamento
Data.PreVendaPagamentos.PreVendaPagamentoItens.ValorParcelaDecimalValor das parcelas aplicadas ao pagamento
Data.PreVendaPagamentos.PreVendaPagamentoItens.DataAtualizacaoData/HoraData da ultima atualização do pagamento item
Data.PreVendaPagamentos.PreVendaPagamentoItens.DataCadastroData/HoraData de cadastro do pagamento item
Data.PreVendaPagamentos.PreVendaPagamentoItens.IdInteiroCódigo de identificação do registro. (campo chave)
Data.PreVendaPagamentos.PreVendaPagamentoItens.IdRetaguardaStringCódigo de identificação do registro na retaguarda
Data.PreVendaPagamentos.PreVendaPagamentoItens.SituacaoInteiro

Indica se o pagamento item está ativo ou cancelado

    • 0 - Cancelado
    • 1 - Ativo


Data.PreVendaPagamentos.PreVendaPagamentoTefsLista de ObjetosLista de Pagamento Tef
Data.PreVendaPagamentos.PreVendaPagamentoTefs.BandeiraStringCódigo da bandeira do cartão
Data.PreVendaPagamentos.PreVendaPagamentoTefs.CodigoRedeStringCódigo da rede do cartão
Data.PreVendaPagamentos.PreVendaPagamentoTefs.DataPreDatadoData/HoraData do pagamento pré-datado
Data.PreVendaPagamentos.PreVendaPagamentoTefs.DiasEntreParcelasInteiroNúmero de dias entre as datas de vencimento das parcelas
Data.PreVendaPagamentos.PreVendaPagamentoTefs.IdPreVendaPagamentoInteiroCódigo da pre venda pagamento relacionada ao item do pagamento Tef
Data.PreVendaPagamentos.PreVendaPagamentoTefs.IdTransacaoDigitalStringCódigo de autorização do pagamento, retornado pelo TPD / TPI
Data.PreVendaPagamentos.PreVendaPagamentoTefs.NsuHostStringCódigo de autorização do pagamento, retornado pela administradora do cartão
Data.PreVendaPagamentos.PreVendaPagamentoTefs.NumeroAutorizacaoStringCódigo de autorização do pagamento, retornado pelo Sitef
Data.PreVendaPagamentos.PreVendaPagamentoTefs.NumeroBinStringIdentificação do cartão (primeiros números do cartão)
Data.PreVendaPagamentos.PreVendaPagamentoTefs.NumeroParcelasInteiroQuantidade de parcelas no pagamento
Data.PreVendaPagamentos.PreVendaPagamentoTefs.PrimeiraParcelaData/HoraData da primeira parcela
Data.PreVendaPagamentos.PreVendaPagamentoTefs.DataAtualizacaoData/HoraData da ultima atualização do pagamento Tef
Data.PreVendaPagamentos.PreVendaPagamentoTefs.DataCadastroData/HoraData de cadastro do pagamento Tef
Data.PreVendaPagamentos.PreVendaPagamentoTefs.IdInteiroCódigo de identificação do registro. (campo chave)
Data.PreVendaPagamentos.PreVendaPagamentoTefs.IdRetaguardaStringCódigo de identificação do registro na retaguarda
Data.PreVendaPagamentos.PreVendaPagamentoTefs.SituacaoInteiro

Indica se o pagamento tef está ativo ou cancelado

    • 0 - Cancelado
    • 1 - Ativo


Data.PreVendaPagamentos.ValorLiquidoDecimalValor da pré venda incluindo os descontos
Data.PreVendaPagamentos.ValorMinimoAceitoDecimalValor mínimo que pode ser pago, configurado na forma de pagamento
Data.PreVendaPagamentos.ValorPagoDecimalValor registrado no pagamento
Data.PreVendaPagamentos.ValorTrocoDecimalValor devolvido de troco ao cliente
Data.PreVendaPagamentos.PagamentoFormaObjetoForma de Pagamento
Data.PreVendaPagamentos.PagamentoForma.IdRetaguardaStringCódigo de identificação da Forma de pagamento na retaguarda
Data.PreVendaPagamentos.PagamentoCondicaoObjetoCondição de Pagamento
Data.PreVendaPagamentos.PagamentoCondicao.IdRetaguardaStringCódigo de indentificação da Condição do pagamento na retaguarda
Data.PreVendaPagamentos.QuantidadeParcelasInteiroQuantidade de Parcelas pagamento
Data.PreVendaPagamentos.DataAtualizacaoData/HoraData de atualização do pagamento
Data.PreVendaPagamentos.DataCadastroData/HoraData de cadastro do pagamento
Data.PreVendaPagamentos.IdInteiroCódigo de identificação do registro. (campo chave)
Data.PreVendaPagamentos.IdRetaguardaStringCódigo de identificação do registro na retaguarda
Data.PreVendaPagamentos.SituacaoInteiro

Indica se o pagamento está ativo ou cancelado

    • 0 - Cancelado
    • 1 - Ativo


Data.VendaPagamentosLista de ObjetosLista de Venda Pagamentos
Data.VendaPagamentos.VendaIdInteiroCódigo de Identificação da Venda
Data.VendaPagamentos.PagamentoFormaIdInteiroCódigo de Identificação da Forma de Pagamento (campo chave)
Data.VendaPagamentos.PagamentoFormaObjetoForma de Pagamento
Data.VendaPagamentos.PagamentoForma.IdRetaguardaStringCódigo de Identificação da Forma de Pagamento na Retaguarda
Data.VendaPagamentos.PagamentoForma.DescricaoStringDescrição da Forma de Pagamento
Data.VendaPagamentos.PagamentoCondicaoIdInteiroCódigo de Identificação da Condição de Pagamento (campo chave)
Data.VendaPagamentos.PagamentoCondicaoObjetoCondição de Pagamento
Data.VendaPagamentos.PagamentoCondicao.IdRetaguardaStringCódigo de Identificação da Condição de Pagamento na Retaguarda
Data.VendaPagamentos.PagamentoCondicao.DescricaoStringDescrição da Condição de Pagamento
Data.VendaPagamentos.PagamentoCondicao.DiasEntreParcelasInteiroDias entre Parcelas
Data.VendaPagamentos.PagamentoOperadoraIdInteiroCódigo de Identificação da Operadora de Pagamento (campo chave)
Data.VendaPagamentos.PagamentoOperadoraObjetoOperadora do Pagamento
Data.VendaPagamentos.PagamentoOperadora.IdRetaguardaStringCódigo de Identificação da Operadora de Pagamento na Retaguarda
Data.VendaPagamentos.PagamentoOperadora.DescricaoStringDescrição da Operadora de Pagamento
Data.VendaPagamentos.PagamentoOperadora.CodigoTefStringCódigo TEF
Data.VendaPagamentos.ValorPagoDecimalValor Pago
Data.VendaPagamentos.ValorTrocoDecimalValor do Troco
Data.VendaPagamentos.ValorLiquidoDecimalValor Líquido
Data.VendaPagamentos.IdRetaguardaCreditoInteiroCódigo de Identificação de Crédito na Retaguarda
Data.VendaPagamentos.CpfCnpjClienteStringCPF ou CNPJ do ClienteMax 14 posições
Data.VendaPagamentos.QuantidadeParcelasInteiroQuantidade de Parcelas
Data.VendaPagamentos.IdDividaStringCódigo de Identificação da Dívida
Data.VendaPagamentos.VendaPagamentoDadoComplementarsLista de ObjetosDados Complementares da Venda Pagamento
Data.VendaPagamentos.VendaPagamentoDadoComplementars.ConteudoStringConteúdo do Dado Complementar
Data.VendaPagamentos.VendaPagamentoDadoComplementars.DescricaoStringDescrição do Dado Complementar
Data.VendaPagamentos.VendaPagamentoDadoComplementars.IdPagamentoDadoComplementarInteiroCódigo de Identificação do Dado Complementar de Pagamento (Campo Chave)
Data.VendaPagamentos.VendaPagamentoDadoComplementars.IdPagamentoDadoComplementarRetaguardaStringCódigo de Identificação do Dado Complementar na Retaguarda
Data.VendaPagamentos.VendaPagamentoDadoComplementars.IdVendaPagamentoInteiroCódigo de Identificação da Venda Pagamento (Campo Chave)
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementarObjetoDado Complementar
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.DescricaoStringDescrição do Pagamento Dado Complementar
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.TipoInteiroTipo do Pagamento Dado Complementar
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.ObrigatorioInteiro

Flag Obrigatório

  • 1 - Sim
  • 0 - Não


Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.TamanhoInteiroTamanho
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.TipoCampoTefInteiroTipo Campo TEF
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.DataAtualizacaoData/HoraData de Atualização do Registro
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.DataCadastroData/HoraData de Criação do Registro
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.IdInteiroCódigo de Identificação do Pagamento Dado Complementar (Campo Chave)
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.IdRetaguardaStringCódigo de Identificação do Pagamento Dado Complementar na Retaguarda
Data.VendaPagamentos.VendaPagamentoDadoComplementars.PagamentoDadoComplementar.SituacaoInteiro

Situação Cadastral

  • 1 - Ativo
  • 0 - Cancelado


Data.VendaPagamentos.VendaPagamentoDadoComplementars.DataAtualizacaoData/HoraData de Atualização do Registro
Data.VendaPagamentos.VendaPagamentoDadoComplementars.DataCadastroData/HoraData de Criação do Registro
Data.VendaPagamentos.VendaPagamentoDadoComplementars.IdInteiroCódigo de Identificação do Dado Complementar (Campo Chave)
Data.VendaPagamentos.VendaPagamentoDadoComplementars.IdRetaguardaStringCódigo de Identificação do Dado Complementar na Retaguarda
Data.VendaPagamentos.VendaPagamentoDadoComplementars.SituacaoInteiro

Situação Cadastral

  • 1 - Ativo
  • 0 - Cancelado


Data.VendaPagamentos.VendaPagamentoItemsLista de ObjetosItens da Venda Pagamento
Data.VendaPagamentos.VendaPagamentoItems.VendaPagamentoIdInteiroCódigo de Identificação da Venda Pagamento
Data.VendaPagamentos.VendaPagamentoItems.NumeroParcelaInteiroNúmero de Parcelas
Data.VendaPagamentos.VendaPagamentoItems.ValorParcelaDecimalValor da Parcela
Data.VendaPagamentos.VendaPagamentoItems.DataVencimentoData/HoraData de Vencimento da Parcela
Data.VendaPagamentos.VendaPagamentoItems.DataAtualizacaoData/HoraData de Atualização do Registro
Data.VendaPagamentos.VendaPagamentoItems.DataCadastroData/HoraData de Cadastro do Registro
Data.VendaPagamentos.VendaPagamentoItems.IdInteiroCódigo de Identificação do Item de Venda Pagamento (Campo Chave)
Data.VendaPagamentos.VendaPagamentoItems.IdRetaguardaStringCódigo de Identificação do Item de Venda Pagamento na Retaguarda
Data.VendaPagamentos.VendaPagamentoItems.SituacaoInteiro

Situação Cadastral

  • 1 - Ativo
  • 0 - Cancelado


Data.VendaPagamentos.VendaPagamentoTefsLista de ObjetosVenda Pagamento Tefs
Data.VendaPagamentos.VendaPagamentoTefs.BandeiraStringBandeira do Cartão
Data.VendaPagamentos.VendaPagamentoTefs.CodigoRedeStringCódigo da Rede
Data.VendaPagamentos.VendaPagamentoTefs.DataPreDatadoData/HoraData do Pré Datado
Data.VendaPagamentos.VendaPagamentoTefs.DiasEntreParcelasInteiroDias Entre Parcelas
Data.VendaPagamentos.VendaPagamentoTefs.IdVendaPagamentoInteiroCódigo de Identificação da Venda Pagamento
Data.VendaPagamentos.VendaPagamentoTefs.IdTransacaoDigitalStringCódigo de Identificação de Transação Digital
Data.VendaPagamentos.VendaPagamentoTefs.NsuHostStringNSU Host
Data.VendaPagamentos.VendaPagamentoTefs.NumeroAutorizacaoStringNúmero da Autorização
Data.VendaPagamentos.VendaPagamentoTefs.NumeroBinStringNúmero Bin
Data.VendaPagamentos.VendaPagamentoTefs.NumeroParcelasInteiroNúmero de Parcelas
Data.VendaPagamentos.VendaPagamentoTefs.PrimeiraParcelaData/HoraData da Primeira Parcela
Data.VendaPagamentos.VendaPagamentoTefs.IdPagamentoMfeInteiroCódigo de Identificação do Pagamento Mfe
Data.VendaPagamentos.VendaPagamentoTefs.SincronizadoPagamentoMfeBooleanoSincronizado Pagamento Nfe
Data.VendaPagamentos.VendaPagamentoTefs.DataAtualizacaoData/HoraData de Atualização do Registro
Data.VendaPagamentos.VendaPagamentoTefs.DataCadastroData/HoraData de Criação do Registro
Data.VendaPagamentos.VendaPagamentoTefs.IdInteiroCódigo de Identificação da Venda Pagamento Tefs (campo chave)
Data.VendaPagamentos.VendaPagamentoTefs.IdRetaguardaStringCódigo de Identificação da Venda Pagamento Tefs na Retaguarda
Data.VendaPagamentos.VendaPagamentoTefs.SituacaoInteiro

Situação Cadastral

  • 1 - Ativo
  • 0 - Cancelado


Data.VendaPagamentos.VendaPagamentoTrocasLista de ObjetosTrocas da Venda Pagamento
Data.VendaPagamentos.VendaPagamentoTrocas.VendaPagamentoIdInteiroCódigo de Identificação da Venda Pagamento (campo chave)
Data.VendaPagamentos.VendaPagamentoTrocas.IdVendaRetaguardaStringCódigo de Identificação da Venda na Retaguarda
Data.VendaPagamentos.VendaPagamentoTrocas.CpfCnpjStringCpf ou Cnpj do ConsumidorMax 14 posições
Data.VendaPagamentos.VendaPagamentoTrocas.NomeStringNome do Consumidor
Data.VendaPagamentos.VendaPagamentoTrocas.MotivoIdInteiroCódigo de Identificação do Motivo (campo chave)
Data.VendaPagamentos.VendaPagamentoTrocas.MotivoObjetoMotivo da Troca
Data.VendaPagamentos.VendaPagamentoTrocas.Motivo.IdRetaguardaStringCódigo de Identificação do Motivo na Retaguarda
Data.VendaPagamentos.VendaPagamentoTrocas.Motivo.DescricaoStringDescrição da Venda Pagamento
Data.VendaPagamentos.VendaPagamentoTrocas.DataTrocaData/HoraData da Troca
Data.VendaPagamentos.VendaPagamentoTrocas.ValorTotalDecimalValor Total
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItemsLista de ObjetosItens de Troca
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItems.IdItemRetaguardaStringCódigo de Identificação do Item na Retaguarda
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItems.TrocaIdInteiroCódigo de Identificação da Troca (Campo chave)
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItems.ProdutoIdInteiroCódigo de Identificação do Produto (campo chave)
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItems.ProdutoObjetoProduto da Troca
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.IdInteiroCódigo de Identificação do Produto (campo chave)
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.IdRetaguardaStringCódigo de Identificação do Produto na Retaguarda
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.CodigoProdutoStringCódigo do Produto
Data.VendaPagamentos.VendaPagamentoTrocas.TrocaItems.Produto.DescricaoStringDescrição do Produto
Data.VendaPagamentos.TrocaItems.ValorDecimalValor do Produto
Data.VendaPagamentos.TrocaItems.QuantidadeDecimalQuantidade
Data.VendaPagamentos.TrocaItems.DataAtualizacaoData/HoraData de Atualização do Registro
Data.VendaPagamentos.TrocaItems.DataCadastroData/HoraData de Criação do Registro
Data.VendaPagamentos.TrocaItems.IdInteiroCódigo de Identificação do Item de Troca (campo chave)
Data.VendaPagamentos.TrocaItems.IdRetaguardaStringCódigo de Identificação do Item de Troca na Retaguarda
Data.VendaPagamentos.TrocaItems.SituacaoInteiro

Situação Cadastral

  • 1 - Ativo
  • 0 - Cancelado


Data.VendaPagamentos.VendaPagamentoTrocas.DataAtualizacaoData/HoraData de Atualização do Registro
Data.VendaPagamentos.VendaPagamentoTrocas.DataCadastroData/HoraData de Criação do Registro
Data.VendaPagamentos.VendaPagamentoTrocas.IdInteiroCódigo de Identificação da Venda Pagamento Troca (campo chave)
Data.VendaPagamentos.VendaPagamentoTrocas.IdRetaguardaStringCódigo de Identificação da Venda Pagamento Troca na Retaguarda
Data.VendaPagamentos.VendaPagamentoTrocas.SituacaoInteiro

Situação Cadastral

  • 1 - Ativo
  • 0 - Cancelado


Data.SerieVendaStringNúmero de série da venda
Data.SincronizadoInteiro

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

    • 0 - Não
    • 1 - Sim


Data.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


Data.SituacaoPreVendaString

Status da pré venda:

    • DISPONIVEL
    • ATENDIMENTO
    • FATURADO PARCIALMENTE
    • RESGATADA
    • RECEBIDO
    • CANCELADA


Data.TerminalOrigemStringNúmero do PDV onde foi gerado o pedido (integração omnichannel)
Data.TipoCancelamentoInteiro

Tipo do cancelamento:

    • 0 - Automático
    • 1 - Manual


Data.TipoDescontoAcrescimoInteiro

Tipo do acréscimo:

    • 0 - Percentual
    • 1 - Valor
    • 2 - Preço Final


Data.TipoEntregaInteiro

Tipo de entrega:

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


Data.TipoPreVendaInteiro

Tipo da pré venda:

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


Data.TipoVendaInteiro

Tipo da venda:

    • 1 - Produto
    • 2 - Serviço
    • 3 - Cartão presente
    • 4 - Pedido


Data.TotalBrutoDecimalValor total do Pedido sem os descontos
Data.TotalLiquidoDecimalValor liquido do Pedido considerando todos os descontos
Data.FretePercentualTotalDecimalValor percentual do Frete
Data.FreteTotalDecimalValor Real do Frete
Data.TipoValorFreteInteiro

Tipo do valor do frete:

    • 0 - Percentual
    • 1 - Real


Data.MultiplosPedidosBooleanoIndica se existe multiplos pedidos na Prevenda
Data.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


Data.AcrescimoPercentualTotalDecimalAcréscimo Percentual Total
Data.AcrescimoTotalDecimalAcréscimo Total
Data.NumeroPdvInteiroNúmero PDV
Data.DataAtualizacaoData/HoraData de atualização da pré venda
Data.DataCadastroData/HoraData que a pré venda foi criado no PDV
Data.IdInteiroCódigo de identificação do registro. (campo chave), gerado pelo PDV Omnishop.
Data.IdRetaguardaStringCódigo de identificação do registro na retaguarda
Data.SituacaoInteiro

Situação Cadastral:

  • 1 - Ativo
  • 0 - Inativo


Data.IdProfissionalRetaguardaString

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


Data.recebimentoAntecipadoBooleanoIndica se a pré-venda foi realizada utilizando pagamento com recebimento antecipado
ErrorsObjetoLista de errosSomente na V3
TotalTimeInteiroTempo da requisição
NumberOfRecordsInteiroNúmero de registros
Card
label400 - Bad Request
Column
width50%

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

Column
width50%

Campo

Tipo

Descrição

Observação

SuccessboolIndica se a requisição foi feita com sucesso
MessagestringMensagem de retorno de erros
DataObjectLista com as pré vendas retornadas
ErrorsLista de objectLista de errosSomente na V3
TotalTimeIntTempo da requisição
NumberOfRecordsIntNúmero de registros