Query claims
Path: /go/packageOpenApiWeb/OpenApiV2/ClaimQuery
Section titled “Path: /go/packageOpenApiWeb/OpenApiV2/ClaimQuery”Query the claims of a service order. serviceOrderId is required; claimId is optional and narrows the search to one claim within that service order.
For the full field reference see API reference · ClaimQuery.
Notes:
- The response array key is
claim(notclaims). - The payment-method key is
claimPaymentMethod(only the claim-report request usespaymentMethod). - Top-level amounts
claimApplyMoney/claimMoney/claimServiceFeeare strings in the smallest currency unit (e.g."500000"= 5000.00 USD). Do not send numbers; the same fields in the webhook use major-unit strings. - Item rows use
pic/itemNum(integer);claimpayoutTypeis deprecated — ignore it if returned. - When
claimType = 3(delay compensation) orsource = auto_delay, the claim additionally carries the Delay auto-compensation extension fields (source/trackingNumber/carrierCode/carrierName/promisedDeliveryTime/actualDeliveryTime/delayDays/delayTier/points/giftCardUsd/autoCompensationTaskId). Design draft — final fields are subject to engineering confirmation.
Request example:
Section titled “Request example:”{ "serviceOrderId": "20260601XSP0001"}Response example:
Section titled “Response example:”{ "errCode": 0, "errMsg": "success", "data": { "claim": [ { "orderId": "1234567890", "claimId": "CL2024010100001", "claimType": 1, "fileLinks": [ "https://example.com/file1.jpg", "https://example.com/file2.jpg" ], "comments": "Product damaged, claiming.", "claimPaymentObj": 1, "claimPaymentMethod": 1, "claimItems": [ { "itemId": "001", "productId": "p001", "skuId": "ABC123", "variantId": "V001", "itemName": "Product 1", "pic": "https://example.com/pic1.jpg", "priceCurrency": "", "itemNum": 2, "claimApplyMoney": "", "claimReviewMoney": "", "claimType": 1, "claimState": 2 } ], "claimInsuranceType": 3, "claimApplyMoney": "500000", "claimMoney": "450000", "claimMoneyCurrency": "USD", "claimServiceFee": "5000", "claimServiceFeeCurrency": "USD", "claimPaymentState": 2, "claimPaymentTime": "2026-06-05T10:05:00+08:00", "claimCompensationType": 7, "claimReviewState": 1, "claimState": 2, "rejectReasonDetail": "", "claimGenTime": "2026-06-02T14:00:00+08:00", "claimTime": "2026-06-05T10:00:00+08:00", "compensationExtension": { "placeConsumerOrders": { "reissueOrderNo": "reissue-order-100086" } } } ] }}