Docs
APIReferênciaCupons e promoções

Criar cupom ou promoção

Cria um desconto em porcentagem ou valor, com prazo, limite de usos, gasto mínimo e produtos.

Permissão da chave: Catálogo › escrever.

Autenticação

bearer
headerAuthorizationBearer <chave de API>

Chave de API da loja (Painel › Integrações › Chaves de API)

Headers

Idempotency-Key?string

Chave única por operação (ex.: o id do pedido no seu sistema). Repetir a chamada com a mesma chave devolve a mesma resposta, sem duplicar.

Padrão (regex)^[A-Za-z0-9._:-]+$
Tamanho8 <= length <= 255

Corpo da requisição

application/json
  1. body
method*string
Valor em"AUTOMATIC""CODE"
code?string
Padrão (regex)^[A-Z0-9_-]{3,32}$
name*string
Tamanho1 <= length <= 60
kind*string
Valor em"PERCENT""FIXED"
value*number
Intervalo1 <= value <= 2147483647
scope?string
Valor em"ALL""CATEGORIES""PRODUCTS"
categoryIds?array<string>
Itensitems <= 100
productIds?array<string>
Itensitems <= 500
startsAt?string
endsAt?string
maxUses?number
Intervalo1 <= value <= 2147483647
maxUsesPerCustomer?number
Intervalo1 <= value <= 2147483647
minSubtotal?
customerId?string
requiredProductIds?array<string>
Itensitems <= 50
startCommands?array<>
Itensitems <= 5
endCommands?array<>
Itensitems <= 5
active?boolean

Corpo da resposta

Exemplo de requisição
curl -X POST "https://api.rivoo.gg/v1/discounts" \  -H "Authorization: Bearer $RIVOO_API_KEY" \  -H "Idempotency-Key: pedido_123" \  -H "Content-Type: application/json" \  -d '{"method":"AUTOMATIC","name":"string","kind":"PERCENT","value":1}'
Exemplo de resposta
Vazio

Arquivar cupom ou promoção DELETE

Encerra o desconto. Pedidos que já usaram continuam com ele. **Permissão da chave:** Catálogo › escrever.

Listar cupons e promoções GET

Lista cupons (com código) e promoções automáticas da loja. **Permissão da chave:** Catálogo › ler.