Wishlist API.
REST + Webhooks. JSON-only. Versioniert via Header apps3k-version: 2024-12-01. Stabilitätsgarantie nach Semver.
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.
https://api.apps3k.ch/wishlist/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
1000 req/min pro Token. Bulk-List-Reads: 100/min. Headers X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset in jeder Antwort.
POST /lists/{id}/items
Fügt einer bestehenden Wishlist ein Produkt hinzu. Idempotent über variant_id — wiederholte Calls mit gleichem variant_id ergeben einen einzigen Eintrag.
Pfad-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
| id | string · uuid | Required | Wishlist-ID (Pfadparameter). |
Body-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
| product_id | string · uuid | Required | Produkt-ID, kommt aus der Shopify-Storefront. |
| variant_id | string · uuid | Optional | Optionale Varianten-ID (z. B. spezifische Größe/Farbe). |
| quantity | integer | Optional | Wunsch-Stückzahl. Default: 1. |
| note | string | Optional | Persönliche Notiz vom Kunden, max. 500 Zeichen. |
Antworten
| Status | Beschreibung |
|---|---|
| 201 | Item erfolgreich hinzugefügt (oder updated bei existierender variant_id). |
| 400 | product_id existiert nicht in dieser Shopify-Storefront. |
| 404 | Wishlist mit dieser ID nicht gefunden. |