Árvore de páginas

Versões comparadas

Chave

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

...

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

Body da requisição

Deck of Cards
idcredito_consulta_get
Card
labelDefinição das propriedades

Campo

Tipo

Descrição

Obrigatório

IdInquilinoStringIdentificador do inquilino
IdLojaRetaguardaStringIdentiticador da loja na retaguarda
IdOperadorRetaguardaStringIdentificador do operador na retaguarda
CpfCnpjStringCPF ou CNPJ do cliente
NomeStringNome do cliente
IdClienteRetaguardaStringIdentificador do cliente na retaguarda
DataInicioData/HoraData início
DataFimData/HoraData fim
Card
labelBody

{
    "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

Deck of Cards
idcredito_consulta_get
Card
label200 - OK

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[].AcrescimoPercentualTotalDecimalAcrescímo Percentual total da pré venda
Data[].AcrescimoTotalDecimalAcrescío total da pré venda
Data[].FreteTotalDecimalValor total do frete
Data[].TotalBrutoDecimalTotal bruto da pré venda
Data[].MultiplosPedidosBooleanoIndica se são multiplos 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
}

Card
label400 - Bad Request

Campo

Tipo

Descrição

Obeservação

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