淘宝开放平台 - 文档中心

请求地址：

环境	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_wave_fence_operate_request	WarehouseWaveFenceOperateRequest	必须			仓波次覆盖范围操作
└ request_time Number 必须 1656674541000 时间戳（毫秒） └ request_id String 必须 1656674541000_001 业务请求ID，用于做幂等 └ supplier_id String 必须 10000000001 服务商ID，淘天颁发 └ wh_code String 必须 SF_WH_001 服务商仓code └ biz_flag_code String 必须 TUOGUAN 合作业务，淘天颁发 └ operate_type String 必须 UPSERT UPSERT / DELETE，大小写不敏感 cover_fence_param CoverFenceList [] 必须略围栏明细列表，单批最多50条 └ to_location_id String 必须 330110005 目的地街道维度地址 id（菜鸟地址库） └ delivery_resource_code String 必须 SF 配（配送资源code），淘天平台提供 └ cutoff_time String 必须 12:00 截单时间。HH:mm 格式 └ out_range_code String 必须 RANG_CODE_01 围栏 code，由服务商生成；建议作用域内全局唯一 └ range_fence_type Number 可选 1 围栏类型；一期仅支持 1（白名单） └ range_fence_wkt String 可选 POLYGON((120.009098 30.281106,120.0106 30.277289,120.011844 30.272842,120.01605 30.27425,120.0218 30.276103,120.020427 30.280032,120.029997 30.282626,120.027294 30.289407,120.017681 30.286369,120.015792 30.285813,120.016307 30.283923,120.01223 30.282478,120.009098 30.281106)) 围栏边界 WKT，必须合法且 simple；坐标系：高德 GCJ-02. 单条长度不超过20w个字符 └ range_fence_name String 可选海创园A区围栏名称，非必填 └ range_fence_tag String 可选 OFFICE_BUILDING 围栏标签；非必填；RESIDENTIAL_AREA(住宅区);FACTORY(工厂);SPORTS_LEISURE(体育休闲服务);COMPANY(公司);AUTO_SERVICE(汽车服务);GOVERNMENT(行政机构);OFFICE_BUILDING(商务楼宇);PUBLIC_FACILITY(公共设施);UNIVERSITY(高校);LIFE_SERVICE(生活服务);ACCOMMODATION(住宿服务);INDUSTRIAL_PARK(产业园区);SHOPPING(购物服务);HOSPITAL(医院);VILLAGE(村庄);UNKNOWN(未知区域);

名称	类型	示例值	描述
warehouse_wave_fence_operate_response	WarehouseWaveFenceOperateResponse	略	返回值
└ success Boolean true 成功失败 └ code String BATCH_SIZE_INVALID 错误码 └ message String coverFenceList 大小不合法具体错误原因

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsWarehouseWaveFenceAsyncRequest req = new LogisticsWarehouseWaveFenceAsyncRequest();
LogisticsWarehouseWaveFenceAsyncRequest.WarehouseWaveFenceOperateRequest obj1 = new LogisticsWarehouseWaveFenceAsyncRequest.WarehouseWaveFenceOperateRequest();
obj1.setRequestTime(1656674541000L);
obj1.setRequestId("1656674541000_001");
obj1.setSupplierId("10000000001");
obj1.setWhCode("SF_WH_001");
obj1.setBizFlagCode("TUOGUAN");
obj1.setOperateType("UPSERT");
List<LogisticsWarehouseWaveFenceAsyncRequest.CoverFenceList> list3 = new ArrayList<LogisticsWarehouseWaveFenceAsyncRequest.CoverFenceList>();
LogisticsWarehouseWaveFenceAsyncRequest.CoverFenceList obj4 = new LogisticsWarehouseWaveFenceAsyncRequest.CoverFenceList();
list3.add(obj4);
obj4.setToLocationId("330110005");
obj4.setDeliveryResourceCode("SF");
obj4.setCutoffTime("12:00");
obj4.setOutRangeCode("RANG_CODE_01");
obj4.setRangeFenceType(1L);
obj4.setRangeFenceWkt("POLYGON((120.009098 30.281106,120.0106 30.277289,120.011844 30.272842,120.01605 30.27425,120.0218 30.276103,120.020427 30.280032,120.029997 30.282626,120.027294 30.289407,120.017681 30.286369,120.015792 30.285813,120.016307 30.283923,120.01223 30.282478,120.009098 30.281106))");
obj4.setRangeFenceName("海创园A区");
obj4.setRangeFenceTag("OFFICE_BUILDING");
obj1.setCoverFenceParam(list3);
req.setWarehouseWaveFenceOperateRequest(obj1);
LogisticsWarehouseWaveFenceAsyncResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
LogisticsWarehouseWaveFenceAsyncRequest req = new LogisticsWarehouseWaveFenceAsyncRequest();
LogisticsWarehouseWaveFenceAsyncRequest.WarehouseWaveFenceOperateRequestDomain obj1 = new LogisticsWarehouseWaveFenceAsyncRequest.WarehouseWaveFenceOperateRequestDomain();
obj1.RequestTime = 1656674541000L;
obj1.RequestId = "1656674541000_001";
obj1.SupplierId = "10000000001";
obj1.WhCode = "SF_WH_001";
obj1.BizFlagCode = "TUOGUAN";
obj1.OperateType = "UPSERT";
List<LogisticsWarehouseWaveFenceAsyncRequest.CoverFenceListDomain> list3 = new List<LogisticsWarehouseWaveFenceAsyncRequest.CoverFenceListDomain>();
LogisticsWarehouseWaveFenceAsyncRequest.CoverFenceListDomain obj4 = new LogisticsWarehouseWaveFenceAsyncRequest.CoverFenceListDomain();
list3.Add(obj4);
obj4.ToLocationId = "330110005";
obj4.DeliveryResourceCode = "SF";
obj4.CutoffTime = "12:00";
obj4.OutRangeCode = "RANG_CODE_01";
obj4.RangeFenceType = 1L;
obj4.RangeFenceWkt = "POLYGON((120.009098 30.281106,120.0106 30.277289,120.011844 30.272842,120.01605 30.27425,120.0218 30.276103,120.020427 30.280032,120.029997 30.282626,120.027294 30.289407,120.017681 30.286369,120.015792 30.285813,120.016307 30.283923,120.01223 30.282478,120.009098 30.281106))";
obj4.RangeFenceName = "海创园A区";
obj4.RangeFenceTag = "OFFICE_BUILDING";
obj1.CoverFenceParam= list3;
req.WarehouseWaveFenceOperateRequest_ = obj1;
LogisticsWarehouseWaveFenceAsyncResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new LogisticsWarehouseWaveFenceAsyncRequest;
$warehouse_wave_fence_operate_request = new WarehouseWaveFenceOperateRequest;
$warehouse_wave_fence_operate_request->request_time="1656674541000";
$warehouse_wave_fence_operate_request->request_id="1656674541000_001";
$warehouse_wave_fence_operate_request->supplier_id="10000000001";
$warehouse_wave_fence_operate_request->wh_code="SF_WH_001";
$warehouse_wave_fence_operate_request->biz_flag_code="TUOGUAN";
$warehouse_wave_fence_operate_request->operate_type="UPSERT";
$cover_fence_param = new CoverFenceList;
$cover_fence_param->to_location_id="330110005";
$cover_fence_param->delivery_resource_code="SF";
$cover_fence_param->cutoff_time="12:00";
$cover_fence_param->out_range_code="RANG_CODE_01";
$cover_fence_param->range_fence_type="1";
$cover_fence_param->range_fence_wkt="POLYGON((120.009098 30.281106,120.0106 30.277289,120.011844 30.272842,120.01605 30.27425,120.0218 30.276103,120.020427 30.280032,120.029997 30.282626,120.027294 30.289407,120.017681 30.286369,120.015792 30.285813,120.016307 30.283923,120.01223 30.282478,120.009098 30.281106))";
$cover_fence_param->range_fence_name="海创园A区";
$cover_fence_param->range_fence_tag="OFFICE_BUILDING";
$warehouse_wave_fence_operate_request->cover_fence_param = $cover_fence_param;
$req->setWarehouseWaveFenceOperateRequest(json_encode($warehouse_wave_fence_operate_request));
$resp = $c->execute($req);

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=taobao.logistics.warehouse.wave.fence.async' \
-d 'partner_id=apidoc' \
-d 'sign=D4883E9BC37CF6042F21AA3CB2F5937C' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-09-16+16%3A01%3A48' \
-d 'v=2.0' \
-d 'warehouse_wave_fence_operate_request=null'

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

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

req.warehouse_wave_fence_operate_request="数据结构示例JSON格式"
try:
	resp= req.getResponse()
	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,"taobao.logistics.warehouse.wave.fence.async");
add_param(pRequest,"warehouse_wave_fence_operate_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
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',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.logistics.warehouse.wave.fence.async', {
	'warehouse_wave_fence_operate_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<logistics_warehouse_wave_fence_async_response>
    <warehouse_wave_fence_operate_response>
        <success>true</success>
        <code>BATCH_SIZE_INVALID</code>
        <message>coverFenceList 大小不合法</message>
    </warehouse_wave_fence_operate_response>
</logistics_warehouse_wave_fence_async_response>

{
    "logistics_warehouse_wave_fence_async_response":{
        "warehouse_wave_fence_operate_response":{
            "success":true,
            "code":"BATCH_SIZE_INVALID",
            "message":"coverFenceList 大小不合法"
        }
    }
}

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下载

开放平台

天猫供应链

taobao.logistics.warehouse.wave.fence.async (仓波次覆盖围栏数据上报接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ