WMSMaster3000 · API v1.7

WMSMaster API.

REST + Webhooks. JSON-only. Versioniert via Header apps3k-version: 2024-12-01. Stabilitätsgarantie nach Semver, Breaking Changes nur in neuen Versionen.

Authentifizierung

Alle Requests verlangen einen Bearer-Token im Authorization-Header. Tokens werden im Workspace-Settings unter API Keys erzeugt und können auf bestimmte Scopes (events:read, bookings:write …) eingeschränkt werden.

Base URL https://api.apps3k.ch/wmsmaster/v1

Fehler

Wir verwenden konventionelle HTTP-Statuscodes. 2xx = Erfolg, 4xx = Client-Fehler (validate, fix, retry), 5xx = Server-Fehler (idempotent retry mit Backoff).

Status Code Bedeutung
400 invalid_request Body- oder Query-Validierung fehlgeschlagen. Details in errors[].
401 unauthorized Token fehlt oder ist ungültig.
403 forbidden_scope Token hat den benötigten Scope nicht.
404 not_found Ressource existiert nicht oder gehört nicht zu diesem Workspace.
409 conflict Versionskonflikt; Idempotency-Key ggf. erneut prüfen.
429 rate_limited Limit überschritten, Retry-After Header beachten.
503 temporarily_unavailable Backend kurz nicht erreichbar; idempotent retry empfohlen.

Rate-Limits

600 req/min pro Token. Bulk-Endpoints separat: 60 req/min. Headers X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset in jeder Antwort.

PATCH /items/{id}

Aktualisiert Stammdaten eines Lagerartikels. Stock-Mutationen laufen separat über Adjust stock.

Pfad-Parameter

Parameter Typ Pflicht Beschreibung
id string · uuid Required Item-ID (Pfadparameter).

Body-Parameter

Parameter Typ Pflicht Beschreibung
sku string Optional Stock Keeping Unit. Workspace-weit eindeutig, max. 64 Zeichen.
name string Optional Artikelbezeichnung.
category string Optional Kategorie-Slug, z. B. buehne-licht.
min_stock integer Optional Mindestbestand für Reorder-Trigger. null = kein Auto-Reorder.
location_id string · uuid Optional Default-Lagerort. Wechsel löst Movement-Eintrag aus.
metadata object Optional Frei wählbare Key/Value-Paare. Max 20 Keys, je 500 Zeichen.

Antworten

Status Beschreibung
200 Item erfolgreich aktualisiert.
400 Validierungsfehler.
404 Kein Item mit dieser ID im Workspace.
409 SKU-Konflikt — bereits vergeben.