API responsável por realizar a consulta do saldo de bônus disponível do cliente.
Introdução à /api_bonus_disponivel
/api_bonus_disponivel
DetalhesEste endpoint precisa receber três informações, sendo elas: "Id da loja" , "Id do cliente" e o "valor da venda".
Buscamos sempre simplificar este fluxo para você que está consumindo dados de nossa API, por isso centralizamos do nosso lado todas as regras de negócio e variáveis que devem consideradas para dar este desconto. Ao nos enviar estes dados, consideramos todas essas regras e retornamos no campo "saldo_bonus" a informação exata de quanto de desconto poderá ser aplicado, sem a necessidade de tratar este valor.
Pontos de atençãoÉ importante dar uma atenção especial para o campo flag_acumular_bonus na resposta.
- Caso retorne true: deve ser exibida a question_acumular_bonus na tela, permitindo que o cliente utilize ou não seu bônus disponível nesta compra;
- Caso retorne false: deve ser aplicado o desconto do bônus automaticamente, sem a possibilidade de acumulo do bônus.
Respostas de Erro:Loja Inválida: quando o body loja_id não foi enviado.
Total Bruto Inválido: quando o body valor_bruto não foi enviado.
Cliente Inválido: quando o body customer_id não foi enviado.
Dicionário de Dados | Resposta
| Campo | Descrição |
|---|---|
| tem_bonus | Informa se o cliente possui bônus para o resgate. |
| saldo_bonus | Saldo de bônus disponíveis para uso nesta compra. |
| produtos | Produtos vinculados ao bônus. |
| ids_bonus | IDs dos bônus disponíveis para uso nesta compra. |
| restricao_horario | Informa se há alguma restrição no horário da requisição. |
| flag_acumular_bonus | Informa se está configurada a possibilidade de acumulo do bônus. |
| question_acumular_bonus | Pergunta a ser exibida na tela caso haja a possibilidade de acumulo do bônus. |
| primeira_data_valida | Primeira data em que o bônus esteve disponível para resgate. |
| msg_venda_prime | Mensagem de venda do módulo Prime. |
| msg_venda_prime_obrigado | Mensagem de agradecimento do módulo Prime. |
| validade_inicio | Data em que o bônus está disponível para resgate. |
| validade_fim | Data em que o bônus deixa de estar disponível para resgate. |
| valor | Valor total do bônus. |
| block_partial_redemption | Informa que a loja possui bloqueio de resgate parcial, não deixando aplicar o resgate se o valor minimo da compra não for atingido, |
| msg_block_valor_min_compra | Mensagem do valor minimo da compra para permitir o resgate de bonus |