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

IdInquilinoStringIdentificador do inquilinoSim
IdLojaRetaguardaStringIdentiticador da loja na retaguardaSim
IdOperadorRetaguardaStringIdentificador do operador na retaguardaNão
CpfCnpjStringCPF ou CNPJ do clienteNão
NomeStringNome do clienteNão
IdClienteRetaguardaStringIdentificador do cliente na retaguardaNão
DataInicioData/HoraData inícioNão
DataFimData/HoraData fimNã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

SuccessBooleanoIndica se a requisição foi feita com sucesso
MessageStringMensagem de retorno em
DataLista de ObjetosLista com as pré-vendas
Data.ClienteObjetoObjeto de cliente
Data.Cliente.NomeStringNome do cliente
Data.Cliente.CpfCnpjStringCPF ou CNPJ do cliente
Data.OfflineBooleano
Data.SituacaoPreVendaStringSituação da pré-venda
Data.IdLojaRetaguardaStringIdentificação da loja na retaguarda
Data.IdOperadorRetaguardaStringIdentificação do operador na retaguarda
Data.TotalLiquidoDecimalTotal liquido da pré-venda
Data.DescontoPercentualTotalDecimalDesconto percentual total da pré-venda
Data.DescontoTotalDecimalDesconto total da pré-venda
Data.AcrescimoPercentualTotalDecimalAcréscimo Percentual total da pré-venda
Data.AcrescimoTotalDecimalAcréscimo total da pré-venda
Data.FreteTotalDecimalValor total do frete
Data.TotalBrutoDecimalTotal bruto da pré-venda
Data.MultiplosPedidosBooleanoIndica se são múltiplos pedidos
Data.DataCadastroData/HoraData de cadastro
Data.IdInteiroId
Data.IdRetaguardaStringIdentificador da pré-venda na retaguarda
ErrorsLista de objetosLista de erros
TotalTimeInteiroTempo total da requisição
NumberOfRecordsInteiroNú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

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


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

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

idLojaRetaguardastringIdentiticador da loja na retaguardaParameter/Path/Query ParamsSim
dataInicioData/HoraData inícioParameter/Path/Query ParamsNão
dataFimData/HoraData fimParameter/Path/Query ParamsNão
idOperadorRetaguardastringIdentificador do operador na retaguardaParameter/Path/Query ParamsNão
cpfCnpjstringCPF ou CNPJ do cliente

Parameter/Path/Query Params

Não

nomestringNome do cliente

Parameter/Path/Query Params

Não

idClienteRetaguardastringIdentificador do cliente na retaguarda

Parameter/Path/Query Params

Não

Retornos

Campo

Tipo

Descrição

SuccessBooleanoIndica se a requisição foi feita com sucesso
MessageStringMensagem de retorno em
DataLista de ObjetosLista com as pré-vendas
Data.ClienteObjetoObjeto de cliente
Data.Cliente.NomeStringNome do cliente
Data.Cliente.CpfCnpjStringCPF ou CNPJ do cliente
Data.OfflineBooleano
Data.SituacaoPreVendaStringSituação da pré-venda
Data.IdLojaRetaguardaStringIdentificação da loja na retaguarda
Data.IdOperadorRetaguardaStringIdentificação do operador na retaguarda
Data.TotalLiquidoDecimalTotal liquido da pré-venda
Data.DescontoPercentualTotalDecimalDesconto percentual total da pré-venda
Data.DescontoTotalDecimalDesconto total da pré-venda
Data.AcrescimoPercentualTotalDecimalAcréscimo Percentual total da pré-venda
Data.AcrescimoTotalDecimalAcréscimo total da pré-venda
Data.FreteTotalDecimalValor total do frete
Data.TotalBrutoDecimalTotal bruto da pré-venda
Data.MultiplosPedidosBooleanoIndica se são múltiplos pedidos
Data.DataCadastroData/HoraData de cadastro
Data.IdInteiroId
Data.IdRetaguardaStringIdentificador 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

SuccessboolIndica se a requisição foi feita com sucesso
MessagestringMensagem de retorno de erros
DataObjetoObjeto de retorno


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






'