Developer API

Uso del cupón

Es posible gestionar el uso de cupones manualmente desde el panel de control,
pero con esta API puedes automatizar el proceso en tu sitio web cuando los usuarios utilicen un cupón, lo que permite una gestión más eficiente.

Esta API está disponible a partir del plan Personal.

Http Header

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

Request

{
	"cpnNo": "ZJLF0399WQBEQZJM",
	"userId": "x77hu",
	"memo": "IP Address: 210.123.111.222, Request Page: example.com/shop/bags/p112233"
}

Campos	Descripción de los campos	Descripción	Tipo
cpnNo	Coupon number	Número de cupón “canjeado” a procesar. Ingrese solo el número de cupón, excluyendo el signo “-”.	string
onsitePwd	On-site coupon usage password	Si se ha configurado una contraseña para el uso en tienda, ingrese la contraseña establecida. Si la contraseña es incorrecta, no podrá usar el cupón.	string
userId	User ID	Se utiliza para gestionar quién ha emitido y canjeado los cupones. Si el valor del número máximo de canjes por persona es entre 2 y 5, debe ingresar el ID de usuario. Normalmente, introduzca el ID de inicio de sesión del miembro registrado en su sitio web.	string
memo	Notes	Puede ingresar notas para gestionar los canjes de cupones. Ingrese la dirección IP del usuario, la página y el servicio donde se canjeó el cupón, y otra información. Cuando el número máximo de canjes por persona es ilimitado, no sabrá quién canjeó el cupón, por lo que puede gestionar por nombre de usuario o nota.	string

Response

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

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