有奖捉虫:云通信与企业服务文档专题,速来> HOT
文档中心 > 渠道合作伙伴 > 渠道 API 文档 > 订单操作相关接口 > 代理商缓存订单查询接口(预付费)

1. 接口描述

接口请求域名: partners.tencentcloudapi.com 。

供代理商拉取缓存的全量预付费客户订单

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAgentDealsByCache。
Version String 公共参数,本接口取值:2018-03-21。
Region String 公共参数,此参数为可选参数。
Offset Integer 偏移量
示例值:0
Limit Integer 限制数目 最大200
示例值:10
CreatTimeRangeStart Timestamp 下单时间范围起始点【请保持时间范围最大90天】
示例值:2020-01-01 00:00:00
CreatTimeRangeEnd Timestamp 下单时间范围终止点【请保持时间范围最大90天】
示例值:2020-01-01 00:00:00
Order Integer 0:下单时间降序;其他:下单时间升序
示例值:0
Status Integer 订单的状态(1:未支付;2:已支付;3:发货中;4:已发货;5:发货失败;6:已退款;7:已关单;8:订单过期;9:订单已失效;10:产品已失效;11:代付拒绝;12:支付中)
示例值:1
OwnerUins.N Array of String 下单人账号ID列表
示例值:100001
DealNames.N Array of String 子订单号列表
示例值:["202001010000123456', '202001010000123457"]
BigDealIds.N Array of String 大订单号列表
示例值:["202001010000123456', '202001010000123457"]
PayerMode Integer 支付方式,0:自付;1:代付
示例值:0

3. 输出参数

参数名称 类型 描述
AgentDealSet Array of AgentDealNewElem 订单数组
TotalCount Integer 符合条件的订单总数量
示例值:401321
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取某代理商缓存订单

输入示例

POST / HTTP/1.1
Host: partners.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAgentDealsByCache
<公共请求参数>

{
    "Limit": "1",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "RequestId": "78b52639-8471-41c1-a05a-1ea787a605e0",
        "AgentDealSet": [
            {
                "DealId": "290644558",
                "DealName": "20240108121000906445591",
                "BigDealId": "20240108121000906445581",
                "GoodsCategoryId": "176258",
                "OwnerUin": "700000232121",
                "AppId": "251205746",
                "GoodsNum": "1",
                "GoodsPrice": {
                    "RealTotalCost": -100000,
                    "OriginalTotalCost": -100000
                },
                "ProductInfo": [
                    {
                        "Name": "计费测试商品新购",
                        "Value": "jfcs"
                    }
                ],
                "Creater": "700000232121",
                "CreatTime": "2024-01-08 15:56:08",
                "UpdateTime": "2024-01-08 15:56:12",
                "PaymentMethod": "按月:个月",
                "Payer": "700000232121",
                "BillId": "20240108121000906445591",
                "PayEndTime": "2024-01-08 15:56:11",
                "Status": "6",
                "VoucherDecline": "0",
                "PayerMode": "0",
                "GoodsName": "计费测试商品",
                "SubGoodsName": "非资源工厂验证预付费子产品(勿动)",
                "ClientRemark": "",
                "ClientType": "new",
                "ProjectType": "platform",
                "SalesUin": "0",
                "DealStatus": "已退款",
                "ActionType": "refund",
                "ActivityId": "",
                "OverdueTime": "2024-01-23 15:56:08",
                "ResourceIds": [
                    "4712106445241"
                ],
                "RefundMap": [
                    {
                        "DealName": "20240108121000906445241",
                        "RefundAmount": 100000
                    }
                ]
            }
        ],
        "TotalCount": 23408
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
UnauthorizedOperation 未授权操作。