注意:以下文档只适用于TOP接口,请谨慎使用!

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

taobao.logistics.orders.detail.get (批量查询物流订单,返回详细信息)

查询物流订单的详细信息,涉及用户隐私字段。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
fields String 必须 tid,order_code,seller_nick,buyer_nick,item_title,receiver_location,status,type,company_name,created,modified,is_quick_cod_order,sub_tids,is_split,mails 需返回的字段列表.可选值:Shipping 物流数据结构中所有字段.fileds中可以指定返回以上任意一个或者多个字段,以","分隔.
tid Number 可选 255222 交易ID.如果加入tid参数的话,不用传其他的参数,但是仅会返回一条物流订单信息.
buyer_nick String 可选 zhangsan 买家昵称
status String 可选 CREATED 物流状态.可查看数据结构 Shipping 中的status字段.
seller_confirm String 可选 yes 卖家是否发货.可选值:yes(是),no(否).如:yes.
receiver_name String 可选 name 收货人姓名
start_created Date 可选 2000-01-01 00:00:00 创建时间开始.格式:yyyy-MM-dd HH:mm:ss
end_created Date 可选 2000-01-01 00:00:00 创建时间结束.格式:yyyy-MM-dd HH:mm:ss
freight_payer String 可选 buyer 谁承担运费.可选值:buyer(买家),seller(卖家).如:buyer
type String 可选 post 物流方式.可选值:post(平邮),express(快递),ems(EMS).如:post
page_no Number 可选 1
  • 默认值:1
  • 页码.该字段没传 或 值<1 ,则默认page_no为1
    page_size Number 可选 40
  • 默认值:40
  • 每页条数.该字段没传 或 值<1 ,则默认page_size为40
    ouid String 可选 asdfsfd 系统自动生成

    响应参数

    名称 类型 示例值 描述
    total_results Number 1 搜索到的物流订单列表总数
    shippings SingleResultDto [] 获取的物流订单详情列表.返回的Shipping包含的具体信息为入参fields请求的字段信息.
    • └ tid
    • Number
    • 125555221
    • 交易ID
    • └ order_code
    • String
    • LP12345678
    • 物流订单编号
    • └ seller_nick
    • String
    • huzh
    • 卖家昵称
    • └ buyer_nick
    • String
    • ddd
    • 买家昵称
    • └ delivery_start
    • Date
    • 2000-01-01 00:00:00
    • 预约取货开始时间
    • └ delivery_end
    • Date
    • 2000-01-01 00:00:00
    • 预约取货结束时间
    • └ out_sid
    • String
    • 1455858255
    • 运单号.具体一个物流公司的运单号码.
    • └ item_title
    • String
    • 连衣花裙
    • 货物名称
    • └ receiver_name
    • String
    • 周锦
    • 收件人姓名
    • └ receiver_phone
    • String
    • 057188155188
    • 收件人电话
    • └ receiver_mobile
    • String
    • 1384567842
    • 收件人手机号码
    • location
    • Location
    • 收件人地址信息(在传输请求参数Fields字段时,必须使用“receiver_location”才能返回此字段)
    • └ zip
    • String
    • 310000
    • 邮政编码
    • └ address
    • String
    • 华星路99号创业大厦
    • 详细地址,最大256个字节(128个中文)
    • └ city
    • String
    • 杭州
    • 所在城市(中文名称)
    • └ state
    • String
    • 浙江
    • 所在省份(中文名称)
    • └ country
    • String
    • 中国
    • 国家名称
    • └ district
    • String
    • 西湖区
    • 区/县(只适用于物流API)
    • └ created
    • Date
    • 2000-01-01 00:00:00
    • 运单创建时间
    • └ modified
    • Date
    • 2000-01-01 00:00:00
    • 运单修改时间
    • └ status
    • String
    • CREATED
    • 物流订单状态,可选值:CREATED(订单已创建) RECREATED(订单重新创建) CANCELLED(订单已取消) CLOSED(订单关闭) SENDING(等候发送给物流公司) ACCEPTING(已发送给物流公司,等待接单) ACCEPTED(物流公司已接单) REJECTED(物流公司不接单) PICK_UP(物流公司揽收成功) PICK_UP_FAILED(物流公司揽收失败) LOST(物流公司丢单) REJECTED_BY_RECEIVER(对方拒签) ACCEPTED_BY_RECEIVER(发货方式在线下单:对方已签收;自己联系:卖家已发货)
    • └ type
    • String
    • free
    • 物流方式.可选值:free(卖家包邮),post(平邮),express(快递),ems(EMS).
    • └ freight_payer
    • String
    • buyer
    • 谁承担运费.可选值:buyer(买家承担),seller(卖家承担运费).
    • └ company_name
    • String
    • sto
    • 物流公司名称
    • └ seller_confirm
    • String
    • yes
    • 卖家是否确认发货.可选值:yes(是),no(否).
    • └ is_quick_cod_order
    • Boolean
    • true
    • 标示为是否快捷COD订单
    • └ is_split
    • Number
    • 0
    • 表明是否是拆单,默认值0,1表示拆单
    • └ sub_tids
    • Number []
    • 1,2,3
    • 拆单子订单列表,对应的数据是:该物流订单下的全部子订单
    • └ ouid
    • String
    • asdfasdf
    • ouid
    • mails
    • LogisticsMail []
    • 包裹信息,包含运单号及快递公司
    • └ out_sid
    • String
    • 1455858255
    • 运单号.具体一个物流公司的运单号码.
    • └ company_name
    • String
    • sto
    • 物流公司名称
    • └ receiver_phone_new
    • String
    • 057188155188
    • 脱敏收件人电话
    • └ receiver_mobile_new
    • String
    • 1384567842
    • 脱敏收件人手机号码
    • └ openuid
    • String
    • 1111
    • 买家的openuid

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    LogisticsOrdersDetailGetRequest req = new LogisticsOrdersDetailGetRequest();
    req.setFields("tid,order_code,seller_nick,buyer_nick,item_title,receiver_location,status,type,company_name,created,modified,is_quick_cod_order,sub_tids,is_split,mails");
    req.setTid(255222L);
    req.setBuyerNick("zhangsan");
    req.setStatus("CREATED");
    req.setSellerConfirm("yes");
    req.setReceiverName("name");
    req.setStartCreated(StringUtils.parseDateTime("2000-01-01 00:00:00"));
    req.setEndCreated(StringUtils.parseDateTime("2000-01-01 00:00:00"));
    req.setFreightPayer("buyer");
    req.setType("post");
    req.setPageNo(1L);
    req.setPageSize(40L);
    req.setOuid("asdfsfd");
    LogisticsOrdersDetailGetResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <logistics_orders_detail_get_response>
        <total_results>1</total_results>
        <shippings>
            <single_result_dto>
                <tid>125555221</tid>
                <order_code>LP12345678</order_code>
                <seller_nick>huzh</seller_nick>
                <buyer_nick>ddd</buyer_nick>
                <delivery_start>2000-01-01 00:00:00</delivery_start>
                <delivery_end>2000-01-01 00:00:00</delivery_end>
                <out_sid>1455858255</out_sid>
                <item_title>连衣花裙</item_title>
                <receiver_name>周锦</receiver_name>
                <receiver_phone>057188155188</receiver_phone>
                <receiver_mobile>1384567842</receiver_mobile>
                <location>
                    <zip>310000</zip>
                    <address>华星路99号创业大厦</address>
                    <city>杭州</city>
                    <state>浙江</state>
                    <country>中国</country>
                    <district>西湖区</district>
                </location>
                <created>2000-01-01 00:00:00</created>
                <modified>2000-01-01 00:00:00</modified>
                <status>CREATED</status>
                <type>free</type>
                <freight_payer>buyer</freight_payer>
                <company_name>sto</company_name>
                <seller_confirm>yes</seller_confirm>
                <is_quick_cod_order>true</is_quick_cod_order>
                <is_split>0</is_split>
                <sub_tids>
                    <number>1</number>
                    <number>2</number>
                    <number>3</number>
                </sub_tids>
                <ouid>asdfasdf</ouid>
                <mails>
                    <logistics_mail>
                        <out_sid>1455858255</out_sid>
                        <company_name>sto</company_name>
                    </logistics_mail>
                </mails>
                <receiver_phone_new>057188155188</receiver_phone_new>
                <receiver_mobile_new>1384567842</receiver_mobile_new>
                <openuid>1111</openuid>
            </single_result_dto>
        </shippings>
    </logistics_orders_detail_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:trade_id 参数:trade_id无效,格式不对、非法值、越界等
    isv.invalid-parameter:trade_id:P07 参数:trade_id:P07无效,格式不对、非法值、越界等 在查询物流详情之前要对交易状态进行判断,没有发货的就不要再查询物流详情
    isv.logistics-query-orders-service-error:S01 查询订单系统出现异常,请重试 如果长时间一直出现,请联系平台技术,并提供api请求的requestId
    isv.invalid-argument
    isp.service-unavailable

    API工具

    如何获得此API

    FAQ

    返回
    顶部