Crear cupón

Esta API permite crear cupones de descuento.

Para generar varios cupones a la vez, utiliza el panel de control.

No es posible subir imágenes de cupones a través de la API.
Si necesitas imágenes, primero crea un grupo de cupones en el panel, registra la imagen allí y luego asígnalo al crear el cupón.

Esta API está disponible en planes Personales o superiores.

POST

/api/coupon/v1/create 

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

Request Parameters

cpnNostring
Número de cupón. Entre 8 y 16 caracteres alfanuméricos. Si no se especifica, el sistema lo genera automáticamente. No se permiten caracteres especiales.
Ejemplo: V5H8GR5T
nmstringrequired
Nombre del cupón.
discTypeIdxintegerrequired
Tipo de descuento. (457: Porcentaje %, 458: Monto fijo)
discdoublerequired
Para porcentaje (457): rango de 1 a 100%. Para monto fijo (458): ingresar la cantidad.
discCurrencystring
Unidad de moneda. Obligatorio cuando se usa descuento por monto fijo (discTypeIdx:458).
strtYmddaterequired
Fecha de inicio de validez del cupón. Ejemplo: 2024-10-01
endYmddaterequired
Fecha de expiración del cupón. Ejemplo: 2024-12-31
La fecha de vencimiento solo se puede establecer hasta el 31 de diciembre del año siguiente.
useLimitintegerrequired
Límite de uso del cupón. (0: Ilimitado, 1–5: Número de usos)
Si se establece en 2 o más, es obligatorio especificar userId.
grpIdxinteger
Grupo de cupones. Se utiliza para gestionar cupones por grupos. El IDX del grupo se puede consultar en el panel de control.
Si hay configuraciones duplicadas entre grupo y cupón, prevalece la del grupo.
tmplIdxinteger
Plantilla de cupón. Se utiliza como referencia al crear un cupón. El IDX de la plantilla se puede consultar en el panel.
onsiteYnstring
Indicador de cupón presencial. Muestra el botón “Usar cupón” en la página del cupón.
Necesario para que el personal en tienda valide el cupón.
onsitePwdstring
Contraseña del cupón presencial. Obligatoria al usar el cupón.
memostring
Nota interna de referencia.
urlstring
Si se introduce una URL, se mostrará un botón “Ir a usar cupón” en la página del cupón.
Al hacer clic en el botón o en la imagen se redirige a esa URL.
colorstring
Color del texto del cupón. Ingresar valor HEX. Ejemplo: #4F4F4F
backgroundstring
Color de fondo del cupón. Ingresar valor HEX. Ejemplo: #FFFFFF
userIdstring
Se utiliza para gestionar al destinatario del cupón.
Obligatorio si el límite de uso está entre 2 y 5. Normalmente es el ID de inicio de sesión o nombre del usuario.
userNmstring
Nombre del usuario del cupón. Uso interno.
userPhnnostring
Teléfono del usuario del cupón. Uso interno.
userEmlstring
Correo electrónico del usuario del cupón. Uso interno.
userEtc1string
Campo adicional para gestión interna.
userEtc2string
Campo adicional para gestión interna. 
{
    "code": 0,
    "message": "",
    "result": "ZJLF0399WQBEQZJM"
}

Response Parameters

codeinteger
Código de respuesta: 0 = Éxito, otros valores = Error
messagestring
Mensaje de respuesta. Si el código no es 0, se devuelve un mensaje de error.
resultstring
Valor de respuesta. Se devuelve el número de cupón generado.
Ejemplo: ZJLF0399WQBEQZJM