TOTVS Varejo PDV Omni

Árvore de páginas

Este método é responsável pela consulta de pedidos de pré-venda disponíveis na retaguarda.

Ao realizarmos uma requisição na API de ProcessoOnlinePreVendaConsulta, será gerada uma  consulta simplificada (lista) de pedidos da pré-venda.

    • Endpoint: /api/pdvsyncserver/retaguarda/v2/ProcessoOnlinePreVendaConsulta
    • Método: POST
    • Autenticação: Bearer token
    • Permissão: Client

    Body da requisição

    Campo

    Tipo

    Descrição

    Obrigatório
    IdInquilino String Identificador do inquilino Sim
    IdLojaRetaguarda String Identiticador da loja na retaguarda Sim
    IdOperadorRetaguarda String Identificador do operador na retaguarda Não
    CpfCnpj String CPF ou CNPJ do cliente Não
    Nome String Nome do cliente Não
    IdClienteRetaguarda String Identificador do cliente na retaguarda Não
    DataInicio Data/Hora Data início Não
    DataFim Data/Hora Data fim Não

    {
        "idInquilino": "string",
        "idLojaRetaguarda": "string",
        "idOperadorRetaguarda": "string",
        "cpfCnpj": "string",
        "nome": "string",
        "idClienteRetaguarda": "string",
        "dataInicio": "2024-06-13T18:42:05.318Z",
        "dataFim": "2024-06-13T18:42:05.318Z"
    }

    Retornos

    Campo

    Tipo

    Descrição
    Success Booleano Indica se a requisição foi feita com sucesso
    Message String Mensagem de retorno em
    Data Lista de Objetos Lista com as pré-vendas
    Data.Cliente Objeto Objeto de cliente
    Data.Cliente.Nome String Nome do cliente
    Data.Cliente.CpfCnpj String CPF ou CNPJ do cliente
    Data.Offline Booleano
    Data.SituacaoPreVenda String Situação da pré-venda
    Data.IdLojaRetaguarda String Identificação da loja na retaguarda
    Data.IdOperadorRetaguarda String Identificação do operador na retaguarda
    Data.TotalLiquido Decimal Total liquido da pré-venda
    Data.DescontoPercentualTotal Decimal Desconto percentual total da pré-venda
    Data.DescontoTotal Decimal Desconto total da pré-venda
    Data.AcrescimoPercentualTotal Decimal Acréscimo Percentual total da pré-venda
    Data.AcrescimoTotal Decimal Acréscimo total da pré-venda
    Data.FreteTotal Decimal Valor total do frete
    Data.TotalBruto Decimal Total bruto da pré-venda
    Data.MultiplosPedidos Booleano Indica se são múltiplos pedidos
    Data.DataCadastro Data/Hora Data de cadastro
    Data.Id Inteiro Id
    Data.IdRetaguarda String Identificador da pré-venda na retaguarda
    Errors Lista de objetos Lista de erros
    TotalTime Inteiro Tempo total da requisição
    NumberOfRecords Inteiro Número de registros


    {
        "success": true,
        "message": "String",
        "data": [
            {
                "cliente": {
                    "nome": "String",
                    "cpfCnpj": "String"
                },
                "offline": false,
                "situacaoPreVenda": "String",
                "idLojaRetaguarda": "String",
                "idOperadorRetaguarda": "String",
                "totalLiquido": 0.0,
                "descontoPercentualTotal": 0.0,
                "descontoTotal": 0.0,
                "acrescimoPercentualTotal": 0.0,
                "acrescimoTotal": 0.0,
                "freteTotal": 0.0,
                "totalBruto": 0.0,
                "multiplosPedidos": false,
                "dataCadastro": "0001-01-01T00:00:00",
                "id": 0,
                "idRetaguarda": "String"
            }
        ],
        "errors": null,
        "totalTime": 0,
        "numberOfRecords": 0
    }

    Campo

    Tipo

    Descrição

    Observação
    Success bool Indica se a requisição foi feita com sucesso
    Message string Mensagem de retorno de erros
    Data Objeto Objeto de retorno
    Errors Lista de objetos Lista de erros Somente é retornado na V3
    TotalTime Int Tempo total da requisição
    NumberOfRecords Int Número de registros


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

    Importante

    As informações desta aba diz respeito apenas a comunicação do TOTVS VAREJO PDV OMNI SMART HUB SERVER (PDV) com a API do ERP Retaguarda (PSH, WSH e etc).

    frontend - Acesso autorizado apenas para o time responsável (Integrações Sync).

    • Endpoint: configurável no cadastro de Inquilinos no frontend, através do campo "Endpoint PreVendaConsultaPedido"
    • Método: GET
    • Autenticação: definida pelo ERP Retaguarda, vide documentação do frontend
    • Permissão: Definido pelo ERP Retaguarda

    Após o envio do POST, o microserviço se encarrega de transforma-lo em GET para comunicação com ERP Retaguarda e retornar os dados solicitados.

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

    Campo

    Tipo

    Descrição

    Tipo Parâmetro

    Obrigatório
    idLojaRetaguarda string Identiticador da loja na retaguarda Parameter/Path/Query Params Sim
    dataInicio Data/Hora Data início Parameter/Path/Query Params Não
    dataFim Data/Hora Data fim Parameter/Path/Query Params Não
    idOperadorRetaguarda string Identificador do operador na retaguarda Parameter/Path/Query Params Não
    cpfCnpj string CPF ou CNPJ do cliente

    Parameter/Path/Query Params

    Não
    nome string Nome do cliente

    Parameter/Path/Query Params

    Não
    idClienteRetaguarda string Identificador do cliente na retaguarda

    Parameter/Path/Query Params

    Não

    Retornos

    Campo

    Tipo

    Descrição
    Success Booleano Indica se a requisição foi feita com sucesso
    Message String Mensagem de retorno em
    Data Lista de Objetos Lista com as pré-vendas
    Data.Cliente Objeto Objeto de cliente
    Data.Cliente.Nome String Nome do cliente
    Data.Cliente.CpfCnpj String CPF ou CNPJ do cliente
    Data.Offline Booleano
    Data.SituacaoPreVenda String Situação da pré-venda
    Data.IdLojaRetaguarda String Identificação da loja na retaguarda
    Data.IdOperadorRetaguarda String Identificação do operador na retaguarda
    Data.TotalLiquido Decimal Total liquido da pré-venda
    Data.DescontoPercentualTotal Decimal Desconto percentual total da pré-venda
    Data.DescontoTotal Decimal Desconto total da pré-venda
    Data.AcrescimoPercentualTotal Decimal Acréscimo Percentual total da pré-venda
    Data.AcrescimoTotal Decimal Acréscimo total da pré-venda
    Data.FreteTotal Decimal Valor total do frete
    Data.TotalBruto Decimal Total bruto da pré-venda
    Data.MultiplosPedidos Booleano Indica se são múltiplos pedidos
    Data.DataCadastro Data/Hora Data de cadastro
    Data.Id Inteiro Id
    Data.IdRetaguarda String Identificador da pré-venda na retaguarda

    {
        "success": true,
        "message": "String",
        "data": [
            {
                "cliente": {
                    "nome": "String",
                    "cpfCnpj": "String"
                },
                "offline": false,
                "situacaoPreVenda": "String",
                "idLojaRetaguarda": "String",
                "idOperadorRetaguarda": "String",
                "totalLiquido": 0.0,
                "descontoPercentualTotal": 0.0,
                "descontoTotal": 0.0,
                "acrescimoPercentualTotal": 0.0,
                "acrescimoTotal": 0.0,
                "freteTotal": 0.0,
                "totalBruto": 0.0,
                "multiplosPedidos": false,
                "dataCadastro": "0001-01-01T00:00:00",
                "id": 0,
                "idRetaguarda": "String"
            }
        ]

    }

    Campo

    Tipo

    Descrição

    Observação
    Success bool Indica se a requisição foi feita com sucesso
    Message string Mensagem de retorno de erros
    Data Objeto Objeto de retorno


    {
        "success": false,
        "message": "string",
        "data": null
    }






    '

    • Sem rótulos