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
| Method | Path | Description |
|---|---|---|
| GET / POST | /warranty-eligibility | Check warranty eligibility for a product |
| POST | /warranty/eligibility | Check eligibility for an order line item |
| GET / POST | /assess-eligibility | Batch reassess eligibility for an organization (admin) |
| GET | /assess-eligibility/all | Batch assess for all organizations (admin) |
Warranties
| Method | Path | Description |
|---|---|---|
| GET | /warranty/{warrantyId} | Get warranty details by ID |
Policies
| Method | Path | Description |
|---|---|---|
| GET | /policies/fetch | Get all policies for a customer |
| GET | /policies/fetch/{policyId} | Get a specific policy by ID |
| POST | /policies/fetch/order-line-item-policy | Find a policy for an order line item |
| POST | /policies/validate | Validate a policy by ID and order name |
Claims
| Method | Path | Description |
|---|---|---|
| POST | /claims/submit | Submit a warranty claim against a policy |
| POST | /claims/submit-manual | Submit a merchant-initiated claim (no policy required) |
| GET | /claims/fetch | Get claims for a policy and customer |
| GET | /claims/{id}/evidence | Get evidence files for a claim |
| POST | /claims/upload-urls | Generate presigned upload URLs for evidence |
| POST | /claims/upload | Upload claim evidence directly |
| POST | /claims/evidence | Attach evidence metadata to a claim |
Products
| Method | Path | Description |
|---|---|---|
| GET | /products/search | Search products by title, SKU, or barcode |
| GET | /products/eligibility | Check eligibility for multiple products |
| POST | /products/register | Register a product for warranty coverage |
Customers
| Method | Path | Description |
|---|---|---|
| GET | /customers/orders | Get orders for a customer |
Registration
| Method | Path | Description |
|---|---|---|
| GET | /registration/lookup | Look up a registration by number |
Serial Numbers
| Method | Path | Description |
|---|---|---|
| POST | /serial-numbers/validate | Validate a serial number |
Analytics
| Method | Path | Description |
|---|---|---|
| POST | /analytics/events | Send widget analytics events |
Configuration
| Method | Path | Description |
|---|---|---|
| GET / POST | /config | Get widget configuration and translations |
Order Status
| Method | Path | Description |
|---|---|---|
| GET | /order-status | Get the status of an order |
POS
| Method | Path | Description |
|---|---|---|
| GET | /pos/customer-search | Search customers in a POS context |
Shopify Integration
| Method | Path | Description |
|---|---|---|
| GET | /shopify/auth/callback | OAuth callback for app installation |
| POST | /shopify/webhooks | Receive Shopify webhook events |
| POST | /shopify/post-purchase/sign-changeset | Sign post-purchase extension changesets |
Product Sync
| Method | Path | Description |
|---|---|---|
| POST | /sync-products | Sync products for an organization |
| POST | /sync-products/all | Sync products for all organizations |
Health
| Method | Path | Description |
|---|---|---|
| GET | /health | Check API health status |
Returns 200 (healthy), 206 (degraded), or 503 (unhealthy).
Related
- Authentication — API key setup and rate limits
- Warranty API — Detailed warranty endpoint reference
- Claims API — Detailed claims endpoint reference
- Policies API — Detailed policies endpoint reference