Skip to content

Programa de fidelidade

Nesta requisição será retornada todas as configurações relacionadas ao programa de fidelidade do estabelecimento em questão na qual for passado o id do parceiro.

Como descobrir o ID do Parceiro?

Para consultar todos os estabelecimentos na qual o seu token possui permissão, realize uma requisição para o endpoint de listagem dos estabelecimentos.

bash
curl --location --request GET 'https://sandbox.fidelizii.com.br/api/v4/estabelecimentos/999999/fidelidade' \
--header 'app-token: {{app-token}}' \
--header 'access-token: {{access-token}}'

Ao realizar a requisição, você irá se deparar com um retorno parecido com o exemplo abaixo:

json
{
    "success": true,
    "message": "Programa de fidelidade retornado com sucesso",
    "data": {
        "label": "Multi-prêmios por pontos",
        "validade": 6, // Regra de validade dos pontos (Meses)
        "descricao": "Troque por Prêmios!",
        "chamada": "Junte pontos e:",
        "observacao": "A cada R$ 10,00 gastos você ganha 1 ponto",
        "id_parceiro": "0000",
        "conversao_dinheiro": { // Regra de conversão de Pontos do programa
            "ativo": 1,
            "pontos": 1,
            "valor": 10
        },
        "carencia_ponto": "dia-conquista", // Regra de carência (Ponto conquistado pode ser usado no dia ou não)
        "travas_seguranca": {
            "interacoes_dia": 10, // Quantas interações o cliente final pode realizar no dia
            "intervalo_interacoes": 0, // Intervalo em minutos entre as interações
            "minimo_pontos_interacao": 1, // Mínimo de pontos por interação
            "maximo_pontos_interacao": 1000 // Máximo de pontos por interação
        },
        "atendentes": {
            "solicitar_senha_pontuar": 1,
            "solicitar_senha_resgate": 1
        },
        "premios_fidelidade": [
            {
                "id_premio": 11111,
                "id_parceiro": 11111,
                "nome": "R$ 10,00 de desconto em sua próx. compra",
                "pontos_compra": 100, // Pontos necessários para realizar o resgate desta premiação
                "resgate_mesmo_dia": 0,
                "tipo_beneficio": "vale_compras",
                "valor_beneficio": 10
            },
            {
                "id_premio": 11111,
                "id_parceiro": 11111,
                "nome": "Suco de Laranja",
                "pontos_compra": 150,
                "resgate_mesmo_dia": 0,
                "tipo_beneficio": "produto_servico",
                "valor_beneficio": null
            },
            {
                "id_premio": 11111,
                "id_parceiro": 11111,
                "nome": "10% de desconto em sua próx. compra",
                "pontos_compra": 150,
                "resgate_mesmo_dia": 0,
                "tipo_beneficio": "desconto_percentual_compra",
                "valor_beneficio": 10
            },
            {
                "id_premio": 11111,
                "id_parceiro": 11111,
                "nome": "10% de desconto em itens da linha X",
                "pontos_compra": 150,
                "resgate_mesmo_dia": 0,
                "tipo_beneficio": "desconto_percentual_item",
                "valor_beneficio": 10
            },
            {
                "id_premio": 11111,
                "id_parceiro": 11111,
                "nome": "10 pontos adicionais no programa de fidelidade",
                "pontos_compra": 150,
                "resgate_mesmo_dia": 0,
                "tipo_beneficio": "fidelidade",
                "valor_beneficio": 10
            }
        ]
    }
}