Saltar al contenido principal

Consultar un negocio

API operation: Open the endpoint in Scalar

Usa GET /business/{business} para recuperar un negocio por ID numérico o slug. La operación es Business.find.business_business.

En la ruta archivada, el parámetro final se llamaba id_or_slug; en la ruta actual se llama business. Ambos ocupan el mismo segmento final. El controlador trata un valor numérico como ID y otro valor aceptado como slug.

El flujo de detalle ordinario es público y devuelve solo un negocio habilitado. mode=dashboard requiere un administrador o administrador de negocio autenticado y puede exponer una estructura administrativa diferente. Los valores de consulta como params, type, location, timestamp y version son específicos de la operación.

Ejemplos de SDK heredado​

const response = await ordering.businesses(businessId).parameters(parameters).get()
const dashboardResponse = await ordering.businesses(businessId).asDashboard().get()

Confirma el paquete y la versión del SDK antes de usar estos helpers. Para expansiones de relaciones, consulta Solicitudes especiales de negocio.

Referencia de OpenAPI​

Operación: GET /business/{business}

Parámetros de ruta

NombreTipoObligatorioDescripción
businessstringSí—

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.
professional_idintegerNo—
dropdownoptionintegerNo—
locationstringNo—
menu_idintegerNo—
modestringNo—
student_idintegerNo—
timestampintegerNo—
typeintegerNo—
user_idintegerNo—
versionstringNo—

Parámetros de encabezado

NombreTipoObligatorioDescripción
X-APP-XstringNo—

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 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