Saltar al contenido principal

Crear un plan de lealtad

API operation: Open the endpoint in Scalar

Usa POST /loyalty_plans para crear un plan de lealtad. La operación descrita aquí es LoyaltyPlan.register.

El esquema documentado requiere autenticación de administrador y actualmente exige name, type, redemption_rate, accumulation_rate y businesses.

Consulta Modelo de plan de lealtad y Modelo de planes de lealtad por negocio.

Referencia de OpenAPI​

Operación: POST /loyalty_plans

Campos del cuerpo de la solicitud

NombreTipoObligatorio
accumulation_ratenumberSí
businessesarray<any>Sí
expire_after_minutesinteger | nullNo
maximum_accumulationnumber | nullNo
maximum_redemption_ratenumberNo
maximum_redemption_typeinteger | nullNo
nameanySí
redemption_ratenumberSí
typestringSí

Respuestas

CódigoDescripción
200Envelope de éxito. result es la instancia serializada de LoyaltyPlan ($fillable menos $hidden).
400Respuesta de error (error=true). Los errores de validación y de negocio comparten este código.
401Respuesta de error: sesión ausente, inválida, o nivel de usuario fuera de los permitidos. Respuesta de error: el proyecto no existe o no tiene una suscripción activa.
404Respuesta vacía: la versión de API solicitada no está admitida.
429Envelope de error: se excedió un límite de consumo del proyecto (o el sujeto está baneado). Lleva Retry-After y X-RateLimit-Limit/Remaining/Reset/Scope/Key.
500Respuesta de error: falló la búsqueda o inicialización del proyecto.
503Envelope de error: la aplicación está temporalmente en mantenimiento. Envelope de error: el proyecto está temporalmente en mantenimiento, o los límites de consumo no se pudieron evaluar y el límite aplicable está configurado con on_error = closed (cabecera Retry-After: 1).
Abrir esta operación en la Referencia de la API