Products API
Query products and assess warranty eligibility
Products API
Use the Products API to search synced products, check warranty eligibility in batch, and register products for warranty coverage.
Search products
GET /api/public/products/search
Searches your synced product catalog by title, SKU, barcode, or vendor.
Query parameters:
search(required) — search query, minimum 2 characterslimit(optional) — max results, default 20, max 50myshopifyDomain(optional) — filter by store domainorgId(optional) — when provided, results include eligibility data (isEligible,warrantyIds, matched rules)
Check product eligibility (batch)
GET /api/public/products/eligibility
Checks warranty eligibility for multiple products at once.
Query parameters:
productIdsString(required) — comma-separated product IDsorgId(required) — organization ID
Returns each product with isEligible, defaultExtendedWarrantyId, defaultOEMWarrantyId, and warrantyIds.
Register a product
POST /api/public/products/register
Registers a product for warranty coverage via the customer-facing registration form.
Required fields: productId, purchaseDate, purchasedFrom, customerName, customerEmail, shopDomain
Optional fields: customerPhone, orderNumber, serialNumber, warrantyId, warrantyType, warrantyTerm, purchaseProofFileCount, productPhotoFileCount
Validation rules:
- Purchase date must be today or earlier, and within the last 2 years
- Email must be valid format
- Product must exist in the Shopify store
- Shop domain must be registered with Umbrella
On success, returns a registrationId and registrationNumber with pending status. A confirmation email is sent to the customer, and the merchant has 30 days to review.
Related
- Authentication — API credentials
- Warranty API — Warranty plan management
- Registration & Serial Numbers API — Registration lookup and serial validation
- Endpoints Overview — Full endpoint listing