Saltar al contenido principal

Panel de pedidos

API operation: Open the endpoint in Scalar

Usa GET /orders/dashboard para resumir por estado los pedidos visibles para el usuario autenticado. La operación pública actual es Order.dashboard.

La visibilidad depende del rol:

  • los administradores pueden resumir los pedidos del proyecto;
  • los administradores de negocio solo ven los negocios que administran como propietarios;
  • los repartidores solo ven los pedidos que tienen asignados;
  • los administradores de repartidores solo ven pedidos asociados con los grupos que administran;
  • los agentes del centro de llamadas pueden acceder a la operación según el middleware actual.

Usa where y los parámetros de selección de campos según la documentación de la operación. El parámetro opcional v forma parte de su contrato.

No los interpretes como totales monetarios calculados ni como una lista de pedidos sin evidencia específica de la versión publicada.

La nota archivada afirmaba que se requería mode=dashboard. Ese parámetro pertenece al comportamiento de panel en otras rutas de pedidos y no se requiere en GET /orders/dashboard.

La autenticación, los campos de respuesta y los errores son específicos de esta operación.

Referencia de OpenAPI​

Operación: GET /orders/dashboard

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.
vintegerNo—

Respuestas

CódigoDescripción
200Respuesta exitosa. El contenido de result varía según la operación y se devuelve como JSON.
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