文档中心 > API类目 > 淘宝物流API

taobao.delivery.template.get (获取用户指定运费模板信息)

获取用户指定运费模板信息

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
template_ids String [] 必须 10000
  • 最大列表长度:20
  • 需要查询的运费模板ID列表
    fields String [] 必须 template_id,template_name,created,modified,supports,assumer,valuation,query_express,query_ems,query_cod,query_post,address,consign_area_id,query_furniture,query_bzsd,query_wlb
  • 最大列表长度:20
  • 需返回的字段列表。
    可选值:示例中的值;各字段之间用","隔开

    template_id:查询模板ID
    template_name:查询模板名称
    assumer:查询服务承担放
    valuation:查询计价规则
    supports:查询增值服务列表
    created:查询模板创建时间
    modified:查询修改时间
    consign_area_id:运费模板上设置的卖家发货地址最小级别ID
    address:卖家地址信息


    query_cod:查询货到付款运费信息
    query_post:查询平邮运费信息
    query_express:查询快递公司运费信息
    query_ems:查询EMS运费信息
    query_bzsd:查询普通保障速递运费信息
    query_wlb:查询物流宝保障速递运费信息
    query_furniture:查询家装物流运费信息

    不能有空格

    响应参数

    名称 类型 示例值 描述
    delivery_templates DeliveryTemplate [] 运费模板列表
    • └ template_id
    • Number
    • 100203
    • 模块ID
    • └ name
    • String
    • 邮费测试模板
    • 模板名称,长度不能超过25个字节
    • └ assumer
    • Number
    • 1
    • 可选值:0,1,2,3
      ,说明如下
      1)买家承担运费的模版
      0:买家承担服务费
      1: 卖家承担服务费
      2)卖家承担运费的模版
      2:卖家承担运费的模版(集市),卖家承担服务费
      3:卖家承担运费的模版(天猫),卖家承担服务费
    • └ valuation
    • Number
    • 0
    • 可选值:0 说明: 0:表示按宝贝件数计算运费

      1:表示按宝贝重量计算运费

      3:表示按宝贝体积计算运费
    • fee_list
    • TopFee []
    • 运费模板中运费详细信息对象,包含默认运费和指定地区运费
    • └ service_type
    • String
    • post
    • 可选值:post:平邮; cod:货到付款; ems:EMS; express:快递公司
    • └ destination
    • String
    • 1,3100000
    • 邮费子项涉及的地区,多个地区用逗号连接数量串;可以用taobao.areas.get接口获取.或者参考:http://www.stats.gov.cn/tjbz/xzqhdm/t20080215_402462675.htm 例 (110000,310000,320000,330000).就代表邮费子项涉 及(北京,上海,江苏,浙江)四个地区.填写时要注意对照地区代码值,如果填入错误地区代码,将会出现错误信息.
    • └ start_standard
    • String
    • 1
    • 首费标准:当valuation(记价方式)为0时输入1-9999范围内的整数
    • └ start_fee
    • String
    • 10.22
    • 首费:输入0.01-999.99(最多包含两位小数) 不能为空也不能为0
    • └ add_standard
    • String
    • 2
    • 增费标准:当valuation(记价方式)为0时输入1-9999范围内的整数
    • └ add_fee
    • String
    • 2.3
    • 增费:输入0.00-999.99(最多包含两位小数) 不能为空不输入运费时必须输入0
    • └ supports
    • String
    • cod,mpos
    • 物流服务模板支持增值服务列表,多个用分号隔开。cod:货到付款 mops:刷卡付款
    • └ created
    • Date
    • 2000-01-01 00:00:00
    • 模板创建时间
    • └ modified
    • Date
    • 2000-01-01 00:00:00
    • 模板修改时间
    • └ address
    • String
    • 浙江省杭州市西湖去文三路XX号
    • 运费模板上设置的发货地址
    • └ consign_area_id
    • Number
    • 1112
    • 该模板上设置的卖家发货地址区域ID,如:address为浙江省杭州市西湖去文三路XX号那么这个consign_area_id的值就是西湖区的ID
    total_results Number 1 获得到符合条件的结果总数

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    DeliveryTemplateGetRequest req = new DeliveryTemplateGetRequest();
    req.setTemplateIds("10000");
    req.setFields("template_id,template_name,created,modified,supports,assumer,valuation,query_express,query_ems,query_cod,query_post,address,consign_area_id,query_furniture,query_bzsd,query_wlb");
    DeliveryTemplateGetResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <delivery_template_get_response>
        <delivery_templates>
            <delivery_template>
                <template_id>100203</template_id>
                <name>邮费测试模板</name>
                <assumer>1</assumer>
                <valuation>0</valuation>
                <fee_list>
                    <top_fee>
                        <service_type>post</service_type>
                        <destination>1,3100000</destination>
                        <start_standard>1</start_standard>
                        <start_fee>10.22</start_fee>
                        <add_standard>2</add_standard>
                        <add_fee>2.3</add_fee>
                    </top_fee>
                </fee_list>
                <supports>cod,mpos</supports>
                <created>2000-01-01 00:00:00</created>
                <modified>2000-01-01 00:00:00</modified>
                <address>浙江省杭州市西湖去文三路XX号</address>
                <consign_area_id>1112</consign_area_id>
            </delivery_template>
        </delivery_templates>
        <total_results>1</total_results>
    </delivery_template_get_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>

    错误码解释

    错误码 错误描述 解决方案
    isv.invalid-parameter:templateids-error 需要查询的运费模版ID列表不正确 输入运费模版ID前,请先确认ID是正确的再输入
    isv.not-query-user-template 没有查询到对应的模板信息 请确认传入的模版ID或用户正确并对应
    isv.invalid-query:userId-and-userNick-empty 用户为空或不存在 请输入用户昵称或登录授权!
    isv.user-not-exist:invalid-nick 用户昵称不正确或不存在 用户昵称不正确或不存在,请确认用户昵称

    API工具

    如何获得此API

    FAQ

    返回
    顶部