TOTVS Varejo PDV Omni

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Erik Lopes Vitelli

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Geovani Lima Azevedo

Gravado em

Chave

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

Este método é responsável pela

...

consulta simplificada (lista) de pedidos da pré-venda.

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

Body da requisição

Deck of Cards
idcredito_consulta_get
Quantidade de itens da página
Card
labelDefinição das propriedades

Campo

Tipo

Descrição

Obrigatório

IdInquilinoString
Identintificador
Identificador do inquilino
DataInicio
Sim
Datetime
IdLojaRetaguarda
Data de início
DataFimDatetimeData Fim
CpfCnpjStringCpf ou Cnpj
SerieStringSerie
CupomStringCupom
IdRetaguardaProdutoStringIdentificador do Produto na retaguarda
IdRetaguardaLojaStringIdentificador da loja na retaguarda
TipoLista de StringTipos
PaginaIntPágina
ItensPaginaInt
StringIdentiticador 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
Card
labelBody

{
    "idInquilino": "string",
    "dataInicioidLojaRetaguarda": "2024-06-13T18:13:32.029Zstring",
    "dataFimidOperadorRetaguarda": "2024-06-13T18:13:32.029Zstring",
    "cpfCnpj": "string",
    "serienome": "string",
    "cupomidClienteRetaguarda": "string",
    "idRetaguardaProdutodataInicio": "string2024-06-13T18:42:05.318Z",
    "idRetaguardaLojadataFim": "string",
    "tipo": [
        "string"
    ],
    "pagina": 0,
    "itensPagina": 02024-06-13T18:42:05.318Z"
}

Retornos

Deck of Cards
idcredito_consulta_get
Card
label200 - OK
de erros os créditos retornados[]IdRetaguardaLojaValor total da notaTipo notaQuantidade de itens da notaSituação

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
.
Cliente
StringIdentificador da loja na retaguarda
ObjetoObjeto de cliente
Data.Cliente.NomeStringNome do cliente
Data.Cliente
Data[].DataHoraStringData e hora da nota
Data[].CpfCnpjStringCPF ou CNPJ do cliente
Data.OfflineBooleano
Data[].ValorTotalSituacaoPreVendaDecimalStringSituação da pré-venda
Data[].TipoIdLojaRetaguardaStringIdentificação da loja na retaguarda
Data[].QtdItensIdOperadorRetaguardaDecimalStringIdentificação do operador na retaguarda
Data[].ItensTotalLiquidoLista de ObjetosItens da nota
Data[].Itens[].DescricaoStringDescrição do item 
Data[].Itens[].ValorUnitarioDecimalValor unitário do item
Data[].Itens[].QtdVendidaDecimalQuantidade vendida
Data[].Itens[].QtdDisponivelDecimalQuantidade disponível
Data[].Itens[].IdRetaguardaCupomItemStringIdentificador do cupom na retaguarda
Data[].Itens[].IdRetaguardaProdutoStringIdentificador do produto na retaguarda
Data[].SerieStringSéria da nota
Data[].IdRetaguardaCupomStringIdentificador do cupom na retaguarda
Data[].CupomStringCupom
DecimalTotal 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 retaguardaData[].SituacaoString
ErrorsLista de objetosLista de erros
TotalTimeInteiroTempo total da requisição
NumberOfRecordsInteiroNúmero de registros


{
    "success": true,
    "message": "String",
    "data": [
        {
            "idRetaguardaLojacliente": "String",{
                "dataHoranome": "13/06/2024 15:19:39String",
                "cpfCnpj": "String",
            "valorTotal": 0.0},
            "tipooffline": "String"false,
            "qtdItenssituacaoPreVenda": 0.0"String",
            "itensidLojaRetaguarda": [
                {"String",
                    "descricaoidOperadorRetaguarda": "String",
                    "valorUnitariototalLiquido": 0.0,
                    "qtdVendidadescontoPercentualTotal": 0.0,
                    "qtdDisponiveldescontoTotal": 0.0,
                    "idRetaguardaCupomItemacrescimoPercentualTotal": "String"0.0,
                    "idRetaguardaProdutoacrescimoTotal": "String"0.0,
                }"freteTotal": 0.0,
            ]"totalBruto": 0.0,
            "seriemultiplosPedidos": "String"false,
            "idRetaguardaCupomdataCadastro": "String0001-01-01T00:00:00",
            "cupomid": "String"0,
            "situacaoidRetaguarda": "String"
        }
    ],
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Card
label400 - Bad Request

Campo

Tipo

Descrição

ObeservaçãoObservação

SuccessboolIndica se a requisição foi feita com sucesso
MessagestringMensagem de retorno de erros
DataObjetoObjeto de retonroretorno
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
}