Skip to content

Cancel Programming Order ​

API Information ​

  • Request Path: /market/order/programming/cancel
  • Request Method: POST
  • Content-Type: application/json

Request Headers ​

ParameterTypeRequiredDescription
AuthorizationStringYesUser authentication token
Content-TypeStringYesMust be set to application/json

Request Body Structure ​

FieldTypeRequiredDescriptionConstraints
orderNoStringYesOrder number of the programming order to cancelMust identify an existing, eligible programming order

Request Body Example ​

json
{
  "orderNo": "ORDER_202310270001"
}

Response Body Structure ​

CommonResponse Object ​

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataBooleantrue 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 CodeDescription
200Success
400Request parameter error or order not eligible for cancellation
401Unauthorized
500Server internal error

Usage Instructions ​

  1. Cancels a non-recurring programming order identified by orderNo.
  2. The caller must be authenticated; server-side checks apply to order type, status, and provider configuration.
  3. 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.
  4. 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.