Saltar al contenido principal

Consultar un plan de lealtad

API operation: Open the endpoint in Scalar

Usa GET /loyalty_plans/{loyalty_plan_id} para recuperar un plan de lealtad. La operación es LoyaltyPlan.find.

La operación de detalle requiere autenticación de administrador, a diferencia de la lectura pública de la colección. La respuesta puede incluir información sobre tipo, acumulación, canje, máximos, vencimiento y asignaciones de negocio.

Consulta Modelo de plan de lealtad para los conceptos del recurso.

Referencia de OpenAPI​

Operación: GET /loyalty_plans/{loyalty_plan_id}

Parámetros de ruta

NombreTipoObligatorioDescripción
loyalty_plan_idintegerSí—

Parámetros de consulta

NombreTipoObligatorioDescripción
paramsstringNoLista de campos separados por comas. La lista se cruza con $fillable del modelo; si está vacía o no es válida, se devuelven todos los campos.

Respuestas

CódigoDescripción
200Envelope de éxito. result es la proyección de LoyaltyPlan que el cliente pidió en ?params (por defecto, $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