Manual de Webservice PDV

Visão Geral do Programa

Este manual contém o detalhe de cada um dos métodos disponíveis nos webservices de integração com o RMS-Retail.

[Tela 1]

Outras Ações/Ações Relacionadas:

Listar as ações relacionadas à tela.

Principais Campos e Parâmetros:

CRM-Crédito

Para integração do módulo CRM-Crédito, dispomos dos métodos listados abaixo:

1. ConsultarCliente: Método responsável por obter os dados completos do cliente.

1. Assinatura: ClienteDTO ConsultarCliente(int pFilial, TipoDeDocumento pTipoDeIdentificacao, string pNumeroDoDocumento) 
2. Parâmetros de envio:

·         pFilial: Código da filial onde está acontecendo a consulta.

·         pTipoDeIdentificacao: Tipo de documento de identificação referente ao parâmetro pNumeroDoDocumento.

·         pNumeroDoDocumento: Número do documento de identificação do cliente.

1. SOAP de envio:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">

   <soapenv:Header/>

   <soapenv:Body>

      <tem:ConsultarCliente>

         <!--Optional:-->

         <tem:pFilial>?</tem:pFilial>

         <!--Optional:-->

         <tem:pTipoDeDocumento>?</tem:pTipoDeDocumento>

         <!--Optional:-->

         <tem:pNumeroDeDocumento>?</tem:pNumeroDeDocumento>

      </tem:ConsultarCliente>

   </soapenv:Body>

</soapenv:Envelope>

1. Parâmetro de retorno: ClienteDTO 

·         Endereco: Endereço do cliente.

·         ComplementoEndereco: Endereço complementar do cliente.

·         NumeroEndereco: Número do endereço.

·         SenhaDoConvenio: Senha do cartão convênio.

·         SaldoDoConvenio: Saldo em cartão convênio.

·         SaldoDaCadernetaEletronica:Saldo em caderneta eletrônica.

·         SaldoDoCheque: Saldo em cheque.

·         SaldoDaAlimentacao: Saldo em cartão alimentação.

·         SaldoDePontos: Saldo em cartão de pontos.

·         SaldoDoSazonal: Saldo em cartão sazonal.

·         SaldoDoEsporadico: Saldo em cartão esporádico.

·         Aniversario: Data de nascimento.

·         NumeroDoCartao: Número do cartão.

·         Categoria: Categoria do cliente.

·         Cidade: Cidade.

·         Empresa: Empresa onde trabalha.

·         Email: E-mail do cliente.

·         CPFCNPJ: Número do CPF/CNPJ.

·         CPFOuCNPJ: Tipo do FIN (CPF/CNPJ).

·         SenhaDaAlimentacao: Senha do cartão alimentação.

·         CodigoInterno: Código interno do cliente.

·         DocumentoDeIdentificacao: Tipo de documento identificado pelo cliente.

·         Nome: Nome do cliente.

·         Bairro: Bairro.

·         NovaSenha: N/A

·         SenhaDePontos: Senha do cartão de pontos.

·         CEP: CEP.

·         SenhaDoSazonal: Senha do cartão sazonal.

·         SenhaDoEsporadico: Senha do cartão esporádico.

·         Estado: Estado. 

·         Status: Status do cliente. 

·         Telefone: Telefone. 

1. SOAP de retorno:  

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

   <s:Body>

      <ConsultarClienteResponse xmlns="http://tempuri.org/">

         <ConsultarClienteResult xmlns:a="http://schemas.datacontract.org/2004/07/RMS.CRM.WS.Util.Entidades" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">

            <a:Aniversario/>

            <a:Bairro/>

            <a:CEP/>

            <a:CPFCNPJ>00000100094180</a:CPFCNPJ>

            <a:CPFOuCNPJ>CPF</a:CPFOuCNPJ>

            <a:Categoria>1</a:Categoria>

            <a:Cidade/>

            <a:CodigoInterno/>

            <a:ComplementoEndereco>25</a:ComplementoEndereco>

            <a:DocumentoDeIdentificacao>NumeroDoCartao</a:DocumentoDeIdentificacao>

            <a:Email/>

            <a:Empresa/>

            <a:Endereco>SASASA</a:Endereco>

            <a:Estado/>

            <a:Nome>TOTVS CRM</a:Nome>

            <a:NovaSenha/>

            <a:NumeroDoCartao>6332000722952005</a:NumeroDoCartao>

            <a:NumeroEndereco>12</a:NumeroEndereco>

            <a:SaldoDaAlimentacao>99974.81</a:SaldoDaAlimentacao>

            <a:SaldoDaCadernetaEletronica>99974.81</a:SaldoDaCadernetaEletronica>

            <a:SaldoDePontos>0</a:SaldoDePontos>

            <a:SaldoDoCheque>99974.81</a:SaldoDoCheque>

            <a:SaldoDoConvenio>99974.81</a:SaldoDoConvenio>

            <a:SaldoDoEsporadico>99974.81</a:SaldoDoEsporadico>

            <a:SaldoDoPrivateLabel>0</a:SaldoDoPrivateLabel>

            <a:SaldoDoSazonal>99974.81</a:SaldoDoSazonal>

            <a:SenhaDaAlimentacao/>

            <a:SenhaDePontos/>

            <a:SenhaDoConvenio/>

            <a:SenhaDoEsporadico/>

            <a:SenhaDoPrivateLabel/>

            <a:SenhaDoSazonal/>

            <a:Status>Ativo</a:Status>

            <a:Telefone>0;0</a:Telefone>

         </ConsultarClienteResult>

      </ConsultarClienteResponse>

   </s:Body>

                   </s:Envelope>

Conteúdos Relacionados:

Links dos principais conceitos e processos.