Z
Zoppy Partners APICupons
/coupons Gerencie cupons de desconto. Suporta cupons individuais (vinculados a um cliente) e compartilhados (shared, com limite de uso). Para entender quando o cupom é criado pela Zoppy e chega até você por webhook, e quando é você que registra o cupom aqui, veja a página Fluxo de Cupons, no menu Geral.
Modelo
| Propriedade | Tipo | Descrição | |
|---|---|---|---|
id | string | Obrigatório | ID único do cupom (UUID) |
externalId | string | null | Opcional | ID do cupom no seu sistema/provedor |
code | string | Obrigatório | Código do cupom |
type | string | Opcional | Tipo do cupom. Valores: percent (percentual), fixed_cart (valor fixo) |
amount | number | Obrigatório | Valor do desconto |
used | boolean | Obrigatório | Se o cupom foi utilizado |
isValid | boolean | Obrigatório | Se o cupom está válido |
minPurchaseValue | number | Opcional | Valor mínimo de compra para uso |
expiryDate | Date | Obrigatório | Data de expiração |
startDate | Date | Obrigatório | Data de início de validade |
acumulative | boolean | Obrigatório | Se o cupom pode ser combinado com outras promoções e descontos da loja. Reflete a configuração de giftback do cliente na Zoppy e nunca vem vazio; crie a promoção no seu sistema respeitando esse valor. Em cupom registrado por você em POST /coupons, vem sempre true |
customer | CustomerResponse | Opcional | Cliente vinculado (apenas cupons individuais) |
usageLimit | number | Opcional | Limite de uso (apenas cupons compartilhados) |
createdAt | Date | Obrigatório | Data de criação |
updatedAt | Date | Obrigatório | Data de atualização |