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

Vouchers

O que é um voucher, quais tipos de desconto existem e como criar, gerar em lote e acompanhar os usos.

Um voucher é um código de desconto que o cliente digita no checkout (por exemplo BEMVINDO10). Ele é diferente de uma promoção (regra automática, sem código) e de um vale-presente (saldo pré-pago). Cada voucher tem um tipo de desconto, regras de uso e um prazo.

Pontos principais
  • A área exige o módulo voucher-system ligado na loja. Nenhuma rota separa leitura de escrita: quem entra pode criar e apagar.
  • O id do voucher é um inteiro.
  • Desconto fixo em centavos (1000 = R$ 10,00). Desconto percentual em pontos-base (1500 = 15,00%, máximo 10000).
  • O código é sempre guardado em maiúsculas e é único.
  • Voucher sem vendor_id vale para o carrinho inteiro; com vendor_id, só desconta os itens daquele seller.
  • Contagem de usos é feita no checkout; aqui você consulta os usos.

Como funciona

  1. Crie um voucher ou gere vários de uma vez.
  2. O cliente digita o código no checkout. A plataforma valida: ativo, dentro do prazo, pedido mínimo, limite total e limite por cliente.
  3. Cada uso vira uma linha em usos e soma em used_count.

Tipos (type)

Valorvalue significaExemplo
fixedDesconto fixo em centavos (maior que zero). Nunca passa do total do pedido.1000 = R$ 10,00
percentagePontos-base, de 1 a 10000.1500 = 15,00%
free_shippingIgnorado: o frete fica grátis.0

Regras de uso

CampoEfeito
min_orderPedido mínimo em centavos. 0 = sem mínimo.
max_usesTotal de usos permitidos. 0 = ilimitado.
max_per_userUsos por cliente. 0 = ilimitado.
starts_at, expires_atJanela de validade (RFC 3339). Vazio = sem limite.
is_activeLiga e desliga sem apagar.

Endpoints

MétodoCaminhoPara quê
GET/api/v1/admin/vouchersLista vouchers
POST/api/v1/admin/vouchersCria um voucher
GET/api/v1/admin/vouchers/{id}Consulta um voucher
PUT/api/v1/admin/vouchers/{id}Altera um voucher
DELETE/api/v1/admin/vouchers/{id}Apaga um voucher
POST/api/v1/admin/vouchers/bulkGera vários
GET/api/v1/admin/vouchers/{id}/redemptionsLista os usos

Erros comuns

  • Percentual em pontos-base. 10 é 0,10%, não 10%. Para 10% envie 1000.
  • Código repetido. Volta 400 voucher code 'X' already exists.
  • Desconto que derruba a margem. Se o Protetor de Margem estiver ativo e o desconto levar produtos abaixo do piso, a criação volta 422 com o detalhamento.
  • Apagar um voucher já usado achando que apaga o histórico. Apagar é definitivo; prefira is_active: false.
  • Gerar mais de 1000 de uma vez. Volta 400; o limite por chamada é 1000.
  • Esperar que o filtro status aceite qualquer palavra. Só active, expired, inactive e exhausted filtram; outro valor é ignorado.

Próximos passos

Vouchers
Crie e mantenha códigos.
Lote e usos
Gere campanhas e veja quem usou.
Anterior
Disputas
Próxima
Vouchers
Nesta página
  • Como funciona
  • Tipos (type)
  • Regras de uso
  • Endpoints
  • Erros comuns
  • Próximos passos