API Polizze

Usa l’API Polizze per interrogare le polizze di garanzia, cioè i record di copertura creati quando un cliente acquista una garanzia.

Recuperare le polizze di un cliente

GET /api/public/policies/fetch

Restituisce tutte le polizze di garanzia di un cliente. Aggiungi ?policy_id={id} per recuperare una singola polizza con i dati del relativo ordine.

Header obbligatori: X-Shopify-Shop-Domain, X-Shopify-Customer-Id

Ogni polizza include: numero di polizza, stato, informazioni sul cliente, informazioni sull’ordine, dettagli del piano di garanzia, dettagli del prodotto protetto e date di copertura.

Recuperare una polizza per ID

GET /api/public/policies/fetch/{policyId}

Restituisce una polizza specifica in base all’ID.

Parametri di query:

• shopDomain (obbligatorio) — il dominio del tuo negozio Shopify
• customerId (facoltativo) — se indicato, include i dati dell’ordine e verifica che la polizza appartenga al cliente

Trovare una polizza da un articolo dell’ordine

POST /api/public/policies/fetch/order-line-item-policy

Trova la polizza di garanzia associata a uno specifico articolo di un ordine. Viene usato nelle pagine di stato dell’ordine per mostrare la copertura in garanzia di ciascun prodotto.

Header obbligatorio: X-Shopify-Shop-Domain

Parametri del body:

• orderId o orderName (uno dei due obbligatorio) — identifica l’ordine
• lineItemId, variantId o position (almeno uno obbligatorio) — identifica l’articolo
• protectionAttributes (facoltativo) — riferimento alla protezione proveniente dalla trasformazione del carrello

Convalidare una polizza

POST /api/public/policies/validate

Verifica che una polizza esista confrontando sia l’ID della polizza sia il nome dell’ordine. Viene usato come controllo di sicurezza nei moduli dei sinistri incorporati.

Campi obbligatori del body: orderName, policyId

Restituisce { "valid": true } oppure { "valid": false }.

Stati della polizza

Stato	Descrizione
active	Nel periodo di copertura, può ricevere sinistri
expired	Periodo di copertura terminato
cancelled	Annullata (rimborso o azione del commerciante)
pending	In elaborazione (in attesa della conferma dell’ordine)
voided	Invalidata per annullamento dell’ordine o chargeback

Correlati

• API Sinistri — Apri sinistri sulle polizze
• API Garanzie — Dettagli dei piani di garanzia
• API Prodotti — Verifiche di idoneità dei prodotti