TracePass
Inizia ora
Passaporti

Eliminare un passaporto

Un passaporto contrassegnato per l'eliminazione → eliminazione logica. Un passaporto che è stato pubblicato si elimina in due passaggi: prima POST /api/v1/passports/{id}/mark-for-deletion, poi questo DELETE. Nulla viene cancellato: il passaporto scompare dall'API (da quel momento ogni chiamata v1 su di esso restituisce 404) e da ogni superficie pubblica. Chi scansiona il codice QR vede una pagina che indica che il passaporto è terminato, e i formati leggibili da macchina rispondono 410 Gone. Restituisce il passaporto con status: "deleted" e attiva il webhook passport.deleted.

DELETE/api/v1/passports/{id}
Scarica OpenAPI 3.1
DELETE/api/v1/passports/{id}

Eliminare un passaporto

Un passaporto contrassegnato per l'eliminazione → eliminazione logica. Un passaporto che è stato pubblicato si elimina in due passaggi: prima POST /api/v1/passports/{id}/mark-for-deletion, poi questo DELETE. Nulla viene cancellato: il passaporto scompare dall'API (da quel momento ogni chiamata v1 su di esso restituisce 404) e da ogni superficie pubblica. Chi scansiona il codice QR vede una pagina che indica che il passaporto è terminato, e i formati leggibili da macchina rispondono 410 Gone. Restituisce il passaporto con status: "deleted" e attiva il webhook passport.deleted.

Un passaporto mai pubblicato → eliminazione definitiva. Un passaporto con stato draft o in_review e publishedAt: null viene rimosso con tutto ciò che appartiene solo a lui: estrazioni IA, eventi di scansione e di assistenza, trasferimenti di proprietà, collegamenti a eventi EPCIS e qualsiasi documento caricato e file archiviato non usato da altri record. I documenti condivisi con altri passaporti o prodotti restano, con il collegamento rimosso. È irreversibile. Nessun webhook viene attivato; l'eliminazione viene registrata nella traccia di controllo del vostro account. Sui piani Free restituisce 403 Forbidden con un reason che rimanda a POST /api/v1/passports/{id}/archive.

Qualsiasi altro stato → 409 Conflict. Il corpo contiene un hint ("A published passport is deleted in two steps: mark it for deletion first.") e un reason.

L'eliminazione tramite API richiede un piano a pagamento. Conta come una scrittura v1. Rispetta Idempotency-Key.

Parametri di percorso

  • idobbligatorio

    string (24 hex chars)

    ID del passaporto.

Header

  • Authorizationobbligatorio

    string

    Bearer <token> — una chiave API tp_ (Developer → API Keys; più semplice, per server-to-server) oppure un access token OAuth 2.0 (Developer → OAuth Apps; per app autorizzate dall'utente, scoped e revocabili). La pagina Authentication contiene il flusso OAuth completo e l'elenco degli scopes.

    e.g. Bearer tp_REDACTED_xxxxxxxxxxxx

  • Idempotency-Key

    string

    UUID v4.

Richiesta

curl -sS -X DELETE \
  https://app.tracepass.eu/api/v1/passports/6650b2c3d4e5f6a7b8c9d0e1 \
  -H "Authorization: Bearer tp_REDACTED_xxxxxxxxxxxx"

Risposta

{
  "_id": "6650b2c3d4e5f6a7b8c9d0e1",
  "status": "deleted",
  "deletedAt": "2026-11-02T09:30:00.000Z",
  "deletedReason": "recycled"
}

Endpoint correlati