端点概览

所有可用 REST API 端点的完整参考

端点概览

所有端点都使用以下基础 URL:https://your-app-domain.com/api/public

保修资格

方法路径说明
GET / POST/warranty-eligibility检查产品的保修资格
POST/warranty/eligibility检查订单行项目的保修资格
GET / POST/assess-eligibility批量重新评估某个组织的保修资格(管理员)
GET/assess-eligibility/all批量评估所有组织(管理员)

保修

方法路径说明
GET/warranty/{warrantyId}按 ID 获取保修详情

保单

方法路径说明
GET/policies/fetch获取某位顾客的所有保单
GET/policies/fetch/{policyId}按 ID 获取特定保单
POST/policies/fetch/order-line-item-policy查找订单行项目对应的保单
POST/policies/validate通过保单 ID 和订单名称验证保单

索赔

方法路径说明
POST/claims/submit针对保单提交保修索赔
POST/claims/submit-manual提交由商家发起的索赔(无需保单)
GET/claims/fetch获取某份保单和顾客的索赔
GET/claims/{id}/evidence获取索赔的证据文件
POST/claims/upload-urls为证据生成预签名上传 URL
POST/claims/upload直接上传索赔证据
POST/claims/evidence将证据元数据附加到索赔

产品

方法路径说明
GET/products/search按标题、SKU 或条形码搜索产品
GET/products/eligibility检查多个产品的保修资格
POST/products/register为产品注册保修保障

顾客

方法路径说明
GET/customers/orders获取某位顾客的订单

注册

方法路径说明
GET/registration/lookup按编号查找注册记录

序列号

方法路径说明
POST/serial-numbers/validate验证序列号

分析

方法路径说明
POST/analytics/events发送小组件分析事件

配置

方法路径说明
GET / POST/config获取小组件配置和翻译

订单状态

方法路径说明
GET/order-status获取订单状态

POS

方法路径说明
GET/pos/customer-search在 POS 环境中搜索顾客

Shopify 集成

方法路径说明
GET/shopify/auth/callback应用安装的 OAuth 回调
POST/shopify/webhooks接收 Shopify Webhook 事件
POST/shopify/post-purchase/sign-changeset为购买后扩展的变更集签名

产品同步

方法路径说明
POST/sync-products同步某个组织的产品
POST/sync-products/all同步所有组织的产品

健康状态

方法路径说明
GET/health检查 API 健康状态

返回 200(健康)、206(降级)或 503(不健康)。

相关内容

预约演示

了解 myUmbrella 如何革新您的保修计划

选择时间

为您的专属演示选择一个方便的时间

ESC

输入关键词,搜索全部内容

未找到结果

请尝试其他搜索词