API文档中心

热门接口:产品ID找同款全量维权查询万能转链字符串ID转换 (有API需求可联系本站)

京东联盟订单查询API

调用权限:核心接口会员卡调用
接口使用场景等说明:

本接口是查询京东联盟推客的推广订单及佣金信息,可查询最近90天内下单的订单,会随着订单状态变化同步更新数据。支持按下单时间、完成时间或更新时间查询。建议按更新时间每分钟调用一次,查询最近一分钟的订单更新数据。支持查询subunionid、推广位、PID参数,支持普通推客及工具商推客订单查询。


官方有可能将该接口下线,尽量不使用本接口,推荐使用订单行查询接口

接口请求地址

环境 http 地址 https 地址
正式环境 http://api.veapi.cn/jd/orderquery 暂无

请求方式:GETPOST

请求参数

参数名称 参数类型 必填 示例值 描述
vekey String V123M56 公共参数,接口秘钥,请在会员中心获取
pageNo Number 1 页码
pageSize Number 20 每页包含条数,上限为500
type Number 1 订单时间查询类型(1:下单时间,2:完成时间(购买用户确认收货时间),3:更新时间
time String 201811031212 查询时间,建议使用分钟级查询,格式:yyyyMMddHH、yyyyMMddHHmm或yyyyMMddHHmmss,如201811031212 的查询范围从12:12:00--12:12:59
childUnionId Number 61800001 子推客unionID,传入该值可查询子推客的订单,注意不可和key同时传入。(需联系运营开通PID权限才能拿到数据)
key String xxxxxxab4d5247fdac36ddbaf0xxxxxx 工具商传入推客的授权key,可帮助该推客查询订单,注意不可和childUnionid同时传入。本参数获取路径:登录京东联盟后台(https://union.jd.com/)——我的推广——我的工具——我的API——领取KEY

请求示例

  • HTTP
  • PHP
  • JAVA
  • PYTHON
GET/POST  http://api.veapi.cn/jd/orderquery?vekey=xxx&time=202301072018&key=e2e1b6ab1c8b87a738757bac144b52defe3346604e5f47a25132578be8101ea45b41f24d5ea6a829 

使用curl函数,curl不是php原生库,需要安装才能使用

$api="http://api.veapi.cn/jd/orderquery?vekey=xxx&time=202301072018&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/orderquery?vekey=xxx&time=202301072018&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/orderquery?vekey=xxx&time=202301072018&key=e2e1b6ab1c8b87a738757bac144b52defe3346604e5f47a25132578be8101ea45b41f24d5ea6a829"

# 发送请求
response = requests.get(target_url)

# 获取页面内容
if response.status_code == 200:
	print response.text

返回值(JSON)

参数名称 参数类型 是否必选 示例值 描述
finishTime Number 1529271683000 订单完成时间((购买用户确认收货时间)时间戳,毫秒)
orderEmt Number 1 下单设备(1:PC,2:无线)
orderId Number 61861861866 订单ID
orderTime Number 1529271683000 下单时间(时间戳,毫秒)
parentId Number 66661861866 父单的订单号:如某个订单因为仓储物流或其它原因拆成多笔订单时,拆分前的原订单号会作为父单号存储在该字段中,拆分出的新订单号作为子单号存储在orderid中,若未发生拆单,该字段为0
payMonth String 20180618 订单维度预估结算时间,不建议使用,可以用订单行sku维度paymonth字段参考,(格式:yyyyMMdd),0:未结算,订单'预估结算时间'仅供参考。账号未通过资质审核或订单发生售后,会影响订单实际结算时间。
plus Number 1 下单用户是否为PLUS会员 0:否,1:是
popId Number 1000066618 订单维度商家ID,不建议使用,可以用订单行sku维度popId参考
skuList Skuinfo[]   订单包含的商品信息列表
actualCosPrice Number 6.88 实际计算佣金的金额。订单完成后,会将误扣除的运费券金额更正。如订单完成后发生退款,此金额会更新。
actualFee Number 6.18 推客获得的实际佣金(实际计佣金额*佣金比例*最终比例)。如订单完成后发生退款,此金额会更新。
commissionRate Number 2.5 佣金比例
estimateCosPrice Number 618.18 预估计佣金额:由订单的实付金额拆分至每个商品的预估计佣金额,不包括运费,以及京券、东券、E卡、余额等虚拟资产支付的金额。该字段仅为预估值,实际佣金以actualCosPrice为准进行计算
estimateFee Number 6.18 推客的预估佣金(预估计佣金额*佣金比例*最终比例),如订单完成前发生退款,此金额也会更新。
finalRate Number 100 最终比例(分成比例+补贴比例)
cid1 Number 737 一级类目ID
frozenSkuNum Number 1 商品售后中数量
pid String 618_618_6018 联盟子站长身份标识,格式:子站长ID_子站长网站ID_子站长推广位ID
positionId Number 66 推广位ID,0代表无推广位
price Number 61.8 商品单价
cid2 Number 738 二级类目ID
siteId Number 6000618 网站ID,0:无网站
skuId Number 5487565 商品ID
skuName String 空气净化器 除雾霾 除甲醛 空气质量屏幕显示 三层净化 商品名称
skuNum Number 2 商品数量
skuReturnNum Number 1 商品已退货数量
subSideRate Number 90 分成比例
subsidyRate Number 10 补贴比例
cid3 Number 749 三级类目ID
unionAlias String **平台 PID所属母账号平台名称(原第三方服务商来源)
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
unionTrafficGroup Number 1 渠道组 1:1号店,其他:京东
validCode Number 18 sku维度的有效码(-1:未知,2.无效-拆单,3.无效-取消,4.无效-京东帮帮主订单,5.无效-账号异常,6.无效-赠品类目不返佣,7.无效-校园订单,8.无效-企业订单,9.无效-团购订单,10.无效-开增值税专用发票订单,11.无效-乡村推广员下单,13.无效-违规订单,14.无效-来源与备案网址不符,15.待付款,16.已付款,17.已完成,18.已结算(5.9号不再支持结算状态回写展示))
subUnionId String   子渠道标识,在转链时可自定义传入,格式要求:字母、数字或下划线,最多支持80个字符(需要联系运营开放白名单才能拿到数据)
traceType Number 3 2:同店;3:跨店
payMonth Number 20180618 订单行维度预估结算时间(格式:yyyyMMdd),0:未结算。订单'预估结算时间'仅供参考。账号未通过资质审核或订单发生售后,会影响订单实际结算时间。
popId Number 30871 商家ID。'订单行维度'
ext1 String 1_1255413_0_XXXX 推客生成推广链接时传入的扩展字段(需要联系运营开放白名单才能拿到数据)。'订单行维度'
cpActId Number 618 招商团活动id:当商品参加了招商团会有该值,为0时表示无活动
unionRole Number 1 站长角色:1 推客 2 团长 3内容服务商
giftCouponKey String xxx_coupon_key 礼金批次ID:使用礼金的订单会有该值
giftCouponOcsAmount Number 100 礼金分摊金额:使用礼金的订单会有该值
proPriceAmount Number 6.18 价保赔付金额:订单申请价保或赔付的金额,实际计佣金额已经减去此金额,您无需处理
unionId Number 2018618618 推客的联盟ID
ext1 String 100_618_大促 订单维度的推客生成推广链接时传入的扩展字段,不建议使用,可以用订单行sku维度ext1参考,(需要联系运营开放白名单才能拿到数据)
validCode Number 18 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. 违规订单-多笔交易异常
hasMore Boolean TRUE 是否还有更多,true:还有数据;false:已查询完毕,没有数据

返回示例

【提示】推广链接通常有时效性,示例中的链接为创建文档时生成,仅用于展示返回结果使用,有可能已失效。
{ "error": "0", "msg": "查询成功!", "data": [ { "ext1": "", "finishTime": "0", "orderEmt": "2", "orderId": "258388333401", "orderTime": "1673093894000", "parentId": "0", "payMonth": "0", "plus": "0", "popId": "10517493", "skuList": [ { "actualCosPrice": "0.00", "actualFee": "0.00", "cid1": "9192", "cid2": "12190", "cid3": "1517", "commissionRate": "3.00", "cpActId": "0", "estimateCosPrice": "19.00", "estimateFee": "0.51", "ext1": "", "finalRate": "90.00", "frozenSkuNum": "0", "giftCouponKey": "", "giftCouponOcsAmount": "0.00", "payMonth": "0", "pid": "", "popId": "10517493", "positionId": "565561", "price": "19.00", "proPriceAmount": "0.00000", "siteId": "0", "skuId": "10067823096685", "skuName": "海氏海诺n95口罩 医用灭菌级独立包装30只 成人儿童一次性防护3d立体五层加厚防尘白色4LY 【成人型】5只装", "skuNum": "1", "skuReturnNum": "0", "subSideRate": "90.00", "subUnionId": "", "subsidyRate": "0.00", "traceType": "2", "unionAlias": "", "unionRole": "1", "unionTag": "00000000000000000000000000000000", "unionTrafficGroup": "4", "validCode": "16" } ], "unionId": "1001034551", "validCode": "16" } ], "hasMore": false, "request_id": "KDpxWwK" }

错误码

如果error不为0时,请点此查看错误码表格

在线
客服

会员请加QQ群交流:

微信
咨询

加微信咨询
顶部