Claims API
File and manage warranty claims programmatically
Claims API
Use the Claims API to submit warranty claims, upload evidence files, and query claim status.
Submit a claim
POST /api/public/claims/submit
Submits a claim against an existing policy. The claim is created with pending status and triggers email notifications to the customer and merchant.
Headers (recommended): X-Shopify-Shop-Domain, X-Shopify-Customer-Id
Required body fields:
policyId— the policy to file againstclaimType— see claim types belowdescription— what happeneddateOfIncident— ISO date of the incident
Optional: additionalInfo
Claim types
| Value | Description |
|---|---|
manufacturer_defect | Product failed due to manufacturing issue |
accidental_damage | Damaged by accident |
wear_and_tear | Degraded through normal use |
spill_or_stain | Damaged by liquid or staining |
lost_or_stolen | Lost or stolen |
other | Other reason |
Returns claimId on success. If the policy has reached its claim limit, returns a CLAIM_LIMIT_REACHED error with details.
Submit a manual claim
POST /api/public/claims/submit-manual
Submits a claim without an existing policy. Used for merchant-initiated claims (e.g., from POS).
Required header: X-Shopify-Shop-Domain
Required body fields: customerEmail, customerName, productName, claimType, description, dateOfIncident
Optional: customerPhone, orderNumber, additionalInfo
Fetch claims for a policy
GET /api/public/claims/fetch?policy_id={policyId}
Required headers: X-Shopify-Shop-Domain, X-Shopify-Customer-Id
Returns all claims for the specified policy and customer, including claim number, status, type, reason, and dates.
Get claim evidence
GET /api/public/claims/{id}/evidence
Required headers: X-Shopify-Shop-Domain, X-Shopify-Customer-Id
Returns evidence files (photos, videos) attached to the claim.
Upload evidence files
POST /api/public/claims/upload-urls
Generates a presigned URL for uploading evidence directly to cloud storage.
Required body fields: fileName, fileType (MIME type), fileSize (bytes), claimId, fileCategory (photo or video)
File limits:
- Photos (JPEG, PNG, GIF, WebP): max 10 MB
- Videos (MP4, QuickTime, WebM): max 100 MB
Upload workflow:
- Call
/claims/upload-urlsto get a presigned URL - PUT the file directly to that URL with the correct Content-Type header
Claim statuses
| Status | Description |
|---|---|
pending | Submitted, awaiting merchant review |
approved | Approved by merchant |
denied | Denied by merchant |
in_review | Being actively reviewed |
resolved | Fully resolved (replacement, refund, etc.) |
Related
- Policies API — Look up policies before filing claims
- Warranty API — Warranty plan details
- Webhooks Reference — Get notified when claim status changes