POST Api/Format/ChannelCancelOrder

渠道取消订单请求

Request Information

URI Parameters

None.

Body Parameters

请求模型

SpeedPower.Utility.Models.Project.Orders.Service.Automatic.ChannelCancelOrderRequestModel
NameDescriptionTypeAdditional 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": "b539628d-7066-410b-9ef6-b6dd8222167a",
        "SiteSettingId": "sample string 2",
        "SettingKey": "sample string 3",
        "SettingValue": "sample string 4"
      },
      {
        "ID": "b539628d-7066-410b-9ef6-b6dd8222167a",
        "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": "2025-09-14T08:13:27.9615276+08:00"
  },
  "OperationTag": {
    "OrderId": "b3fac2ea-4028-4bed-b317-511284344b03",
    "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"

b539628d-7066-410b-9ef6-b6dd8222167a
--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"

b539628d-7066-410b-9ef6-b6dd8222167a
--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"

2025-09-14T08:13:27.9615276+08:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OperationTag.OrderId"

b3fac2ea-4028-4bed-b317-511284344b03
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OperationTag.Creater"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

渠道取消订单请求

SpeedPower.Utility.Models.Project.Orders.Service.Automatic.ChannelCancelOrderResponseModel
NameDescriptionTypeAdditional 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": "034d577f-728c-48da-8120-7486100b0eb9",
          "SiteSettingId": "sample string 2",
          "SettingKey": "sample string 3",
          "SettingValue": "sample string 4"
        },
        {
          "ID": "034d577f-728c-48da-8120-7486100b0eb9",
          "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": "2025-09-14T08:13:27.9615276+08:00"
    },
    "OperationTag": {
      "OrderId": "72eae358-168d-42fc-af44-da57ee221191",
      "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"

034d577f-728c-48da-8120-7486100b0eb9
--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"

034d577f-728c-48da-8120-7486100b0eb9
--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"

2025-09-14T08:13:27.9615276+08:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Request.OperationTag.OrderId"

72eae358-168d-42fc-af44-da57ee221191
--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--