v1

latestOpenAPI 3.1.02026-08-04650218.3 KB

/api_consulta_bonus

Este endpoint retorna o saldo dos bônus disponíveis do cliente com a informação adicional da compra mínima que o cliente precisa fazer para resgatar 100% do bônus disponível.

post/api_consulta_bonus

Headers

Celularstring required

Celular do cliente em base64.

CodEmpresastring required

Código da empresa enviado pela CRMBonus.

Authorizationstring required

Token de autenticação.

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.

Response

200

statusboolean
messagestring

Example response

{
  "status": true,
  "message": "sucesso",
  "data": {
    "tem_bonus": true,
    "saldo_bonus": 200,
    "compra_minima": 400,
    "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
      }
    ]
  }
}