Endpunkte im Überblick

Vollständige Referenz aller verfügbaren REST-API-Endpunkte

Endpunkte im Überblick

Alle Endpunkte verwenden die Basis-URL: https://your-app-domain.com/api/public

Garantieberechtigung

MethodePfadBeschreibung
GET / POST/warranty-eligibilityGarantieberechtigung für ein Produkt prüfen
POST/warranty/eligibilityBerechtigung für eine Bestellposition prüfen
GET / POST/assess-eligibilityBerechtigung für eine Organisation im Batch neu bewerten (Admin)
GET/assess-eligibility/allBatch-Bewertung für alle Organisationen (Admin)

Garantien

MethodePfadBeschreibung
GET/warranty/{warrantyId}Garantiedetails nach ID abrufen

Policen

MethodePfadBeschreibung
GET/policies/fetchAlle Policen eines Kunden abrufen
GET/policies/fetch/{policyId}Eine bestimmte Police nach ID abrufen
POST/policies/fetch/order-line-item-policyDie Police zu einer Bestellposition finden
POST/policies/validateEine Police anhand von ID und Bestellname validieren

Ansprüche

MethodePfadBeschreibung
POST/claims/submitEinen Garantieanspruch zu einer Police einreichen
POST/claims/submit-manualEinen vom Händler veranlassten Anspruch einreichen (keine Police erforderlich)
GET/claims/fetchAnsprüche zu einer Police und einem Kunden abrufen
GET/claims/{id}/evidenceNachweisdateien zu einem Anspruch abrufen
POST/claims/upload-urlsVorsignierte Upload-URLs für Nachweise generieren
POST/claims/uploadNachweise zu einem Anspruch direkt hochladen
POST/claims/evidenceNachweis-Metadaten an einen Anspruch anhängen

Produkte

MethodePfadBeschreibung
GET/products/searchProdukte nach Titel, SKU oder Barcode suchen
GET/products/eligibilityBerechtigung für mehrere Produkte prüfen
POST/products/registerEin Produkt für Garantiedeckung registrieren

Kunden

MethodePfadBeschreibung
GET/customers/ordersBestellungen eines Kunden abrufen

Registrierung

MethodePfadBeschreibung
GET/registration/lookupEine Registrierung anhand der Nummer nachschlagen

Seriennummern

MethodePfadBeschreibung
POST/serial-numbers/validateEine Seriennummer validieren

Analysen

MethodePfadBeschreibung
POST/analytics/eventsAnalyseereignisse des Widgets senden

Konfiguration

MethodePfadBeschreibung
GET / POST/configWidget-Konfiguration und Übersetzungen abrufen

Bestellstatus

MethodePfadBeschreibung
GET/order-statusDen Status einer Bestellung abrufen

POS

MethodePfadBeschreibung
GET/pos/customer-searchKunden im POS-Kontext suchen

Shopify-Integration

MethodePfadBeschreibung
GET/shopify/auth/callbackOAuth-Callback für die App-Installation
POST/shopify/webhooksShopify-Webhook-Ereignisse empfangen
POST/shopify/post-purchase/sign-changesetChangesets der Post-Purchase-Erweiterung signieren

Produktsynchronisierung

MethodePfadBeschreibung
POST/sync-productsProdukte für eine Organisation synchronisieren
POST/sync-products/allProdukte für alle Organisationen synchronisieren

Systemstatus

MethodePfadBeschreibung
GET/healthDen Status der API prüfen

Gibt 200 (fehlerfrei), 206 (eingeschränkt) oder 503 (gestört) zurück.

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