文档中心 > API类目 > 淘宝客API

taobao.tbk.coupon.convert (淘宝客-推广者-单品券高效转链)

单品券高效转链API

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
adzone_id Number 必须 123 推广位id,mm_xx_xx_xx pid三段式中的第三段
item_id String 可选 123 淘客商品id
platform Number 可选 1
  • 默认值:1
  • 1:PC,2:无线,默认:1
    relation_id String 可选 12345 渠道管理ID(如是主站选品推广场景,必须入参该字段,且bizSceneId字段需入参2-消费者比价场景,否则二次转链失败)
    special_id String 可选 12345 会员运营ID
    external_id String 可选 12345 淘宝客外部用户标记,如自身系统账户ID;微信ID等
    xid String 可选 abcdefg 团长与下游渠道合作的特殊标识,用于统计渠道推广效果
    ucrowd_id Number 可选 1 会员人群ID,用于统计人群推广效果
    get_topn_rate Number 可选 0
  • 默认值:0
  • 是否获取前N件佣金 ,0-否,1-是,其他值-否
    mini_program_link Number 可选 0
  • 默认值:0
  • 是否需要获取小程序链接,需要设置1。(暂未对外开放)
    biz_scene_id String 可选 1 1-动态ID转链场景,2-消费者比价场景,3-商品库导购场景(不填默认为1)
    promotion_type String 可选 2 1-自购省,2-推广赚(代理模式专属ID,代理模式必填,其它模式不用填写本字段)
    manage_item_pub_id Number 可选 1 商品库服务账户(场景id3权限对应的memberid)
    sku_id Number 可选 1234567 入参商品id下的skuid,传入时会透传至转链结果url中

    响应参数

    名称 类型 示例值 描述
    result RpcResult 1 result
    • results
    • MaterialDto
    • 1
    • data
    • └ coupon_remain_count
    • Number
    • 6859
    • 优惠券剩余量
    • └ coupon_total_count
    • Number
    • 8000
    • 优惠券总量
    • └ coupon_info
    • String
    • 满16元减10元
    • 优惠券面额
    • └ coupon_end_time
    • String
    • 2016-09-26
    • 优惠券结束时间
    • └ coupon_start_time
    • String
    • 2016-09-25
    • 优惠券开始时间
    • └ coupon_click_url
    • String
    • https://uland.taobao.com/coupon/edetail?e=nqUNB1NOF3Bt3vqbdXnGloankzPYmeEFkgNrw6YHQf9pZTj41Orn8MwBAs06HAOzqQomYNedOiHDYPmqkFXqLR0HgBdG%2FDDL%2F1M%2FBw7Sf%2FesGXLf%2BqX4cbeC%2F2cR0p0NlWH0%2BknxpnCJJP%2FQkZSsyo1HvKjXo4uz&pid=mm_26381042_12970066_52864659&af=1
    • 商品优惠券推广链接
    • └ category_id
    • Number
    • 1
    • 后台一级类目
    • └ max_commission_rate
    • String
    • 20.3
    • 当不入参special_id、relation_id、external_id时,展示常规佣金率(%)
    • └ item_id
    • String
    • 524136796550
    • 商品id
    • └ item_url
    • String
    • https://s.click.taobao.com/t?spm=a2e2e.10720394/c.90202110.1.4399704cUUhhH0&e=m%3D2%26s%3D0NJS731SUEdw4vFB6t2Z2ueEDrYVVa64LKpWJ%2Bin0XLjf2vlNIV67uIA4kDYDopEpOjgxi0uT208hw4H8GMUew7uoRPWrIBwR7CIpaNCoiKr9WTFywb%2BCtGNFs53xi4QGSKqJrqeJvt5ArodCWjzv9fsai3uVirbXH%2BQH9e66Y4%3D
    • 商品淘客链接
    • └ ysyl_click_url
    • String
    • https://uland.taobao.com/coupon/edetail?e=nqUNB1NOF3Bt3vqbdXnGloankzPYmeEFkgNrw6YHQf9pZTj41Orn8MwBAs06HAOzqQomYNedOiHDYPmqkFXqLR0HgBdG%2FDDL%2F1M%2FBw7Sf%2FesGXLf%2BqX4cbeC%2F2cR0p0NlWH0%2BknxpnCJJP%2FQkZSsyo1HvKjXo4uz&pid=mm_26381042_12970066_52864659&af=1
    • 预售有礼-推广链接
    • └ ysyl_tlj_face
    • String
    • 0.6
    • 预售有礼-预估淘礼金(元)
    • └ ysyl_tlj_send_time
    • String
    • 2019-11-10 21:59:59
    • 预售有礼-淘礼金发放时间
    • └ ysyl_tlj_use_start_time
    • String
    • 2019-11-10 21:59:59
    • 预售有礼-淘礼金使用开始时间
    • └ ysyl_commission_rate
    • String
    • 20.3
    • 预售有礼-佣金比例(%)( 预售有礼活动享受的推广佣金比例,注:推广该活动有特殊分成规则,请详见:https://tbk.bbs.taobao.com/detail.html?appId=45301&postId=9334376 )
    • └ ysyl_tlj_use_end_time
    • String
    • 2019-11-10 21:59:59
    • 预售有礼-淘礼金使用结束时间
    • └ min_commission_rate
    • String
    • 20.3
    • 当入参special_id、relation_id、external_id时,该字段展示预估最低佣金率(%)
    • └ reward_info
    • Number
    • 1
    • 比价场景专用,当系统检测到入参消费者ID购买当前商品会获得《天天开彩蛋》玩法的彩蛋时,该字段显示1,否则为0
    • └ campaign_type
    • Number
    • 2
    • 计划类型,0代表通用计划,1代表定向计划,2代表鹊桥计划,3代表营销计划
    • └ coupon_type
    • Number
    • 1
    • 优惠券(商品优惠券推广链接中的券)类型,1 公开券,2 私有券,3 妈妈券
    • topn_info
    • StepRateDto
    • 前N件佣金信息-当入参get_topn_rate=1,前N件佣金生效且最高,透出该组字段
    • └ topn_start_time
    • Number
    • 1937297392332
    • 前N件佣金开始时间,当前N件佣金失效,本字段置空
    • └ topn_end_time
    • Number
    • 1937297392332
    • 前N件佣金结束时间,当前N件佣金 失效,本字段置空
    • └ topn_total_count
    • Number
    • 3000
    • 前N件初始总库存,当前N件佣金失效,本字段置空(失效:任务完成、时间结束、商品下架)
    • └ topn_quantity
    • Number
    • 3000
    • 前N件剩余库存,当前N件佣金失效,本字段置空
    • mini_program
    • MiniProgramDto
    • 小程序链接(暂未对外开放)
    • └ mini_program_appid
    • String
    • 1
    • 小程序APPID
    • └ mini_program_path
    • String
    • 见具体值
    • 小程序路径
    • └ mini_program_qrcode_url
    • String
    • 见具体值
    • 小程序码url地址
    • └ extra_info
    • String
    • skuid已失效,未参与转链
    • 转链成功的场景下,需要补充说明的信息
    • └ result_code
    • Number
    • 1
    • 见错误码描述
    • └ result_msg
    • String
    • 1
    • 见错误描述

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    TbkCouponConvertRequest req = new TbkCouponConvertRequest();
    req.setAdzoneId(123L);
    req.setItemId("123");
    req.setPlatform(1L);
    req.setRelationId("12345");
    req.setSpecialId("12345");
    req.setExternalId("12345");
    req.setXid("abcdefg");
    req.setUcrowdId(1L);
    req.setGetTopnRate(0L);
    req.setMiniProgramLink(0L);
    req.setBizSceneId("1");
    req.setPromotionType("2");
    req.setManageItemPubId(1L);
    req.setSkuId(1234567L);
    TbkCouponConvertResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <tbk_coupon_convert_response>
        <result>
            <results>
                <coupon_remain_count>6859</coupon_remain_count>
                <coupon_total_count>8000</coupon_total_count>
                <coupon_info>满16元减10元</coupon_info>
                <coupon_end_time>2016-09-26</coupon_end_time>
                <coupon_start_time>2016-09-25</coupon_start_time>
                <coupon_click_url>https://uland.taobao.com/coupon/edetail?e=nqUNB1NOF3Bt3vqbdXnGloankzPYmeEFkgNrw6YHQf9pZTj41Orn8MwBAs06HAOzqQomYNedOiHDYPmqkFXqLR0HgBdG%2FDDL%2F1M%2FBw7Sf%2FesGXLf%2BqX4cbeC%2F2cR0p0NlWH0%2BknxpnCJJP%2FQkZSsyo1HvKjXo4uz&amp;pid=mm_26381042_12970066_52864659&amp;af=1</coupon_click_url>
                <category_id>1</category_id>
                <max_commission_rate>20.3</max_commission_rate>
                <item_id>524136796550</item_id>
                <item_url>https://s.click.taobao.com/t?spm=a2e2e.10720394/c.90202110.1.4399704cUUhhH0&amp;e=m%3D2%26s%3D0NJS731SUEdw4vFB6t2Z2ueEDrYVVa64LKpWJ%2Bin0XLjf2vlNIV67uIA4kDYDopEpOjgxi0uT208hw4H8GMUew7uoRPWrIBwR7CIpaNCoiKr9WTFywb%2BCtGNFs53xi4QGSKqJrqeJvt5ArodCWjzv9fsai3uVirbXH%2BQH9e66Y4%3D</item_url>
                <ysyl_click_url>https://uland.taobao.com/coupon/edetail?e=nqUNB1NOF3Bt3vqbdXnGloankzPYmeEFkgNrw6YHQf9pZTj41Orn8MwBAs06HAOzqQomYNedOiHDYPmqkFXqLR0HgBdG%2FDDL%2F1M%2FBw7Sf%2FesGXLf%2BqX4cbeC%2F2cR0p0NlWH0%2BknxpnCJJP%2FQkZSsyo1HvKjXo4uz&amp;pid=mm_26381042_12970066_52864659&amp;af=1</ysyl_click_url>
                <ysyl_tlj_face>0.6</ysyl_tlj_face>
                <ysyl_tlj_send_time>2019-11-10  21:59:59</ysyl_tlj_send_time>
                <ysyl_tlj_use_start_time>2019-11-10  21:59:59</ysyl_tlj_use_start_time>
                <ysyl_commission_rate>20.3</ysyl_commission_rate>
                <ysyl_tlj_use_end_time>2019-11-10  21:59:59</ysyl_tlj_use_end_time>
                <min_commission_rate>20.3</min_commission_rate>
                <reward_info>1</reward_info>
                <campaign_type>2</campaign_type>
                <coupon_type>1</coupon_type>
                <topn_info>
                    <topn_start_time>1937297392332</topn_start_time>
                    <topn_end_time>1937297392332</topn_end_time>
                    <topn_total_count>3000</topn_total_count>
                    <topn_quantity>3000</topn_quantity>
                </topn_info>
                <mini_program>
                    <mini_program_appid>1</mini_program_appid>
                    <mini_program_path>见具体值</mini_program_path>
                    <mini_program_qrcode_url>见具体值</mini_program_qrcode_url>
                </mini_program>
                <extra_info>skuid已失效,未参与转链</extra_info>
            </results>
            <result_code>1</result_code>
            <result_msg>1</result_msg>
        </result>
    </tbk_coupon_convert_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>

    错误码解释

    错误码 错误描述 解决方案
    isp.special-campaign-error 定向计划服务异常 建议加入重试机制
    isv.item-not-exist 宝贝已下架或非淘客宝贝 使用有效的item_id
    isv.pid-not-correct site_id或adzone_id与登录账号不匹配 使用登录账号下的site_id与adzone_id
    isv.invalid-parameter:adzone_id 入参adzone_id非法 检查adzone_id相关入参
    isp.tbkapi-service-unavailable 内部服务不可用 稍后重试
    isv.me_param_not_correct me参数不合法 参考文档
    isp.url_xid_not_match 输入推广url验证失败 检查url参数
    isv.coupon_not_exist 优惠券不存在 修改优惠券参数
    11 优惠券已领完 更换优惠券参数
    isp.url_item_get_error 输入url的解析商品id失败,请检查 输入url的解析商品id失败,请检查
    isp.rebate-id-not-match relationId, specialId, externalId不匹配 relationId, specialId, externalId三者若传入,那么对应绑定的用户必须是一致的
    isp.relation-id-not-corrent relationId不正确 检查relationId是否正确
    isp.special-id-not-corrent specialId不正确 检查specialId是否正确
    isp.isp.mrc-service-unavailable 服务异常 检查itemId等入参是否正常,然后重试
    isp.top-mapping-parse-error 服务异常 检查itemId等入参是否正常,然后重试
    35 您输入的商品ID不合法,请使用升级后的新商品ID,如有疑问请加入【淘宝联盟】线上合规升级咨询群(钉钉群:44965410)进行咨询 您输入的商品ID不合法,请使用升级后的新商品ID,如有疑问请加入【淘宝联盟】线上合规升级咨询群(钉钉群:44965410)进行咨询
    33 不支持该商品id 不支持该商品id
    36 ID识别异常 入参itemId无效,更换itemId
    25 内部服务异常 请重试

    API工具

    如何获得此API

    FAQ

    返回
    顶部