API Overview
Klarer Einstieg in die Toolboxx API
Authentifizierte Endpunkte fuer User und Artikel-Items. API-Tokens werden in der Toolboxx unter Einstellungen -> Administration -> API-Tokens erstellt und dann als Bearer Token an jeden Request angehaengt.
Auth
API-Token in Toolboxx erstellen und als Authorization: Bearer <token> mitsenden.
OpenAPI
/openapi.jsonBase URL
https://api.toolboxx.biz/api
Alle Endpunkte sind REST-Resources mit JSON Responses. Pagination ist standardmaessig aktiv.
Public Endpoints
Keine Authentifizierung erforderlich
Login
POST/login
Gibt API Token zurueck. Erwartet email und password.
Lead einreichen
POST/leads/{token}
Oeffentlicher Lead-Eingang. Token wird in der ToolBoxx unter Leads → Quellen erstellt. Nimmt beliebige JSON-Felder entgegen. Optionale IP- und Origin-Whitelist konfigurierbar.
Protected Endpoints
Erfordern Authorization: Bearer <token>
User
GET/user
Gibt den aktuell eingeloggten Benutzer zurueck.
Items Collection
GET/items
Paginiert sortiert nach created_at.
Items Create
POST/items
Erstellt neue Items mit gemappten englischen Feldern.
Item Detail
/items/{item}
Includes Manufacturer, Category und Unit Relation.
DMS Collection
GET/dms
Paginiert sortiert nach created_at.
DMS Upload
POST/dms
Dokument hochladen. Multipart/form-data mit file.
DMS Detail
/dms/{dms}
Dokumentenmanagement Ressource.
Contacts Collection
GET/contacts
Paginiert sortiert nach created_at.
Contacts Create
POST/contacts
Erstellt neue Kontakte mit gemappten englischen Feldern.
Contacts Lookup
GET/contacts/lookup
Rufnummernsuche über Kontakte & Ansprechpartner, unabhängig von der Schreibweise: ?phone=+49 441 123-456
Orders Collection
GET/orders
Paginiert sortiert nach created_at.
Orders Create
POST/orders
Erstellt neue Auftraege mit gemappten englischen Feldern.
Order Detail
/orders/{order}
Auftrag Ressource inkl. Positionen.
Contact Detail
/contacts/{contact}
Kontakt Ressource mit allen Daten.
Contact History
/contacts/{contact}/history
Neueste zuerst, optional ?limit=5. Anlegen mit type, note, event_date & resubmission_date. Typen: 10|11|12|13|14|99. Wortgleiche Einträge innerhalb einer Minute werden nicht doppelt angelegt (Antwort 200 statt 201).
Contact History Detail
/contacts/{contact}/history/{history}
Nur manuelle Einträge ohne Verknüpfung (relation_id), sonst 403.
Documents Collection
GET/documents
Rechnungen, Angebote, Auftragsbestätigungen, Lieferscheine & Gutschriften. Filter: ?type=invoice|offer|orderconfirmation|deliverynote|creditnote
Documents Create
POST/documents
Erstellt Dokument mit Positionen. Pflichtfeld: type.
Document Detail
/documents/{document}
Dokument inkl. Positionen. Typ kann nicht geaendert werden.
Packages Collection
GET/packages
Pakete & Sendungsnummern, read-only, neueste zuerst. Filter: ?contact_id=, ?relation=contact|document&relation_id=, ?tracking_number=, ?limit=5.
Package Detail
GET/packages/{package}
Paket mit Versanddienstleister, Produkt, Maßen, Preis und Label-Status.
Invoices Collection
GET/invoices
Kombinierte Rechnungsliste (Auftragswesen-Rechnungen & DMS-Ausgangsrechnungen), read-only. Filter: ?source=document|dms, ?status=payed|not_payed|draft|cancellation, ?period=this_month|last_month|this_year|last_year, ?from=YYYY-MM-DD&to=YYYY-MM-DD.
Invoice Detail
GET/invoices/{invoice}
Einzelne Rechnung per row_key (z. B. d12203 / m36975).
Mails Collection
GET/mails
Das Postfach, read-only – dieselben Ansichten wie in der ToolBoxx, Entwürfe nie enthalten. Filter: ?filter=zero|in|out|deleted|all, ?group=thread|mail, ?account=info@example.de, ?account_id[]=15, ?since=YYYY-MM-DD HH:MM:SS. Standard ist eine Zeile je Gespräch; group=mail liefert jede Mail einzeln.
Mail Thread
GET/mails/{mail}
Alle Mails eines Gesprächs, älteste zuerst – per id einer Mail oder per thread_id.