Listar bonificações

Utilizado para listar todas as bonificações do seu ambiente, podendo usar filtros.

Listar bonificações de um cliente específico:

GET /bonificacoes/?cliente={cliente}

Exibindo mais registros

GET /bonificacoes/?cliente={cliente}&limit=25&offset=50

Query Params

Name
Type
Description

cliente

String

Identificador único do cliente.

referencia_externa

String

Filtrar pelo Identificador do seu sistema

offset

integer

Elemento inicial da lista

limit

integer

Número de elementos da lista (max: 25)

{ 
  "totalCount": 4,
  "limit": 25,
  "offset": 0,
  "dados":[
    {
        "id": "14587",
        "cliente": "155",
        "modalidade": "pontos",
        "descricao": "Resgate de Pontos",
        "grupo": "",
        "referencia_externa": "123459",
        "validade": "",
        "pontos": {
            "operacao": "resgate",
            "pontos": 10
        }
    },
    {
        "id":"14586",
        "cliente":"155",
        "modalidade": "pontos",
        "descricao":"Entrada de Pontos",
        "grupo": "geral",
        "referencia_externa": "123458",
        "validade": "2026-01-01",
        "pontos": {
            "operacao":"entrada",
            "pontos": 35
        }
    },
    {
        "id":"14585",
        "cliente":"154",
        "modalidade": "cashback",
        "descricao":"Entrada de Cashback",
        "grupo": "geral",
        "referencia_externa": "123457",
        "validade": "2026-01-01",
        "cashback": {
            "operacao":"entrada",
            "cashback": 17.30
        }
    },
    {
        "id":"14584",
        "cliente":"153",
        "modalidade": "venda",
        "descricao":"Compra",
        "grupo": "geral",
        "referencia_externa": "123456",
        "validade": "2026-01-01",
        "venda": {
            "valor": 150.30,
            "cashback_resgatado": 25
        }
    }
  ]
}

Last updated