Skip to main content

Módulo de Planes (Plans)

Obtener listado paginado de planes

Este módulo permite consultar los planes disponibles en el sistema mediante un listado paginado. El endpoint admite filtros opcionales para facilitar la búsqueda por ID, tipo de plan o término de búsqueda. La estructura de autenticación, paginación y formato de respuesta es consistente con los demás módulos públicos de la API.

Función: Devuelve un listado paginado de planes que puede ser filtrado por ID, tipo de plan o término de búsqueda.

image.png

Parámetros
ParámetroTipoObligatorioDescripción
filters[plan_id]integerNoID del plan
filters[plan_type]stringNoTipo de plan (ej. alojamiento)
searchstringNoTérmino de búsqueda
skipintegerNoCantidad de registros a omitir
takeintegerSíCantidad de registros a retornar
Pasos para ejecutar la consulta
  1. Ingrese a {BASE_URL}/api/public/v1/plans.
  2. Busque la sección Plans → Obtener listado paginado de planes.
  3. En el campo take, escriba cuántos registros desea obtener.
  4. Si desea aplicar filtros, agregue plan_id, plan_type o search.
  5. Pulse “Enviar petición”.
  6. Si la consulta es exitosa, recibirá un 200 OK con los planes encontrados.
  7. Si ocurre un problema durante la consulta, el endpoint retornará 500 INTERNAL_ERROR.

Obtener listado de tipos de productos

Este módulo permite consultar los tipos de productos disponibles en el sistema. El endpoint devuelve una lista de tipos de planes que pueden ser utilizados para clasificar los productos y mantiene la misma estructura de autenticación y formato de respuesta de los demás módulos públicos de la API.

Función: Devuelve una lista de los tipos de productos disponibles.

image.png

Parámetros
Este endpoint no requiere parámetros para la consulta.

Pasos para ejecutar la consulta
Ingrese a {BASE_URL}/api/public/v1/plan_types.
Busque la sección Plan Types → Obtener listado de tipos de productos.
Pulse “Enviar petición”.
Si la consulta es exitosa, recibirá un 200 OK con los tipos de productos disponibles.
Si no se envía un token válido, el endpoint retornará 401 UNAUTHORIZED.
Si ocurre un problema durante la consulta, el endpoint retornará 500 INTERNAL_ERROR.

Back to top