索赔 API
以编程方式提交和管理保修索赔
索赔 API
使用索赔 API 提交保修索赔、上传证据文件并查询索赔状态。
提交索赔
POST /api/public/claims/submit
针对现有保单提交索赔。索赔创建后状态为 pending,并会向顾客和商家发送电子邮件通知。
请求头(建议): X-Shopify-Shop-Domain、X-Shopify-Customer-Id
必填请求体字段:
policyId— 要提交索赔的保单claimType— 参见下方的索赔类型description— 事情经过dateOfIncident— 事故的 ISO 格式日期
选填: additionalInfo
索赔类型
| 值 | 说明 |
|---|---|
manufacturer_defect | 商品因制造问题而故障 |
accidental_damage | 意外损坏 |
wear_and_tear | 正常使用导致的损耗 |
spill_or_stain | 被液体泼溅或沾污而损坏 |
lost_or_stolen | 丢失或被盗 |
other | 其他原因 |
成功时返回 claimId。如果该保单已达到索赔次数上限,则返回 CLAIM_LIMIT_REACHED 错误及详细信息。
提交手动索赔
POST /api/public/claims/submit-manual
在没有现有保单的情况下提交索赔。用于商家发起的索赔(例如来自 POS)。
必填请求头: X-Shopify-Shop-Domain
必填请求体字段: customerEmail、customerName、productName、claimType、description、dateOfIncident
选填: customerPhone、orderNumber、additionalInfo
获取某份保单的索赔
GET /api/public/claims/fetch?policy_id={policyId}
必填请求头: X-Shopify-Shop-Domain、X-Shopify-Customer-Id
返回指定保单和顾客的所有索赔,包括索赔编号、状态、类型、原因和日期。
获取索赔证据
GET /api/public/claims/{id}/evidence
必填请求头: X-Shopify-Shop-Domain、X-Shopify-Customer-Id
返回附加在该索赔上的证据文件(照片、视频)。
上传证据文件
POST /api/public/claims/upload-urls
生成预签名 URL,用于将证据直接上传到云存储。
必填请求体字段: fileName、fileType(MIME 类型)、fileSize(字节)、claimId、fileCategory(photo 或 video)
文件限制:
- 照片(JPEG、PNG、GIF、WebP):最大 10 MB
- 视频(MP4、QuickTime、WebM):最大 100 MB
上传流程:
- 调用
/claims/upload-urls获取预签名 URL - 使用正确的 Content-Type 请求头,将文件直接 PUT 到该 URL
索赔状态
| 状态 | 说明 |
|---|---|
pending | 已提交,等待商家审核 |
approved | 已被商家批准 |
denied | 已被商家拒绝 |
in_review | 正在审核中 |
resolved | 已完全解决(更换、退款等) |
相关内容
- 保单 API — 提交索赔前查询保单
- 保修 API — 保修计划详情
- Webhook 参考 — 在索赔状态变更时接收通知


