Skip to main content
Os endpoints de tiers permitem consultar os níveis de fidelidade disponíveis no programa e o progresso do cliente.

Status de Autenticação dos Endpoints

EndpointStatus
GET /pub/widget/tiersPúblico

Listar Tiers

Retorna todos os níveis de fidelidade disponíveis no programa.

Requisição

GET /pub/widget/tiers Headers
X-Bq-Tenant
string
required
Identificador público da loja.

Exemplo

curl -X GET "https://api.bonifiq.com.br/pub/widget/tiers" \
  -H "X-Bq-Tenant: {tenant_key}"

Resposta

{
  "HasError": false,
  "Message": null,
  "Item": [
    {
      "Id": 1,
      "Name": "Bronze",
      "Color": "#CD7F32",
      "MinPoints": 0,
      "MaxPoints": 999,
      "Benefits": [
        "Acesso a recompensas básicas",
        "1 ponto a cada R$ 1,00 gasto"
      ],
      "Icon": "bronze-medal",
      "IsCurrent": false
    },
    {
      "Id": 2,
      "Name": "Prata",
      "Color": "#C0C0C0",
      "MinPoints": 1000,
      "MaxPoints": 4999,
      "Benefits": [
        "Acesso a recompensas exclusivas",
        "1.5 pontos a cada R$ 1,00 gasto",
        "Frete grátis acima de R$ 100"
      ],
      "Icon": "silver-medal",
      "IsCurrent": true
    },
    {
      "Id": 3,
      "Name": "Ouro",
      "Color": "#FFD700",
      "MinPoints": 5000,
      "MaxPoints": 9999,
      "Benefits": [
        "Acesso a todas as recompensas",
        "2 pontos a cada R$ 1,00 gasto",
        "Frete grátis",
        "Acesso antecipado a promoções"
      ],
      "Icon": "gold-medal",
      "IsCurrent": false
    },
    {
      "Id": 4,
      "Name": "Diamante",
      "Color": "#B9F2FF",
      "MinPoints": 10000,
      "MaxPoints": null,
      "Benefits": [
        "Benefícios exclusivos VIP",
        "3 pontos a cada R$ 1,00 gasto",
        "Frete grátis expresso",
        "Atendimento prioritário",
        "Presentes especiais"
      ],
      "Icon": "diamond",
      "IsCurrent": false
    }
  ]
}
O campo IsCurrent indica qual é o tier atual do cliente autenticado. As informações detalhadas do tier atual também estão disponíveis no endpoint /pub/widget/customer/info.