VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Lives de vendas

Voucher relâmpago

Entrega o código do voucher relâmpago da live ao cliente que assistiu o tempo mínimo, depois que o organizador o revelou.

O voucher relâmpago é um cupom escondido que o organizador libera no meio da live. Ele passa por duas travas: o organizador precisa revelar o voucher, e o cliente precisa ter assistido o tempo mínimo (flash_unlock_after_seconds, 900 segundos, ou 15 minutos, no padrão). Só quando as duas valem, esta rota devolve o código, que o cliente digita no carrinho.

Pontos principais
  • Acompanhe flash.revealed e flash.unlocked no heartbeat para saber quando mostrar o botão de resgatar. O evento flash_voucher.revealed do WebSocket também avisa da revelação.
  • Resgatar não consome o voucher. Chamar a rota duas vezes devolve o mesmo código. Quem limita quantas pessoas usam é o próprio voucher (usage_limit), na hora de aplicá-lo no carrinho.
  • Exige token de cliente.
POST/api/v1/storefront/live-sessions/{id}/flash-voucher/claimCliente

Resgatar o voucher relâmpago

Parâmetros de caminho

iduuidobrigatório
Id da live.

A rota não tem corpo.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/storefront/live-sessions/$SESSION_ID/flash-voucher/claim" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Código liberado
json
{ "code": "LIVE-RELAMPAGO-10" }

Campos da resposta

codestring
Código do voucher para aplicar no carrinho.

Erros

StatusQuandoCorpo
401Sem token de cliente.{"error":"authentication required"}
403O organizador ainda não revelou o voucher, ou a live não tem voucher relâmpago.{"error":"flash_unavailable"}
403O cliente ainda não assistiu o tempo mínimo.{"error":"not_unlocked"}
403Módulo live-commerce desligado.{"error":"module_disabled","module":"live-commerce"}
404A gamificação não está disponível.{"error":"gamification not available"}
Os dois 403 pedem ações diferentes

flash_unavailable é esperar o organizador revelar; not_unlocked é continuar assistindo e enviando heartbeat. Não repita a chamada em loop: use o heartbeat para saber a hora certa.

Veja também

  • Tempo assistido
  • Ranking
  • Erros
Anterior
Ranking da live
Próxima
Mensagens do cliente
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também