Produkt-API

Mit der Produkt-API durchsuchen Sie synchronisierte Produkte, prüfen die Garantieberechtigung gesammelt und registrieren Produkte für die Garantiedeckung.

Produkte suchen

GET /api/public/products/search

Durchsucht Ihren synchronisierten Produktkatalog nach Titel, SKU, Barcode oder Anbieter.

Query-Parameter:

• search (erforderlich) — Suchbegriff, mindestens 2 Zeichen
• limit (optional) — maximale Anzahl an Ergebnissen, Standard 20, höchstens 50
• myshopifyDomain (optional) — nach Shop-Domain filtern
• orgId (optional) — falls angegeben, enthalten die Ergebnisse Berechtigungsdaten (isEligible, warrantyIds, zutreffende Regeln)

Produktberechtigung prüfen (gesammelt)

GET /api/public/products/eligibility

Prüft die Garantieberechtigung mehrerer Produkte gleichzeitig.

Query-Parameter:

• productIdsString (erforderlich) — kommagetrennte Produkt-IDs
• orgId (erforderlich) — Organisations-ID

Gibt jedes Produkt mit isEligible, defaultExtendedWarrantyId, defaultOEMWarrantyId und warrantyIds zurück.

Ein Produkt registrieren

POST /api/public/products/register

Registriert ein Produkt über das Registrierungsformular für Kunden für die Garantiedeckung.

Pflichtfelder: productId, purchaseDate, purchasedFrom, customerName, customerEmail, shopDomain

Optionale Felder: customerPhone, orderNumber, serialNumber, warrantyId, warrantyType, warrantyTerm, purchaseProofFileCount, productPhotoFileCount

Validierungsregeln:

• Das Kaufdatum muss heute oder früher und innerhalb der letzten 2 Jahre liegen
• Die E-Mail-Adresse muss ein gültiges Format haben
• Das Produkt muss im Shopify-Shop existieren
• Die Shop-Domain muss bei Umbrella registriert sein

Bei Erfolg werden eine registrationId und eine registrationNumber mit dem Status pending zurückgegeben. Der Kunde erhält eine Bestätigungs-E-Mail, und der Händler hat 30 Tage Zeit für die Prüfung.

Verwandte Themen

• Authentifizierung — API-Zugangsdaten
• Garantie-API — Verwaltung von Garantieplänen
• API für Registrierungen & Seriennummern — Registrierungsabfrage und Validierung von Seriennummern
• Endpunkte im Überblick — Vollständige Liste der Endpunkte