POST api/Integracao/PontuaConsumidor

Informações para Requisição

URI Parameters

None.

Body Parameters

PontuaConsumidor
NomeDescriçãoTipoDetalhe
cpf

CPF do consumidor a ser pontuado

 string

None.
cartao

Cartão vinculado ao consumidor

 string

None.
token_externo

ID Único do consumidor no seu sistema, pode ser populado com o UUID, ID de autenticação do Facebook, LinkedIn etc.

 string

None.
telefone

Telefone do consumidor a ser consultado

 string

None.
premio_identificador

String IdProduto externo para pontuação.

 string

None.
pontuacao_reais

Pontuação em reais do consumidor

 decimal number

Required
tipo_compra

Descricao do Tipo da compra

 string

None.
verificador

Código para verificar se a pontuação já foi realizada

 string

None.
estorno

Estorno de uma pontuação

 boolean

None.
produtos

Collection of ProdutosPontuaConsumidor

None.

Request Formats

application/json, text/json

Sample: 
{
  "cpf": "sample string 1",
  "cartao": "sample string 2",
  "token_externo": "sample string 3",
  "telefone": "sample string 4",
  "premio_identificador": "sample string 5",
  "pontuacao_reais": 6.0,
  "tipo_compra": "sample string 7",
  "verificador": "sample string 8",
  "estorno": true,
  "produtos": [
    {
      "identificador": "sample string 1",
      "descricao": "sample string 2",
      "valor": 3.0
    },
    {
      "identificador": "sample string 1",
      "descricao": "sample string 2",
      "valor": 3.0
    }
  ]
}

application/xml, text/xml

Sample: 
<PontuaConsumidor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fidelimax.WebApi.Models">
  <CPF>sample string 1</CPF>
  <Cartao>sample string 2</Cartao>
  <DescricaoTipoCompra>sample string 7</DescricaoTipoCompra>
  <EstornoPonto>true</EstornoPonto>
  <IdProdutoExterno>sample string 5</IdProdutoExterno>
  <PontuacaoConsumidor>6</PontuacaoConsumidor>
  <Produtos xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fidelimax.WebApi.Models.Parametros.Credito">
    <d2p1:ProdutosPontuaConsumidor>
      <d2p1:Descricao>sample string 2</d2p1:Descricao>
      <d2p1:Identificador>sample string 1</d2p1:Identificador>
      <d2p1:Valor>3</d2p1:Valor>
    </d2p1:ProdutosPontuaConsumidor>
    <d2p1:ProdutosPontuaConsumidor>
      <d2p1:Descricao>sample string 2</d2p1:Descricao>
      <d2p1:Identificador>sample string 1</d2p1:Identificador>
      <d2p1:Valor>3</d2p1:Valor>
    </d2p1:ProdutosPontuaConsumidor>
  </Produtos>
  <Telefone>sample string 4</Telefone>
  <TokenExterno>sample string 3</TokenExterno>
  <VerificadorCompra>sample string 8</VerificadorCompra>
</PontuaConsumidor>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PontuaConsumidor'.

Informações de Resposta

Resource Description

RetornoPontuaConsumidor
NomeDescriçãoTipoDetalhe
saldo

Saldo de pontos do consumidor

 decimal number

None.
pontuacao_resgatar

Identifica se possui proxima compra bonificado

 boolean

None.
pontos_expirar

Pontos a expirar no fim do mês

 decimal number

None.
estorno

Pontos foram extornados

 boolean

None.
cashback

Pontos foram extornados

 decimal number

None.
CodigoResposta

CodigoResposta

None.
MensagemErro

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "saldo": 1.0,
  "pontuacao_resgatar": true,
  "pontos_expirar": 3.0,
  "estorno": true,
  "cashback": 5.0,
  "CodigoResposta": 100,
  "MensagemErro": "sample string 6"
}

application/xml, text/xml

Sample: 
<RetornoPontuaConsumidor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fidelimax.WebApi.Models">
  <CodigoResposta xmlns="http://schemas.datacontract.org/2004/07/FideliMax.WebApi.Objects">Ok</CodigoResposta>
  <MensagemErro xmlns="http://schemas.datacontract.org/2004/07/FideliMax.WebApi.Objects">sample string 6</MensagemErro>
  <Cashback>5</Cashback>
  <Estorno>true</Estorno>
  <PontosExpirarMes>3</PontosExpirarMes>
  <ProximaCompraBonificada>true</ProximaCompraBonificada>
  <SaldoPontos>1</SaldoPontos>
</RetornoPontuaConsumidor>