v1

latestOpenAPI 3.1.02026-08-04650218.3 KB

/api_bonus_disponivel

API responsável por realizar a consulta do saldo de bônus disponível do cliente.

post/api_bonus_disponivel

Headers

Authorizationstring required

Token de autenticação.

CodEmpresastring required

Código da empresa enviado pela CRMBonus.

Celularinteger required

Celular do cliente em base64.

Content-Typestring required
System-Namestring required

Nome do sistema PDV que está enviando a requisição

User-Agentstring required

Request body

loja_idinteger required

ID da loja na CRM&Bônus.

customer_idinteger required

ID do cliente na CRM&Bônus.

valor_brutonumber float required

Valor dos produtos em que o desconto do bônus pode ser aplicado.

Response

200

statusboolean
messagestring

Example response

{
  "status": true,
  "message": "sucesso",
  "data": {
    "tem_bonus": true,
    "saldo_bonus": 200,
    "ids_bonus": 135960828,
    "question_acumular_bonus": "O cliente tem BONUS DE 200.00, deseja utilizar agora?",
    "primeira_data_valida": "2024-03-04 00:00:00",
    "historico": [
      {
        "validade_inicio": "2024-03-04 00:00:00",
        "validade_fim": "2024-04-03 23:59:59",
        "valor": 200
      }
    ]
  }
}