Endpoints Overview

Complete reference of all available REST API endpoints

Endpoints Overview

All endpoints use the base URL: https://your-app-domain.com/api/public

Warranty Eligibility

MethodPathDescription
GET / POST/warranty-eligibilityCheck warranty eligibility for a product
POST/warranty/eligibilityCheck eligibility for an order line item
GET / POST/assess-eligibilityBatch reassess eligibility for an organization (admin)
GET/assess-eligibility/allBatch assess for all organizations (admin)

Warranties

MethodPathDescription
GET/warranty/{warrantyId}Get warranty details by ID

Policies

MethodPathDescription
GET/policies/fetchGet all policies for a customer
GET/policies/fetch/{policyId}Get a specific policy by ID
POST/policies/fetch/order-line-item-policyFind a policy for an order line item
POST/policies/validateValidate a policy by ID and order name

Claims

MethodPathDescription
POST/claims/submitSubmit a warranty claim against a policy
POST/claims/submit-manualSubmit a merchant-initiated claim (no policy required)
GET/claims/fetchGet claims for a policy and customer
GET/claims/{id}/evidenceGet evidence files for a claim
POST/claims/upload-urlsGenerate presigned upload URLs for evidence
POST/claims/uploadUpload claim evidence directly
POST/claims/evidenceAttach evidence metadata to a claim

Products

MethodPathDescription
GET/products/searchSearch products by title, SKU, or barcode
GET/products/eligibilityCheck eligibility for multiple products
POST/products/registerRegister a product for warranty coverage

Customers

MethodPathDescription
GET/customers/ordersGet orders for a customer

Registration

MethodPathDescription
GET/registration/lookupLook up a registration by number

Serial Numbers

MethodPathDescription
POST/serial-numbers/validateValidate a serial number

Analytics

MethodPathDescription
POST/analytics/eventsSend widget analytics events

Configuration

MethodPathDescription
GET / POST/configGet widget configuration and translations

Order Status

MethodPathDescription
GET/order-statusGet the status of an order

POS

MethodPathDescription
GET/pos/customer-searchSearch customers in a POS context

Shopify Integration

MethodPathDescription
GET/shopify/auth/callbackOAuth callback for app installation
POST/shopify/webhooksReceive Shopify webhook events
POST/shopify/post-purchase/sign-changesetSign post-purchase extension changesets

Product Sync

MethodPathDescription
POST/sync-productsSync products for an organization
POST/sync-products/allSync products for all organizations

Health

MethodPathDescription
GET/healthCheck API health status

Returns 200 (healthy), 206 (degraded), or 503 (unhealthy).

Book a Demo

See how myUmbrella can transform your warranty program

Choose a Time

Select a convenient time for your personalized demo

ESC

Start typing to search across all content

No results found

Try a different search term