Desarrolladores

Documentación API para integraciones

Conecta tu POS, marketplace o panel propio con OperioHub. Cada endpoint vive en una página propia generada desde contenido estructurado, para que la referencia pueda crecer sin convertir la landing en una página interminable.

Ver endpoints Abrir primera guía

API Reference

Endpoints de integración

La referencia se genera desde ficheros de contenido validados por Astro. Para publicar un nuevo endpoint, añadimos una especificación y el template común se encarga del diseño, tablas, ejemplos y errores.

Prueba rápida

Envía una petición desde la documentación

Usa el endpoint de creación de pedido con un payload editable y pega un token válido para comprobar la integración sin salir de la referencia.

Consola de prueba

Envía una petición de creación

Ajusta la URL base, pega un token válido y modifica el payload para enviar una petición de prueba desde esta página. También puedes copiar el ejemplo como cURL o JavaScript.

Base URL Token

Campos del payload

dispatchOrderId externalRestaurant.source externalRestaurant.externalId externalRestaurant.displayName externalRestaurant.location deliveryInfo.pickupAddress deliveryInfo.pickupLat deliveryInfo.pickupLng deliveryInfo.deliveryAddress deliveryInfo.deliveryLat deliveryInfo.deliveryLng deliveryInfo.deliveryPhoneCode paymentInfo.method paymentInfo.status paymentInfo.totalAmount paymentInfo.cashExpectedAmount Webhook de estado webhooks.onOrderStatusWebhook.url webhooks.onOrderStatusWebhook.auth.type webhooks.onOrderStatusWebhook.auth.token

Payload

{
  "dispatchOrderId": "EXT-1001",
  "externalRestaurant": {
    "source": "marketplace",
    "externalId": "store-123",
    "displayName": "Restaurante Externo",
    "location": "Av. de Orihuela, 27, 03007 Alicante",
    "phone": "+34 600 000 111",
    "contactEmail": "externo\u0040example.com",
    "photoUrl": "https://cdn.example.com/store-photo.jpg",
    "logoUrl": "https://cdn.example.com/store-logo.png"
  },
  "customerInfo": {
    "customerName": "Ana Perez",
    "customerPhone": "+34 600 000 000",
    "customerEmail": null,
    "customerNotes": null
  },
  "deliveryInfo": {
    "pickupAddress": "Av. de Orihuela, 27, 03007 Alicante",
    "pickupLat": 38.344498,
    "pickupLng": -0.509259,
    "deliveryAddress": "C. Cisne, 21-17, 03006 Alicante",
    "deliveryLat": 38.346158,
    "deliveryLng": -0.510089,
    "deliveryNotes": "Piso 7, puerta 13"
  },
  "paymentInfo": {
    "method": "cash",
    "status": "pending",
    "totalAmount": "18.50",
    "currency": "EUR",
    "cashExpectedAmount": "20.00"
  }
}

La respuesta aparecerá aquí.

Orders API

POST /api/orders Dispatcher Crear pedido Crea pedidos desde una cuenta dispatcher para un restaurante ya dado de alta o para un restaurante externo enviado en la petición. POST /api/orders/:orderId/status Dispatcher Actualizar estado de pedido Actualiza el estado operativo de un pedido desde una integración dispatcher sin exponer la actualización general del pedido. POST /api/orders/:orderId/cancel Dispatcher o restaurant Cancelar pedido Cancela manualmente un pedido activo desde una cuenta dispatcher o restaurante usando el mismo flujo operativo que el frontend. GET /api/orders Dispatcher, restaurant o rider Listar pedidos Consulta pedidos con filtros, paginación y ordenación desde el perfil autenticado. GET /api/orders/:orderId Dispatcher, restaurant o rider Consultar detalle de pedido Obtiene la información de un único pedido dentro del alcance del perfil autenticado.

Routes API

POST /api/routes/bulk Dispatcher Asignar pedidos a riders en bulk Crea rutas para varios riders en una sola peticion, con resultado independiente por asignacion.

Dispatchers API

GET /api/dispatchers/me/riders Dispatcher Listar riders del dispatcher Devuelve el catálogo de riders asociados al dispatcher autenticado, incluyendo presencia online y última ubicación vigente si existe.

Marketplace externo

POST quoteEndpointUrl configurado en la interfaz Flota externa Cotización de reparto externo OperioHub solicita una propuesta y la flota responde en la misma llamada con precio, ETAs y rider previsto. POST webhooks.award.url configurado en la interfaz Flota externa Recibir una adjudicación OperioHub confirma a la flota ganadora que su propuesta ha sido adjudicada y entrega credenciales temporales de operación. POST webhooks.cancellation.url configurado en la interfaz Flota externa Recibir una cancelación OperioHub notifica a la flota adjudicada la cancelación iniciada desde el espacio de trabajo del restaurante. POST /api/marketplace/orders/:orderId/external-status Flota externa adjudicada Actualizar el estado del pedido externo Actualiza los estados operativos de un pedido adjudicado con la credencial temporal de estado entregada en la adjudicación. POST /api/marketplace/orders/:orderId/external-rider-location Flota externa adjudicada Enviar tracking del rider externo Publica la última ubicación del rider externo mediante el token temporal entregado en la adjudicación. POST data.webhooks.incidentChat.url (ACK) y operations.incidentChat.url Flota externa adjudicada Chat de incidencias externo Sincroniza el chat de incidencias entre el restaurante y la flota externa con dos direcciones acordadas en la adjudicación.