有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

本接口(QueryClientDeals)用于查询指定代理商名下所有订单,包括代理商自付、代付订单以及代理商名下代客自付订单。此接口主要用于辅助代理商对账使用,所以主要提供跟金额有关的信息,不提供商品详细信息。
接口请求域名:partners.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共请求参数 页面。其中,此接口的 Action 字段为 QueryClientDeals。

参数名称 是否必选 类型 描述
creatTimeRangeStart String 下单时间范围起始,格式为 2016-11-11 00:00:00
creatTimeRangeEnd String 下单时间范围结束,格式为 2016-11-11 00:00:00
page Int 分页号,从0开始
rows Int 页码大小,最大值为30
order Int 按下单时间对订单列表排序,0:降序;1:升序
status Int 订单的状态
1:未支付
2:已支付
3:发货中
4:已发货
5:发货失败
6:已退款
7:已关单
8:订单过期
9:订单已失效
10:产品已失效
11:代付拒绝
12:支付中
ownerUin String 下单人 uin
payerMode Int 支付方式,0:自付;1:代付

3. 输出参数

参数名称 类型 描述
code Int 公共错误码,0 表示成功,其他值表示失败。详见错误码页面的 公共错误码
codeDesc String 业务侧错误码。成功时返回 Success,错误时返回具体业务错误原因。
message String 模块错误信息描述,与接口相关。
data Array 输出结果,包含查询到的所有定时任务列表信息。

其中,data 参数的构成如下:

参数名称 类型 描述
totalNum Int 查询到的订单总数量
deals Array 指定分页的订单集合

其中,deals 中每个订单根据订单对应商品类型,包含的信息会有不同,每个订单的基本信息如下:

参数名称 类型 描述
dealId String 订单自增 ID
dealName String 订单号
goodsCategoryId String 商品类型 ID
ownerUin String 订单所有者
appId String 订单所有者对应 appId
goodsNum String 商品数量
goodsPrice String 价格详情, json 字符串,realTotalCost 代表实付金额(不包含代金券)
creater String 下单人
creatTime String 下单时间
payEndTime String 支付结束时间
billId String 扣费流水号
payer String 支付人
payerMode String 0:自付;1:代付
dealStatus String 订单状态,中文描述
status String 订单状态,数字
goodsName String 产品名称
clientRemark String 客户备注
flag String 客户类型,值为:a,b,c
actionType String 订单操作类型,purchase(新购),renew(续费),modify(配置变更)
voucherDecline Int 代金券抵扣金额,单位分
bigDealId String 大订单号
clientType String 客户类型(new:新拓;old:存量;assign:指派)
projectType String 项目类型(self:自拓;repeat:直销;platform:官网合作)

4. 示例

https://partners.api.qcloud.com/v2/index.php?
&<公共请求参数>
&page=0&rows=1

返回示例如下,符合条件订单有69个,但是分页指定仅返回一个:

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "totalNum": "2750",
        "deals": [
            {
                "dealId": "24***598",
                "dealName": "201904****7525",
                "bigDealId": "2019*****526",
                "goodsCategoryId": "10**19",
                "ownerUin": "328***433",
                "appId": "1251***831",
                "goodsNum": "1",
                "goodsPrice": {
                    "realTotalCost": 3874
                },
                "creater": "75420214",
                "creatTime": "2019-04-01 11:08:57",
                "payer": "3286***433",
                "billId": "2019040******885387530174345",
                "payEndTime": "2019-04-01 11:09:03",
                "status": "4",
                "voucherDecline": null,
                "payerMode": "0",
                "goodsName": "新购云服务器",
                "clientRemark": "",
                "flag": "",
                "clientType": "",
                "projectType": "",
                "dealStatus": "分配完成",
                "actionType": "purchase"
            }
        ]
    }
}