保修 API
通过 API 创建、读取和管理保修计划
保修 API
使用保修 API 获取保修计划详情,并检查产品是否符合保修保障条件。
按 ID 获取保修
GET /api/public/warranty/{warrantyId}
返回保修计划详情及其对应的 Shopify 产品(用于将保修加入购物车)。
路径参数:warrantyId(必填)— 保修计划 ID。
返回保修对象,包括计划类型、状态、条款(期限和价格)、保障详情,以及对应的 Shopify 产品及其变体 ID 和价格。
检查保修资格(基于产品)
GET / POST /api/public/warranty-eligibility
检查某个产品是否符合保修保障条件,并返回可用的计划。这是店面小组件使用的主要端点。
必需的请求头:
X-Shopify-Shop-Domain— 您的店铺域名X-Shopify-Product-Id— 要检查的产品 ID(也可通过请求体或查询参数传入)
POST 请求体或 GET 查询参数:
shopifyShopDomain(必填)— 您的店铺域名eligibleProductId(必填)— Shopify 产品 IDcached(可选)— 设为false可绕过缓存
返回符合条件的延长保修(含 Shopify 产品数据)、符合条件的 OEM 保修、计划限制、商家信息、语言区域、翻译和货币数据。
检查保修资格(订单行项目)
POST /api/public/warranty/eligibility
检查特定订单行项目的保修资格。用于购买后场景和订单状态页面。
必需的请求头:X-Shopify-Shop-Domain
请求体参数:
orderId或orderName(二者必填其一)— 用于识别订单lineItemId、variantId或position(至少填写一个)— 用于识别行项目
该端点会依次按 lineItemId、variantId、position 查找行项目。响应格式与基于产品的资格检查端点相同。
计划类型
| 计划类型 | 值 | 说明 |
|---|---|---|
| 延长保修 | extended_warranty | 在结账时购买的付费保修 |
| OEM 保修 | oem_warranty | 免费附带的制造商保修 |


