Skip to content

Cancel coverage (by service order)

Endpoint: /go/packageOpenApiWeb/OpenApiV2/CancelServiceOrder

Section titled “Endpoint: /go/packageOpenApiWeb/OpenApiV2/CancelServiceOrder”

Use the service order ID returned by order synchronization. Shipping-protection IDs contain SP; product-protection IDs contain PP. Both products can be cancelled only before shipment is synchronized. Product protection supports full or partial cancellation before shipment.

The merchant platform must retain the relationship between service orders and order items.

The API does not support cancellation after shipment. For exceptional cases, contact the product and business teams instead of calling this endpoint directly.

See API reference · CancelServiceOrder for the complete schema.

Note:

  • For a partial product-protection cancellation, both cancelFee and cancelItems must be provided. If only one is supplied, the current endpoint processes the request as a full cancellation. If you are unsure, contact the product and business teams before calling the endpoint.
  • The partial-failure list uses the JSON key CancelError (PascalCase).
{
"cancelServiceOrderItems": [
{
"cancelId": "cancel-20250314-001",
"serviceOrderId": "20250314XSP83011364A832",
"cancelTime": "2025-03-14T10:00:00+08:00"
}
]
}
{
"errCode": 0,
"errMsg": "success",
"data": {
"serviceOrderIds": ["20250314XSP83011364A832"],
"CancelError": []
}
}