文档中心 > API类目 > 海外-淘宝客API

taobao.ovs.tbk.material.item.optional (淘宝客-推广者-物料搜索正式版)

淘宝客-推广者-物料搜索正式版,海外联盟商品库搜索,支持入参推广者对应的“推广位”、关键词和相关筛选条件,获取对应的物料信息和推广者对应的推广链接,并且额外支持渠道自定义参数、分站物料、禁限售/运过滤、海外特色商品库等。 -- Merchandise Search, Search the overseas item library using adzone ID, keywords, and filters to get material info and promotion links.

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
start_price Number 可选 9 商品筛选-折扣价范围下限。单位:元 -- Product Filter - Minimum Discount Price. Unit: Yuan
is_tmall Boolean 可选 true 商品筛选-是否天猫商品。true表示属于天猫商品,false或不设置表示不限 -- Product Filter - Is Tmall Product. "true" means Tmall product; "false" or not set means not limited
unid String 可选 1234567 渠道自定义参数 -- Channel Custom Parameters
end_tk_rate Number 可选 1234 商品筛选-淘客佣金比率上限。如:1234表示12.34% -- Product Filter - Maximum Taoke Commission Rate. For example, 1234 means 12.34%
page_size Number 必须 20 页大小,默认20,1~100 -- Page Size, default is 20, range 1~100
adzone_id Number 必须 12345678 推广位ID,mm_xxx_xxx_12345678三段式的最后一段数字 -- Ad Zone ID, the last segment of the three-part "mm_xxx_xxx_12345678"
language String 必须 zh_CN 语言:zh_CN(中文);en_US(英文) -- Language: zh_CN (Chinese); en_US (English)
end_price Number 可选 19 商品筛选-折扣价范围上限。单位:元 -- Product Filter - Maximum Discount Price. Unit: Yuan
sort String 可选 tk_rate_des 排序方式:排序_des(降序),排序_asc(升序),销量(total_sales),淘客收入比率(tk_rate),营销计划佣金(tk_mkt_rate),累计推广量(tk_total_sales),总支出佣金(tk_total_commi),预估到价格(final_promotion_price),匹配分(match) -- Sort Type: sort_des (descending), sort_asc (ascending), Sales (total_sales), Taoke Commission Rate (tk_rate), Marketing Plan Commission (tk_mkt_rate), Total Promotion Volume (tk_total_sales), Total Paid Commission (tk_total_commi), Estimated Price (final_promotion_price), Match Score (match)
material_id Number 可选 106395 物料ID,不传时默认物料ID为Site对应站点的物料ID -- Material ID. If not provided, the default is the material ID corresponding to the site.
q String 可选 衣服 商品筛选-查询词 -- Product Filter - Search Keyword
site String 必须 TW 站点标识:TW(台湾);HK(香港);MY(马来);SG(新加坡);AU(澳大利亚);CA(加拿大);MO(澳门);GLOBAL(全球),GLOBAL(全球)不存在禁限售的逻辑,若填写指定的站点,会校验禁限售的逻辑。 -- Site Identifier: TW (Taiwan); HK (Hong Kong); MY (Malaysia); SG (Singapore); AU (Australia); CA (Canada); MO (Macau); GLOBAL (Global). The "GLOBAL" identifier does not apply any restricted or prohibited sales logic. If a specific site is specified, the restricted/prohibited sales logic will be enforced.
has_coupon Boolean 可选 true 优惠券筛选-是否有优惠券。true表示该商品有优惠券, false或不设置表示不限 -- Coupon Filter - Has Coupon. "true" means the product has a coupon; "false" or not set means not limited
start_tk_rate Number 可选 1234 商品筛选-淘客佣金比率下限。如:1234表示12.34% -- Product Filter - Minimum Taoke Commission Rate. For example, 1234 means 12.34%
page_no Number 必须 1 页码,默认1 -- Page Number, default is 1
cat String 可选 16,18 商品筛选-后台类目ID。用,分割,最大10个。 -- Product Filter - Backend Category ID. Separate with commas, up to 10.

响应参数

名称 类型 示例值 描述
total_results Number 1234 搜索到符合条件的结果总数 -- Total number of results matching the criteria
next_page Number 2 下一页页码 -- Next page number
has_next Boolean true 是否还有下一页 -- Is there a next page?
result_list MaterialItemSummaryInfo [] 商品列表 -- Product list
  • └ item_id
  • String
  • O0rq6kjfzt6WxJ3gj8H42ahkiJ-5Aqw2ATWpWVJn09UZ
  • 商品信息-淘宝客新商品ID -- Product information - Taobao Partner new product ID
  • coupon_info
  • MaterialItemCouponInfoDTO
  • 商品优惠券信息 -- Product coupon information
  • └ coupon_start_fee
  • String
  • 17
  • 优惠券信息-满减的满额 -- Coupon information - Minimum amount for discount
  • └ coupon_remain_count
  • Number
  • 27000
  • 优惠券信息-券数量 -- Coupon information - Number of coupons
  • └ coupon_amount
  • String
  • 5
  • 优惠券信息-券面额 -- Coupon information - Coupon value
  • └ coupon_activity_id
  • String
  • 30660aec6d334a929186b8ca49892bca
  • 优惠券信息-券模版ID -- Coupon information - Coupon template ID
  • └ coupon_sale_text_info
  • String
  • 满17元减5元
  • 优惠券信息-券文案 -- Coupon information - Coupon description
  • └ coupon_effective_start_time
  • Number
  • 1748361600000
  • 优惠券信息-券有效时间-开始时间 毫秒时间戳 -- Coupon information - Coupon validity period - Start time (in milliseconds timestamp)
  • └ coupon_effective_end_time
  • Number
  • 1749052799000
  • 优惠券信息-券有效时间-结束时间 毫秒时间戳 -- Coupon information - Coupon validity period - End time (in milliseconds timestamp)
  • publish_info
  • MaterialItemPublishInfoDTO
  • 淘客推广信息 -- Taobao Partner promotion information
  • └ click_url
  • String
  • https://intl.taobao.com/dp?h5Url=https%3A%2F%2Fpre-wormhole.tmall.com%2Fwow%2Fz%2Foversea%2Fgam%2Fpre-ovs-affiliate-pdp%3Fwh_showError%3Dtrue%26itemId%3D527575926534%26pid%3Dmm_26632943_457000242_108856900407%26relationId%3D2852359894%26language%3Dzh_CN%26site%3DOTHER%26ovs_scene%3Dtop_api_link_convert%26is_ovs_cpa%3D1%26ovs_cpa_scene%3Daffiliate_joint_attribution
  • 默认跳转链接 -- Default redirect link
  • income_info
  • MaterialItemIncomeInfoDTO
  • 商品佣金信息 -- Product commission information
  • └ commission_rate
  • String
  • 200
  • 商品佣金比率 -- Product commission rate
  • └ lock_rate_start_time
  • Number
  • 1748361600000
  • 推广信息-商品信息-锁佣开始时间 -- Promotion information - product information - commission lock start time
  • └ lock_rate
  • String
  • 300
  • 推广信息-商品信息-锁住的佣金率 -- Promotion information - product information - locked commission rate
  • └ lock_rate_end_time
  • Number
  • 1749052799000
  • 推广信息-商品信息-锁佣结束时间 -- Promotion information - product information - commission lock end time
  • └ commission_amount
  • String
  • 0.30
  • 商品佣金金额 -- Product commission amount
  • └ income_rate
  • String
  • 15.01
  • 商品信息-收入比率(%);商品佣金比率+补贴比率 -- Product information - Revenue ratio (%); Commission ratio + Subsidy ratio
  • └ commission_type
  • String
  • MKT
  • 佣金类型。MKT表示营销计划,SP表示定向计划,COMMON表示通用计划,ZX表示自选计划 -- Commission type. MKT represents Marketing Plan, SP represents Targeted Plan, COMMON represents General Plan, ZX represents Custom Plan
  • └ coupon_share_url
  • String
  • https://intl.taobao.com/dp?h5Url=https%3A%2F%2Fpre-wormhole.tmall.com%2Fwow%2Fz%2Foversea%2Fgam%2Fpre-ovs-affiliate-pdp%3Fwh_showError%3Dtrue%26itemId%3D527575926534%26pid%3Dmm_26632943_457000242_108856900407%26relationId%3D2852359894%26language%3Dzh_CN%26site%3DOTHER%26ovs_scene%3Dtop_api_link_convert%26is_ovs_cpa%3D1%26ovs_cpa_scene%3Daffiliate_joint_attribution
  • 券二合一页链接 -- Combined coupon page link
  • price_promotion_info
  • MaterialItemPromotionInfoDTO
  • 价格促销信息 -- Price promotion information
  • └ reserve_price
  • String
  • 69.8
  • 商品信息-一口价,通常显示为划线价 -- Product information - Fixed price, usually displayed as a strike-through price
  • └ predict_rounding_up_price
  • String
  • 9.9
  • 促销信息-预估凑单价(元)。预估凑单叠加优惠后的商品单价 -- Promotion information - estimated bundle price (RMB). Estimated unit price after combining bundle and discounts.
  • promotion_tag_list
  • MaterialItemPromotionTagDTO []
  • 标签信息列表 -- Tag information list
  • └ tag_name
  • String
  • 满100减10
  • 标签名称 -- Tag name
  • └ final_promotion_price
  • String
  • 59.9
  • 促销信息-预估到手价(元)。若属于预售商品,付定金时间内,预估到手价价=定金+尾款的预估到手价 -- Promotion information - estimated final price (RMB). For pre-sale items, during the deposit payment period, the estimated final price equals the deposit plus the estimated balance payment price.
  • └ predict_rounding_up_price_desc
  • String
  • 需凑单,需买2件
  • 促销信息-凑单价说明,描述凑单价的实现说明。如 “可凑单”或“需买X件” -- Promotion information - bundle price description, explaining how the bundle price is achieved, such as "bundling available" or "need to buy X items".
  • final_promotion_path_list
  • MaterialItemPromotionPathDTO []
  • 到手价优惠路径列表 -- Final price discount path list
  • └ promotion_title
  • String
  • 商品券
  • 优惠名称 -- Discount name
  • └ promotion_start_time
  • Number
  • 1750435200000
  • 优惠开始时间 -- Discount start time
  • └ promotion_desc
  • String
  • 满15减6
  • 优惠利益点文案,如“1件7.92折”、“每200减20”等 -- Discount benefit description, such as "7.92% off for 1 item", "20 RMB off every 200 RMB", etc.
  • └ promotion_id
  • String
  • 4c1fd912051543e1ab095e5925618bf7
  • 优惠ID -- Discount ID
  • └ promotion_end_time
  • Number
  • 1751299199000
  • 优惠结束时间 -- Discount end time
  • └ promotion_fee
  • String
  • 6
  • 实际优惠金额(元) -- Actual discount amount (RMB)
  • └ zk_final_price
  • String
  • 29.9
  • 促销信息-销售价格,无促销时等于一口价,有促销时为促销价。若属于预售商品,付定金时间内,在线售卖价=预售价 -- Promotion information - selling price. When there is no promotion, it equals the fixed price; when there is a promotion, it is the promotional price. For pre-sale items, during the deposit payment period, the online selling price equals the pre-sale price.
  • more_promotion_list
  • MaterialItemMorePromotionDTO []
  • 更多活动优惠 -- More promotional discounts
  • └ promotion_title
  • String
  • 1748966401000
  • 优惠开始时间 -- Discount start time
  • └ promotion_start_time
  • String
  • 直降9元
  • 优惠利益点文案,如“1件7.92折”、“每200减20”等 -- Discount benefit description, such as "7.92% off for 1 item", "20 RMB off every 200 RMB", etc.
  • └ promotion_desc
  • String
  • 1753943938000
  • 优惠结束时间 -- Discount end time
  • └ promotion_end_time
  • String
  • 2191463496637
  • 优惠ID -- Discount ID
  • └ promotion_id
  • String
  • 秒杀直降
  • 优惠名称 -- Discount name
  • item_basic_info
  • MaterialItemBasicInfoDTO
  • 商品基本信息 -- Basic product information
  • └ white_image
  • String
  • https://img.alicdn.com/bao/uploaded/O1CN01u4x0VE25MYAW4d8ep_!!6000000007512-0-yinhe.jpg
  • 商品信息-商品白底图 -- Product information - product image with white background
  • └ brand_name
  • String
  • 凯利来
  • 商品信息-品牌名称 -- Product information - brand name
  • └ level_one_category_name
  • String
  • 零食/坚果/特产
  • 商品信息-一级类目名称 -- Product information - primary category name
  • └ pict_url
  • String
  • https://img.alicdn.com/bao/uploaded/i1/3461918757/O1CN01rvW7VL2EYlLspAtaW_!!0-item_pic.jpg
  • 商品信息-商品主图 -- Product information - main product image
  • └ short_title
  • String
  • 凯利来手撕面包蛋糕点心糕点充饥
  • 商品信息-商品短标题 -- Product information - short product title
  • └ title
  • String
  • 凯利来千层软手撕面包整箱早餐鲜活蛋糕休闲零食蛋糕点心夜宵充饥
  • 商品信息-商品标题 -- Product information - product title
  • └ category_name
  • String
  • 传统西式糕点
  • 商品信息-叶子类目名称 -- Product information - leaf category name
  • └ is_prepay
  • Boolean
  • true
  • 商品信息-是否加入消费者保障 -- Product information - participation in consumer protection
  • └ small_images
  • String []
  • 商品信息-商品小图列表 -- Product information - list of small product images
  • └ seller_id
  • Number
  • 3461918757
  • 店铺信息-卖家ID -- Store information - seller ID
  • └ sub_title
  • String
  • 新老包装交替发货,现做现发。
  • 商品信息-商品子标题 -- Product information - product subtitle
  • └ provcity
  • String
  • 河南 濮阳
  • 商品信息-宝贝所在地 -- Product information - product location
  • └ tk_total_sales
  • String
  • 100000
  • 商品信息-淘客30天推广量 -- Product information - Taoke 30-day promotion volume
  • └ ratesum
  • Number
  • 16
  • 店铺信息-卖家等级 -- Store information - seller level
  • └ annual_vol
  • String
  • 80万+
  • 年销量 -- Annual sales volume
  • └ shop_title
  • String
  • 凯利来旗舰店
  • 店铺信息-店铺名称 -- Store information - store name
  • └ shop_dsr
  • Number
  • 48435
  • 店铺信息-店铺dsr评分 -- Store information - store DSR score
  • └ user_type
  • Number
  • 1
  • 店铺信息-卖家类型,0表示淘宝,1表示天猫,3表示特价版 -- Store information - seller type (0 for Taobao, 1 for Tmall, 3 for Special Price Edition)
  • └ level_one_category_id
  • Number
  • 50002766
  • 商品信息-一级类目ID -- Product information - primary category ID
  • └ category_id
  • Number
  • 50012598
  • 商品信息-叶子类目ID -- Product information - leaf category ID
  • presale_info
  • MaterialItemPresaleInfoDTO
  • 预售信息 -- Pre-sale information
  • └ presale_discount_fee_text
  • String
  • 179
  • 预售商品-预售优惠金额 -- Pre-sale product - pre-sale discount amount
  • └ presale_end_time
  • Number
  • 1747065599000
  • 预售商品-付定金结束时间(毫秒) -- Pre-sale product - deposit payment end time (ms)
  • └ presale_deposit
  • String
  • 1
  • 预售商品-定金(元) -- Pre-sale product - deposit (RMB)
  • └ presale_tail_end_time
  • Number
  • 1747065599000
  • 预售商品-付尾款结束时间(毫秒) -- Pre-sale product - balance payment end time (ms)
  • └ presale_start_time
  • Number
  • 1746532800000
  • 预售商品-付定金开始时间(毫秒) -- Pre-sale product - deposit payment start time (ms)
  • └ presale_tail_start_time
  • Number
  • 1747065599000
  • 预售商品-付尾款开始时间(毫秒) -- Pre-sale product - balance payment start time (ms)

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OvsTbkMaterialItemOptionalRequest req = new OvsTbkMaterialItemOptionalRequest();
req.setStartPrice(9L);
req.setIsTmall(true);
req.setUnid("1234567");
req.setEndTkRate(1234L);
req.setPageSize(20L);
req.setAdzoneId(12345678L);
req.setLanguage("zh_CN");
req.setEndPrice(19L);
req.setSort("tk_rate_des");
req.setMaterialId(106395L);
req.setQ("衣服");
req.setSite("TW");
req.setHasCoupon(true);
req.setStartTkRate(1234L);
req.setPageNo(1L);
req.setCat("16,18");
OvsTbkMaterialItemOptionalResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<ovs_tbk_material_item_optional_response>
    <total_results>1234</total_results>
    <next_page>2</next_page>
    <has_next>true</has_next>
    <result_list>
        <material_item_summary_info>
            <item_id>O0rq6kjfzt6WxJ3gj8H42ahkiJ-5Aqw2ATWpWVJn09UZ</item_id>
            <coupon_info>
                <coupon_start_fee>17</coupon_start_fee>
                <coupon_remain_count>27000</coupon_remain_count>
                <coupon_amount>5</coupon_amount>
                <coupon_activity_id>30660aec6d334a929186b8ca49892bca</coupon_activity_id>
                <coupon_sale_text_info>满17元减5元</coupon_sale_text_info>
                <coupon_effective_start_time>1748361600000</coupon_effective_start_time>
                <coupon_effective_end_time>1749052799000</coupon_effective_end_time>
            </coupon_info>
            <publish_info>
                <click_url>https://intl.taobao.com/dp?h5Url=https%3A%2F%2Fpre-wormhole.tmall.com%2Fwow%2Fz%2Foversea%2Fgam%2Fpre-ovs-affiliate-pdp%3Fwh_showError%3Dtrue%26itemId%3D527575926534%26pid%3Dmm_26632943_457000242_108856900407%26relationId%3D2852359894%26language%3Dzh_CN%26site%3DOTHER%26ovs_scene%3Dtop_api_link_convert%26is_ovs_cpa%3D1%26ovs_cpa_scene%3Daffiliate_joint_attribution</click_url>
                <income_info>
                    <commission_rate>200</commission_rate>
                    <lock_rate_start_time>1748361600000</lock_rate_start_time>
                    <lock_rate>300</lock_rate>
                    <lock_rate_end_time>1749052799000</lock_rate_end_time>
                    <commission_amount>0.30</commission_amount>
                </income_info>
                <income_rate>15.01</income_rate>
                <commission_type>MKT</commission_type>
                <coupon_share_url>https://intl.taobao.com/dp?h5Url=https%3A%2F%2Fpre-wormhole.tmall.com%2Fwow%2Fz%2Foversea%2Fgam%2Fpre-ovs-affiliate-pdp%3Fwh_showError%3Dtrue%26itemId%3D527575926534%26pid%3Dmm_26632943_457000242_108856900407%26relationId%3D2852359894%26language%3Dzh_CN%26site%3DOTHER%26ovs_scene%3Dtop_api_link_convert%26is_ovs_cpa%3D1%26ovs_cpa_scene%3Daffiliate_joint_attribution</coupon_share_url>
            </publish_info>
            <price_promotion_info>
                <reserve_price>69.8</reserve_price>
                <predict_rounding_up_price>9.9</predict_rounding_up_price>
                <promotion_tag_list>
                    <material_item_promotion_tag_d_t_o>
                        <tag_name>满100减10</tag_name>
                    </material_item_promotion_tag_d_t_o>
                </promotion_tag_list>
                <final_promotion_price>59.9</final_promotion_price>
                <predict_rounding_up_price_desc>需凑单,需买2件</predict_rounding_up_price_desc>
                <final_promotion_path_list>
                    <material_item_promotion_path_d_t_o>
                        <promotion_title>商品券</promotion_title>
                        <promotion_start_time>1750435200000</promotion_start_time>
                        <promotion_desc>满15减6</promotion_desc>
                        <promotion_id>4c1fd912051543e1ab095e5925618bf7</promotion_id>
                        <promotion_end_time>1751299199000</promotion_end_time>
                        <promotion_fee>6</promotion_fee>
                    </material_item_promotion_path_d_t_o>
                </final_promotion_path_list>
                <zk_final_price>29.9</zk_final_price>
                <more_promotion_list>
                    <material_item_more_promotion_d_t_o>
                        <promotion_title>1748966401000</promotion_title>
                        <promotion_start_time>直降9元</promotion_start_time>
                        <promotion_desc>1753943938000</promotion_desc>
                        <promotion_end_time>2191463496637</promotion_end_time>
                        <promotion_id>秒杀直降</promotion_id>
                    </material_item_more_promotion_d_t_o>
                </more_promotion_list>
            </price_promotion_info>
            <item_basic_info>
                <white_image>https://img.alicdn.com/bao/uploaded/O1CN01u4x0VE25MYAW4d8ep_!!6000000007512-0-yinhe.jpg</white_image>
                <brand_name>凯利来</brand_name>
                <level_one_category_name>零食/坚果/特产</level_one_category_name>
                <pict_url>https://img.alicdn.com/bao/uploaded/i1/3461918757/O1CN01rvW7VL2EYlLspAtaW_!!0-item_pic.jpg</pict_url>
                <short_title>凯利来手撕面包蛋糕点心糕点充饥</short_title>
                <title>凯利来千层软手撕面包整箱早餐鲜活蛋糕休闲零食蛋糕点心夜宵充饥</title>
                <category_name>传统西式糕点</category_name>
                <is_prepay>true</is_prepay>
                <seller_id>3461918757</seller_id>
                <sub_title>新老包装交替发货,现做现发。</sub_title>
                <provcity>河南 濮阳</provcity>
                <tk_total_sales>100000</tk_total_sales>
                <ratesum>16</ratesum>
                <annual_vol>80万+</annual_vol>
                <shop_title>凯利来旗舰店</shop_title>
                <shop_dsr>48435</shop_dsr>
                <user_type>1</user_type>
                <level_one_category_id>50002766</level_one_category_id>
                <category_id>50012598</category_id>
            </item_basic_info>
            <presale_info>
                <presale_discount_fee_text>179</presale_discount_fee_text>
                <presale_end_time>1747065599000</presale_end_time>
                <presale_deposit>1</presale_deposit>
                <presale_tail_end_time>1747065599000</presale_tail_end_time>
                <presale_start_time>1746532800000</presale_start_time>
                <presale_tail_start_time>1747065599000</presale_tail_start_time>
            </presale_info>
        </material_item_summary_info>
    </result_list>
</ovs_tbk_material_item_optional_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部