Criar nova bonificação

Utilizado para inserir uma nova bonificação para um cliente.

De acordo com a modalidade da bonificação que deseja realizar, informe apenas um dos objetos: venda, cashback ou pontos.

POST /bonificacoes

Body Params

Name
Type
Description

cliente*

String

Identificador único do cliente.

modalidade*

String

venda, cashback, pontos

descricao

String

Descrição do bonificação

grupo**

String

Tag identificador único do grupo de bonificação. **Obrigatório para modalidade de venda e para operações de entrada nas modalidades de pontos e cashback

referencia_externa

String

Campo livre para busca

object

Informações de bonificação para modalidade venda

object

Informações de bonificação para modalidade cashback

object

Informações de bonificação para modalidade pontos

venda (Object)

Name
Type
Description

valor*

float

Valor da venda, sem desconto de resgate.

cashback_resgatado

float

Valor do Cashback Resgatado a ser aplicado sobre o valor da venda.

cliente_indicacao

String

Identificador único do cliente que indicou. Obs: O programa de indicação deve estar devidamente configurado.

cashback (Object)

Name
Type

operacao*

String

entrada, resgate

cashback*

float

Valor de Cashback da bonificação.

pontos (Object)

Name
Type
Description

operacao*

String

entrada, resgate

pontos*

int

Quantidade de Pontos da bonificação.

{
    "id":"14584",
    "cliente":"153",
    "modalidade": "venda",
    "descricao":"Compra",
    "grupo": "geral",
    "referencia_externa": "123456",
    "validade": "2026-01-01", // **
    "venda": { // **
        "valor": 150.30,
        "cashback_resgatado": 25, // **
        "cashback": 20, // **
        "pontos": 200, // **
        "cliente_indicacao": "15254", // **
        "indicacao": { // **
            "indicou_cashback": 25.50, // **
            "indicou_pontos": 10, // **
            "indicado_cashback": 15, // **
            "indicado_pontos": 4, // **
        }
    },
    "cashback": { // **
        "operacao":"entrada",
        "cashback": 17.30
    },
    "pontos": { // **
        "operacao":"resgate",
        "pontos": 200
    }
}

/* 
    ** Este parâmetro pode não ser retornado, dependendo das informações 
    enviadas ou configurações do programa de bonificação.
*/

Last updated