POST Api/Format/ChannelCancelOrder
渠道取消订单请求
Request Information
URI Parameters
None.
Body Parameters
请求模型
SpeedPower.Utility.Models.Project.Orders.Service.Automatic.ChannelCancelOrderRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderExternalNumber |
外部订单号 |
string |
Required String length: inclusive between 0 and 128 |
| SiteSetting |
站点配置项 |
SpeedPower.Utility.Models.Project.Agents.Service.Setting.ParentSiteSettingModel |
None. |
| OperationTag |
操作标签 |
SpeedPower.Utility.Models.Project.Orders.Service.Automatic.OperationTagModel |
None. |
Request Formats
application/json, text/json
Sample:
{
"OrderExternalNumber": "sample string 1",
"SiteSetting": {
"SiteExpandSettings": [
{
"ID": "329b36ca-8d6b-47e2-9a00-f8d85e0b581d",
"SiteSettingId": "sample string 2",
"SettingKey": "sample string 3",
"SettingValue": "sample string 4"
},
{
"ID": "329b36ca-8d6b-47e2-9a00-f8d85e0b581d",
"SiteSettingId": "sample string 2",
"SettingKey": "sample string 3",
"SettingValue": "sample string 4"
}
],
"ID": "sample string 1",
"CompanyId": "sample string 2",
"ChannelCode": "sample string 3",
"SiteCode": "sample string 4",
"SiteName": "sample string 5",
"SiteStatus": true,
"SiteProfile": "sample string 7",
"Time": "2026-08-08T12:50:11.9183248+08:00"
},
"OperationTag": {
"OrderId": "3a69b92f-44ed-440d-b2ab-4f2497310949",
"Creater": "sample string 2"
}
}
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="OrderExternalNumber" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SiteSetting.SiteExpandSettings[0].ID" 329b36ca-8d6b-47e2-9a00-f8d85e0b581d --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SiteSetting.SiteExpandSettings[0].SiteSettingId" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SiteSetting.SiteExpandSettings[0].SettingKey" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SiteSetting.SiteExpandSettings[0].SettingValue" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SiteSetting.SiteExpandSettings[1].ID" 329b36ca-8d6b-47e2-9a00-f8d85e0b581d --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SiteSetting.SiteExpandSettings[1].SiteSettingId" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SiteSetting.SiteExpandSettings[1].SettingKey" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SiteSetting.SiteExpandSettings[1].SettingValue" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SiteSetting.ID" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SiteSetting.CompanyId" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SiteSetting.ChannelCode" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SiteSetting.SiteCode" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SiteSetting.SiteName" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SiteSetting.SiteStatus" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SiteSetting.SiteProfile" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SiteSetting.Time" 2026-08-08T12:50:11.9183248+08:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="OperationTag.OrderId" 3a69b92f-44ed-440d-b2ab-4f2497310949 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="OperationTag.Creater" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
渠道取消订单请求
SpeedPower.Utility.Models.Project.Orders.Service.Automatic.ChannelCancelOrderResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ErrorType |
错误类型(可为NULL) |
SpeedPower.Utility.Models.Project.Orders.Service.Automatic.ChannelCancelOrderErrorType |
None. |
| Request |
请求模型返回 |
SpeedPower.Utility.Models.Project.Orders.Service.Automatic.ChannelCancelOrderRequestModel |
None. |
| Succeed |
操作是否成功 |
boolean |
None. |
| Message |
操作消息 |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ErrorType": 0,
"Request": {
"OrderExternalNumber": "sample string 1",
"SiteSetting": {
"SiteExpandSettings": [
{
"ID": "7f6e9209-85a7-48c0-ad0e-8aa09dd2689a",
"SiteSettingId": "sample string 2",
"SettingKey": "sample string 3",
"SettingValue": "sample string 4"
},
{
"ID": "7f6e9209-85a7-48c0-ad0e-8aa09dd2689a",
"SiteSettingId": "sample string 2",
"SettingKey": "sample string 3",
"SettingValue": "sample string 4"
}
],
"ID": "sample string 1",
"CompanyId": "sample string 2",
"ChannelCode": "sample string 3",
"SiteCode": "sample string 4",
"SiteName": "sample string 5",
"SiteStatus": true,
"SiteProfile": "sample string 7",
"Time": "2026-08-08T12:50:11.9183248+08:00"
},
"OperationTag": {
"OrderId": "05bc22d3-829b-46bf-bbfc-dcd9efa447a6",
"Creater": "sample string 2"
}
},
"Succeed": true,
"Message": "sample string 2"
}
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ErrorType" ChannelError --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.OrderExternalNumber" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.SiteSetting.SiteExpandSettings[0].ID" 7f6e9209-85a7-48c0-ad0e-8aa09dd2689a --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.SiteSetting.SiteExpandSettings[0].SiteSettingId" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.SiteSetting.SiteExpandSettings[0].SettingKey" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.SiteSetting.SiteExpandSettings[0].SettingValue" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.SiteSetting.SiteExpandSettings[1].ID" 7f6e9209-85a7-48c0-ad0e-8aa09dd2689a --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.SiteSetting.SiteExpandSettings[1].SiteSettingId" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.SiteSetting.SiteExpandSettings[1].SettingKey" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.SiteSetting.SiteExpandSettings[1].SettingValue" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.SiteSetting.ID" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.SiteSetting.CompanyId" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.SiteSetting.ChannelCode" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.SiteSetting.SiteCode" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.SiteSetting.SiteName" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.SiteSetting.SiteStatus" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.SiteSetting.SiteProfile" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.SiteSetting.Time" 2026-08-08T12:50:11.9183248+08:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.OperationTag.OrderId" 05bc22d3-829b-46bf-bbfc-dcd9efa447a6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Request.OperationTag.Creater" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Succeed" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Message" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e--