1. 接口描述
接口请求域名: partners.tencentcloudapi.com 。
可以查询代理商代付的预付费订单
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAgentPayDealsV2。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-21。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Offset | 是 | Integer | 偏移量 示例值:0 |
Limit | 是 | Integer | 限制数目 最大100 示例值:10 |
CreatTimeRangeStart | 否 | Timestamp | 下单时间范围起始点(不传时会默认查15天内订单,传值时需要传15天内的起始时间) 示例值:2020-01-01 00:00:00 |
CreatTimeRangeEnd | 否 | Timestamp | 下单时间范围终止点 示例值:2020-01-01 00:00:00 |
Order | 否 | Integer | 0:下单时间降序;其他:下单时间升序 示例值:0 |
Status | 否 | Integer | 订单的状态(1:未支付;2:已支付;3:发货中;4:已发货;5:发货失败;6:已退款;7:已关单;8:订单过期;9:订单已失效;10:产品已失效;11:代付拒绝;12:支付中) 示例值:2 |
OwnerUins.N | 否 | Array of String | 下单人账号ID列表 示例值:[100001,100002] |
DealNames.N | 否 | Array of String | 子订单号列表 示例值:["2020101030303"] |
BigDealIds.N | 否 | Array of String | 大订单号列表 示例值:["2020101030303"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AgentPayDealSet | Array of AgentDealNewElem | 订单数组 |
TotalCount | Integer | 符合条件的订单总数量 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取某代理商代付订单
输入示例
POST / HTTP/1.1
Host: partners.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAgentPayDealsV2
<公共请求参数>
{
"Limit": "1",
"Offset": "0"
}
输出示例
{
"Response": {
"RequestId": "asas",
"AgentPayDealSet": [
{
"DealId": "1078264383",
"DealName": "20240108122000905906371",
"BigDealId": "20240108122000905906361",
"GoodsCategoryId": "100058",
"OwnerUin": "700000232122",
"AppId": "251205747",
"GoodsNum": "1",
"GoodsPrice": {
"RealTotalCost": 1650,
"OriginalTotalCost": 1750
},
"ProductInfo": [
{
"Name": "磁盘属性",
"Value": "数据盘"
},
{
"Name": "容量",
"Value": "50GB"
},
{
"Name": "磁盘类型",
"Value": "高性能云硬盘"
},
{
"Name": "可用区",
"Value": "广州二区"
}
],
"Creater": "700000232122",
"CreatTime": "2024-01-08 10:13:49",
"UpdateTime": "2024-01-08 10:14:55",
"PaymentMethod": "按月:1个月",
"Payer": "700000413752",
"BillId": "20240108122000905906371",
"PayEndTime": "2024-01-08 10:14:53",
"Status": "4",
"VoucherDecline": "100",
"PayerMode": "1",
"GoodsName": "云硬盘CBS",
"SubGoodsName": "高性能云硬盘",
"ClientRemark": "",
"ClientType": "new",
"ProjectType": "platform",
"SalesUin": "0",
"DealStatus": "分配完成",
"ActionType": "purchase",
"ActivityId": "",
"OverdueTime": "2024-01-23 10:13:48",
"ResourceIds": [
"disk-bos529hc"
]
}
],
"TotalCount": 154
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
UnauthorizedOperation | 未授权操作。 |