/consulta_bonus

API responsável pela consulta do saldo de bônus.

Dicionário de Dados | Requisição

{
    "nome": "João Silva",
    "celular": "11985728710",
    "valor_bruto": 100,
    "items": [
        {
            "sku": "ABC-12345-S-BL",
            "value_of": 100,
            "value_per": 80,
            "quantity": 1
        }
    ]
}
CampoDescrição
nomeNome do cliente.
celularNúmero de celular do cliente com DDD e sem o uso da máscara.
valor_brutoValor da compra antes da aplicação do saldo de bônus.
[items] skuIdentificador do produto.
[items] value_ofValor base de referência do produto.
[items] value_perValor do produto com desconto.
[items] quantityQuantidade do produto.

Dicionário de Dados | Resposta

{
    "status": true,
    "message": "sucesso",
    "data": {
        "tem_bonus": true,
        "saldo_bonus": 30,
        "bonus_total": 264,
        "compra_minima": 880,
        "produtos": "",
        "ids_bonus": "136473650,136473651",
        "restricao_horario": false,
        "is_multi_resgate": true,
        "primeira_data_valida": "2024-07-10 00:00:00",
        "historico": [
            {
                "validade_inicio": "2024-07-10 00:00:00",
                "validade_fim": "2025-10-10 23:59:00",
                "valor": 189
            },
            {
                "validade_inicio": "2024-07-10 00:00:00",
                "validade_fim": "2025-05-05 23:59:00",
                "valor": 75
            }
        ],
        "loja_id": 100164,
        "user_id": 27056298,
        "user_name": "João Silva",
        "user_cpf": 40541655086
    }
}
CampoDescrição
tem_bonusInforma se o cliente possui bônus disponíveis para resgate.
saldo_bonusSaldo do bônus disponível para uso nessa compra.
bonus_totalValor total do bônus.
compra_minimaValor de compra necessária para utilização do "bonus_total".
produtos
ids_bonusIDs dos bônus disponíveis.
primeira_data_validaPrimeira data em que o bônus esteve disponível para resgate.
validade_inicioData em que o bônus está disponível para resgate.
validade_fimData em que o bônus deixa de estar disponível para resgate.
valorValor do bônus disponível para uso baseado na compra realizada (valor_bruto).
loja_idID da loja na CRMBonus.
user_idID do cliente na CRMBonus.
user_nameNome do cliente.
user_cpfNúmero de CPF do cliente.
Body Params
string
Defaults to João Silva

Nome do cliente.

int32
required
Defaults to 11985728710

Número de celular do cliente com DDD e sem o uso da máscara.

float
required
Defaults to 100

Valor da compra antes da aplicação do saldo de bônus.

items
array of objects

Obrigatório apenas quando a configuração "motor v2" na CRMBonus estiver ativa

items
Headers
string
required

Token de autenticação.

string
required

Código da empresa enviado pela CRMBonus.

string
required

Nome do sistema que está realizando a requisição.

string
required
Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json