技术文档

【CPS服务】接口导航

由于京东联盟（http://media.jd.com）系统优化升级，京东联盟API将于 2014年04月03 起停用。

新的京东联盟API预计可于二季度末开放。由此带来的不便，还请谅解！

1. 联盟店铺转换	2. 联盟推广活动查询
3. 联盟推广商品查询	4. 联盟店铺搜索
5. 查询效果报表数据	6. 获取联盟用户详细信息
7. 获取专柜推广报表	8. 商品转换接口(获取商品推广代码)
9. 店铺转换接口(获取店铺推广代码)	10. 活动转换接口(获取活动推广代码)
11. 获取专柜信息	12. 专柜转换接口(获取专柜推广代码)
13. 获取效果概况	14.获取结算单信息
15. 获取计划列表	16. 获取计划详情
17. 查询店铺推广详情	18. 获取类目信息
19. 保存计划信息	20. 保存计划基本信息

1. 联盟店铺转换

接口名称：

jingdong.union.promotionshop.update

功能说明：

查询相关的店铺名称的店铺推广数据（查询若无结果或者没输入查询条件则返回默认店铺推广数据）

API用户授权类型：

不需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	否	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
shopName	String	否		店铺名称串,如果shopName不填或者没有相匹配的店铺信息则返回默认的推广数据
fields	String	否	shop_name,shop_promUrl,shop_materialUrl, shop_goodsVolume,shop_praiseDegree, shop_promQuantity,shop_mainCategories, shop_pk,shop_name,totalCount	需返回的字段列表

返回结果

名称	类型	示例值	描述
shopList	ShopSafVo[ ]		店铺推广列表
totalCount	Number		结果总数,如果为null和设置field时没有设置该属性则在结果中不显示
isDefault	Boolean		返回的结果是否是默认的推广数据

GoodSafVo（商品推广对象列表）

名称	类型	是否必须	示例值	描述
shop_name	String	否		店铺名称,如果为null和设置field时没有设置该属性则在结果中不显示
shop_promUrl	String	否		店铺推广URL,如果为null和设置field时没有设置该属性则在结果中不显示
shop_commRatio	Number	否		店铺佣金比例
shop_praiseDegree	Number	否		好评度
shop_promQuantity	Number	否		累计推广量
shop_goodsVolume	Number	否		店铺内商品总数
shop_materialUrl	String	否		店铺logurl,如果为null和设置field时没有设置该属性则在结果中不显示
shop_pk	Number	否		主键
shop_mainCategories	String	否		主营类目,如果为null和设置field时没有设置该属性则在结果中不显示

返回示例

JSON数据格式

{
    "jingdong_union_promotionshop_update_response": {
        "msg": {
            "shopList": {
                "shop_promUrl": "",
                "shop_commRatio": "",
                "shop_materialUrl": "",
                "shop_goodsVolume": "",
                "shop_praiseDegree": "",
                "shop_promQuantity": "",
                "shop_mainCategories": "",
                "shop_pk": "",
                "shop_name": ""
            },
            "isDefault": "",
            "totalCount": ""
        }
    }
}

2. 联盟推广活动查询

接口名称：

jingdong.union.promotionactivity.query

功能说明：

查询相关的活动推广数据

API用户授权类型：

不需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	否	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
keywords	String	否		活动名称关键字,如果activity_keywords和activity_categoryId为空或者是没有找到相匹配的结果，则返回默认的广数据
categoryId	Number	否		活动所属类目ID,如果activity_keywords和activity_categoryId为空或者是没有找到相匹配的结果，则返回默认的推广数据
property	String	否	commisionRatio	排序列的属性名，默认值commisionRatio
sort	String	否	DESC/ASC	升序或降序排列,默认值DESC
pageIndex	Number	是		页码，当输入页码小于1时候默认pageIndex为1
pageSize	Number	是		每页条数，当输入条数小于1时候默认pageSize为10
fields	Number	否	activity_pk,activity_name,activity_url, activity_width,activity_height, activity_start,activity_end, activity_shopName,activity_mainCategory, activity_commRatio,totalCount	需要返回的字段

返回结果

名称	类型	示例值	描述
activity_list	ActivitySafVo[ ]		联盟活动对象列表
totalCount	Number		结果总个数,如果为null和设置field时没有设置该属性则在结果中不显示
isDefault	Boolean		返回的结果是否是默认的推广数据

ActivitySafVo（联盟活动对象列表）

名称	类型	是否必须	示例值	描述
activity_name	String	否		活动名称,如果为null和设置field时没有设置该属性则在结果中不显示
activity_url	String	否		活动推广URL,如果为null和设置field时没有设置该属性则在结果中不显示
activity_width	Number	否		图片宽度
activity_height	Number	否		图片长度
activity_start	Date	否		推广开始时间
activity_end	Date	否		推广开始时间
activity_shopName	String	否		店铺名称,如果为null和设置field时没有设置该属性则在结果中不显示
activity_mainCategory	String	否		主营类目,如果为null和设置field时没有设置该属性则在结果中不显示
activity_commRatio	Number	否		佣金比例
activity_pk	String	否		主键

返回示例

JSON数据格式

{
    "jingdong_union_promotionactivity_query_response": {
        "msg": {
            "isDefault": "",
            "totalCount": "",
            "activity_list": {
                "activity_pk": "",
                "activity_start": "",
                "activity_height": "",
                "activity_url": "",
                "activity_width": "",
                "activity_shopName": "",
                "activity_name": "",
                "activity_mainCategory": "",
                "activity_end": "",
                "activity_commRatio": ""
            }
        }
    }
}

3. 联盟推广商品查询

接口名称：

jingdong.union.promotiongood.query

功能说明：

查询相关的商品推广数据（查询若无结果或者没输入查询条件则返回默认商品推广数据）

注：查询结果（数量）基于京东联盟后台数据

API用户授权类型：

不需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	否	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
keywords	String	否		商品标题包含关键词,如果good_keywords和good_categoryId不填或者没有相匹配的查询结果,则会返回默认的推广数据
categoryId	Number	否		商品类目ID,如果good_keywords和good_categoryId不填或者没有相匹配的查询结果,则会返回默认的推广数据
property	String	否	price/commisionRatio/promotionQuantity	排序列的属性名,默认值commisionRatio
sort	String	否	DESC/ASC	升序或降序排列,默认值DESC
pageIndex	Number	是		结果页数
pageSize	Number	是		每页放回的结果数,每页上限为20
fields	Number	否	good_pk,good_skuId,good_shopName, good_name,good_price,good_praiseDegree, good_targetUrl,good_shopUrl,good_materialUrl, good_commRatio,good_commision, good_promQuantity,good_startDate,good_endDate, totalCount	需要返回的字段列表

返回结果

名称	类型	示例值	描述
good_list	GoodSafVo[ ]		商品推广对象列表
totalCount	Number		总个数,如果为null和设置field时没有设置该属性则在结果中不显示
isDefault	Boolean		返回的结果是否是默认的推广数据

GoodSafVo（商品推广对象列表）

名称	类型	是否必须	示例值	描述
good_pk	Number	否		主键（京东联盟中的商品编号）
good_skuId	Number	否		sku id
good_shopName	String	否		商家名称,如果为null和设置field时没有设置该属性则在结果中不显示
good_name	String	否		商品标题名称,如果为null和设置field时没有设置该属性则在结果中不显示
good_price	Number	否		商品价格，返回结果负数不做处理
good_praiseDegree	Number	否		好评度
good_targetUrl	String	否		目标页URL,如果为null和设置field时没有设置该属性则在结果中不显示
good_shopUrl	String	否		店铺URL,如果为null和设置field时没有设置该属性则在结果中不显示
good_materialUrl	String	否		商品主图素材URL，如果为null和设置field时没有设置该属性则在结果中不显示，字段为空不做特殊处理
good_commRatio	Number	否		佣金比例
good_commision	Number	否		佣金
good_promQuantity	Number	否		30天内的交易量
good_startDate	Date	否		推广开始时间
good_endDate	Date	否		推广开始时间

返回示例

JSON数据格式

{
    "jingdong_union_promotiongood_query_response": {
        "msg": {
            "isDefault": "",
            "totalCount": "",
            "good_list": {
                "good_endDate": "",
                "good_shopName": "",
                "good_targetUrl": "",
                "good_materialUrl": "",
                "good_promQuantity": "",
                "good_praiseDegree": "",
                "good_startDate": "",
                "good_name": "",
                "good_commRatio": "",
                "good_price": "",
                "good_pk": "",
                "good_shopUrl": "",
                "good_commision": "",
                "good_skuId": ""
            }
        }
    }
}

4. 联盟店铺搜索

接口名称：

jingdong.union.promotionshop.query

功能说明：

搜索相关的店铺推广数据

API用户授权类型：

不需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	否	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
keywords	String	否	田云素衣	店铺主题关键字,如果shop_categoryId和shop_keywords都不填或者输入的查询条件没有相匹配的结果则返回默认的推广数据
categoryId	Number	否		一级类目ID,如果shop_categoryId和shop_keywords都不填或者输入的查询条件没有相匹配的结果则返回默认的推广数据
property	String	否	commisionRatio/goodsVolume/promotionQuantity/praiseDegree	排序列的属性名,默认值commisionRatio
sort	String	否	DESC/ASC	升序或降息排列,默认值DESC
pageIndex	Number	是		结果页数
pageSize	Number	是		每页显示的结果数,上限为20
fields	Number	否	shop_commRatio,shop_materialUrl, shop_goodsVolume,shop_praiseDegree, shop_promQuantity,shop_mainCategories, shop_pk,shop_promotionUrl,shop_name, totalCount	返回的字段列表

返回结果

名称	类型	示例值	描述
shop_list	ShopSafVo[ ]		店铺推广对象列表
totalCount	Number		结果总个数,如果为null和设置field时没有设置该属性则在结果中不显示
isDefault	Boolean		返回的结果是否是默认推广数据

ShopSafVo（店铺推广对象列表）

名称	类型	是否必须	示例值	描述
shop_pk	Number	否		主键
shop_name	String	否		店铺名称,如果为null和设置field时没有设置该属性则在结果中不显示
shop_promotionUrl	String	否		推广URL,如果为null和设置field时没有设置该属性则在结果中不显示
shop_commRatio	Number	否		佣金比例
shop_praiseDegree	Number	否		好评度
shop_promQuantity	Number	否		累计推广量
shop_goodsVolume	Number	否		商品总量
shop_materialUrl	String	否		主图URL,如果为null和设置field时没有设置该属性则在结果中不显示
shop_mainCategories	String	否		主营类目,如果为null和设置field时没有设置该属性则在结果中不显示

返回示例

JSON数据格式

{
    "jingdong_union_promotionshop_query_response": {
        "msg": {
            "shop_list": {
                "shop_commRatio": "",
                "shop_materialUrl": "",
                "shop_goodsVolume": "",
                "shop_praiseDegree": "",
                "shop_promQuantity": "",
                "shop_mainCategories": "",
                "shop_pk": "",
                "shop_promotionUrl": "",
                "shop_name": ""
            },
            "isDefault": "",
            "totalCount": ""
        }
    }
}

5. 查询效果报表数据

接口名称：

jingdong.union.promotionreport.query

功能说明：

查询站长的推广效果数据

API用户授权类型：

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
startDate	Date	是	2013-05-0900:00:00	起始时间,日期格式:yyyy-MM-ddHH:mm:ss （仅支持按日查询，时分秒数据只可为00:00:00）
endDate	Date	是	2013-05-3000:00:00	结束时间,日期格式:yyyy-MM-ddHH:mm:ss （仅支持按日查询，时分秒数据只可为00:00:00）
pageIndex	Number	是	1	页码
pageSize	Number	是	20	每页显示条数,上限为20
fields	Number	否	report_skuId,report_itemNum, report_shopName,report_itemPrice, report_commRatio,report_sourceType, report_orderNo,report_unionId, report_commision,report_itemName, report_orderStatus,totalCount	需要返回返回的字段列表

返回结果

名称	类型	示例值	描述
report_list	EffectReportSafVo[ ]		报表对象列表
totalCount	Number		结果总个数,如果为null和设置field时没有设置该属性则在结果中不显示

EffectReportSafVo（报表对象列表）

名称	类型	是否必须	示例值	描述
report_unionId	Number	否		联盟ID
report_orderNo	Number	否		订单号
report_commRatio	Number	否		佣金比例
report_commision	Number	否		佣金
report_sourceType	String	否		推广来源（stdl：静态链接；adsp：动态链接）静态链接：专柜推广链接动态链接：店铺、商品、活动推广链接
report_orderStatus	Number	否		订单状态（1:待完成 2:完成 3:无效）
report_itemPrice	Number	否		商品价格
report_skuId	Number	否		skuid,如果为null和设置field时没有设置该属性则在结果中不显示
report_itemName	String	否		商品名称,如果为null和设置field时没有设置该属性则在结果中不显示
report_itemNum	Number	否		商品数量,如果为null和设置field时没有设置该属性则在结果中不显示
report_shopName	String	否		店铺名称,如果为null和设置field时没有设置该属性则在结果中不显示

返回示例

JSON数据格式

{
    "jingdong_union_promotionreport_query_response": {
        "msg": {
            "totalCount": "",
            "report_list": {
                "report_skuId": "",
                "report_itemNum": "",
                "report_shopName": "",
                "report_itemPrice": "",
                "report_commRatio": "",
                "report_sourceType": "",
                "report_orderNo": "",
                "report_unionId": "",
                "report_commision": "",
                "report_itemName": "",
                "report_orderStatus": ""
            }
        }
    }
}

6. 获取联盟用户详细信息

接口名称：

jingdong.union.master.account.get

功能说明：

获取联盟用户详细信息

API用户授权类型：

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
				此接口无需输入应用级参数，但需要构建空参数360buy_param_json={}

返回结果

名称	类型	示例值	描述
union_id	String		联盟id
type	Number	1,2	联盟类型:1-个人，2-公司
pin	String		京东账号名称
nick	String		昵称
mobile	String		联系电话
email	String		电子邮件地址
name	String		姓名
campany_name	String		公司名称（公司类型）
campany_address	String		公司联系地址
bank_name	String		收款银行名称
bank_address	String		收款银行开户地址
card_no	String		银行账号（卡号）
owner_name	String		收款人姓名
owner_id	String		收款人身份证号

返回示例

JSON数据格式

{
"jingdong_union_master_account_get_responce":{
"campany_name":"",
"bank_name":"",
"owner_name":"",
"card_no":"",
"type":"1,
2",
"union_id":"",
"nick":"",
"pin":"",
"email":"",
"name":"",
"owner_id":"",
"campany_address":"",
"bank_address":"",
"mobile":""
}

7. 获取专柜推广报表

接口名称：

jingdong.union.report.window.search

功能说明：

获取专柜推广报表详细信息

API用户授权类型：

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
page_index	Number	是		页码
page_size	Number	是		每页显示的记录数
start_date	Date	是	2013-07-03 00:00:00	开始时间,格式:yyyy-MM-dd HH:mm:ss（仅支持按日查询，时分秒数据只可为00:00:00）
end_date	Date	是	2013-07-03 00:00:00	结束时间,格式:yyyy-MM-dd HH:mm:ss （仅支持按日查询，时分秒数据只可为00:00:00）

返回结果

名称	类型	示例值	描述
datas	WindowAdvDetail[ ]		查询结果集合
page_index	Number		页码
page_size	Number		每页数据条数
success	Boolean	true,false	是否成功
message	String	操作成功!	操作结果描述

WindowAdvDetail 类型描述属性

名称	类型	是否必须	示例值	描述
orderTime	Date	否	2013-07-03 00:00:00	下单时间
spaceName	String	否		广告位名称
size	String	否	200*300	广告位尺寸
siteName	String	否		网站名称
clickNum	Number	否		点击量
introductionOrders	Number	否		引入订单量
completeOrders	Number	否		完成订单量
itemNum	Number	否		成交商品数量
amount	Number	否		成交金额
commission	Number	否		佣金金额

返回示例

JSON数据格式

{
  "jingdong_union_report_window_search_response":{
  "result":{
  "message":"操作成功!",
"datas":{
  "amount":"",
"itemNum":"",
"completeOrders":"",
"spaceName":"",
"clickNum":"",
"orderTime":"2013-07-03 00:00:00",
"commission":"",
"introductionOrders":"",
"siteName":"",
"size":"200*300"
  },
"page_size":"",
"page_index":"",
"success":"true,
false"
  }
  }
  }

SDK调用代码示例

JdClient client = new DefaultJdClient(serverURL, accessToken, appKey, appSecret);
UnionReportWindowSearchRequest request = new UnionReportWindowSearchRequest();
request.setStartDate(DateUtils.toDate("2013-05-01 00:00:00"));
request.setEndDate(DateUtils.toDate("2013-07-01 00:00:00"));
request.setPageIndex(1);
request.setPageSize(20);
UnionReportWindowSearchResponse response = client.execute(request);

8. 商品转换接口(获取商品推广代码)

接口名称：

jingdong.union.goods.code.get

功能说明：

根据商品ID查询商品推广代码

API用户授权类型：

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称

类型

是否必须

示例值

描述

good_id

Number

是

30442010

商品ID

根据jingdong.union.promotiongood.query接口 good_pk 字段获取

返回结果

名称	类型	示例值	描述
url_code	String		url推广代码
img_code	String		图片推广代码
link_code	String		文字链推广代码
success	Boolean	true,false	是否成功
message	String	获取推广代码成功	操作结果描述

返回示例

JSON数据格式

{
"jingdong_union_goods_code_response":{
"result":{
"link_code":"",
"message":"操作成功!",
"success":"true,
false",
"url_code":"",
"img_code":""
}
}
}

SDK调用代码示例

JdClient client = new DefaultJdClient(serverURL, accessToken, appKey, appSecret);
UnionGoodsCodeGetRequest goodsRequest = new UnionGoodsCodeGetRequest();
goodsRequest.setGoodId(GOOD_ID);
UnionGoodsCodeGetResponse goodsResponse = client.execute(goodsRequest);
String imgCode = goodsResponse.getImgCode();
String linkCode = goodsResponse.getLinkCode();
String urlCode = goodsResponse.getUrlCode();

9. 店铺转换接口(获取店铺推广代码)

接口名称：

jingdong.union.shop.code.get

功能说明：

根据店铺ID查询店铺推广代码

API用户授权类型：

不需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	否	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
shop_id	Number	是	30442004	店铺ID

返回结果

名称	类型	示例值	描述
url_code	String		url推广代码
img_code	String		图片推广代码
link_code	String		文字链推广代码
message	String	获取推广代码成功	操作结果描述
success	Boolean	true,false	是否成功

返回示例

JSON数据格式

{
"jingdong_union_shop_code_response":{
"result":{
"link_code":"",
"success":"true,
false",
"message":"操作成功!",
"url_code":"",
"img_code":""
}
}
}

SDK调用代码示例

JdClient client = new DefaultJdClient(serverURL, accessToken, appKey, appSecret);
UnionShopCodeGetRequest shopRequest = new UnionShopCodeGetRequest();
shopRequest.setShopId(SHOP_ID);
UnionShopCodeGetResponse shopResponse = client.execute(shopRequest);
String imgCode = shopResponse.getImgCode();
String linkCode = shopResponse.getLinkCode();
String urlCode = shopResponse.getUrlCode();

10. 活动转换接口(获取活动推广代码)

接口名称：

jingdong.union.activity.code.get

功能说明：

根据活动ID查询活动推广代码

API用户授权类型：

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	否	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
activity_id	Number	是	31345235	活动ID

返回结果

名称	类型	示例值	描述
url_code	String		url推广代码
img_code	String		图片推广代码
link_code	String		文字链推广代码
success	Boolean	true,false	是否成功
message	String	操作成功!	操作结果描述

返回示例

JSON数据格式

{
"jingdong_union_activity_code_response":{
"result":{
"link_code":"",
"message":"操作成功!",
"success":"true,
false",
"url_code":"",
"img_code":""
}
}
}

SDK调用代码示例

JdClient client = new DefaultJdClient(serverURL, accessToken, appKey, appSecret);
UnionActivityCodeGetRequest activityRequest = new UnionActivityCodeGetRequest();
activityRequest.setActivityId(ACTIVITY_ID);
UnionActivityCodeGetResponse activityResponse = client.execute(activityRequest);
String imgCode = activityResponse.getImgCode();
String linkCode = activityResponse.getLinkCode();
String urlCode = activityResponse.getUrlCode();

11. 获取专柜信息

接口名称：

jingdong.union.zone.info.get

功能说明：

获得指定专柜id获取专柜信息

API用户授权类型：

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
Zone_id	Number	是		专柜ID

返回结果

名称	类型	示例值	描述
ad_zone	AdZoneVo		专柜信息

AdZoneVo属性

名称	类型	是否必须	示例值	描述
zone_id	Number	否		专柜id
union_id	Number	否		联盟id
web_id	Number	否		网站id
web_name	String	否	京东商城	网站名称
web_url	String	否	http://www.jd.com	网站域名
zone_name	String	否		专柜名称
width	Number	否		专柜宽度
height	Number	否		专柜高度
category	List	否		专柜推广类目
size_id	Number	否		专柜尺寸id
size_name	String	否		专柜尺寸名称
promotion_type	Number	否	1,2	专柜推广类型
status	Number	否	1,2	专柜状态

返回示例

JSON数据格式

{
"jingdong_union_zone_info_response":{
"ad_zone":{
"zone_id":"",
"status":"1,2",
"web_url":"http://www.jd.com",
"width":"",
"size_id":"",
"size_name":"",
"promotion_type":"1,2",
"web_name":"京东商城",
"union_id":"",
"category":[{ "category_name":"" }],
"height":"",
"zone_name":"",
"web_id":""
}
}
}

SDK调用代码示例

JdClient client = new DefaultJdClient(serverURL, accessToken, appKey, appSecret);
UnionZoneInfoGetRequest infoRequest = new UnionZoneInfoGetRequest();
infoRequest.setZoneId(62001L);
UnionZoneInfoGetResponse infoResponse = client.execute(infoRequest);
AdZoneVo vo = infoResponse.getAdZone();

12. 专柜转换接口(获取专柜推广代码)

接口名称：

jingdong.union.zone.code.get

功能说明：

根据指定专柜id获取转化代码

API用户授权类型：

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
Zone_id	Number	是		专柜ID

返回结果

名称	类型	示例值	描述
zone_code	String		专柜推广代码

返回示例

JSON数据格式

{
"jingdong_union_zone_code_response":{
"zone_code":""
}
}

SDK调用代码示例

JdClient client = new DefaultJdClient(serverURL, accessToken, appKey, appSecret);
UnionZoneCodeGetRequest codeRequest = new UnionZoneCodeGetRequest();
codeRequest.setZoneId(62001L);
UnionZoneCodeGetResponse infoResponse = client.execute(codeRequest);
String code = infoResponse.getZoneCode();

13. 获取效果概况

接口名称：

jingdong.union.report.overview.search

功能说明：

查询站长的推广效果概况

API用户授权类型：

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
page_index	Number	是		页码
page_size	Number	是		每页记录数
start_date	Date	是	2013-07-03 00:00:00	查询开始时间，格式：yyyy-MM-dd HH:mm:ss
end_date	Date	是	2013-07-03 00:00:00	查询结束时间，格式：yyyy-MM-dd HH:mm:ss

返回结果

名称	类型	示例值	描述
data	OverviewVo[]		效果概况数据
page_index	Number		页码
page_size	Number		每页记录数
page_total	Number		总页数
start_date	Date	2013-07-03 00:00:00	查询开始时间（仅支持按日查询，时分秒数据只可为00:00:00）
end_date	Date	2013-07-03 00:00:00	查询结束时间（仅支持按日查询，时分秒数据只可为00:00:00）

OverviewVo属性

名称	类型	是否必须	示例值	描述
order_time	Date	否	2013-07-03 00:00:00	时间,格式:yyyy-MM-dd HH:mm:ss
click_num	Number	否		点击量
introduction_orders	Number	否		引入订单量
complete_orders	Number	否		完成订单量
item_num	Number	否		成交商品件数
amount	Number	否		成交金额
commission	Number	否		佣金

返回示例

JSON数据格式

{
"jingdong_union_report_overview_response":{
"result":{
"page_size":"",
"end_date":"2013-07-03 00:00:00",
"page_total":"",
"page_index":"",
"data":{
"amount":"",
"item_num":"",
"order_time":"2013-07-03 00:00:00",
"click_num":"",
"introduction_orders":"",
"commission":"",
"complete_orders":""
},
"start_date":"2013-07-03 00:00:00"
}
}
}

SDK调用代码示例

JdClient client = new DefaultJdClient(serverURL, accessToken, appKey, appSecret);
UnionReportOverviewSearchRequest reportOverviewRequest = new UnionReportOverviewSearchRequest();
reportOverviewRequest.setPageSize(10L);
reportOverviewRequest.setPageIndex(1L);
SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
reportOverviewRequest.setStartDate(sf.parse("2013-05-01 00:00:00"));
reportOverviewRequest.setEndDate(sf.parse("2013-07-04 00:00:00"));
UnionReportOverviewSearchResponse reportOverviewResponse = client.execute(reportOverviewRequest);

14. 获取结算单信息

接口名称：

jingdong.union.master.bill.search

功能说明：

查询站长的结算单信息

API用户授权类型：

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
page_index	Number	是		页码
page_size	Number	是		每页记录数
start_date	Date	是	2013-07-03 00:00:00	查询开始时间，格式：yyyy-MM-dd HH:mm:ss
end_date	Date	是	2013-07-03 00:00:00	查询结束时间，格式：yyyy-MM-dd HH:mm:ss

返回结果

名称	类型	示例值	描述
bill_list	MasterBillVo[]		结算数据
page_total	Number		总页数
page_index	Number		页码
page_size	Number		每页记录数

MasterBillVo属性

名称	类型	是否必须	示例值	描述
bill_id	Number	否		结算单号
union_id	Number	否		联盟id
pay_month	String	否	201307	佣金所属月份(如：201307)
pay_time	Date	否		支付时间
total	Number	否		税前总佣金
tax	Number	否		扣税
pay_amount	Number	否		实际支付佣金
after_tax	Number	否		税后总佣金
adjust	Number	否		手动调整佣金
bank_name	String	否		收款银行名称
bank_card	String	否		收款银行卡号
pay_id	String	否		支付流水号
technical_fee	Number	否		技术服务费
status	Number	否	0/1/2	结算单状态（0/1/2）

返回示例

JSON数据格式

{
"jingdong_union_bill_list_response":{
"data":{
"page_size":"",
"page_index":"",
"page_total":"",
"bill_list":{
"total":"",
"pay_amount":"",
"bank_name":"",
"status":"0/1/2",
"pay_month":"201307",
"pay_time":"2013-07-03 00:00:00",
"technical_fee":"",
"union_id":"",
"bank_card":"",
"tax":"",
"adjust":"",
"after_tax":"",
"pay_id":"",
"bill_id":""
}
}
}
}

SDK调用代码示例

JdClient client = new DefaultJdClient(serverURL, accessToken, appKey, appSecret);
UnionMasterBillSearchRequest unionBillListRequest = new UnionMasterBillSearchRequest();
unionBillListRequest.setPageSize(10L);
unionBillListRequest.setPageIndex(1L);
UnionMasterBillSearchResponse unionBillListResponse = client.execute(unionBillListRequest);

15. 获取计划列表

接口名称：

jingdong.union.planlist.search

功能说明：

根据商家账号查询商家计划列表

API用户授权类型：

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
pageIndex	Number	是		页码
pageSize	Number	是		每页行数

返回结果

名称	类型	示例值	描述
planListVO	PlanListVO		计划列表对象

简要描述
计划列表对象

名称	类型	是否必须	示例值	描述
totalCount	Number	否		计划总数
planList	UnionPlan[]	否		计划列表
totalPage	Number	否		计划总页数

计划列表

名称	类型	是否必须	示例值	描述
pk	Number	否		计划编号
planName	String	否		推广计划名称
startDate	Date	否		计划开始时间
endDate	Date	否		计划结束时间
averageCommision	Number	否		平均类目佣金比率
goodsCount	Number	否		主推商品件数
activityCount	Number	否		活动推广个数
status	Number	否		计划状态

返回示例

JSON数据格式

{
"jingdong_union_plan_list_response":{
"planListVO":{
"totalCount":"",
"planList":{
"activityCount":"",
"startDate":"",
"planName":"",
"status":"",
"goodsCount":"",
"endDate":"",
"averageCommision":"",
"pk":""
},
"totalPage":""
}
}
}

SDK调用代码示例

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
UnionPlanlistSearchRequest request=new UnionPlanlistSearchRequest();
request.setPageIndex( 123 );
request.setPageSize( 123 );
UnionPlanlistSearchResponse response=client.execute(request);

16. 获取计划详情

接口名称：

jingdong.union.plandetail.get

功能说明：

根据商家账号和计划编号查询商家计划详情

API用户授权类型：

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
planId	Number	是	1	计划编号

返回结果

名称	类型	示例值	描述
planVO	PlanVO		计划详情对象

简要描述
计划详情对象属性

名称	类型	是否必须	示例值	描述
planName	String	否		计划名称
startDate	Date	否	2013-07-03 00:00:00	开始时间
endDate	Date	否	2013-07-03 00:00:00	结束时间
notes	String	否		说明
categoryCommision	UnionCategoryCommision[]	否		类目对象列表
planGoods	GoodsVO[]	否		商品对象列表
planActivity	UnionPlanActivity[]	否		活动对象列表
planName	String	否		计划名称

类目对象列表

名称	类型	是否必须	示例值	描述
categoryLevel1Id	Number	否		一级类目编号
categoryLevel2Id	Number	否		二级类目编号
categoryLevel3Id	Number	否		三级类目编号
categoryLevel1Name	String	否		一级类目名称
categoryLevel2Name	String	否		二级类目名称
categoryLevel3Name	String	否		三级类目名称
commisionRatioLevel2	Number	否		二级类目佣金
commisionRatio	Number	否		三级类目佣金

商品对象列表属性

名称	类型	是否必须	示例值	描述
skuId	Number	否		SKUID（商品编号）
goodsName	String	否		商品名称
saleVolume	Number	否		销量
praiseDegree	Number	否		好评度
commisionRatio	Number	否		佣金

活动对象列表属性

名称	类型	是否必须	示例值	描述
activityName	String	否		活动名称
activityUrl	String	否		活动链接
activityStarttime	Date	否	2013-07-03 00:00:00	活动开始时间
activityEndtime	Date	否	2013-07-03 00:00:00	活动结束时间
activityImgList	UnionActivityimg[]	否		活动图片列表

返回示例

JSON数据格式

{
"jingdong_union_plan_detail_response":{
"planVO":{
"startDate":"2013-07-03 00:00:00",
"planName":"",
"categoryCommision":{
"categoryLevel2Id":"",
"categoryLevel2Name":"",
"commisionRatio":"",
"categoryLevel3Id":"",
"categoryLevel1Id":"",
"commisionRatioLevel2":"",
"categoryLevel1Name":"",
"categoryLevel3Name":""
},
"endDate":"2013-07-03 00:00:00",
"notes":"",
"planActivity":{
"activityImgList":{
"imgUrl":""
},
"activityUrl":"",
"activityEndtime":"2013-07-03 00:00:00",
"activityStarttime":"2013-07-03 00:00:00",
"activityName":""
},
"planGoods":{
"saleVolume":"",
"skuId":"",
"commisionRatio":"",
"praiseDegree":"",
"goodsName":""
}
}
}
}

SDK调用代码示例

JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
UnionPlandetailGetRequest request=new UnionPlandetailGetRequest();
request.setPlanId( 123 );
UnionPlandetailGetResponse response=client.execute(request);

17. 查询店铺推广详情

接口名称：

jingdong.union.advdetail.get

功能说明：

查询店铺推广详情

API用户授权类型：

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述

plan_id	Number	是		计划id
goods_page_size	Number	否		商品列表每页显示条数
goods_page_index	Number	否		商品列表第几页
goods_sort_column	String	否	price/commisionRatio/commision/promotionQuantity/praiseDegree/startDate	商品列表排序列
goods_sort	String	否	DESC/ASC	商品列表排序方式：DESC/ASC
activity_page_size	Number	否		活动列表每页显示条数
activity_page_index	Number	否		活动列表显示第几页
activity_sort_column	String	否	commisionRatio/startDate/width	活动列表排序列
activity_sort	String	否	DESC/ASC	活动列表排序方式：DESC/ASC

返回结果

名称	类型	示例值	描述
adv_detail	AdvDetailVo		店铺推广详情返回对象

简要描述
店铺推广详情返回对象

名称	类型	是否必须	示例值	描述
promotion_plan	PromotionPlanVO	否		推广计划对象
promotion_shop	PromotionShopVO	否		推广店铺对象
promotion_goods	PromotionGoodsVO	否		推广商品对象
promotion_activity	PromotionActivityVO	否		推广活动对象

推广计划对象

名称	类型	是否必须	示例值	描述
pk	Number	否		主键
pop_id	Number	否		商家id
plan_name	String	否		计划名称
start_date	Date	否	2013-07-03 00:00:00	计划开始时间
end_date	Date	否	2013-07-03 00:00:00	计划结束时间
status	Number	否	1/11/9/6/10/-1	计划状态,1:草稿,11:提交成功,9:推广结束,6:已生效,10:已冻结,-1:已删除
update_time	Date	否	2013-07-03 00:00:00	更新时间
insert_time	Date	否	2013-07-03 00:00:00	插入时间
average_commision	Number	否		类目平均佣金
goods_count	Number	否		主推商品总数
activity_count	Number	否		推广活动个数

推广店铺对象

名称	类型	是否必须	示例值	描述
pk	Number	否		主键
pop_id	Number	否		商家id
shop_id	Number	否		店铺id
plan_id	Number	否		店铺推广所属计划id
shop_name	String	否		店铺名称
shop_mainurl	String	否		店铺主图url
main_categories	String	否		店铺主营类目
shop_url	String	否		店铺链接
average_commision	Number	否		平均类目佣金
goods_volume	Number	否		店铺商品数量
accumulative_total	Number	否		店铺累计推广商品数量
praise_degree	Number	否		店铺好评度
update_time	Date	否	2013-07-03 00:00:00	更新时间
insert_time	Date	否	2013-07-03 00:00:00	插入时间

推广商品对象

名称	类型	是否必须	示例值	描述
goods_list	JosGoodsVO[]	否		推广商品列表
total_count	Number	否		总页数

推广商品列表

名称	类型	是否必须	示例值	描述
pk	Number	否		主键
sku_id	Number	否		商品skuid
plan_id	Number	否		推广商品所属计划id
goods_name	String	否		商品名称
unitPrice	Number	否		商品单价
praise_degree	Number	否		商品好评度
mainimgurl	String	否		商品主图url
commision_ratio	Number	否		商品佣金比例
commision	Number	否		商品佣金
ware_url	String	否		商品在京东主站的url
recent_sales	String	否		最近30天推广量
total_sales	Number	否		累计推广量
start_time	Date	否	2013-07-03 00:00:00	商品推广开始时间
plan_endtime	Date	否	2013-07-03 00:00:00	商品推广结束时间
insert_time	Date	否	2013-07-03 00:00:00	插入时间
update_time	Date	否	2013-07-03 00:00:00	修改时间

推广活动对象

名称	类型	是否必须	示例值	描述
activity_list	JosActivityImgVO[]	否		活动列表
total_count	Number	否		查询出的总条数

活动列表

名称	类型	是否必须	示例值	描述
activity_pk	Number	否		活动主键
plan_id	Number	否		计划主键
activity_name	String	否		活动名称
activity_url	String	否		活动URL
activity_starttime	Date	否	2013-07-03 00:00:00	活动开始时间
activity_endtime	Date	否	2013-07-03 00:00:00	活动结束时间
average_commision	Number	否		类目平均佣金
img_pk	Number	否		图片主键
img_url	String	否	/g15/M09/02/0C/rBEh WFHHtFsIAAAAAA CVuAWYPKsAAAe AQPOChEAAJXQ 933.jpg	图片相对url（完整url需加前缀字段img_urlprefix的值，如完整url为 http://img30.360buyimg.com/ads// g15/M09/02/0C/rBEhWFHHtFsI AAAAAACVuAWYPKsAAAeA QPOChEAAJXQ933.jpg ）
img_width	Number	否		图片宽度
img_height	Number	否		图片高度
img_urlprefix	String	否	http://img30.360buy img.com/ads/	图片url前缀

返回示例

JSON数据格式

{
"jingdong_union_adv_detail_response":{
"adv_detail":{
"promotion_goods":{
"goods_list":{
"insert_time":"2013-07-03 00:00:00",
"goods_name":"",
"unitPrice":"",
"plan_endtime":"2013-07-03 00:00:00",
"praise_degree":"",
"total_sales":"",
"commision_ratio":"",
"plan_id":"",
"commision":"",
"ware_url":"",
"update_time":"2013-07-03 00:00:00",
"mainimgurl":"",
"recent_sales":"",
"start_time":"2013-07-03 00:00:00",
"sku_id":"",
"pk":""
},
"total_count":""
},
"promotion_shop":{
"average_commision":"",
"goods_volume":"",
"shop_id":"",
"insert_time":"2013-07-03 00:00:00",
"pop_id":"",
"praise_degree":"",
"shop_mainurl":"",
"plan_id":"",
"shop_name":"",
"accumulative_total":"",
"update_time":"2013-07-03 00:00:00",
"shop_url":"",
"main_categories":"",
"pk":""
},
"promotion_activity":{
"activity_list":{
"img_url":"/g15/M09/02/0C/rBEhWFHHtFsIAAAAAACVuAWYPKsAAAeAQPOChEAAJXQ933.jpg",
"activity_pk":"",
"average_commision":"",
"activity_starttime":"2013-07-03 00:00:00",
"activity_url":"",
"img_urlprefix":"http://img30.360buyimg.com/ads/",
"activity_endtime":"2013-07-03 00:00:00",
"img_height":"",
"activity_name":"",
"img_pk":"",
"img_width":"",
"plan_id":""
},
"total_count":""
},
"promotion_plan":{
"average_commision":"",
"end_date":"2013-07-03 00:00:00",
"update_time":"2013-07-03 00:00:00",
"status":"1/11/9/6/10/-1",
"activity_count":"",
"insert_time":"2013-07-03 00:00:00",
"pop_id":"",
"start_date":"2013-07-03 00:00:00",
"goods_count":"",
"plan_name":"",
"pk":""
}
}
}
}

SDK调用代码示例

JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
UnionAdvdetailGetRequest request=new UnionAdvdetailGetRequest();
request.setPlanId( 123 );
request.setGoodsPageSize( 123 );
request.setGoodsPageIndex( 123 );
request.setGoodsSortColumn( "jingdong" );
request.setGoodsSort( "jingdong" );
request.setActivityPageSize( 123 );
request.setActivityPageIndex( 123 );
request.setActivitySortColumn( "jingdong" );
request.setActivitySort( "jingdong" );
UnionAdvdetailGetResponse response=client.execute(request);

18. 获取类目信息

接口名称：

jingdong.union.categoryinfo.search

功能说明：

根据商家计划编号查询商家类目及佣金信息（计划编号为“”或null则只返回类目信息)

API用户授权类型：

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
planId	String	是		计划编号，输入null或输入"" f返回商家经营的分类;输入正确的编号返回分类和佣金比例

返回结果

名称	类型	示例值	描述
resultVO	ResultVO		类目查询结果

ResultVO属性

名称	类型	是否必须	示例值	描述
successed	Boolean	是		查询状态
code	Number	是		状态码，0成功，1失败
message	String	否		状态信息，成功时为空，失败时为失败原因
result	CategoryCommisionVO[]	是		类目对象列表

类目对象列表属性

名称	类型	是否必须	示例值	描述
categoryLevel1Id	Number	是		一级类目编号
categoryLevel2Id	Number	是		二级类目编号
categoryLevel3Id	Number	是		三级类目编号
categoryLevel1Name	String	是		一级类目名称
categoryLevel2Name	String	是		二级类目名称
categoryLevel3Name	String	是		三级类目名称
commisionRatioLevel2	Number	否		二级类目佣金比例，输入计划编号为空时没有此值
commisionRatio	Number	否		三级类目佣金比例，输入计划编号为空时没有此值
priceStart	Number	是		起始佣金比例范围
priceEnd	Number	是		终止佣金比例范围

返回示例

JSON数据格式

{
  "jingdong_union_categoryinfo_search_response":{
  "resultVO":{
  "message":"",
"result":[{
  "priceStart":"",
"categoryLevel2Id":"",
"categoryLevel2Name":"",
"commisionRatio":"",
"categoryLevel3Id":"",
"categoryLevel1Id":"",
"priceEnd":"",
"commisionRatioLevel2":"",
"categoryLevel1Name":"",
"categoryLevel3Name":""
  }],
"successed":"",
"code":""
  }
  }
  }

SDK调用代码示例

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
UnionCategoryinfoSearchRequest request=new UnionCategoryinfoSearchRequest();
request.setPlanId( "jingdong" );
UnionCategoryinfoSearchResponse response=client.execute(request);

19. 保存计划信息

接口名称：

jingdong.union.plan.save

功能说明：

根据商家输入的计划信息新建或修改商家计划

API用户授权类型：

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
planId	String	是		计划编号
planName	String	是		计划名称
startDate	String	是		开始时间,格式:yyyy-MM-dd
endDate	String	是		结束时间,格式:yyyy-MM-dd
notes	String	否		说明
status	Number	是		计划状态，1表示保存草稿，其它值表示保存
category	String	是	[{'categoryLevel1Id':652,'categoryLevel2Id':653,'categoryLevel3Id':'655', 'categoryLevel1Name':' 手机数码','categoryLevel2Name':'手机通讯', 'categoryLevel3Name':'手机 ','commisionRatio':'2','commisionRatioLevel2':'2'},……,]	类目佣金json ，取jingdong.union.categoryinfo.search接口返回的信息即可，commisionRatioLevel2表示二级类目的佣金比例值，commisionRatio为三级类目佣金，目前只取二级佣金值

返回结果

名称	类型	示例值	描述
resultVO	ResultVO		计划保存结果

ResultVO属性

名称	类型	是否必须	示例值	描述
successed	Boolean	是		查询状态
code	Number	是		状态码，0成功，1失败
message	String	否		状态信息，成功时为空，失败时为失败原因
result	Number	是		计划编号

返回示例

JSON数据格式

{
  "jingdong_union_plan_save_response":{
  "resultVO":{
  "message":"",
"result":"",
"successed":"",
"code":""
  }
  }
  }

SDK调用代码示例

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
UnionPlanSaveRequest request=new UnionPlanSaveRequest();
request.setPlanId( "jingdong" );
request.setPlanName( "jingdong" );
request.setStartDate( "jingdong" );
request.setEndDate( "jingdong" );
request.setNotes( "jingdong" );
request.setStatus( 123 );
request.setCategory( "jingdong" );
UnionPlanSaveResponse response=client.execute(request);

20. 获取计划基本信息

接口名称：

jingdong.union.planbaseinfo.get

功能说明：

根据商家计划编号查询商家计划基本信息

API用户授权类型：

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
planId	String	是		计划编号

返回结果

名称	类型	示例值	描述
resultVO	ResultVO		计划查询结果

ResultVO属性

名称	类型	是否必须	示例值	描述
successed	Boolean	是		查询状态
code	Number	是		状态码，0成功，1失败
message	String	否		状态信息，成功时为空，失败时为失败原因
result	PlanInfoVO	是		计划基本信息

PlanInfoVO属性

名称	类型	是否必须	示例值	描述
planName	String	是		计划名称
startDate	String	是		开始时间,格式:yyyy-MM-dd
endDate	String	是		结束时间,格式:yyyy-MM-dd
notes	String	否		说明
status	Number	是		计划状态 1未提交2待审核3未通过4审核失败5审核通过6投放中（竞投中） 7暂停8终止9已结束 10已冻结 11 提交成功 12 已删除（非物理删除）

返回示例

JSON数据格式

{
  "jingdong_union_planbaseinfo_get_response":{
  "resultVO":{
  "message":"",
"result":{
  "startDate":"",
"planName":"",
"status":"",
"endDate":"",
"notes":""
  },
"successed":"",
"code":""
  }
  }
  }

SDK调用代码示例

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
UnionPlanbaseinfoGetRequest request=new UnionPlanbaseinfoGetRequest();
request.setPlanId( "jingdong" );
UnionPlanbaseinfoGetResponse response=client.execute(request);

服务目录

公告栏

接入流程

开发指南

常用工具

业务流程

常见问题

面向买家服务

面向商家服务

京麦服务市场

供应商服务

京东云服务