Appearance
Cancel Programming Order
API Information
- Request Path:
/market/order/programming/cancel - Request Method:
POST - Content-Type:
application/json
Request Headers
| Parameter | Type | Required | Description |
|---|---|---|---|
| Authorization | String | Yes | User authentication token |
| Content-Type | String | Yes | Must be set to application/json |
Request Body Structure
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
| orderNo | String | Yes | Order number of the programming order to cancel | Must identify an existing, eligible programming order |
Request Body Example
json
{
"orderNo": "ORDER_202310270001"
}Response Body Structure
CommonResponse Object
| Field | Type | Description |
|---|---|---|
| code | Integer | Response status code |
| message | String | Response message |
| data | Boolean | true when cancellation completed successfully |
Response Examples
Success Response
json
{
"code": 200,
"message": "success",
"data": true
}Failure Response
json
{
"code": 400,
"message": "Invalid parameters",
"data": null
}Error Code Description
| Error Code | Description |
|---|---|
| 200 | Success |
| 400 | Request parameter error or order not eligible for cancellation |
| 401 | Unauthorized |
| 500 | Server internal error |
Usage Instructions
- Cancels a non-recurring programming order identified by
orderNo. - The caller must be authenticated; server-side checks apply to order type, status, and provider configuration.
- For providers such as TianYi, when order line items carry a remote mission id (
providerOrderNo), the service attempts to delete the mission on the provider side before updating local order state. - On success, the order status is moved to failed (acquisition failed), automatic provider failover for that order is turned off, and a status history entry may be recorded when the status changes.
Notes
- Not applicable to recurring programming orders.
- Orders already delivered or completed cannot be cancelled through this API.
- If the upstream provider cancel API fails (for example TianYi mission DELETE), the operation may surface as a server error after remote cleanup is attempted.