Skip to main content

Comprobar cupón

POST https://backend.qrupones.com/coupon/checkCoupon

Seguridad​

Esta api utiliza clientSecret, user y password como método de autenticación.

  • Name: X-QRAPI-SECRET
  • Name: X-QRAPI-USER
  • Name: X-QRAPI-PASS
  • In: headers

Consulta cómo obtener las Credenciales

Parámetros de solicitud​

NombreDescripciónRequeridoTipo
CodigoCódigo del cupónRequeridostring
SucursalIDID de la SucursalRequeridonumber

Ejemplo de solicitud​

{
"Codigo": "WNDDJ",
"SucursalID": 81823
}

Respuesta​

CodeDescription
200Retorna todos los datos del cupón
400Retorna los posibles errores de la solicitud
401Unauthorized

Estados del cupon​

info

Estos son los tipos de estados de cupones

export enum CouponStatesEnum {
Vigente = 0,
Usado = 1,
Expirado = 2
}

export enum CouponStatesNames {
Vigente = 'Vigente',
Usado = 'Usado',
Expirado = 'Expirado',
Invalido = 'Invalido'
}

Uso 📝​

check-coupon.js
const headers = new Headers()
headers.append('X-QRAPI-SECRET', 'yourClientSecret')
headers.append('X-QRAPI-USER', 'yourUser')
headers.append('X-QRAPI-PASS', 'yourPassword')

const requestOptions = {
method: 'POST',
headers: headers,
body: JSON.stringify({
Codigo: 'yourCouponCode',
SucursalID: 123
}),
redirect: 'follow'
}

fetch('https://backend.qrupones.com/coupon/checkCoupon', requestOptions)
.then((response) => response.json())
.then((result) => console.log(result))
.catch((error) => console.error('error', error))

Respuesta exitosa ✅​

{
"data": {
"CuponID": 1234,
"CodigoQR": "WNDDJ",
"EstadoQR": 1,
"CantidadCanjes": 0,
"CanjesMaximos": 5,
"FechaExpiracion": "2023-12-31T23:59:59.000Z",
"CampanaID": 1,
"MensajeCanje": "Campaña de Ejemplo",
"ClienteNombre": "Cliente Genérico",
"Celular": "123456789",
"CodigoPais": 591,
"Nit": "1234567",
"EstadoCupon": "Usado",
"TipoCampana": "Descuento porcentual",
"TipoCampanaDetalle": 20
}
}

Respuesta exitosa - Cupón no encontrado ℹ️​

{
"data": "Cupón no encontrado o no válido para esta sucursal"
}

Respuesta con error ⚠️​

{
"errors": [
{
"msg": "No existen los parametros de seguridad en la solicitud"
}
]
}