Obtener los planes de lealtad por negocio
API operation: Open the endpoint in Scalar
Usa GET /loyalty_plans/{loyalty_plan_id}/businesses para listar las configuraciones específicas de negocio asociadas con un plan de lealtad. La operación es BusinessLoyaltyPlan.findAll.
La operación requiere autenticación de administrador. Cada elemento devuelto identifica un negocio y puede incluir ajustes de acumulación, canje, límites máximos y vencimiento.
Para conocer los conceptos relacionados con el recurso, consulta Modelo de planes de lealtad por negocio.
Referencia de OpenAPI
Operación: GET /loyalty_plans/{loyalty_plan_id}/businesses
Parámetros de ruta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
loyalty_plan_id | integer | Sí | — |
Parámetros de consulta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
params | string | No | Lista 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. |
orderBy | string | No | Campo de ordenamiento, con - como prefijo para indicar orden descendente. Se pueden encadenar varios campos separados por comas. |
page | integer | No | Número de página, empezando en 1. Solo se aplica a las listas que devuelven un bloque de paginación. |
page_size | integer | No | Cantidad de elementos por página. |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta exitosa. result es la proyección de BusinessLoyaltyPlan que el cliente pidió en ?params (por defecto, $fillable menos $hidden). |
| 400 | Respuesta de error (error=true). Los errores de validación y de negocio comparten este código. |
| 401 | Respuesta 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. |
| 404 | Respuesta vacía: la versión de API solicitada no está admitida. |
| 429 | Envelope 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. |
| 500 | Respuesta de error: falló la búsqueda o inicialización del proyecto. |
| 503 | Envelope 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). |