Z
Zoppy Partners APIConfig. de Cupom
/coupons-config Consulte a configuração de giftback da empresa. Ela é somente leitura pela Partners API: a edição é feita no painel da Zoppy. Trate esta consulta como referência dos parâmetros padrão da conta, e não como diagnóstico de cupom não gerado: as regras de cada cupom vêm do fluxo de automação que o cria.
Modelo
| Propriedade | Tipo | Descrição | |
|---|---|---|---|
id | string | Obrigatório | ID da configuração (UUID) |
enableGiftback | boolean | Obrigatório | Se o giftback está habilitado nas configurações da conta. O campo é informativo: não é ele que decide se um cupom será gerado, e sim o fluxo de automação que cria o cupom. |
percentValue | number | Obrigatório | Percentual do valor da compra concluída que vira crédito no cupom. |
maxPercentValue | number | Opcional | Teto do percentual aplicado. |
expirationDays | number | Obrigatório | Quantidade de dias de validade do cupom a partir da criação. |
startDays | number | Opcional | Dias de carência antes do cupom passar a valer. |
acumulative | boolean | Opcional | Se o cupom pode ser somado a outras promoções. |
excludeSaleItems | boolean | Opcional | Se itens em promoção ficam fora do cálculo. |
allowedCategories | Array<{ id, name }> | Opcional | Categorias em que o cupom pode ser usado. Vazio significa sem restrição. |
abandonedCartDelay | number | Opcional | Tempo de espera, em minutos, antes de considerar um carrinho abandonado. |
companyId | string | Obrigatório | ID da empresa dona da configuração |