cainiao.pickup.business.preorderview.get (菜鸟商家寄件下单前获取预览信息)

该合作企业伙伴(商家)批量操作下单前可以看到的预览信息,通过展示下单时的预览信息及营销内容提升寄件转化率

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
biz_type String 可选 GuoGuoSMB
  • 默认值:GuoGuoSMB
  • 提供给合作伙伴使用的商家域业务类型
    mobile String 可选 13817778888 下单操作人的手机号,用作联系,可以不填写
    package_info_list GuoGuoPackageInfo [] 必须
  • 最大列表长度:30
  • 批量下单时包裹信息列表,最多传30个
    • └ package_id
    • String
    • 可选
    • taobao_order_123
    • 用于下单的外部单号,防止幂等
    • └ weight
    • String
    • 可选
    • 1000
    • 包裹重量。单位:克
    • receiver
    • BusinessCustomer
    • 必须
    • 收件人信息
    • └ name
    • String
    • 必须
    • 张三
    • 收件人姓名
    • └ mobile
    • String
    • 必须
    • 13799998888
    • 收件人电话
    • └ full_address_detail
    • String
    • 必须
    • 浙江省杭州市西湖区文一西路西溪首座小邮局
    • 收件人详细地址
    • └ area_id
    • String
    • 可选
    • 330100
    • 收件人地址库编码,可不填
    • encrypted_customer_info
    • EncryptedCustomerInfo
    • 可选
    • 淘宝加密字段(如果无法取到明文的收件人信息,可以本字段代替,否则勿使用本字段。若本字段下属2个字段都不为空,则取解密后的地址为收件人地址。否则此字段无效,依然取上面的full_address_detail等信息为收件人信息。若下属2个字段都不为空但有误,会下单失败)
    • └ oaid
    • String
    • 可选
    • adu7d82eb
    • 淘宝加密后的收件人信息ID
    • └ taobao_order_id
    • String
    • 可选
    • 123456
    • 淘宝订单ID
    • sender
    • BusinessCustomer
    • 可选
    • 寄件人信息
    • └ name
    • String
    • 必须
    • 张三
    • 寄件人姓名
    • └ mobile
    • String
    • 必须
    • 13799998888
    • 寄件人电话
    • └ full_address_detail
    • String
    • 必须
    • 浙江省杭州市西湖区文一西路西溪首座小邮局
    • 寄件人详细地址
    • └ area_id
    • String
    • 可选
    • 330100
    • 寄件人地址库编码,可不填
    • └ item_id
    • String
    • 可选
    • 138_small_b
    • 服务商品

    响应参数

    名称 类型 示例值 描述
    result TdOpenServiceResult {} 返回对象
    • data
    • OrderViewDto
    • {}
    • 返回对象
    • promotion_infos
    • Promotioninfos []
    • []
    • 整批下单的促销信息列表
    • └ promotion_copy
    • String
    • 下单立减
    • 优惠文案
    • └ promotion_price
    • String
    • 350
    • 优惠价格
    • └ promotion_type
    • Number
    • 0
    • 优惠类型,用于区分优惠类别
    • └ coupon_price
    • Number
    • 1000
    • 批量下单能够优惠的总金额
    • └ total_actual_price
    • Number
    • 2000
    • 批量下单优惠后预估价格
    • └ total_origin_price
    • Number
    • 3000
    • 批量下单原始预估价格
    • pre_order_info_list
    • GuoGuoPreOrderInfo []
    • {}
    • 单个包裹的预估信息
    • └ estimate_origin_price
    • Number
    • 1200
    • 原始价格
    • └ coupon_price
    • Number
    • 200
    • 优惠价格
    • └ estimate_actual_price
    • Number
    • 1000
    • 实际价格
    • └ no_service_reason
    • String
    • 当前区域无服务
    • 无法提供服务的原因
    • └ can_service
    • Boolean
    • false
    • 订单能否提供服务
    • └ package_id
    • String
    • 67893874673892
    • 传入的包裹运单号
    • └ estimation_weight_desc
    • String
    • 1公斤内预估
    • 预估价时,采用的预估重量描述
    • └ sender_address_desc
    • String
    • 浙江省杭州市西湖区文一西路西溪首座小邮局
    • 寄件人地址
    • order_preview_desc
    • HrefLabel
    • {}
    • 该次预估价调用的整体描述
    • └ display_info
    • String
    • 当日已寄件(含本次)14单,再下3单可享受每票2元
    • 描述信息
    • └ select_type
    • String
    • 本字段暂时无效
    • 勾选类型(本字段暂时无效)
    • └ href_desc
    • String
    • 具体请查看XXX
    • 链接描述(如果描述信息里如果有链接)
    • └ link_url
    • String
    • http://xxx.com
    • 链接地址(如果描述信息里如果有链接)
    • └ high_lights
    • String []
    • [14单,3单,2元]
    • 描述信息里建议加高亮处理的部分文案
    • └ tooltip
    • String
    • 提示
    • 提示信息
    • └ link_type
    • String
    • LINK
    • 链接类型(若link_url无值则本字段无效):LINK("LINK","页面地址,当前页面打开"),NEW_LINK("NEW_LINK","页面地址,新页面打开"),IMG("IMG","图片地址"),如果没有传递,则默认代表LINK
    • order_ads_desc
    • HrefLabel
    • {}
    • 该次预估价调用的一些服务广告信息
    • └ display_info
    • String
    • 今日17点前揽收,当日揽收,17点后下单,次日揽收,晚到必赔
    • 描述信息
    • └ select_type
    • String
    • Default
    • 勾选类型:AutoSelected(无需选择器,自动包含),Default(有选择器,由客户决定是否勾选)
    • └ href_desc
    • String
    • 查看裹裹服务协议
    • 链接描述,此处一般是具体协议的描述
    • └ link_url
    • String
    • http://xxx.com
    • 链接描述,此处一般是具体协议的详情链接
    • └ high_lights
    • String []
    • 同意《裹裹服务协议》
    • 建议加高亮处理的内容,一般是希望用户了解的服务协议
    • └ link_type
    • String
    • LINK
    • 链接类型(若link_url无值则本字段无效):LINK("LINK","页面地址,当前页面打开"),NEW_LINK("NEW_LINK","页面地址,新页面打开"),IMG("IMG","图片地址"),如果没有传递,则默认代表LINK
    • └ tooltip
    • String
    • 提示
    • 提示信息
    • order_benefit_desc_list
    • OrderBenefitItem []
    • {}
    • 本单可以享受的权益
    • └ key
    • String
    • CompensationForLate
    • 权益Key
    • └ name
    • String
    • 晚揽必赔
    • 权益Name
    • └ desc
    • String
    • 千元内免保价
    • 权益介绍
    • └ ori_price
    • String
    • 10元/票
    • 原价(一般是价格,如果显示“无价格”表示这个本来不收费,建议就不要展示价格信息)
    • └ current_price
    • String
    • 1元/票、赠送
    • 现价(可能是价格,也可能是优惠描述)
    • └ show_condition
    • String
    • AlwaysShow
    • 展示条件:AlwaysShow(始终展示),AlwaysHidden(始终隐藏)
    • └ use_condition
    • String
    • NoCondition
    • 使用条件:NoCondition(无使用条件)
    • └ select_type
    • String
    • Default
    • 勾选类型:AutoSelected(无需选择器,自动包含),Default(有选择器,由客户决定是否勾选)
    • └ tooltip
    • String
    • 17:00前下单快递员当日上门揽收,揽收超时可向在线客服申请赔付
    • 补充介绍信息,建议做成浮层效果
    • external_order_fees
    • ExternalOrderFee []
    • {}
    • 本次订单额外需要支付的费用(已经计入到总价里了,这里只是展示告知客户)
    • └ fee_desc
    • String
    • 一单加价
    • 费用描述
    • └ fee_price
    • Number
    • 100
    • 费用价格,单位:分
    • └ fee_status
    • String
    • Removed
    • 当前费用收取状态,Used(已计入总价中),Removed(已免除,免收),若无返回也表示已经计入到了总价中
    • └ fee_status_reason
    • String
    • VIP专享:免收权益
    • 当前费用收取状态原因描述,例如常见的免收原因:VIP专享:免收权益
    • suggest_display_info
    • HrefLabel
    • {}
    • 该费用的展示的建议方式(PC端)
    • └ tooltip
    • String
    • 提示
    • 提示信息
    • └ link_type
    • String
    • 资源地址的类型
    • 链接类型(若link_url无值则本字段无效):LINK("LINK","页面地址,当前页面打开"),NEW_LINK("NEW_LINK","页面地址,新页面打开"),IMG("IMG","图片地址"),如果没有传递,则默认代表LINK
    • └ link_url
    • String
    • http://xxx
    • 展现的资源地址
    • └ href_desc
    • String
    • 点击查看xxx
    • 链接描述
    • └ high_lights
    • String []
    • 优惠100元
    • 高亮内容
    • └ display_info
    • String
    • 本订单优惠100元
    • 显示内容
    • suggest_display_info_for_mobile
    • HrefLabel
    • {}
    • 该费用的展示的建议方式(移动端)
    • └ display_info
    • String
    • 本订单优惠100元
    • 显示内容
    • └ high_lights
    • String []
    • 优惠100元
    • 高亮内容
    • └ href_desc
    • String
    • 点击查看xxx
    • 链接描述
    • └ link_url
    • String
    • http://xxx
    • 展现的资源地址
    • └ link_type
    • String
    • 资源地址的类型
    • 链接类型(若link_url无值则本字段无效):LINK("LINK","页面地址,当前页面打开"),NEW_LINK("NEW_LINK","页面地址,新页面打开"),IMG("IMG","图片地址"),如果没有传递,则默认代表LINK
    • └ tooltip
    • String
    • 提示
    • 提示信息
    • └ price_tag
    • String
    • 网点专属报价
    • 报价类型(本字段可能没有返回)
    • └ success
    • Boolean
    • true
    • 是否操作成功
    • └ retry
    • Boolean
    • false
    • 是否需要重试
    • └ status_message
    • String
    • 系统错误
    • 错误描述,如果不能使用服务,会在这里提示错误信息
    • └ status_code
    • String
    • SYS_ERROIR
    • 错误码

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    CainiaoPickupBusinessPreorderviewGetRequest req = new CainiaoPickupBusinessPreorderviewGetRequest();
    req.setBizType("GuoGuoSMB");
    req.setMobile("13817778888");
    List<CainiaoPickupBusinessPreorderviewGetRequest.GuoGuoPackageInfo> list2 = new ArrayList<CainiaoPickupBusinessPreorderviewGetRequest.GuoGuoPackageInfo>();
    CainiaoPickupBusinessPreorderviewGetRequest.GuoGuoPackageInfo obj3 = new CainiaoPickupBusinessPreorderviewGetRequest.GuoGuoPackageInfo();
    list2.add(obj3);
    obj3.setPackageId("taobao_order_123");
    obj3.setWeight("1000");
    CainiaoPickupBusinessPreorderviewGetRequest.BusinessCustomer obj5 = new CainiaoPickupBusinessPreorderviewGetRequest.BusinessCustomer();
    obj5.setName("张三");
    obj5.setMobile("13799998888");
    obj5.setFullAddressDetail("浙江省杭州市西湖区文一西路西溪首座小邮局");
    obj5.setAreaId("330100");
    CainiaoPickupBusinessPreorderviewGetRequest.EncryptedCustomerInfo obj6 = new CainiaoPickupBusinessPreorderviewGetRequest.EncryptedCustomerInfo();
    obj6.setOaid("adu7d82eb");
    obj6.setTaobaoOrderId("123456");
    obj5.setEncryptedCustomerInfo(obj6);
    list4.setReceiver(obj5);
    CainiaoPickupBusinessPreorderviewGetRequest.BusinessCustomer obj8 = new CainiaoPickupBusinessPreorderviewGetRequest.BusinessCustomer();
    obj8.setName("张三");
    obj8.setMobile("13799998888");
    obj8.setFullAddressDetail("浙江省杭州市西湖区文一西路西溪首座小邮局");
    obj8.setAreaId("330100");
    list7.setSender(obj8);
    obj3.setItemId("138_small_b");
    req.setPackageInfoList(list2);
    CainiaoPickupBusinessPreorderviewGetResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <cainiao_pickup_business_preorderview_get_response>
        <result>
            <data>
                <promotion_infos>
                    <promotioninfos>
                        <promotion_copy>下单立减</promotion_copy>
                        <promotion_price>350</promotion_price>
                        <promotion_type>0</promotion_type>
                    </promotioninfos>
                </promotion_infos>
                <coupon_price>1000</coupon_price>
                <total_actual_price>2000</total_actual_price>
                <total_origin_price>3000</total_origin_price>
                <pre_order_info_list>
                    <guo_guo_pre_order_info>
                        <estimate_origin_price>1200</estimate_origin_price>
                        <coupon_price>200</coupon_price>
                        <estimate_actual_price>1000</estimate_actual_price>
                        <no_service_reason>当前区域无服务</no_service_reason>
                        <can_service>false</can_service>
                        <package_id>67893874673892</package_id>
                    </guo_guo_pre_order_info>
                </pre_order_info_list>
                <estimation_weight_desc>1公斤内预估</estimation_weight_desc>
                <sender_address_desc>浙江省杭州市西湖区文一西路西溪首座小邮局</sender_address_desc>
                <order_preview_desc>
                    <display_info>当日已寄件(含本次)14单,再下3单可享受每票2元</display_info>
                    <select_type>本字段暂时无效</select_type>
                    <href_desc>具体请查看XXX</href_desc>
                    <link_url>http://xxx.com</link_url>
                    <high_lights>
                        <string>[14单</string>
                        <string>3单</string>
                        <string>2元]</string>
                    </high_lights>
                    <tooltip>提示</tooltip>
                    <link_type>LINK</link_type>
                </order_preview_desc>
                <order_ads_desc>
                    <display_info>今日17点前揽收,当日揽收,17点后下单,次日揽收,晚到必赔</display_info>
                    <select_type>Default</select_type>
                    <href_desc>查看裹裹服务协议</href_desc>
                    <link_url>http://xxx.com</link_url>
                    <high_lights>
                        <string>同意《裹裹服务协议》</string>
                    </high_lights>
                    <link_type>LINK</link_type>
                    <tooltip>提示</tooltip>
                </order_ads_desc>
                <order_benefit_desc_list>
                    <order_benefit_item>
                        <key>CompensationForLate</key>
                        <name>晚揽必赔</name>
                        <desc>千元内免保价</desc>
                        <ori_price>10元/票</ori_price>
                        <current_price>1元/票、赠送</current_price>
                        <show_condition>AlwaysShow</show_condition>
                        <use_condition>NoCondition</use_condition>
                        <select_type>Default</select_type>
                        <tooltip>17:00前下单快递员当日上门揽收,揽收超时可向在线客服申请赔付</tooltip>
                    </order_benefit_item>
                </order_benefit_desc_list>
                <external_order_fees>
                    <external_order_fee>
                        <fee_desc>一单加价</fee_desc>
                        <fee_price>100</fee_price>
                        <fee_status>Removed</fee_status>
                        <fee_status_reason>VIP专享:免收权益</fee_status_reason>
                        <suggest_display_info>
                            <tooltip>提示</tooltip>
                            <link_type>资源地址的类型</link_type>
                            <link_url>http://xxx</link_url>
                            <href_desc>点击查看xxx</href_desc>
                            <high_lights>
                                <string>优惠100元</string>
                            </high_lights>
                            <display_info>本订单优惠100元</display_info>
                        </suggest_display_info>
                        <suggest_display_info_for_mobile>
                            <display_info>本订单优惠100元</display_info>
                            <high_lights>
                                <string>优惠100元</string>
                            </high_lights>
                            <href_desc>点击查看xxx</href_desc>
                            <link_url>http://xxx</link_url>
                            <link_type>资源地址的类型</link_type>
                            <tooltip>提示</tooltip>
                        </suggest_display_info_for_mobile>
                    </external_order_fee>
                </external_order_fees>
                <price_tag>网点专属报价</price_tag>
            </data>
            <success>true</success>
            <retry>false</retry>
            <status_message>系统错误</status_message>
            <status_code>SYS_ERROIR</status_code>
        </result>
    </cainiao_pickup_business_preorderview_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>

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部