Query service orders

Paginated service-order query

Path: /go/packageOpenApiWeb/OpenApiV2/ServiceOrderQuery

Query policies by merchant order number, front-end order number, or update-time range, paging with a cursor.

• Provide at least one of the three filter groups: merchant order number, front-end order number, time range; when several are sent, the server picks in the order orderId → frontOrderId → time range
• With a time range, begTime and endTime must be sent together and span at most 30 days
• pageSize defaults to 100 when omitted or ≤ 0, maximum 1000; for time-range queries only cursor is additionally required (pass "0" on the first call)
• sort: 0 ascending (default), 1 descending
• Response includes frontOrderId and serviceOrderId; claimState=0 (INIT) is a valid value
• policyStatus is the policy benefit status code, not shop-order orderState (UNPAIED / PAIED / SHIPED, …; see Order states). Codes and Chinese/English text for policyStatus / policyStatusDesc / policyStatusDescEn are in Policy states. Query values: 1 Uninsured / 2 Insured / 3 Effective / 5 Refunded / 8 Cancelled
• policyStatusDesc is Chinese when you do not change the request. Use policyStatusDescEn on the same row for the fixed English string (no extra request field needed)

For the full field reference see API reference · ServiceOrderQuery.

Request examples:

// By time range + cursor pagination (ascending)
{
    "begTime": "2025-06-01T00:00:00+08:00",
    "endTime": "2025-06-30T23:59:59+08:00",
    "pageSize": 200,
    "cursor": "0",
    "sort": 0
}

// By long order number
{
    "orderId": "PP2025060100001AB00012"
}

// By short order number
{
    "frontOrderId": "XM202506010001"
}

// Pagination request (using the nextCursor from the previous response)
{
    "begTime": "2025-06-01T00:00:00+08:00",
    "endTime": "2025-06-30T23:59:59+08:00",
    "pageSize": 200,
    "cursor": "1747209600|12345678",
    "sort": 0
}

Response example:

{
    "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
            }
        ]
    }
}