Ir para o conteúdo

setIdentificaCliente

Identifica o cliente pelo CPF/CNPJ antes da notificação da venda, verificando se ele é cadastrado e se tem direito a descontos/faixas de preço especiais.

Retorna o saldo em programa de fidelidade, nome e classificação do cliente, além dos prêmios e vouchers disponíveis para aplicação no PDV.

Sobre o saldo

O saldo retornado refere-se ao saldo do cliente em Campanha de Fidelidade ativa — a quantidade de pontos que ele pode utilizar através de módulos do Zoombox (ex.: Totem).

Item Valor
URL (WSDL) http://servidor:porta/IntegradorGSWS/GerenciaVendaWS?wsdl
Método setIdentificaCliente
Protocolo SOAP
Namespace http://ws.integrador.gs.com.br/

Parâmetros de entrada

Nome Tipo de dado Obrigatório Regra
CPF String Sim Somente números. Máx. 11 (CPF) ou 14 (CNPJ). Para clientes não identificados, 00000000000.
idLoja String Sim Código único de identificação da loja. Deve ser o mesmo código enviado no campo loja da WSVenda.
Hash String Sim Chave MD5 gerada a partir de CPF - Data Atual. O CPF deve ser o mesmo informado; a data deve ser a data do envio. Ver cálculo do Hash.
token String Sim Valor fornecido à empresa integradora pela Rock Conecta.

Regras do XML

  • Mesmo que não exista valor para um campo, a tag correspondente deve existir.
  • As tags devem ser envoltas por < e >, sem espaços em branco após o < nem antes do >.
  • Os valores dos exemplos são ilustrativos — use os valores reais na chamada.

Exemplo de requisição

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ws="http://ws.integrador.gs.com.br/">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:setIdentificaCliente>
      <CPF>12345678909</CPF>
      <Hash>9d9357fa875c8c9298e2d99fd5d246d1</Hash>
      <idLoja>10</idLoja>
      <token>ff2d83dd-8019-450c-8374-f0329230f628</token>
    </ws:setIdentificaCliente>
  </soapenv:Body>
</soapenv:Envelope>

Resposta

O modelo de resposta segue a Classe WSRetorno. Em setIdentificaCliente, o retorno inclui lCodigoTagCliente, lPremio e lVoucher. Consulte também os Códigos de retorno do WebService.

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body>
    <ns2:setIdentificaClienteResponse xmlns:ns2="http://ws.integrador.gs.com.br/">
      <return>
        <codigopreco>2</codigopreco>
        <codigoretorno>9</codigoretorno>
        <idCliente>1361</idCliente>
        <informacaocliente>JOAO</informacaocliente>
        <msgretorno>CLIENTE IDENTIFICADO.</msgretorno>
        <saldocliente>4970.1</saldocliente>
        <situacaocadastro>3</situacaocadastro>
        <lCodigoTagCliente>
          <codigo>3</codigo>
          <descricao>Cliente Clube</descricao>
        </lCodigoTagCliente>
        <lPremio>
          <codigoBarra>123456789012</codigoBarra>
          <codigoResgate>825</codigoResgate>
          <idCampanha>257</idCampanha>
          <nome>LIQUIDIFICADOR</nome>
          <pontos>800</pontos>
          <urlImagem>http://www.someweb.com/images/liquidificador.png</urlImagem>
          <valorMinimoVenda>199</valorMinimoVenda>
          <quantidadePremio>1</quantidadePremio>
          <cupomResgate>433</cupomResgate>
          <valorPremio>150</valorPremio>
          <descricao>Liquidificador Philco</descricao>
        </lPremio>
        <lVoucher>
          <id>1775578</id>
          <mecanicas>
            <descricaoTipoMecanica>Por 5.64 na compra da 2.00 UN comprada(s).</descricaoTipoMecanica>
            <gerarAPartir>2.0000</gerarAPartir>
            <idTipoMecanica>9</idTipoMecanica>
            <tipoMecanica>PRECOEXCLUSIVO_NAUNIDADE</tipoMecanica>
            <unidadeDeMedida>UN</unidadeDeMedida>
            <naUnidade>2.0000</naUnidade>
            <precoExclusivo>5.6400</precoExclusivo>
          </mecanicas>
          <lProdutos>
            <descricaoproduto>Água De Coco Sococo 1 L</descricaoproduto>
            <percentualdesconto>30.00</percentualdesconto>
            <quantidade>5.00</quantidade>
            <valorunitario>6.30</valorunitario>
            <lCodigobarraproduto>7896004401409</lCodigobarraproduto>
          </lProdutos>
        </lVoucher>
        <lVoucher>
          <id>658535</id>
          <idExterno>123466</idExterno>
          <mecanicas>
            <descricaoTipoMecanica>Ganhe 5.00% de desconto a partir de 3.00 UN comprada(s).</descricaoTipoMecanica>
            <gerarAPartir>3.0000</gerarAPartir>
            <idTipoMecanica>6</idTipoMecanica>
            <tipoMecanica>PERCENTUALDESCONTO_GERARAPARTIR</tipoMecanica>
            <unidadeDeMedida>UN</unidadeDeMedida>
          </mecanicas>
          <lProdutos>
            <descricaoproduto>Molho de tomate Elefante 150g</descricaoproduto>
            <percentualdesconto>10.00</percentualdesconto>
            <quantidade>15.00</quantidade>
            <lCodigobarraproduto>7898926572113</lCodigobarraproduto>
            <lCodigobarraproduto>7896094201453</lCodigobarraproduto>
          </lProdutos>
        </lVoucher>
      </return>
    </ns2:setIdentificaClienteResponse>
  </S:Body>
</S:Envelope>

Estruturas do retorno

Além dos campos comuns da Classe WSRetorno, este método retorna as listas abaixo.

lCodigoTagCliente — classificação do cliente

Campo Descrição
codigo Código da classificação (tag) do cliente.
descricao Descrição da classificação (ex.: Cliente Clube).

lPremio — prêmios de fidelidade

Prêmios resgatados pelo cliente em campanhas de fidelidade.

Campo Descrição
codigoBarra Código de barras do prêmio.
codigoResgate Código de resgate.
idCampanha ID da campanha de fidelidade.
nome Nome do prêmio.
pontos Pontos necessários para o resgate.
urlImagem URL da imagem do prêmio.
valorMinimoVenda Valor mínimo de venda para elegibilidade.
quantidadePremio Quantidade do prêmio.
cupomResgate Cupom de resgate.
valorPremio Valor do prêmio.
descricao Descrição do prêmio.

lVoucher — vouchers disponíveis

Vouchers a serem disponibilizados ao PDV. Cada voucher pode conter mecanicas e uma lista de lProdutos.

Campo Descrição
id Identificação única do voucher.
idExterno Identificação externa (quando aplicável).
mecanicas Regra promocional do voucher (tipo, unidade, preço/percentual).
lProdutos Produtos aos quais o voucher se aplica (descrição, percentual/valor, quantidade, códigos de barra).

Utilização dos vouchers

Os vouchers retornados aqui devem ter sua utilização informada na setNotificaVenda, via lUtilizacaoVoucher.

Referências