淘宝开放平台

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
warehouse_order_get_request	WarehouseOrderGetRequest	必须			查询入参对象
└ store_id String 必须 S001 门店编码 └ biz_order_id Number 必须 8000121012231001 订单ID

名称	类型	示例值	描述
api_result	TopBaseResult		返回结果
model WarehouseOrderResponse 仓单对象 └ merchant_code String CSSJ 商家编码 └ store_id String S001 门店编码 └ biz_order_id Number 80010021029801 订单ID └ order_from Number 31 订单来源 (2=美团/3=饿了么/26=京东到家/31=淘鲜达/28=私域渠道) └ out_order_id String 180051001920101 渠道订单ID └ warehouse_status Number 1 仓作业单状态 1 = 任务生成 2 = 拣货开始 3 = 拣货完成 4 = 打包开始 5 = 打包完成 -1 = 任务取消 └ warehouse_status_desc String 任务生成仓作业单状态描述 └ delivery_time_mind Number 1 订单配送时效 1 = 自提 / 2 = 小时达 └ exc_status_desc String 正常仓单异常状态 (正常/缺货出/任务取消) └ task_dispatched_time Date 2023-09-19 10:00:00 仓作业任务下发时间(仓接单) └ task_generate_time Date 2023-09-19 10:05:00 仓作业任务生成时间(准备开始作业) └ pick_worker_id String worker001 拣货人员ID └ pick_worker_name String 张三拣货人员姓名 └ pick_start_time Date 2023-09-19 10:15:00 拣货开始时间(人员开始拣货) └ pick_finish_time Date 2023-09-19 10:18:00 拣货结束时间 └ pack_worker_id String worker001 打包人员ID └ pack_worker_name String 张三打包人员姓名 └ pack_start_time Date 2023-09-19 10:20:00 打包开始时间 └ pack_finish_time Date 2023-09-19 10:22:00 打包结束时间 └ latest_arrival_time Date 2023-09-19 11:00:00 用户选择最晚送达时间 └ latest_outbound_time Date 2023-09-19 10:30:00 最晚出库时间 └ actual_outbound_time Date 2023-09-19 10:25:00 实际出库时间 └ cancel_time Date 2023-09-19 10:00:00 仓作业取消时间 sub_orders WarehouseSubOrderResponse [] 子单列表 └ biz_sub_order_id Number 80010021029802 交易子单号 └ out_sub_order_id String 180051001920102 渠道子单号 └ sku_code String 23001001 商品编码 └ sku_name String 牛奶500ml 商品名称 └ stock_unit String 份库存单位 └ buy_stock_quantity BigDecimal 2.0 库存单位购买数量(应拣数量) └ pick_stock_quantity BigDecimal 2.0 库存单位拣货数量 └ success Boolean true 接口是否成功 └ err_code String SUCCESS 返回码 └ err_msg String 调用成功返回码说明

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTclsAelophyWarehouseOrderGetRequest req = new AlibabaTclsAelophyWarehouseOrderGetRequest();
AlibabaTclsAelophyWarehouseOrderGetRequest.WarehouseOrderGetRequest obj1 = new AlibabaTclsAelophyWarehouseOrderGetRequest.WarehouseOrderGetRequest();
obj1.setStoreId("S001");
obj1.setBizOrderId(8000121012231001L);
req.setWarehouseOrderGetRequest(obj1);
AlibabaTclsAelophyWarehouseOrderGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaTclsAelophyWarehouseOrderGetRequest req = new AlibabaTclsAelophyWarehouseOrderGetRequest();
AlibabaTclsAelophyWarehouseOrderGetRequest.WarehouseOrderGetRequestDomain obj1 = new AlibabaTclsAelophyWarehouseOrderGetRequest.WarehouseOrderGetRequestDomain();
obj1.StoreId = "S001";
obj1.BizOrderId = 8000121012231001L;
req.WarehouseOrderGetRequest_ = obj1;
AlibabaTclsAelophyWarehouseOrderGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaTclsAelophyWarehouseOrderGetRequest;
$warehouse_order_get_request = new WarehouseOrderGetRequest;
$warehouse_order_get_request->store_id="S001";
$warehouse_order_get_request->biz_order_id="8000121012231001";
$req->setWarehouseOrderGetRequest(json_encode($warehouse_order_get_request));
$resp = $c->execute($req, $sessionKey);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.tcls.aelophy.warehouse.order.get' \
-d 'partner_id=apidoc' \
-d 'session=c7b96576-2ee3-4f5f-b419-1a4871b3dc4f' \
-d 'sign=4BAFBAB95250B1F8F2C12807C2DDC6C2' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+17%3A49%3A51' \
-d 'v=2.0' \
-d 'warehouse_order_get_request=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaTclsAelophyWarehouseOrderGetRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.warehouse_order_get_request="数据结构示例JSON格式"
try:
	resp= req.getResponse(sessionkey)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.tcls.aelophy.warehouse.order.get");
add_param(pRequest,"warehouse_order_get_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.tcls.aelophy.warehouse.order.get', {
	'warehouse_order_get_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_tcls_aelophy_warehouse_order_get_response>
    <api_result>
        <model>
            <merchant_code>CSSJ</merchant_code>
            <store_id>S001</store_id>
            <biz_order_id>80010021029801</biz_order_id>
            <order_from>31</order_from>
            <out_order_id>180051001920101</out_order_id>
            <warehouse_status>1</warehouse_status>
            <warehouse_status_desc>任务生成</warehouse_status_desc>
            <delivery_time_mind>1</delivery_time_mind>
            <exc_status_desc>正常</exc_status_desc>
            <task_dispatched_time>2023-09-19 10:00:00</task_dispatched_time>
            <task_generate_time>2023-09-19 10:05:00</task_generate_time>
            <pick_worker_id>worker001</pick_worker_id>
            <pick_worker_name>张三</pick_worker_name>
            <pick_start_time>2023-09-19 10:15:00</pick_start_time>
            <pick_finish_time>2023-09-19 10:18:00</pick_finish_time>
            <pack_worker_id>worker001</pack_worker_id>
            <pack_worker_name>张三</pack_worker_name>
            <pack_start_time>2023-09-19 10:20:00</pack_start_time>
            <pack_finish_time>2023-09-19 10:22:00</pack_finish_time>
            <latest_arrival_time>2023-09-19 11:00:00</latest_arrival_time>
            <latest_outbound_time>2023-09-19 10:30:00</latest_outbound_time>
            <actual_outbound_time>2023-09-19 10:25:00</actual_outbound_time>
            <cancel_time>2023-09-19 10:00:00</cancel_time>
            <sub_orders>
                <warehouse_sub_order_response>
                    <biz_sub_order_id>80010021029802</biz_sub_order_id>
                    <out_sub_order_id>180051001920102</out_sub_order_id>
                    <sku_code>23001001</sku_code>
                    <sku_name>牛奶500ml</sku_name>
                    <stock_unit>份</stock_unit>
                    <buy_stock_quantity>2.0</buy_stock_quantity>
                    <pick_stock_quantity>2.0</pick_stock_quantity>
                </warehouse_sub_order_response>
            </sub_orders>
        </model>
        <success>true</success>
        <err_code>SUCCESS</err_code>
        <err_msg>调用成功</err_msg>
    </api_result>
</alibaba_tcls_aelophy_warehouse_order_get_response>

{
    "alibaba_tcls_aelophy_warehouse_order_get_response":{
        "api_result":{
            "model":{
                "merchant_code":"CSSJ",
                "store_id":"S001",
                "biz_order_id":80010021029801,
                "order_from":31,
                "out_order_id":"180051001920101",
                "warehouse_status":1,
                "warehouse_status_desc":"任务生成",
                "delivery_time_mind":1,
                "exc_status_desc":"正常",
                "task_dispatched_time":"2023-09-19 10:00:00",
                "task_generate_time":"2023-09-19 10:05:00",
                "pick_worker_id":"worker001",
                "pick_worker_name":"张三",
                "pick_start_time":"2023-09-19 10:15:00",
                "pick_finish_time":"2023-09-19 10:18:00",
                "pack_worker_id":"worker001",
                "pack_worker_name":"张三",
                "pack_start_time":"2023-09-19 10:20:00",
                "pack_finish_time":"2023-09-19 10:22:00",
                "latest_arrival_time":"2023-09-19 11:00:00",
                "latest_outbound_time":"2023-09-19 10:30:00",
                "actual_outbound_time":"2023-09-19 10:25:00",
                "cancel_time":"2023-09-19 10:00:00",
                "sub_orders":{
                    "warehouse_sub_order_response":[
                        {
                            "biz_sub_order_id":80010021029802,
                            "out_sub_order_id":"180051001920102",
                            "sku_code":"23001001",
                            "sku_name":"牛奶500ml",
                            "stock_unit":"份",
                            "buy_stock_quantity":"2.0",
                            "pick_stock_quantity":"2.0"
                        }
                    ]
                }
            },
            "success":true,
            "err_code":"SUCCESS",
            "err_msg":"调用成功"
        }
    }
}

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>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

五道口API

alibaba.tcls.aelophy.warehouse.order.get (仓作业单获取)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ