URL base
/v1/buyer/.
Autenticación
Cada solicitud debe llevar dos cabeceras:X-API-KEY (tu clave de API, emitida por contacto de comprador) y OW-KEY (el secreto compartido de OpenWrench emitido junto a ella). La clave delimita automáticamente cada solicitud a tu empresa: solo verás tus propios datos. Las solicitudes a las que les falte cualquiera de las cabeceras devuelven 401.
GET /v1/buyer/me para inspeccionar la identidad (contacto, instalación, empresa) detrás de tu clave.
Las claves no expiran por sí solas. Para rotar una, solicita a soporte un nuevo par clave/secreto compartido, despliega el nuevo par y luego pide a soporte que revoque el antiguo.
La sección Internal Teams API, más abajo en esta pestaña, usa una clave de API de partner distinta: tu clave de comprador no autenticará contra esos endpoints
/v1/partners/. Consulta la introducción a la Internal Teams API para más detalles.Límites de tasa
10 solicitudes por ventana de 20 segundos por clave. Al superarlo recibirás429 Too Many Requests: espera al menos 20 segundos antes de reintentar y espacia los trabajos en segundo plano (como exportaciones paginadas completas) para que se mantengan por debajo del límite.
Mantener las órdenes de trabajo sincronizadas
Si tu integración replica las órdenes de trabajo en otro sistema (una herramienta de tickets, un ERP, un data warehouse), constrúyela sobre push, no sobre sondeo:- Registra un endpoint de webhook. OpenWrench envía los eventos
workorder.create,workorder.status_updateyworkorder.new_notea medida que ocurren. - En cada evento, obtén esa única orden de trabajo con
GET /v1/buyer/work_order/work_orders/{id}. - Usa
GET /v1/buyer/work_order/work_orderspara consultas puntuales, la carga inicial única y la conciliación ocasional, con un filtro estrecho y una página pequeña.
Envoltura de respuesta
Respuestas de una sola entidad:count total:
401 significa clave faltante o inválida; 400 cubre entrada inválida, filtros incorrectos y denegaciones de permisos; 429 es el límite de tasa.
Paginación y filtrado
Los endpoints de listado aceptanoffset, limit (por defecto 10, máx. 25), sort_by y order (asc | desc). Los parámetros de consulta adicionales se tratan como filtros. Cada endpoint admite su propio conjunto de claves de filtro, y las claves que no reconoce se ignoran en lugar de rechazarse. Los filtros de varios valores usan una clave en plural con valores separados por comas (statuses=Unassigned,PendingApproval). Para órdenes de trabajo, consulta la referencia de filtros.
Formatos de fecha
La mayoría de las marcas de tiempo son cadenas ISO 8601 con offset (por ejemplo2026-08-14T13:05:22.000-07:00); algunos campos de marca de tiempo de base de datos se serializan como yyyy-MM-dd HH:mm:ss.S. Las fechas simples son yyyy-MM-dd. Cuando envíes fecha-hora, usa ISO 8601.
Los filtros de fecha de los listados de facturas, propuestas y órdenes de trabajo son la excepción. Usan MM/dd/yyyy HH:mm:ss, una hora local de reloj sin offset, por ejemplo 10/09/2026 00:00:00:
- Zona horaria. Pasa el parámetro de consulta opcional
timezonepara establecer la zona en la que OpenWrench interpreta los valores. Usa un nombre de zona IANA, comoAmerica/Chicago,America/New_YorkoUTC. Los nombres distinguen mayúsculas y minúsculas. Sintimezone, OpenWrench interpreta los valores en UTC. - Zonas rechazadas. Los offsets fijos (
-05:00,GMT-5,Z,Etc/GMT+5), las abreviaturas (CST) y los nombres desconocidos devuelven400. - Sin offset en el valor. OpenWrench ignora un offset como
-05:00al final de un valor de filtro. Usatimezoneen su lugar. - Los valores mal formados devuelven
400. Un valor que no coincide con el formato devuelve400, por ejemploInvalid markedPaidAtStartDate. Expected format MM/dd/yyyy HH:mm:ss. Eso incluye valores ISO 8601 (2026-10-09T00:00:00), fechas sin hora (10/09/2026) y valores formados solo por espacios. OpenWrench sigue leyendo un valor vacío como 1 de enero de 1970. - Extremos finales. Las fechas finales de facturas y propuestas cubren todo el día final: OpenWrench reemplaza la hora por 23:59:59 en esa fecha en
timezone. Las fechas finales de órdenes de trabajo son exactas, así que envía23:59:59para incluir el día completo. - Horario de verano. Una hora dentro de la hora omitida en un cambio de adelanto de reloj se desplaza hacia delante la duración del salto. Una hora dentro de la hora repetida en un cambio de atraso de reloj se refiere a la ocurrencia en horario estándar, que es la segunda.
Guías detalladas
Las guías de esta pestaña recorren cada parte de la API en profundidad, con payloads, modelos de estado y patrones de integración:Órdenes de trabajo
Crear, filtrar, reasignar, cerrar. Modelo de estados, notas y tipos de problema.
Webhooks
Eventos de creación de orden de trabajo, cambio de estado y nueva nota enviados a tu endpoint.
Llamadas de servicio
Evidencia de la visita: registros de trabajo, tiempo real trabajado y detalles del técnico.
Activos y ubicaciones
Ubicaciones, regiones, tipos de activos, modelos, medidores y seguimiento de refrigerante.
Facturas
El flujo de aprobación, sincronización con AP, exportaciones aplanadas y actualizaciones masivas.
Cotizaciones y propuestas
Lee las cotizaciones del proveedor y concílialas con las facturas.
Mantenimiento preventivo
Lee cronogramas, omite ejecuciones y controla el PM desde un planificador externo.
Red de proveedores
Consulta tu red y prioriza a los proveedores de red privada para el despacho.
Encuestas de sitio
Recorridos y las órdenes de trabajo que salen de sus hallazgos.
Archivos y adjuntos
Sube una vez, referencia en todas partes, descarga la evidencia.
Cuenta y utilidades
Ping, identidad de la clave, aprovisionamiento de usuarios y tipos de cambio.