Solicitudes especiales de negocio
Las operaciones de lista y detalle de negocios usan params tanto para seleccionar ciertos campos como para solicitar expansiones de relaciones o campos calculados específicos de la operación. Estas expansiones no constituyen un esquema universal de Business: usa únicamente los valores admitidos por la operación exacta y la versión aplicable.
Expansiones comunes
Las listas y los detalles de negocio pueden expandirse mediante:
Valor de params | Contexto devuelto cuando se admite |
|---|---|
menus | Menús y, según la operación y el modo, su árbol de categorías/productos. |
city | La ciudad relacionada; la respuesta también incluye city_id. |
reviews | Agregados de reseñas y datos de reseñas relacionados. |
gallery | Elementos de la galería del negocio. |
offers | Ofertas visibles según el modo actual, las funcionalidades del proyecto y quien realiza la solicitud. |
categories, products, products_featured | Relaciones de catálogo. Usa el token products_featured; featured_products no está admitido. |
zones | Contexto de zonas de entrega y cálculo de entrega. |
webhooks | Webhooks de negocio en operaciones que permiten esta relación. El token actual está en plural. |
paymethods | Métodos de pago del negocio. Los campos de credenciales sensibles pueden omitirse de la respuesta. |
available_drivers_count | Conteos de disponibilidad calculados para el contexto de negocio/búsqueda seleccionado. |
El contrato público actual de la referencia de la API también contiene expansiones más recientes como owners, agents, types, configs, taxes y third_party_integrations. Su disponibilidad y visibilidad dependen de la variante de lista o detalle, el modo, quien realiza la solicitud y las funcionalidades del proyecto; esta guía no las presenta como campos universales.
Contexto de búsqueda
La búsqueda pública de negocios puede combinar un type de pedido, una location o una opción de dropdown y params=zones. Por ejemplo:
GET https://api.ordering.co/v400/en/YOUR_PROJECT/business?type=1&location=40.7539143,-73.9810162¶ms=zones,name,slug
{
"error": false,
"result": [
{
"id": 22,
"name": "Example business",
"timezone": "America/New_York",
"open": false,
"distance": 0,
"delivery_zone": 15,
"minimum": 1,
"delivery_price": 2
}
]
}
Esta es una estructura ilustrativa, no un esquema de respuesta completo. La ubicación, el tipo de pedido, el dropdown, el horario, el sitio y la configuración del proyecto pueden afectar la elegibilidad y los campos calculados.
Modo de panel
mode=dashboard expone estructuras administrativas y está sujeto a control de acceso. Las rutas de lista y detalle pueden usar comprobaciones de rol distintas: no infieras el acceso a una a partir de la otra. El contrato público de cada operación define sus permisos.
Para los campos del recurso base, consulta Modelo de negocio. Las guías de endpoints relacionadas son Consultar un negocio y Obtener lista de negocios.