TracePass
Loslegen
Pässe

Pass suspendieren

Reversibles Suspendieren. Der öffentliche Viewer schaltet auf die Suspended-Seite (HTTP 423 mit strukturiertem Body); QR-Scans sterben effektiv, ohne dass die URL auf 404 geht. Verwenden Sie das für Rückrufe, Streitigkeiten, interne Holds oder Qualitätsuntersuchungen. Erneut veröffentlichen über das Dashboard nach der Klärung.

POST/api/v1/passports/{id}/suspend
OpenAPI 3.1 herunterladen
POST/api/v1/passports/{id}/suspend

Pass suspendieren

Reversibles Suspendieren. Der öffentliche Viewer schaltet auf die Suspended-Seite (HTTP 423 mit strukturiertem Body); QR-Scans sterben effektiv, ohne dass die URL auf 404 geht. Verwenden Sie das für Rückrufe, Streitigkeiten, interne Holds oder Qualitätsuntersuchungen. Erneut veröffentlichen über das Dashboard nach der Klärung.

Optionaler Body { reason: string } — erscheint im passport.suspended-Webhook-Payload und im Audit-Trail des Dashboards (auf 500 Zeichen gekürzt). Leerer Body ist OK; das Suspend feuert den Webhook trotzdem. Zählt als ein v1-Schreibvorgang. Unterstützt Idempotency-Key. Das passende POST /api/v1/passports/by-serial/{serial}/suspend ist die By-Serial-Alternative.

Nach dem Inverkehrbringen abgelehnt. Ein Pass, der als in Verkehr gebracht registriert ist oder dessen Registrierung läuft, antwortet mit 409 passport_placed_on_market: Er muss öffentlich bleiben, korrigieren Sie stattdessen seine Daten.

Pfad-Parameter

  • iderforderlich

    string (24 hex chars)

    Pass-ID.

Header

  • Authorizationerforderlich

    string

    Bearer <token> — entweder ein tp_ API-Schlüssel (Developer → API Keys; am einfachsten, für Server-zu-Server) oder ein OAuth-2.0-Access-Token (Developer → OAuth Apps; für nutzerautorisierte Apps, scoped und widerrufbar). Die Authentication-Seite enthält den vollständigen OAuth-Flow und die Scope-Liste.

    e.g. Bearer tp_REDACTED_xxxxxxxxxxxx

  • Idempotency-Key

    string

    UUID v4.

Body-Felder

  • reason

    string (≤ 500)

    Freitext-Suspendierungsgrund.

    e.g. Quality investigation pending — batch BB-2026-04-12.

Anfrage

curl -sS -X POST \
  https://app.tracepass.eu/api/v1/passports/6650b2c3d4e5f6a7b8c9d0e1/suspend \
  -H "Authorization: Bearer tp_REDACTED_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "reason": "Quality investigation pending — batch BB-2026-04-12." }'

Antwort

{
  "_id": "6650b2c3d4e5f6a7b8c9d0e1",
  "status": "suspended",
  "suspendedAt": "2026-05-09T16:00:00.000Z",
  "suspensionReason": "Quality investigation pending — batch BB-2026-04-12."
}

Verwandte Endpoints