Obtener lista de negocios
API operation: Open the endpoint in Scalar
Usa GET /business para obtener una lista de negocios. La operación es Business.findAll.business.
La operación permite búsquedas públicas y puede admitir valores como type, location, dropdownoption, params, offset, limit y timestamp. No todas las combinaciones son válidas; la compatibilidad puede depender de la configuración del proyecto.
mode=dashboard requiere autenticación. El controlador de lista admite administradores, administradores de negocio y administradores de repartidores, y aplica la visibilidad correspondiente a cada rol. El flujo de búsqueda ordinario puede filtrar negocios por contexto de entrega sin usar el modo de panel.
GET https://api.ordering.co/v400/en/YOUR_PROJECT/business?type=1&location=40.7539143,-73.9810162¶ms=zones,name,slug
Los tipos de pedido admitidos pueden variar según la configuración del proyecto; no asumas que se limitan a entrega, recogida y consumo en el lugar.
Para campos y expansiones, consulta Modelo de negocio y Solicitudes especiales de negocio.
Referencia de OpenAPI
Operación: GET /business
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. |
where | string | No | Filtro en JSON sobre los campos que el modelo declara como filtrables. Los campos válidos de cada recurso se exponen en la extensión de schema x-ordering-whereable. |
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. |
dropdownoption | integer | No | — |
dropdown_option_id | integer | No | — |
city | string | No | — |
disabled_business | boolean | No | — |
limit | integer | No | — |
location | string | No | Filtro de ubicación serializado como lat,lng. El flujo heredado también acepta un objeto codificado en JSON con lat y lng. |
menu_id | integer | No | — |
mode | string | No | — |
offset | integer | No | — |
order_type_id | integer | No | — |
timestamp | integer | No | — |
type | integer | No | — |
v | string | No | — |
Parámetros de encabezado
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
X-APP-X | string | No | — |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta exitosa. El contenido de result varía según la operación y se devuelve como JSON. |
| 400 | Respuesta de error (error=true). Los errores de validación y de negocio comparten este código. |
| 401 | 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. |
| 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). |