Skip to main content
POST
Carimbar cartão

Carimbar Cartão

Adiciona um carimbo a um cartão fidelidade de um cliente. Se o cartão for completado, a recompensa é automaticamente disponibilizada.

Comportamento atual

  • a rota aceita X-Idempotency-Key para retry seguro
  • o card_id esperado aqui é o user_loyalty_progress.id retornado por GET /api/v1/public/loyalty-cards
  • a resposta atual retorna o shape de PublicLoyaltyCardResponse

Path Parameters

string
required
ID do progresso retornado por GET /api/v1/public/loyalty-cards

Body Parameters

string
required
ID do cliente dono do cartão (UUID)

Request

Response

Campos da Resposta

string
ID do progresso de fidelidade
string
ID do cliente dono do progresso
integer
Quantidade atual de carimbos após a operação
integer
Total de carimbos necessários
boolean
Se o cartão foi completado com este carimbo
string
Data original de criação do progresso

Headers

X-Idempotency-Key
string | null
X-API-Key
string
required

Chave de API

Path Parameters

card_id
string
required

Body

application/json

Carimbar cartão de fidelidade.

client_id
string
required

ID do cliente

Response

Successful Response

Dados de um cartão de fidelidade.

id
string
required
client_id
string | null
completed
boolean
default:false
created_at
string<date-time> | null
max_stamps
integer
default:0
stamps
integer
default:0