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

taobao.logistics.fulfilorder.search (物流履约单据查询)

物流履约单据查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
search_request ErpSearchFulfilOrdersRequest 必须 搜索入参
  • └ end_modify_time
  • Date
  • 可选
  • 2024-03-28 10:05:00
  • 单据修改的结束时间。开始和结束时间必须成对出现;开始时间 到 结束时间 不能超过 30 分钟。时间范围查询和交易单号查询只能选择一个,不能同时传入。在传入的时间范围内,最多支持翻页到5000条数据,超过则需要自己缩减时间范围
  • └ start_modify_time
  • Date
  • 可选
  • 2024-03-28 10:00:00
  • 单据修改的开始时间。开始和结束时间必须成对出现;开始时间 到 结束时间 不能超过 30 分钟。时间范围查询和交易单号查询只能选择一个,不能同时传入。在传入的时间范围内,最多支持翻页到5000条数据,超过则需要自己缩减时间范围
  • └ page_no
  • Number
  • 可选
  • 1
  • 页码。必须为正数
  • └ trade_id_list
  • String []
  • 可选
  • 123123
  • 交易单号列表
  • └ page_size
  • Number
  • 可选
  • 20
  • 分页大小。范围 1-100

响应参数

名称 类型 示例值 描述
result PaginationResult 结果
  • └ err_desc
  • String
  • 错误描述
  • 错误描述
  • └ start
  • Number
  • 0
  • 分页查询结果的开始下标
  • └ err_code
  • String
  • 错误码
  • 错误码
  • └ total_count
  • Number
  • 10
  • 总数
  • data_list
  • FullOrderViewDTO []
  • 数据列表
  • fulfilorder_item_list
  • FulfilOrderItemDTO []
  • 物流履约单商品明细
  • └ sc_item_name
  • String
  • 美赞臣港版蓝臻升级版婴儿奶粉1段820g/罐
  • 后端货品名
  • └ sc_item_code
  • String
  • 3243308
  • 后端货品编码
  • └ sc_item_id
  • Number
  • 715355125479
  • 后端货品id
  • └ goods_qty
  • Number
  • 2
  • 预计发货数量
  • └ sub_trade_id
  • String
  • 2099894485315482359
  • 子交易单
  • └ fx_sub_trade_id
  • String
  • 111
  • 分销场景下,分销toC交易子单
  • └ bar_code
  • String
  • 8712045044513
  • 条码
  • └ feature_map
  • String
  • {"key":"value"}
  • 扩展信息,invQlty(临期品可售场景)=139 gift_type(赠品类型):1(普通品)、5(交易赠品)、2(供应链赠品);
  • └ trade_id
  • String
  • 2099894485315482359
  • 交易主单id
  • └ fx_trade_id
  • String
  • 111
  • 分销交易主单id
  • └ combine_item_id
  • Number
  • 111
  • 组合货品主品Id
  • └ combine_item_name
  • String
  • XXX
  • 组合货品主品名称
  • └ combine_qty
  • Number
  • 1
  • 组合货品交易下单数量
  • └ item_id
  • Number
  • 111
  • 前端商品Id
  • └ item_code
  • String
  • XXX
  • 前端商品Code
  • └ item_name
  • String
  • XXX
  • 前端商品名称
  • └ sku_id
  • Number
  • 0
  • skuId
  • fulfilorder
  • FulfilOrderDTO
  • 物流履约单信息
  • └ tms_code
  • String
  • DISTRIBUTOR_30764537
  • 配送资源code
  • └ gmt_modified
  • Date
  • 1711527120000
  • 修改时间
  • └ fx_trade_id
  • String
  • 111
  • 分销场景下,分销toC交易单
  • └ order_status
  • Number
  • 300
  • 状态,新建=0; 下发履行处理中=50; 下发仓生产中=100; 仓库生产完毕=200; 配送中=300;
  • └ owner_id
  • Number
  • 2299814231
  • 货主
  • └ biz_order_status
  • Number
  • 800100
  • 业务状态,declareType(清关方式):cbd(跨境)、pgd(邮关); distributorId(分销商SellerId); distributorNick(分销商SellerNick); g_logistics(物流模式):cainiao(菜鸟)、ecology(生态; outbound_time(出库时间); split_flag(拆单标记)=1; merge_flag(合单标记)=1; invQlty(临期品可售场景)=139 gift_type(赠品类型):1(普通品)、5(交易赠品)、2(供应链赠品); 新建=0; 下发履行处理中=50; 下发仓生产中=100; 仓库生产完毕=200; 配送中=300; 新建=100100; 待促销处理=100331; 待分仓占库存=100341; 缺货等待=100345; 待智能审单=100351; 待客服处理=100355; 待合单处理=100361; 合单等待=100365; 业务控单中=100369; 待发货=100371; 拆单废弃=200100; 取消=400300; 履行调度Hold单中=500200; 履行接单完成=500300; 已下发给仓库=600100; 仓库已接单=600200; 生产中=600300; 仓库已打印=600310; 仓库已拣选=600320; 已打包=600330; 部分出库中=600400; 仓库拒单=600800; 全部出库=700100; 全部揽收=800100; 配揽收=800110; 全部签收=800900; 部分签收=800910; 部分签收部分拒签=800920; 部分拒签=800940; 全部拒签=800950; 拦截成功=800960; 订单已出库=7070; 订单关闭=7120; 已签收=7130;拦截成功=7150;
  • └ trade_create_time
  • Date
  • 2023-03-28 10:00:00
  • 交易创建时间
  • └ store_order_no
  • String
  • LBX03223115499428272
  • 仓储单号
  • └ fx_trade_type
  • Number
  • 0
  • 分销类型。0=toC单据,1=分销场景的B2B订单,2=分销场景的B2C订单。
  • └ seller_id
  • Number
  • 2299814231
  • 卖家id
  • └ trade_pay_time
  • Date
  • 2023-03-28 10:00:00
  • 交易付款时间
  • └ fx_seller_id
  • String
  • 123
  • 分销场景下,toC卖家
  • └ order_code
  • String
  • SCP517950131206
  • 物流履约单号
  • └ mail_nos
  • String
  • 621113609142636
  • 运单号(列表,逗号分隔)
  • └ trade_id
  • String
  • -2
  • 交易单号
  • └ store_code
  • String
  • CAN507
  • 仓code
  • └ platform_source
  • Number
  • 213
  • 单据来源
  • └ feature_map
  • String
  • {"key":"value"}
  • 扩展信息,declareType(清关方式):cbd(跨境)、pgd(邮关); distributorId(分销商SellerId); distributorNick(分销商SellerNick); g_logistics(物流模式):cainiao(菜鸟)、ecology(生态;
  • └ fulfil_time_map
  • String
  • {"key":"value"}
  • 时间节点,outbound_time(出库时间);
  • └ flag_feature_map
  • String
  • {"key":"value"}
  • 标记信息,split_flag(拆单标记)=1; merge_flag(合单标记)=1;
  • └ error_code
  • String
  • XXX
  • 错误编码
  • └ error_message
  • String
  • 联系人姓名超长
  • 错误描述
  • └ source_lg_order_code
  • String
  • LP0001
  • 交易LP
  • └ consign_lg_order_code
  • String
  • LP0001
  • 发货LP
  • └ request_success
  • Boolean
  • true
  • 调用是否成功
  • └ limit
  • Number
  • 20
  • 本次分页查询的数量限制
  • └ total_page
  • Number
  • 1
  • 当前查询条件下的总页数。可以使用 查询页数 >= 总页数 作为当前查询入参(不包含页数)的结束条件

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsFulfilorderSearchRequest req = new LogisticsFulfilorderSearchRequest();
LogisticsFulfilorderSearchRequest.ErpSearchFulfilOrdersRequest obj1 = new LogisticsFulfilorderSearchRequest.ErpSearchFulfilOrdersRequest();
obj1.setEndModifyTime(StringUtils.parseDateTime("2024-03-28 10:05:00"));
obj1.setStartModifyTime(StringUtils.parseDateTime("2024-03-28 10:00:00"));
obj1.setPageNo(1L);
obj1.setTradeIdList("123123");
obj1.setPageSize(20L);
req.setSearchRequest(obj1);
LogisticsFulfilorderSearchResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<logistics_fulfilorder_search_response>
    <result>
        <err_desc>错误描述</err_desc>
        <start>0</start>
        <err_code>错误码</err_code>
        <total_count>10</total_count>
        <data_list>
            <full_order_view_d_t_o>
                <fulfilorder_item_list>
                    <fulfil_order_item_d_t_o>
                        <sc_item_name>美赞臣港版蓝臻升级版婴儿奶粉1段820g/罐</sc_item_name>
                        <sc_item_code>3243308</sc_item_code>
                        <sc_item_id>715355125479</sc_item_id>
                        <goods_qty>2</goods_qty>
                        <sub_trade_id>2099894485315482359</sub_trade_id>
                        <fx_sub_trade_id>111</fx_sub_trade_id>
                        <bar_code>8712045044513</bar_code>
                        <feature_map>{&quot;key&quot;:&quot;value&quot;}</feature_map>
                        <trade_id>2099894485315482359</trade_id>
                        <fx_trade_id>111</fx_trade_id>
                        <combine_item_id>111</combine_item_id>
                        <combine_item_name>XXX</combine_item_name>
                        <combine_qty>1</combine_qty>
                        <item_id>111</item_id>
                        <item_code>XXX</item_code>
                        <item_name>XXX</item_name>
                        <sku_id>0</sku_id>
                    </fulfil_order_item_d_t_o>
                </fulfilorder_item_list>
                <fulfilorder>
                    <tms_code>DISTRIBUTOR_30764537</tms_code>
                    <gmt_modified>1711527120000</gmt_modified>
                    <fx_trade_id>111</fx_trade_id>
                    <order_status>300</order_status>
                    <owner_id>2299814231</owner_id>
                    <biz_order_status>800100</biz_order_status>
                    <trade_create_time>2023-03-28 10:00:00</trade_create_time>
                    <store_order_no>LBX03223115499428272</store_order_no>
                    <fx_trade_type>0</fx_trade_type>
                    <seller_id>2299814231</seller_id>
                    <trade_pay_time>2023-03-28 10:00:00</trade_pay_time>
                    <fx_seller_id>123</fx_seller_id>
                    <order_code>SCP517950131206</order_code>
                    <mail_nos>621113609142636</mail_nos>
                    <trade_id>-2</trade_id>
                    <store_code>CAN507</store_code>
                    <platform_source>213</platform_source>
                    <feature_map>{&quot;key&quot;:&quot;value&quot;}</feature_map>
                    <fulfil_time_map>{&quot;key&quot;:&quot;value&quot;}</fulfil_time_map>
                    <flag_feature_map>{&quot;key&quot;:&quot;value&quot;}</flag_feature_map>
                    <error_code>XXX</error_code>
                    <error_message>联系人姓名超长</error_message>
                    <source_lg_order_code>LP0001</source_lg_order_code>
                    <consign_lg_order_code>LP0001</consign_lg_order_code>
                </fulfilorder>
            </full_order_view_d_t_o>
        </data_list>
        <request_success>true</request_success>
        <limit>20</limit>
        <total_page>1</total_page>
    </result>
</logistics_fulfilorder_search_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

返回
顶部