API de eliminación de cupones

La API de eliminación de cupones de Vivoldi permite eliminar permanentemente cupones ya emitidos.

Una vez eliminado, el cupón se invalida de inmediato y cualquier intento de uso será bloqueado.
Para eliminar varios cupones en lote, utilice el panel de control.

Esta API está disponible a partir del plan Personal.

DELETE

/api/coupon/v1/delete?cpnNo={cpnNo} 


DELETE /api/coupon/v1/delete
        ?cpnNo=ZJLF0399WQBEQZJM

Request Parameters

cpnNostringrequired
Número de cupón. 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

code integer
Código de respuesta: 0 = Éxito, otros valores = Error
message string
Mensaje de respuesta. Si el código no es 0, se devuelve un mensaje de error.
result null

Cuándo usar esta API

Utilice esta API en los siguientes casos:

  • Bloquear inmediatamente cupones emitidos por error
  • Limpiar cupones tras finalizar una campaña
  • Eliminar cupones duplicados o de prueba
  • Desactivar cupones con riesgo de uso indebido

En entornos de producción, se utiliza principalmente para el control de riesgos más que para una simple limpieza.

Diferencia entre eliminación y expiración

Existen dos formas de impedir el uso de un cupón.

Si se establece endYmd (fecha de expiración) en una fecha pasada, el cupón queda expirado pero los datos se conservan y puede reactivarse posteriormente.
En cambio, al utilizar la API de eliminación, el cupón se elimina de forma permanente y no puede recuperarse.

Si solo necesita desactivarlo temporalmente, se recomienda ajustar la fecha de expiración mediante la API de actualización en lugar de eliminarlo.

Casos de uso

  • Limpieza tras campañas: Elimine cupones innecesarios tras finalizar un evento para mantener el listado organizado
  • Eliminar cupones inválidos: Borre de inmediato cupones creados por error, para pruebas o con configuraciones incorrectas
  • Bloquear cupones filtrados: Si un código se expone, utilice la API para impedir su uso al instante

Después de eliminarlos, el mismo código puede reutilizarse para crear un nuevo cupón.

Aspectos a tener en cuenta

La eliminación es irreversible. Verifique lo siguiente antes de continuar:

  • Asegúrese de que el cupón no esté en uso en una campaña activa.
  • Si elimina un cupón ya distribuido, los usuarios recibirán un error al intentar usarlo.
  • Los datos analíticos pueden eliminarse. Guarde el historial si lo necesita.