Saltar al contenido principal

Obtener usuario

API operation: Open the endpoint in Scalar

Usa GET /users/{user} para obtener un usuario. La operación pública actual es User.find.users_user.

La ruta archivada llamaba user_id a su parámetro entero final; la ruta y el controlador actuales usan user en la misma posición. Por lo demás, el método HTTP y los segmentos fijos de la ruta son idénticos.

Los administradores y agentes pueden consultar otros usuarios. Otros solicitantes pueden estar limitados a su propio usuario; el acceso de administradores de negocio puede depender de sus permisos.

Usa params solo para campos y relaciones admitidos por la operación actual. Las relaciones candidatas incluyen direcciones, tokens push, grupos de repartidores, billeteras, nivel de lealtad, ocupación y relaciones de negocio seleccionadas, pero la disponibilidad varía con la proyección solicitada.

Ejemplo del explorador de API heredado

Ejemplo de SDK heredado​

const response = await ordering.users(userId).get();

Confirma el paquete y la versión del SDK antes de usar este método auxiliar histórico.

Referencia de OpenAPI​

Operación: GET /users/{user}

Parámetros de ruta

NombreTipoObligatorioDescripción
userintegerSí—

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.
delivery_block_fromstringNo—
delivery_block_tostringNo—

Respuestas

CódigoDescripción
200Respuesta exitosa. result usa la proyección pública conservadora de User.
400Respuesta de error (error=true). Los errores de validación y de negocio comparten este código.
401Envelope de error: sesión ausente, inválida, o nivel de usuario fuera de los permitidos. Respuesta de error para el código declarado por la operación. Consulta result para ver los detalles disponibles. Envelope 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