Bas-URL
/v1/supplier/.
Autentisering
Varje förfrågan måste innehålla två rubriker:X-API-KEY (din API-nyckel, utfärdad per leverantörskontakt) och OW-KEY (den delade hemligheten från OpenWrench som utfärdas tillsammans med den). Nyckeln avgränsar automatiskt varje förfrågan till din anläggning. Du ser bara arbetsordrar, fakturor och data som tillhör dig. Förfrågningar som saknar någon av rubrikerna returnerar 401.
Hastighetsgränser
10 förfrågningar per 20-sekundersfönster per nyckel. Utöver det får du429 Too Many Requests: vänta minst 20 sekunder innan du försöker igen, och sprid ut bakgrundsjobb (till exempel fullständiga sidindelade exporter) så att de håller sig under gränsen.
Hålla arbetsordrar synkroniserade
De flesta leverantörsintegrationer finns till för att spegla OpenWrench-arbetsorderkön till ett annat system. Bygg det på push, inte polling:- Registrera en webhook-slutpunkt. OpenWrench skickar händelserna
workorder.create,workorder.status_updateochworkorder.new_notenär de inträffar. - Vid varje händelse, hämta just den arbetsordern med
GET /v1/supplier/work_order/work_orders/{id}. - Använd
GET /v1/supplier/work_order/work_ordersendast för den engångsvisa initiala laddningen och för tillfällig avstämning, med ett smalt filter och en liten sida.
Svarshöljet
Svar för enskilda entiteter:count:
401 betyder att uppgifter saknas eller är ogiltiga; 400 täcker felaktig indata, felaktiga filter och behörighetsavslag; 429 är hastighetsgränsen.
Paginering och filtrering
List-slutpunkter accepteraroffset, limit (standard 10, max 25), sort_by och order (asc | desc). Ytterligare frågeparametrar behandlas som filter. Varje slutpunkt stöder sin egen uppsättning filternycklar, och nycklar den inte känner igen ignoreras i stället för att avvisas. Filter med flera värden använder en pluralnyckel med kommaseparerade värden (statuses=TechScheduled,TechRescheduled). För arbetsordrar, se filterreferensen.
Datumformat
De flesta tidsstämplar är ISO 8601-strängar med offset (till exempel2026-08-14T13:05:22.000-07:00); vissa databastidsstämpelfält serialiseras som yyyy-MM-dd HH:mm:ss.S. Rena datum är yyyy-MM-dd.
När du skickar datum-tider, använd ISO 8601 med ett T mellan datum och tid och en explicit offset. Ett mellanslagsseparerat värde som 2026-09-10 10:43:00+00:00 är inte ISO 8601 och avvisas; skicka 2026-09-10T10:43:00.000+00:00 i stället. UTC kan skrivas som +00:00 eller Z.
Datumfilter i faktura-, förslags- och arbetsorderlistorna är undantaget. De tar MM/dd/yyyy HH:mm:ss, en lokal klocktid utan offset, till exempel 10/09/2026 00:00:00:
- Tidszon. Skicka den valfria frågeparametern
timezoneför att ange vilken zon OpenWrench läser värdena i. Använd ett IANA-zonnamn, somAmerica/Chicago,America/New_YorkellerUTC. Namnen är skiftlägeskänsliga. Utantimezoneläser OpenWrench värdena i UTC. - Avvisade zoner. Fasta offset (
-05:00,GMT-5,Z,Etc/GMT+5), förkortningar (CST) och okända namn returnerar400. - Ingen offset i värdet. OpenWrench ignorerar en offset som
-05:00i slutet av ett filtervärde. Användtimezonei stället. - Felformaterade värden returnerar
400. Ett värde som inte matchar formatet returnerar400, till exempelInvalid markedPaidAtStartDate. Expected format MM/dd/yyyy HH:mm:ss. Det gäller även ISO 8601-värden (2026-10-09T00:00:00), datum utan tid (10/09/2026) och värden som bara består av mellanslag. OpenWrench läser fortfarande ett tomt värde som 1 januari 1970. - Slutgränser. Slutdatum för fakturor och förslag täcker hela slutdagen: OpenWrench ersätter tiden med 23:59:59 på det datumet i
timezone. Slutdatum för arbetsordrar är exakta, så skicka23:59:59för att ta med hela dagen. - Sommartid. En tid i den överhoppade timmen vid övergång till sommartid flyttas framåt med glappets längd. En tid i den upprepade timmen vid övergång till normaltid avser förekomsten i normaltid, alltså den andra.
Teknikertid
WrenchMode-slutpunkterna exponerar per-tekniker arbets- och körtid:GET /v1/supplier/wrench_mode/events/analytics/{fromDate}/{toDate} returnerar en per-tekniker sammanställning av körning/arbete/totalt (fönster max 1 månad), och GET /v1/supplier/wrench_mode/events returnerar den råa händelseloggen bakom det. Servicebesöks-utökningarna (/with_work_logs, /with_tech_details) ger den per-besök-historien.
Detaljerade guider
Guiderna i den här fliken går igenom varje del av API:et i detalj, med nyttolaster, statussemantik och integrationsmönster:Arbetsordrar
Ta emot, acceptera eller avvisa, reservdelsstatusar, ECD, bilagor och anteckningar.
Webhooks
Nytt arbete, statusändringar och köparens anteckningar skickade till din slutpunkt.
Servicebesök
Schemalägg, checka in, checka ut och sätt slutstatus.
WrenchMode
Analyser per tekniker och den råa händelseloggen för körning/arbete.
Offerter och fakturering
Skicka in förslag, fakturautkast och publicera med en PDF.
Inköp och lager
Från inköpsförfrågan till order till mottagning, kataloger och lager.
Referensdata
Köparföretag, platser, tillgångar och hur datamaskering fungerar.
Filer och användare
Fillagringen bakom bilagor och teknikerprovisionering.