- 京东联盟接口接入说明
- 京东联盟接口
京东联盟订单行查询接口
调用权限：核心接口会员卡调用
接口使用场景等说明：查询推广订单及佣金信息，可查询最近90天内下单的订单，会随着订单状态变化同步更新数据。支持按下单时间、完成时间或更新时间查询。建议按更新时间每分钟调用一次，查询最近一分钟的订单更新数据。
本接口支持查询subunionid、推广位、PID参数，支持普通推客及工具商推客订单查询。
注：参数KEY获取路径：
请按下图所示，登录您的京东联盟后台（https://union.jd.com/）——我的推广——我的工具——我的API——领取KEY
接口请求地址
| 环境 | http 地址 | https 地址 |
|---|---|---|
| 正式环境 | http://api.veapi.cn/jd/orderrowquery | 暂无 |
请求方式：GET 或 POST
请求参数
| 参数名称 | 参数类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| vekey | String | 是 | V123M56 | 公共参数，接口秘钥，请在会员中心获取 |
| pageIndex | Number | 是 | 1 | 页码 |
| pageSize | Number | 是 | 20 | 每页包含条数，上限为500 |
| type | Number | 是 | 1 | 订单时间查询类型:1-下单时间，2-完成时间（购买用户确认收货时间），3-更新时间 |
| startTime | String | 是 | 2020-01-02 21:23:00 | 开始时间 格式yyyy-MM-dd HH:mm:ss，与endTime间隔不超过1小时 |
| endTime | String | 是 | 2020-01-02 21:23:00 | 结束时间 格式yyyy-MM-dd HH:mm:ss，与startTime间隔不超过1小时 |
| childUnionId | Number | 否 | 61800001 | 子推客unionID，传入该值可查询子推客的订单，注意不可和key同时传入。（需联系运营开通PID权限才能拿到数据） |
| key | String | 否 | xxxxxxab4d5247fdac36ddbaf0xxxxxx | 工具商传入推客的授权key，可帮助该推客查询订单，注意不可和childUnionid同时传入。本参数获取路径：登录京东联盟后台（https://union.jd.com/）——我的推广——我的工具——我的API——领取KEY |
| fields | String | 否 | goodsInfo | 支持出参数据筛选，逗号','分隔，目前可用：goodsInfo（商品信息）,categoryInfo(类目信息） |
| orderId | Number | 否 | 415900297816660001 | 订单号，当orderId不为空时，其他参数否 |
请求示例
- HTTP
- PHP
- JAVA
- PYTHON
GET/POST http://api.veapi.cn/jd/orderrowquery?vekey=xxx&startTime=2023-01-07+20:18:14&endTime=2023-01-07+20:18:59&type=1&key=e2e1b6ab1c8b87a738757bac144b52defe3346604e5f47a25132578be8101ea45b41f24d5ea6a829
使用curl函数，curl不是php原生库，需要安装才能使用
$api="http://api.veapi.cn/jd/orderrowquery?vekey=xxx&startTime=2023-01-07+20:18:14&endTime=2023-01-07+20:18:59&type=1&key=e2e1b6ab1c8b87a738757bac144b52defe3346604e5f47a25132578be8101ea45b41f24d5ea6a829"; $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $api); //curl_setopt($ch, CURLOPT_POST, true); //POST方式时启用 //curl_setopt($ch, CURLOPT_POSTFIELDS, $postData ); //POST方式时传参 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); //如果使用https请启用 curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); //如果使用https请启用 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true ); //返回数据流，不直接输出 curl_setopt($ch, CURLOPT_ENCODING, 'gzip'); //使用gzip压缩传输让访问更快 curl_setopt($ch, CURLOPT_TIMEOUT, 6); //允许执行的最长秒数。这里设定6S curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5); $result = curl_exec($ch); $info = curl_getinfo($ch); curl_close($ch); echo $result; //返回值
使用okhttp3/httpclient/jsoup/hutool，以hutool为例：
import cn.hutool.http.HttpResponse;
import cn.hutool.http.HttpRequest;
public class testGetParam {
public static void main(String[] args) {
// API网址
String url = "http://api.veapi.cn/jd/orderrowquery?vekey=xxx&startTime=2023-01-07+20:18:14&endTime=2023-01-07+20:18:59&type=1&key=e2e1b6ab1c8b87a738757bac144b52defe3346604e5f47a25132578be8101ea45b41f24d5ea6a829";
// JDK 8u111版本后，若目标页面为HTTPS协议，请启用proxy用户密码鉴权
//System.setProperty("jdk.http.auth.tunneling.disabledSchemes", "");
// 发送请求
String result = HttpRequest.get(url)
.timeout(10000)//设置超时，毫秒
.execute().body();
System.out.println(result);
}
}
推荐使用 requests，支持访问http,https网页：
import requests # 要访问的API网页 target_url = "http://api.veapi.cn/jd/orderrowquery?vekey=xxx&startTime=2023-01-07+20:18:14&endTime=2023-01-07+20:18:59&type=1&key=e2e1b6ab1c8b87a738757bac144b52defe3346604e5f47a25132578be8101ea45b41f24d5ea6a829" # 发送请求 response = requests.get(target_url) # 获取页面内容 if response.status_code == 200: print response.text
返回值（JSON）
| 参数名称 | 参数类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| id | String | 是 | 415900297816660001 | 标记唯一订单行：订单+sku维度的唯一标识 |
| orderId | Number | 是 | 108618000005 | 订单号 |
| parentId | Number | 是 | 0 | 父单的订单号：如一个订单拆成多个子订单时，原订单号会作为父单号，拆分的订单号为子单号存储在orderid中。若未发生拆单，该字段为0 |
| orderTime | String | 是 | 2020/1/2 15:50 | 下单时间,格式yyyy-MM-dd HH:mm:ss |
| finishTime | String | 是 | 2020/1/3 15:59 | 完成时间（购买用户确认收货时间）,格式yyyy-MM-dd HH:mm:ss |
| modifyTime | String | 是 | 2020/1/2 16:01 | 更新时间,格式yyyy-MM-dd HH:mm:ss |
| orderEmt | Number | 是 | 2 | 下单设备 1.pc 2.无线 |
| plus | Number | 是 | 0 | 下单用户是否为PLUS会员 0：否，1：是 |
| unionId | Number | 是 | 1000618618 | 推客ID |
| skuId | Number | 是 | 44303679033 | 商品ID |
| skuName | String | 是 | 朴坊 WAZZUPbaby 变色龙盲盒第三弹 第三代龙出没注意盲盒 单个盲盒，款式随机 | 商品名称 |
| skuNum | Number | 是 | 1 | 商品数量 |
| skuReturnNum | Number | 是 | 0 | 商品已退货数量 |
| skuFrozenNum | Number | 是 | 0 | 商品售后中数量 |
| price | Number | 是 | 69 | 商品单价 |
| commissionRate | Number | 是 | 5 | 佣金比例(投放的广告主计划比例) |
| subSideRate | Number | 是 | 90 | 分成比例（单位：%） |
| subsidyRate | Number | 是 | 0 | 补贴比例（单位：%） |
| finalRate | Number | 是 | 90 | 最终分佣比例（单位：%）=分成比例+补贴比例 |
| estimateCosPrice | Number | 是 | 54 | 预估计佣金额：由订单的实付金额拆分至每个商品的预估计佣金额，不包括运费，以及京券、东券、E卡、余额等虚拟资产支付的金额。该字段仅为预估值，实际佣金以actualCosPrice为准进行计算 |
| estimateFee | Number | 是 | 2.43 | 推客的预估佣金（预估计佣金额*佣金比例*最终比例），如订单完成前发生退款，此金额也会更新。 |
| actualCosPrice | Number | 是 | 0 | 实际计算佣金的金额。订单完成后，会将误扣除的运费券金额更正。如订单完成后发生退款，此金额会更新。 |
| actualFee | Number | 是 | 0 | 推客分得的实际佣金（实际计佣金额*佣金比例*最终比例）。如订单完成后发生退款，此金额会更新。 |
| validCode | Number | 是 | 16 | sku维度的有效码（-1：未知,2.无效-拆单,3.无效-取消,4.无效-京东帮帮主订单,5.无效-账号异常,6.无效-赠品类目不返佣,7.无效-校园订单,8.无效-企业订单,9.无效-团购订单,11.无效-乡村推广员下单,13. 违规订单-其他,14.无效-来源与备案网址不符,15.待付款,16.已付款,17.已完成（购买用户确认收货）,19.无效-佣金比例为0,20.无效-此复购订单对应的首购订单无效,21.无效-云店订单，22.无效-PLUS会员佣金比例为0，23.无效-支付有礼，24.已付定金，25. 违规订单-流量劫持，26. 违规订单-流量异常，27. 违规订单-违反京东平台规则，28. 违规订单-多笔交易异常 |
| traceType | Number | 是 | 2 | 同跨店：2同店 3跨店 |
| positionId | Number | 是 | 0 | 推广位ID |
| siteId | Number | 是 | 61866 | 应用id（网站id、appid、社交媒体id） |
| unionAlias | String | 是 | **平台 | PID所属母账号平台名称（原第三方服务商来源），两方分佣会有该值 |
| pid | String | 是 | 618_618_618 | 格式:子推客ID_子站长应用ID_子推客推广位ID |
| cid1 | Number | 是 | 1620 | 一级类目id |
| cid2 | Number | 是 | 11158 | 二级类目id |
| cid3 | Number | 是 | 11969 | 三级类目id |
| subUnionId | String | 是 | 331967 | 子渠道标识，在转链时可自定义传入，格式要求：字母、数字或下划线，最多支持80个字符(需要联系运营开放白名单才能拿到数据) |
| unionTag | String | 是 | 1 | 联盟标签数据（32位整型二进制字符串：00000000000000000000000000000001。数据从右向左进行，每一位为1表示符合特征，第1位：红包，第2位：组合推广，第3位：拼购，第5位：有效首次购（0000000000011XXX表示有效首购，最终奖励活动结算金额会结合订单状态判断，以联盟后台对应活动效果数据报表https://union.jd.com/active为准）,第8位：复购订单，第9位：礼金，第10位：联盟礼金，第11位：推客礼金，第12位：京喜APP首购，第13位：京喜首购，第14位：京喜复购，第15位：京喜订单，第16位：京东极速版APP首购，第17位白条首购，第18位校园订单，第19位是0或1时，均代表普通订单，第20位：预售订单，第21位：学生订单，第22位：全球购订单 ，第23位：京喜拼拼首购订单，第24位：京喜拼拼复购订单 例如：00000000000000000000000000000001:红包订单，00000000000000000000000000000010:组合推广订单，00000000000000000000000000000100:拼购订单，00000000000000000000000000011000:有效首购，00000000000000000000000000000111：红包+组合推广+拼购等） 注：一个订单同时使用礼金和红包，仅礼金位数为1，红包位数为0 |
| popId | Number | 是 | 709982 | 商家ID |
| ext1 | String | 是 | hello_world | 推客生成推广链接时传入的扩展字段。 |
| payMonth | String | 是 | 0 | 预估结算时间，订单完成后才会返回，格式：yyyyMMdd，默认：0。表示最新的预估结算日期。当payMonth为当前的未来时间时，表示该订单可结算；当payMonth为当前的过去时间时，表示该订单已结算 |
| cpActId | Number | 是 | 0 | 招商团活动id：当商品参加了招商团会有该值，为0时表示无活动 |
| unionRole | Number | 是 | 1 | 站长角色：1 推客 2 团长 3内容服务商 |
| giftCouponOcsAmount | Number | 是 | 0 | 礼金分摊金额：使用礼金的订单会有该值 |
| giftCouponKey | String | 是 | xxx_coupon_key | 礼金批次ID：使用礼金的订单会有该值 |
| balanceExt | String | 是 | {20191020:10,20191120:-2} | 计佣扩展信息，表示结算月:每月实际佣金变化情况，格式：{20191020:10,20191120:-2}，订单完成后会有该值 |
| sign | String | 否 | B44C0FC3F104167FEC8A53DFD2B26E40 | 数据签名，用来核对出参数据是否被修改，入参fields中写入sign时返回 |
| proPriceAmount | Number | 否 | 6.18 | 价保赔付金额：订单申请价保或赔付的金额，实际计佣金额已经减去此金额，您无需处理 |
| rid | Number | 否 | 37843 | 团长渠道ID，仅限招商团长管理渠道使用，团长开通权限后才可使用。 |
| goodsInfo | Object | 否 | 商品信息，入参传入fields，goodsInfo获取 | |
| └─ imageUrl | String | 否 | http://img14.360buyimg.com/ads/jfs/t22495/56/628456568/380476/9befc935/5b39fb01N7d1af390.jpg | sku主图链接 |
| └─ owner | String | 否 | g | g=自营，p=pop |
| └─ mainSkuId | Number | 否 | 6161111 | 自营商品主Id（owner=g取此值） |
| └─ productId | Number | 否 | 1236547 | 非自营商品主Id（owner=p取此值） |
| └─ shopName | String | 否 | XXXX旗舰店 | 店铺名称（或供应商名称） |
| └─ shopId | Number | 否 | 45619 | 店铺Id |
| categoryInfo | Object | 否 | 类目信息,入参传入fields，categoryInfo获取 | |
| └─ cid1 | Number | 否 | 1 | 一级类目id |
| └─ cid2 | Number | 否 | 2 | 二级类目id |
| └─ cid3 | Number | 否 | 3 | 三级类目id |
| └─ cid1Name | String | 否 | 珠宝首饰 | 一级类目名称 |
| └─ cid2Name | String | 否 | 木手串/把件 | 二级类目名称 |
| └─ cid3Name | String | 否 | 其他 | 三级类目名称 |
| └─ expressStatus | Number | 否 | 10 | 发货状态（10：待发货，20：已发货） |
| channelId | Number | 否 | 1 | 渠道关系ID |
| skuTag | String | 否 | 00001 | 目前unionTag为32位，为支持更多标签标识能力，现新增64位标签字段，64位新标签可以兼容32位unionTag，右32位参考 unionTag字段描述。第35位：广义新订单，第36位：虚拟商品订单 |
| itemId | String | 否 | Q9Z2ZdyMsa9g7jpsfgQNVA0R_3SD7M7ISbsR0zCKPoF | 联盟商品ID |
| callerItemId | String | 否 | UOWr2TlQWFp0JAokyWv5S1fP_309lO7rgdWouKuKnsF | 工具商联盟商品ID |
| hasMore | Boolean | 是 | true | 是否还有更多,true：还有数据；false:已查询完毕，没有数据 |
返回示例
【提示】推广链接通常有时效性，示例中的链接为创建文档时生成，仅用于展示返回结果使用，有可能已失效。
{ "error": "0", "msg": "查询成功！", "data": [ { "actualCosPrice": "0.0", "actualFee": "0.0", "balanceExt": "", "categoryInfo": { "cid1": "0", "cid2": "0", "cid3": "0" }, "channelId": "0", "cid1": "9192", "cid2": "12190", "cid3": "1517", "commissionRate": "3.0", "cpActId": "0", "estimateCosPrice": "19.0", "estimateFee": "0.51", "expressStatus": "10", "ext1": "", "finalRate": "90.0", "finishTime": "", "giftCouponKey": "", "giftCouponOcsAmount": "0.0", "goodsInfo": { "mainSkuId": "0", "productId": "0", "shopId": "0" }, "id": "814954503250251776", "modifyTime": "2023-01-07 20:18:25", "orderEmt": "2", "orderId": "258388333401", "orderTime": "2023-01-07 20:18:14", "parentId": "0", "payMonth": "0", "pid": "", "plus": "0", "popId": "10517493", "positionId": "565561", "price": "19.0", "proPriceAmount": "0.00", "rid": "0", "siteId": "0", "skuFrozenNum": "0", "skuId": "10067823096685", "skuName": "海氏海诺n95口罩 医用灭菌级独立包装30只 成人儿童一次性防护3d立体五层加厚防尘白色4LY 【成人型】5只装", "skuNum": "1", "skuReturnNum": "0", "subSideRate": "90.0", "subUnionId": "", "subsidyRate": "0.0", "traceType": "2", "unionAlias": "", "unionId": "1001034551", "unionRole": "1", "unionTag": "00000000000000000000000000000000", "validCode": "16" } ], "hasMore": false, "request_id": "huK9PuX" }
错误码
如果error不为0时，请点此查看错误码表格
加微信咨询