跳转到内容

查询服务单

接口名:/go/packageOpenApiWeb/OpenApiV2/ServiceOrderQuery

Section titled “接口名:/go/packageOpenApiWeb/OpenApiV2/ServiceOrderQuery”

查询保单列表,支持按电商平台订单号、电商平台前端订单号、更新时间范围查询,通过游标分页翻页。

  • 电商平台订单号、电商平台前端订单号、时间范围三组条件至少填一组;同时传多组时,服务端按 orderId → frontOrderId → 时间范围的顺序选择
  • 使用时间范围时 begTime 和 endTime 必须同时填写,范围不超过 30 天
  • pageSize 省略或小于等于 0 时默认 100,最大 1000;时间范围查询仅 cursor 条件必填(首次传 "0")
  • sort:0 正序(默认),1 逆序
  • 出参:frontOrderId、serviceOrderId;claimState=0(INIT)合法
  • policyStatus 是保单权益状态码,不是同步订单的 orderState(UNPAIED / PAIED / SHIPED 等,见 订单状态)。policyStatus / policyStatusDesc / policyStatusDescEn 的码与中英文对照见 保单权益状态。查询常见码:1 未投保 / 2 已投保 / 3 已生效 / 5 已退保 / 8 已取消
  • policyStatusDesc 不改入参时为中文。英文看同条记录的 policyStatusDescEn(固定英文,不依赖入参)

完整字段说明见 API 接口文档 · ServiceOrderQuery。

// 按时间范围 + 游标分页查询(正序)
{
"begTime": "2025-06-01T00:00:00+08:00",
"endTime": "2025-06-30T23:59:59+08:00",
"pageSize": 200,
"cursor": "0",
"sort": 0
}
// 按长订单号查询
{
"orderId": "PP2025060100001AB00012"
}
// 按短订单号查询
{
"frontOrderId": "XM202506010001"
}
// 翻页请求(使用上次返回的 nextCursor)
{
"begTime": "2025-06-01T00:00:00+08:00",
"endTime": "2025-06-30T23:59:59+08:00",
"pageSize": 200,
"cursor": "1747209600|12345678",
"sort": 0
}
{
"errCode": 0,
"errMsg": "success",
"data": {
"totalCount": 1520,
"nextCursor": "1747209600|12345678",
"list": [
{
"orderId": "PP2025060100001AB00012",
"frontOrderId": "XM202506010001",
"serviceOrderId": "20250601XSP0001",
"guaranteeBegTime": "2025-06-01T10:00:00+08:00",
"guaranteeEndTime": "2026-06-01T10:00:00+08:00",
"policyStatus": 3,
"policyStatusDesc": "已生效",
"policyStatusDescEn": "Effective",
"policyUpdateTime": "2025-06-01T10:30:00+08:00",
"claimState": 1
},
{
"orderId": "PP2025060100002CD00034",
"frontOrderId": "XM202506010002",
"serviceOrderId": "20250602XSP0002",
"guaranteeBegTime": "2025-06-02T08:00:00+08:00",
"guaranteeEndTime": "2026-06-02T08:00:00+08:00",
"policyStatus": 2,
"policyStatusDesc": "已投保",
"policyStatusDescEn": "Insured",
"policyUpdateTime": "2025-06-02T08:30:00+08:00",
"claimState": 0
}
]
}
}