TracePass
Inizia ora
Passaporti

Sospendere un passaporto

Sospensione reversibile. Il visualizzatore pubblico passa alla pagina di stato sospeso (HTTP 423 con corpo strutturato); le scansioni QR di fatto smettono di funzionare senza che l'URL vada in 404. Usatelo per richiami, controversie, blocchi interni o indagini sulla qualità del prodotto. Ripubblicate dalla dashboard una volta risolto.

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

Sospendere un passaporto

Sospensione reversibile. Il visualizzatore pubblico passa alla pagina di stato sospeso (HTTP 423 con corpo strutturato); le scansioni QR di fatto smettono di funzionare senza che l'URL vada in 404. Usatelo per richiami, controversie, blocchi interni o indagini sulla qualità del prodotto. Ripubblicate dalla dashboard una volta risolto.

Corpo opzionale `{ reason: string }` — compare nel payload del webhook `passport.suspended` e nella traccia di controllo della dashboard (troncato a 500 caratteri). Un corpo vuoto va bene; la sospensione attiva comunque il webhook. Conta come una scrittura v1. Rispetta `Idempotency-Key`. Il corrispondente `POST /api/v1/passports/by-serial/{serial}/suspend` è l'alternativa per numero di serie.

Parametri di percorso

  • idobbligatorio

    ObjectId

    ID del passaporto.

Header

  • Authorizationobbligatorio

    string

    `Bearer <api-key>`.

  • Idempotency-Key

    string

    UUID v4.

Campi del corpo

  • reason

    string (≤ 500)

    Motivo della sospensione a testo libero.

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

Richiesta

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." }'

Risposta

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

Endpoint correlati