Developer API

Editar cupón

Esta API permite modificar la información de un cupón ya creado.
Sin embargo, si el cupón ya ha sido utilizado, solo se puede editar el campo "memo"; los demás campos no se pueden modificar.

Esta API está disponible a partir del plan Personal.

Http Header

PUT /api/coupon/v1/update
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: application/json
User-agent: {Your User-agent}
Accept-Language: en

Request

{
	"cpnNo": "",  // You can specify a coupon code manually. If left empty, a 16-character code will be generated automatically by the system.
	"grpIdx": 271,
	"tmplIdx": 0,
	"nm": "$5 discount coupon",
	"discTypeIdx": 458,
	"disc": 5,
	"strtYmd": "2025-01-01",
	"endYmd": "2025-12-31",
	"onsiteYn": "Y",
	"onsitePwd": "123456",
	"memo": "New Member Registration, IP: 211.111.222.33",
	"url": "https://bestshop.com",
	"useLimit": 1,
	"userId": "att78z",
	"userNm": "Brown Smith",
	"userPhnno": "+1 123-4567-8900",
	"userEml": "",
	"userEtc1": "Gold rating",
	"userEtc2": ""
}

Campos	Descripción de los campos	Descripción	Tipo
cpnNo	Código del cupón	Código del cupón que se desea modificar. Ingrese el código sin el símbolo "-".	string
grpIdx	Grupo de cupones	El grupo de cupones se utiliza para clasificar los cupones. Si hay conflicto entre la configuración del grupo y la del cupón, se aplicará la del grupo. El índice del grupo se puede consultar en la página de grupos de cupones del panel. Valor predeterminado: 0	int
tmplIdx	Plantilla de cupón	La plantilla del cupón se utiliza para mostrar la descripción, el uso, el destino y las advertencias del cupón al usuario. El índice de plantilla se puede consultar en la página de plantillas de cupones del panel. Valor predeterminado: 0	int
nm	Nombre del cupón	El nombre del cupón que se mostrará en la página del cupón.	string
discTypeIdx	Tipo de descuento	Establece el tipo de descuento del cupón (porcentaje o monto). 457: Porcentaje (%), 458: Monto fijo Use porcentaje para aplicar un descuento en %. Use monto para aplicar un descuento con un valor específico.	int
disc	Valor de descuento	Si el tipo de descuento es porcentaje (457), ingrese un valor entre 1% y 100%. Si es monto fijo (458), ingrese el monto del descuento.	double
discCurrency	Moneda	Configure la unidad monetaria cuando se utilice descuento por monto (458). KRW, CAD, CNY, EUR, GBP, IDR, JPY, MUR, RUB, SGD, USD Valor predeterminado: KRW	string
strtYmd	Fecha de inicio	Establece la fecha desde la cual el cupón será válido. Formato de fecha: yyyy-mm-dd (10 caracteres) Ejemplo: 2024-10-01	date
endYmd	Fecha de vencimiento	Establece la fecha límite para usar el cupón. Formato de fecha: yyyy-mm-dd (10 caracteres) Ejemplo: 2024-12-31	date
onsiteYn	¿Cupón presencial?	Si el valor es Y, se mostrará un botón “Usar cupón” en la página. El cliente muestra el cupón al personal, quien lo valida. Ideal para tiendas físicas.	Y o N
onsitePwd	Contraseña del cupón presencial	Si se configura una contraseña, el personal deberá ingresarla para validar el cupón. Esto evita que el usuario lo use por su cuenta.	string
memo	Nota	Utilizado para fines de gestión interna. No se muestra al usuario.	string
url	URL	Si se ingresa una URL, se mostrará un botón “Ir a usar el cupón” en la página. Si se ha subido una imagen del cupón, al hacer clic también se redirigirá a esa URL.	string
useLimit	Límite de uso por persona	Establece cuántas veces una persona puede usar el cupón. Valores entre 2 y 5 requieren el uso de la API REST de Vivoldi y se debe proporcionar el ID del usuario. Si se gestiona manualmente desde el panel, solo se puede elegir entre “Ilimitado” o “1 vez”. 0: Ilimitado, 1: 1 vez, 2: 2 veces, 3: 3 veces, 4: 4 veces, 5: 5 veces	int
color	Color del texto	Establece el color del texto en la página del cupón. Debe estar en formato HEX, hasta 9 caracteres incluyendo transparencia. Valor predeterminado: #4F4F4FFF	string
background	Color de fondo	Establece el color de fondo del cupón en la página. Debe estar en formato HEX, hasta 9 caracteres incluyendo transparencia. Valor predeterminado: #FFFFFFFF	string
userId	ID del usuario	Se utiliza para identificar quién recibió y usó el cupón. Obligatorio si el límite de uso es de 2 a 5 veces. Generalmente se usa el ID de inicio de sesión del usuario en el sitio web.	string
userNm	Nombre del usuario	Si ya se sabe quién usará el cupón, se puede ingresar su nombre aquí. Útil para gestionar la emisión y uso del cupón.	string
userPhnno	Teléfono del usuario	Número de contacto del usuario que usará el cupón.	string
userEml	Email del usuario	Correo electrónico del usuario que usará el cupón.	string
userEtc1	Información adicional 1	Se puede usar para registrar información adicional del usuario con fines internos.	string
userEtc2	Información adicional 2	Se puede usar para registrar información adicional del usuario con fines internos.	string

Response

{
	"code": 0,
	"message": "",
	"result": "ZJLF0399WQBEQZJM"
}

Campos	Descripción	Tipo
code	Código de respuesta (0:Éxito)	int
message	El mensaje de respuesta, o un mensaje relacionado si el código de respuesta es distinto de cero.	string