Árvore de páginas

Este método é responsável pela consulta online do identificador PDV


  • Endpoint: /api/retaguarda/v2/processoonlineformascondicoescliente
  • Método: GET
  • Autenticação: Bearer token
  • Permissão: Client

O parâmetros desta requisição são enviado no header, abaixo estão listados os parâmetros

ParametroDescriçãoTipoObrigatórioObservação
IdInquilinoIdentificador do inquilinoStringSim
idRetaguardaLojaIdentificador da loja da retaguardaStringSim
cpfCnpjCPF / CNPJStringSim

Retornos

    Campo

    Tipo

    Descrição

    success Booleano Indica se a requisição retornou sucesso
    message String Campo com as mensagens de erro
    data Lista Obejto Dado de retorno em lista
    data.idRetaguardaFormaPagto String Identificador da forma de pagamento no retaguarda
    data.condicaoPagto Objeto Lista Objeto com uma lista das condições de pagamento
    data.condicaoPagto.idRetaguarda String Identificador da condição de pagamento no retaguarda
    data.condicaoPagto.padrao Booleano Indica a condição de pagamento padrão


    {
        "success": true,
        "message": "",
        "data": {[
            "idRetaguardaFormaPagto": "FP001209A",
            "condicaoPagto": [
                {
                    "idRetaguarda": "CONDPGTO008198A",
                    "padrao": true
                },
                {
                    "idRetaguarda": "CONDPGTO003051B",
                    "padrao": true
                }
            ]
        ]},
        "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
    }





    • Sem rótulos