Garantie-API

Garantiepläne über die API erstellen, abrufen und verwalten

Garantie-API

Mit der Garantie-API rufen Sie die Details eines Garantieplans ab und prüfen, ob ein Produkt für Garantiedeckung berechtigt ist.

Garantie nach ID abrufen

GET /api/public/warranty/{warrantyId}

Gibt die Details des Garantieplans und seine Darstellung als Shopify-Produkt zurück (wird verwendet, um die Garantie in den Warenkorb zu legen).

Pfadparameter: warrantyId (erforderlich) — die ID des Garantieplans.

Gibt das Garantieobjekt mit Plantyp, Status, Laufzeiten (Dauer und Preis) und Deckungsdetails zurück, dazu das zugehörige Shopify-Produkt mit Varianten-IDs und Preisen.

Garantieberechtigung prüfen (produktbasiert)

GET / POST /api/public/warranty-eligibility

Prüft, ob ein Produkt für Garantiedeckung berechtigt ist, und gibt die verfügbaren Pläne zurück. Dies ist der wichtigste Endpunkt, den das Storefront-Widget verwendet.

Pflicht-Header:

  • X-Shopify-Shop-Domain — Ihre Shop-Domain
  • X-Shopify-Product-Id — die zu prüfende Produkt-ID (oder im Body/in der Query übergeben)

POST-Body oder GET-Query-Parameter:

  • shopifyShopDomain (erforderlich) — Ihre Shop-Domain
  • eligibleProductId (erforderlich) — die Shopify-Produkt-ID
  • cached (optional) — auf false setzen, um den Cache zu umgehen

Gibt die berechtigte erweiterte Garantie (mit Shopify-Produktdaten), die berechtigte OEM-Garantie, Planlimits, Händlerinformationen, Gebietsschema, Übersetzungen und Währungsdaten zurück.

Garantieberechtigung prüfen (Bestellposition)

POST /api/public/warranty/eligibility

Prüft die Berechtigung für eine bestimmte Bestellposition. Wird im Post-Purchase-Kontext und auf der Bestellstatusseite verwendet.

Pflicht-Header: X-Shopify-Shop-Domain

Body-Parameter:

  • orderId oder orderName (einer davon erforderlich) — identifiziert die Bestellung
  • lineItemId, variantId oder position (mindestens einer erforderlich) — identifiziert die Bestellposition

Der Endpunkt sucht die Bestellposition zuerst über lineItemId, dann über variantId und dann über position. Das Antwortformat entspricht dem des produktbasierten Berechtigungsendpunkts.

Plantypen

PlantypWertBeschreibung
Erweiterte Garantieextended_warrantyKostenpflichtige Garantie, an der Kasse gekauft
OEM-Garantieoem_warrantyHerstellergarantie, kostenlos enthalten

Verwandte Themen

Demo buchen

Erfahren Sie, wie myUmbrella Ihr Garantieprogramm verändern kann

Termin wählen

Wählen Sie einen passenden Termin für Ihre persönliche Demo

ESC

Tippen Sie, um alle Inhalte zu durchsuchen

Keine Ergebnisse gefunden

Versuchen Sie einen anderen Suchbegriff