通用物料搜索API(导购)
名称 | 类型 | 是否必须 | 示例值 | 更多限制 | 描述 |
---|---|---|---|---|---|
start_dsr | Number | 可选 | 10 | 商品筛选(特定媒体支持)-店铺dsr评分。筛选大于等于当前设置的店铺dsr评分的商品0-50000之间 | |
page_size | Number | 可选 | 20 |
|
页大小,默认20,1~100 |
page_no | Number | 可选 | 1 |
|
第几页,默认:1 |
platform | Number | 可选 | 1 |
|
链接形式:1:PC,2:无线,默认:1 |
end_tk_rate | Number | 可选 | 1234 | 商品筛选-淘客佣金比率上限。如:1234表示12.34% | |
start_tk_rate | Number | 可选 | 1234 | 商品筛选-淘客佣金比率下限。如:1234表示12.34% | |
end_price | Number | 可选 | 10 | 商品筛选-折扣价范围上限。单位:元 | |
start_price | Number | 可选 | 10 | 商品筛选-折扣价范围下限。单位:元 | |
is_overseas | Boolean | 可选 | false | 商品筛选-是否海外商品。true表示属于海外商品,false或不设置表示不限 | |
is_tmall | Boolean | 可选 | false | 商品筛选-是否天猫商品。true表示属于天猫商品,false或不设置表示不限 | |
sort | String | 可选 | tk_rate_des | 排序_des(降序),排序_asc(升序),销量(total_sales),淘客佣金比率(tk_rate), 累计推广量(tk_total_sales),总支出佣金(tk_total_commi),价格(price),匹配分(match) | |
itemloc | String | 可选 | 杭州 | 商品筛选-所在地 | |
cat | String | 可选 | 16,18 | 商品筛选-后台类目ID。用,分割,最大10个,该ID可以通过taobao.itemcats.get接口获取到 | |
q | String | 可选 | 女装 | 商品筛选-查询词 | |
material_id | Number | 可选 | 2836 |
|
不传时默认物料id=2836;如果直接对消费者投放,可使用官方个性化算法优化的搜索物料id=17004 |
has_coupon | Boolean | 可选 | false | 优惠券筛选-是否有优惠券。true表示该商品有优惠券,false或不设置表示不限 | |
ip | String | 可选 | 13.2.33.4 | ip参数影响邮费获取,如果不传或者传入不准确,邮费无法精准提供 | |
adzone_id | Number | 必须 | 12345678 | mm_xxx_xxx_12345678三段式的最后一段数字 | |
need_free_shipment | Boolean | 可选 | true | 商品筛选-是否包邮。true表示包邮,false或不设置表示不限 | |
need_prepay | Boolean | 可选 | true | 商品筛选-是否加入消费者保障。true表示加入,false或不设置表示不限 | |
include_pay_rate_30 | Boolean | 可选 | true | 商品筛选(特定媒体支持)-成交转化是否高于行业均值。True表示大于等于,false或不设置表示不限 | |
include_good_rate | Boolean | 可选 | true | 商品筛选-好评率是否高于行业均值。True表示大于等于,false或不设置表示不限 | |
include_rfd_rate | Boolean | 可选 | true | 商品筛选(特定媒体支持)-退款率是否低于行业均值。True表示大于等于,false或不设置表示不限 | |
npx_level | Number | 可选 | 2 |
|
商品筛选-牛皮癣程度。取值:1不限,2无,3轻微 |
device_encrypt | String | 可选 | MD5 | 智能匹配-设备号加密类型:MD5 | |
device_value | String | 可选 | xxx | 智能匹配-设备号加密后的值(MD5加密需32位小写) | |
device_type | String | 可选 | IMEI | 智能匹配-设备号类型:IMEI,或者IDFA,或者UTDID(UTDID不支持MD5加密),或者OAID | |
end_ka_tk_rate | Number | 可选 | 1234 | 商品筛选-KA媒体淘客佣金比率上限。如:1234表示12.34% | |
start_ka_tk_rate | Number | 可选 | 1234 | 商品筛选-KA媒体淘客佣金比率下限。如:1234表示12.34% | |
lock_rate_end_time | Number | 可选 | 1567440000000 | 锁佣结束时间 | |
lock_rate_start_time | Number | 可选 | 1567440000000 | 锁佣开始时间 | |
longitude | String | 可选 | 121.473701 | 本地化业务入参-LBS信息-经度 | |
latitude | String | 可选 | 31.230370 | 本地化业务入参-LBS信息-纬度 | |
city_code | String | 可选 | 310000 | 本地化业务入参-LBS信息-国标城市码,仅支持单个请求,请求饿了么卡券物料时,该字段必填。 (详细城市ID见:https://mo.m.taobao.com/page_2020010315120200508) | |
seller_ids | String | 可选 | 1,2,3,4 | 商家id,仅支持饿了么卡券商家ID,支持批量请求1-100以内,多个商家ID使用英文逗号分隔 | |
special_id | String | 可选 | 2323 | 会员运营ID | |
relation_id | String | 可选 | 3243 | 渠道关系ID,仅适用于渠道推广场景 | |
page_result_key | String | 可选 | abcdef | 本地化业务入参-分页唯一标识,非首页的请求必传,值为上一页返回结果中的page_result_key字段值 | |
ucrowd_id | Number | 可选 | 1 | 人群ID,仅适用于物料评估场景material_id=41377 | |
ucrowd_rank_items | Ucrowdrankitems [] | 可选 |
|
物料评估-商品列表 | |
|
|||||
get_topn_rate | Number | 可选 | 0 | 是否获取前N件佣金信息 0否,1是,其他值否 | |
biz_scene_id | String | 可选 | 1 | 1-动态ID转链场景,2-消费者比价场景(不填默认为1) | |
promotion_type | String | 可选 | 2 | 1-自购省,2-推广赚(代理模式专属ID,代理模式必填,非代理模式不用填写该字段) |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
total_results | Number | 1212 | 搜索到符合条件的结果总数 |
result_list | MapData [] | resultList | |
|
|||
page_result_key | String | abcde | 本地化-lbs分页标识,请在下一次翻页时作为入参传入 |
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret); TbkDgMaterialOptionalRequest req = new TbkDgMaterialOptionalRequest(); req.setStartDsr(10L); req.setPageSize(20L); req.setPageNo(1L); req.setPlatform(1L); req.setEndTkRate(1234L); req.setStartTkRate(1234L); req.setEndPrice(10L); req.setStartPrice(10L); req.setIsOverseas(false); req.setIsTmall(false); req.setSort("tk_rate_des"); req.setItemloc("杭州"); req.setCat("16,18"); req.setQ("女装"); req.setMaterialId(2836L); req.setHasCoupon(false); req.setIp("13.2.33.4"); req.setAdzoneId(12345678L); req.setNeedFreeShipment(true); req.setNeedPrepay(true); req.setIncludePayRate30(true); req.setIncludeGoodRate(true); req.setIncludeRfdRate(true); req.setNpxLevel(2L); req.setDeviceEncrypt("MD5"); req.setDeviceValue("xxx"); req.setDeviceType("IMEI"); req.setEndKaTkRate(1234L); req.setStartKaTkRate(1234L); req.setLockRateEndTime(1567440000000L); req.setLockRateStartTime(1567440000000L); req.setLongitude("121.473701"); req.setLatitude("31.230370"); req.setCityCode("310000"); req.setSellerIds("1,2,3,4"); req.setSpecialId("2323"); req.setRelationId("3243"); req.setPageResultKey("abcdef"); req.setUcrowdId(1L); List<TbkDgMaterialOptionalRequest.Ucrowdrankitems> list2 = new ArrayList<TbkDgMaterialOptionalRequest.Ucrowdrankitems>(); TbkDgMaterialOptionalRequest.Ucrowdrankitems obj3 = new TbkDgMaterialOptionalRequest.Ucrowdrankitems(); list2.add(obj3); obj3.setCommirate(1234L); obj3.setPrice("10.12"); obj3.setItemId("542808901898"); req.setUcrowdRankItems(list2); req.setGetTopnRate(0L); req.setBizSceneId("1"); req.setPromotionType("2"); TbkDgMaterialOptionalResponse rsp = client.execute(req); System.out.println(rsp.getBody());
<tbk_dg_material_optional_response> <total_results>1212</total_results> <result_list> <map_data> <coupon_start_time>2017-10-29</coupon_start_time> <coupon_end_time>2017-10-29</coupon_end_time> <info_dxjh>{"19013551":"2850","74510538":"2550"}</info_dxjh> <tk_total_sales>11</tk_total_sales> <tk_total_commi>323</tk_total_commi> <coupon_id>d62db1ab8d9546b1bf0ff49bda5fc33b</coupon_id> <num_iid>556633720749</num_iid> <title>毛呢阔腿裤港味复古女裤子秋冬九分裤萝卜裤显瘦高腰韩版2017新款</title> <pict_url>https://img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg</pict_url> <small_images> <string>https://img.alicdn.com/i4/3077291146/TB2NA3poDnI8KJjSszgXXc8ApXa_!!3077291146.jpg</string> </small_images> <reserve_price>102.00</reserve_price> <zk_final_price>88.00</zk_final_price> <user_type>1</user_type> <provcity>杭州</provcity> <item_url>https://item.taobao.com/item.htm?id=564591813536</item_url> <include_mkt>false</include_mkt> <include_dxjh>false</include_dxjh> <commission_rate>1550表示15.5%</commission_rate> <volume>123</volume> <seller_id>232332</seller_id> <shop_title>xx旗舰店</shop_title> <coupon_total_count>22323</coupon_total_count> <coupon_remain_count>111</coupon_remain_count> <coupon_info>满299元减20元</coupon_info> <commission_type>MKT表示营销计划,SP表示定向计划,COMMON表示通用计划</commission_type> <shop_dsr>13</shop_dsr> <coupon_share_url>uland.xxx</coupon_share_url> <url>s.click.xxx</url> <level_one_category_name>女装</level_one_category_name> <level_one_category_id>20</level_one_category_id> <category_name>连衣裙</category_name> <category_id>162201</category_id> <short_title>xxsd</short_title> <white_image>https://img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg</white_image> <oetime>2018-08-21 11:23:43</oetime> <ostime>2018-08-21 11:23:43</ostime> <jdd_num>10</jdd_num> <jdd_price>5</jdd_price> <uv_sum_pre_sale>23</uv_sum_pre_sale> <x_id>uESS0mv8JvfJRMKlIgCD5At9VuHVBXoqBRihfQlo4ybLiKygRlqiN4eoxoZDfe38uSogWy6GB971jD2N8tLuuc</x_id> <coupon_start_fee>29.00</coupon_start_fee> <coupon_amount>10.00</coupon_amount> <item_description>季凉被 全棉亲肤</item_description> <nick>旗舰店</nick> <orig_price>25</orig_price> <total_stock>5555</total_stock> <sell_num>1111</sell_num> <stock>4444</stock> <tmall_play_activity_info>前n件x折</tmall_play_activity_info> <item_id>5678899993</item_id> <real_post_fee>0.00</real_post_fee> <lock_rate>1567440000000</lock_rate> <lock_rate_end_time>1567440000000</lock_rate_end_time> <lock_rate_start_time>1567440000000</lock_rate_start_time> <presale_discount_fee_text>付定金立减5元</presale_discount_fee_text> <presale_tail_end_time>1567440000000</presale_tail_end_time> <presale_tail_start_time>1567440000000</presale_tail_start_time> <presale_end_time>1567440000000</presale_end_time> <presale_start_time>1567440000000</presale_start_time> <presale_deposit>100</presale_deposit> <ysyl_tlj_send_time>2019-11-10 21:59:59</ysyl_tlj_send_time> <ysyl_commission_rate>2030(表示20.3%)</ysyl_commission_rate> <ysyl_tlj_face>0.6</ysyl_tlj_face> <ysyl_click_url>https://uland.taobao.com/coupon/edetail?e=nqUNB1NOF3Bt3vqbdXnGloankzPYmeEFkgNrw6YHQf9pZTj41Orn8MwBAs06HAOzqQomYNedOiHDYPmqkFXqLR0HgBdG%2FDDL%2F1M%2FBw7Sf%2FesGXLf%2BqX4cbeC%2F2cR0p0NlWH0%2BknxpnCJJP%2FQkZSsyo1HvKjXo4uz&pid=mm_26381042_12970066_52864659&af=1</ysyl_click_url> <ysyl_tlj_use_end_time>2019-11-10 21:59:59</ysyl_tlj_use_end_time> <ysyl_tlj_use_start_time>2019-11-10 21:59:59</ysyl_tlj_use_start_time> <sale_begin_time>1567440000000</sale_begin_time> <sale_end_time>1567440000000</sale_end_time> <distance>300</distance> <usable_shop_id>10001</usable_shop_id> <usable_shop_name>饿了么卡券专营店</usable_shop_name> <sale_price>168</sale_price> <kuadian_promotion_info>["每100减20","每200减50"]</kuadian_promotion_info> <superior_brand>1</superior_brand> <reward_info>1</reward_info> <is_brand_flash_sale>1</is_brand_flash_sale> <localization_extend></localization_extend> <match_score>10.0</match_score> <commi_score>20.0</commi_score> <hot_flag>1</hot_flag> <topn_info> <topn_quantity>3000</topn_quantity> <topn_total_count>3000</topn_total_count> <topn_end_time>1937297392332</topn_end_time> <topn_start_time>1937297392332</topn_start_time> <topn_rate>30</topn_rate> </topn_info> <bybt_info> <bybt_brand_logo>//img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg</bybt_brand_logo> <bybt_pic_url>//img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg</bybt_pic_url> <bybt_item_tags> <string>["https://gw.alicdn.com/tfs/TB1CvN50KH2gK0jSZJnXXaT1FXa-167-42.png?getAvatar=avatar"</string> <string>"https://gw.alicdn.com/tfs/TB10rZqkCR26e4jSZFEXXbwuXXa-132-42.png?getAvatar=avatar"]</string> </bybt_item_tags> <bybt_coupon_amount>10.00</bybt_coupon_amount> <bybt_show_price>100.00</bybt_show_price> <bybt_lowest_price>200.00</bybt_lowest_price> <bybt_end_time>1559750399000</bybt_end_time> <bybt_start_time>1559750399000</bybt_start_time> </bybt_info> <tt_sold_count>200+</tt_sold_count> <maifan_promotion> <maifan_promotion_end_time>1559750399000</maifan_promotion_end_time> <maifan_promotion_start_time>1559750399000</maifan_promotion_start_time> <maifan_promotion_discount>200</maifan_promotion_discount> <maifan_promotion_condition>100</maifan_promotion_condition> </maifan_promotion> <cpa_reward_type>0 1 2</cpa_reward_type> <cpa_reward_amount>1.11 2.22 3.21</cpa_reward_amount> <activity_id>188</activity_id> <rank_page_url>s.click.xxx</rank_page_url> <item_search_type>1-1</item_search_type> <sp_campaign_list> <sp_campaign> <sp_cid>123</sp_cid> <sp_name>定向计划活动1</sp_name> <sp_rate>1550表示15.5%</sp_rate> <sp_lock_status>0</sp_lock_status> <sp_apply_link>http://pub.alimama.com/portal/promo/shop/campaign/detail.htm?mode=info&campaignId=1000492470&creatorId=98836808&breadcrumb=false</sp_apply_link> <sp_status>1</sp_status> </sp_campaign> </sp_campaign_list> </map_data> </result_list> <page_result_key>abcde</page_result_key> </tbk_dg_material_optional_response>
<error_response> <code>50</code> <msg>Remote service error</msg> <sub_code>isv.invalid-parameter</sub_code> <sub_msg>非法参数</sub_msg> </error_response>
错误码 | 错误描述 | 解决方案 |
---|---|---|
1001 | 非法的me参数值 | 传入正确的me参数值,含有券ID与商品ID信息 |
10000 | 该itemId对应的宝贝已下架或非淘客宝贝 | 更换新的itemId查询 |
4 | 查询不到对应的adzoneId,请检查adzoneId是否正确 | 查询不到对应的adzoneId,请检查adzoneId是否正确 |
30002 | 参数q与cat不能都为空 | 参数q与cat不能都为空 |
2 | pid不正确,请检查是否输入了正确的adzoneId和siteId | pid不正确,请检查是否输入了正确的adzoneId和siteId |
50001 | 当前条件查询无结果 | 更换查询条件 |
40001 | 调用失败 | 请稍后重试 |
30001 | 无效物料ID | 请传入有效的物料ID |
5 | pid校验失败 | 检查pid相关参数,稍后重试 |
isp.entry-sys-error | 内部服务出错 | 稍后重试 |
isp.pid-check-error | pid校验服务出错 | 检查pid相关参数,稍后重试 |
isp.sys-error | 内部服务异常 | 稍后重试 |
50002 | 调用频率高,请稍后再试 | 调用频率高,请稍后再试 |
1201 | 口令类型无效 | 请重试 |
719 | 系统异常 | 请重试。另同步重要通知:您需将商品ID字段类型调整为同时兼容number和string类型,否则8月8日起调用将会出现异常,如已调整完成可忽略本次错误提示,点击https://mo.m.taobao.com/union/page_20220701_150002_297 查看公告详情,如有疑问可加入【淘宝联盟】线上合规升级咨询群(钉钉群:44748908)进行咨询。 |
1911 | 该appkey没有本sceneId权限,如有需要请联系对口商务/运营申请(钉钉咨询群号:44964951) | 该appkey没有本sceneId权限,如有需要请联系对口商务/运营申请(钉钉咨询群号:44964951) |