保单 API
查询和管理保修保单实例
保单 API
使用保单 API 查询保修保单 — 即顾客购买保修时生成的保障记录。
按顾客获取保单
GET /api/public/policies/fetch
返回某位顾客的全部保修保单。添加 ?policy_id={id} 可获取单个保单及其订单数据。
必填请求头: X-Shopify-Shop-Domain、X-Shopify-Customer-Id
每个保单包含:保单编号、状态、顾客信息、订单信息、保修计划详情、受保产品详情以及保障日期。
按 ID 获取保单
GET /api/public/policies/fetch/{policyId}
按 ID 返回指定保单。
查询参数:
shopDomain(必填)— 您的 Shopify 店铺域名customerId(选填)— 提供后会包含订单数据,并验证该保单是否属于此顾客
按订单行项目查找保单
POST /api/public/policies/fetch/order-line-item-policy
查找订单中某个行项目对应的保修保单。用于订单状态页面,按产品显示保修保障。
必填请求头: X-Shopify-Shop-Domain
请求体参数:
orderId或orderName(二者必填其一)— 标识订单lineItemId、variantId或position(至少填写一个)— 标识行项目protectionAttributes(选填)— 来自购物车转换的保障引用
验证保单
POST /api/public/policies/validate
同时匹配保单 ID 和订单名称,验证保单是否存在。在嵌入式索赔表单中用作安全验证步骤。
必填请求体字段: orderName、policyId
返回 { "valid": true } 或 { "valid": false }。
保单状态
| 状态 | 说明 |
|---|---|
active | 处于保障期内,可受理索赔 |
expired | 保障期已结束 |
cancelled | 已取消(退款或商家操作) |
pending | 处理中(等待订单确认) |
voided | 因订单取消或拒付而作废 |


