O Banco de Dados

Rewards - Extrato

MasterData - Entidade RW

Os campos utilizados para o Extrato serão:

E-mail Usuário: identificação do usuário na VTEX, o e-mail que será utilizado;

Data e Hora: informações do momento de adição do registro, de data e hora;

Pedido: número do pedido que gerou o registro, seja de crédito ou de débito;

Valor do Pedido: valor do pedido indicado;

Giftcard: número do Giftcard que foi atualizado;

Valor: cálculo de crédito ou débito à ser atualizado no Giftcard. Valor pode ser negativo (para débito) ou positivo (para crédito);

Pendente até: data da liberação do crédito, ou seja, data do registro+30 dias.

Liberado: campo booleano, preenchido como false inicialmente. Passados os 30 dias para liberação, deve ser alterado para true, para que o Valor seja aplicado do Giftcard;

Transação: informação do tipo de atualização, baseado no Valor - Crédito ou Débito;

Tipo: informação de onde a atualização é proveniente: Giftcard ou Rewards.

APIs - MasterData

Os métodos e chamadas utilizamos serão os mesmos já indicados acima, tanto para Criação de Registro quanto para atualização desses Registros.

APIs - GiftCard

Listar Giftcards- https://ambiente.vtexcommercestable.com.br/api/gift-card-system/pvt/giftCards?customerId={customerId}

A utilização dessa API será para listar as carteiras de Giftcard vinculadas à um usuário.

A variável customerId é o campo userProfileId, valor encontrado utilizando a API de Orders, puxando as informações do Pedido: https://documenter.getpostman.com/view/487146/S1LyUnDN?version=latest#15a2050b-c544-40fd-8762-2613a731472c

Criar Giftcard- https://ambiente.vtexcommercestable.com.br/api/gift-card-system/pvt/giftCards

Em casos em que o usuário não possuir Giftcards, ou seja, nada é retornado na API de Listar Giftcards, é necessário criar um Giftcard com esse request.

Essa chamada retornará uma resposta com as informações do Giftcard criado.

Adicionar ou Remover Crédito- https://{{accountName}}.{{environment}}.com.br/api/gift-card-system/pvt/giftCards/{cardId}/credit

Essa chamada será utilizada para atualizar o Giftcard, adicionando ou removendo crédito. Há dois parâmetros a serem utilizados na chamada:

"description": será uma observação adicionada à atualização;

"value": será o valor, em centavos, da atualização. Pode ser tanto positivo quanto negativo.

https://documenter.getpostman.com/view/18468/vtex-giftcard-system-api/6YtyvrM?version=latest#intro