🎁Prêmios

O programa de fidelidade oferece prêmios para resgate, aqui você vai ver como manipular esses prêmios.

Listando prêmios disponíveis para resgate

Nesse endpoint você vai conseguir ver os produtos e cupons que estão disponíveis para resgate filtrando por tipo.

Lista os prêmios disponíveis à partir de filtro

GET https://gateway-awards.fidelizarmais.com/api/v1/protected/awards-available

Para listar os prêmios, é necessário que você informe o storeId (id da loja) e também o coupon (bool que valida se é cupom ou não)

Path Parameters

Name
Type
Description

storeId*

guid

id da loja

coupon*

bool

pesquisa por prêmios que são cupons (true) e que não são (false)

offset

int

quantidade de itens que devem ser pulados

limit

int

quantidade de itens que devem ser retornados

name

string

nome do prêmio

visible*

bool

sempre colocar true

Headers

Name
Type
Description

store-key*

guid

id da loja

secret-key*

guid

chave secreta

Listando cupons resgatados por um cliente

Aqui você consegue ver todos os cupons que um cliente específico já resgatou.

Lista os cupons resgatados por documento

GET https://sandbox.fidelizarmais.com/api/v1/protected/coupon-award/by

Para listar os cupons resgatados, é necessário que você informe o storeId (id da loja) e também o document (CPF/CNPJ do cliente)

Path Parameters

Name
Type
Description

storeId*

guid

id da loja

document*

string

CPF/CNPJ, somente números

Headers

Name
Type
Description

store-key*

guid

id da loja

secret-key*

guid

chave secreta

Last updated