Modelo de negocio
El recurso Business representa una tienda o ubicación de servicio dentro de un proyecto de Ordering.co.
Operaciones principales
| Acción | Método | Recurso | Propósito |
|---|---|---|---|
| Listar negocios | GET | /business | Devuelve los negocios visibles según la consulta seleccionada y el contexto de quien llama. |
| Consultar un negocio | GET | /business/{business} | Devuelve un negocio por ID numérico o slug. |
| Crear un negocio | POST | /business | Crea un negocio bajo las reglas de administrador o administrador de negocio. |
| Actualizar un negocio | POST | /business/{business} | Actualiza parcialmente un negocio por ID numérico. |
| Eliminar un negocio | DELETE | /business/{business} | Elimina un negocio cuando lo permiten las comprobaciones de propiedad y recursos compartidos. |
Una tabla anterior indicaba PUT para la actualización, pero la ruta enumerada aquí usa POST. La documentación de cada operación define el contrato para los parámetros, autenticación, campos de solicitud, respuestas y errores de cada operación.
Campos representativos
El esquema descrito contiene muchos campos específicos de cada operación. Los grupos comunes incluyen:
| Grupo | Campos representativos |
|---|---|
| Identidad | id, name, slug, description, about, enabled, featured |
| Contacto | email, phone, cellphone, address, address_notes, zipcode |
| Ubicación | city_id, location, timezone, country_code, state, locality |
| Comercio | currency, minimum, delivery_price, service_fee, tax, tax_type |
| Preparación y entrega | schedule, delivery_time, pickup_time, always_deliver |
| Medios y presentación | logo, header, seo_image, seo_title, seo_description |
| Propiedad y organización | owner_id, franchise_id, parent_business_id, types |
Las grafías alchohol y use-printer no son nombres de campo en el esquema descrito aquí. El esquema descrito usa alcohol y use_printer.
Algunas propiedades se pueden filtrar y aparecen en los metadatos x-ordering-whereable de la operación. La presencia de un campo en el modelo no significa que cada operación devuelva o acepte ese campo. Las respuestas con selección parcial de campos y las expansiones de relaciones también pueden cambiar la estructura de la respuesta.
Para horarios y ubicaciones estructurados, consulta Tipos de datos especiales. Para expansiones de relaciones específicas de endpoints, consulta Solicitudes especiales de negocio.