阿里安全开放平台-阿里聚安全

请求地址：

环境	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。

名称	类型	是否必须	示例值	描述
merchant_code	String	必须	DARUNFA	商家编号
merchant_warehouse_code	String	必须	DRF5072	商家仓code
service_type	String	必须	WAVE_ARRIVE	WAVE_ARRIVE-波次达。ONE_HOUR-小时达
delivery_dock_codes	String	可选	["demo"]	查询的配送站列表，不填为查仓下面所有配送站信息

名称	类型	示例值	描述
result	TopApiResult		结果
data DeliveryRangesResultDTO 数据 └ service_type String WAVE_ARRIVE 网络类型 WAVE_ARRIVE-波次达。ONE_HOUR-小时达 └ nc_warehouse_code String DRF5072 鸟巢仓code └ merchant_code String DARUNFA 商家code ranges DeliveryRangesDTO [] 配送站信息 range LngLat [] 范围 └ lng String 119.377607 经纬度 └ lat String 26.056302 经纬度 └ dock_code String UDTCLSHN00137 配送站code └ dock_name String xx站点配送站名称 └ merchant_warehouse_code String DRF5072 仓code └ success Boolean true 请求是否成功 └ error_code String DELIVERY_DOCK_NOT_EXIST 异常code └ error_msg String 配送站范围有误异常信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTcCompassDeliveryRangesGetRequest req = new AlibabaTcCompassDeliveryRangesGetRequest();
req.setMerchantCode("DARUNFA");
req.setMerchantWarehouseCode("DRF5072");
req.setServiceType("WAVE_ARRIVE");
req.setDeliveryDockCodes("[\"demo\"]");
AlibabaTcCompassDeliveryRangesGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaTcCompassDeliveryRangesGetRequest req = new AlibabaTcCompassDeliveryRangesGetRequest();
req.MerchantCode = "DARUNFA";
req.MerchantWarehouseCode = "DRF5072";
req.ServiceType = "WAVE_ARRIVE";
req.DeliveryDockCodes = "[\"demo\"]";
AlibabaTcCompassDeliveryRangesGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaTcCompassDeliveryRangesGetRequest;
$req->setMerchantCode("DARUNFA");
$req->setMerchantWarehouseCode("DRF5072");
$req->setServiceType("WAVE_ARRIVE");
$req->setDeliveryDockCodes("[\"demo\"]");
$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.tc.compass.delivery.ranges.get' \
-d 'partner_id=apidoc' \
-d 'session=01d72f94-6a45-4b17-85a8-6ba361f23204' \
-d 'sign=DFF3CFD65A7013AF3AA37BD1511B6604' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+21%3A10%3A16' \
-d 'v=2.0' \
-d 'delivery_dock_codes=%22demo%22' \
-d 'merchant_code=DARUNFA' \
-d 'merchant_warehouse_code=DRF5072' \
-d 'service_type=WAVE_ARRIVE'

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

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

req.merchant_code="DARUNFA"
req.merchant_warehouse_code="DRF5072"
req.service_type="WAVE_ARRIVE"
req.delivery_dock_codes="[\"demo\"]"
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.tc.compass.delivery.ranges.get");
add_param(pRequest,"merchant_code","DARUNFA");
add_param(pRequest,"merchant_warehouse_code","DRF5072");
add_param(pRequest,"service_type","WAVE_ARRIVE");
add_param(pRequest,"delivery_dock_codes",""demo"");
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.tc.compass.delivery.ranges.get', {
	'merchant_code':'DARUNFA',
	'merchant_warehouse_code':'DRF5072',
	'service_type':'WAVE_ARRIVE',
	'delivery_dock_codes':'"demo"'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_tc_compass_delivery_ranges_get_response>
    <result>
        <data>
            <service_type>WAVE_ARRIVE</service_type>
            <nc_warehouse_code>DRF5072</nc_warehouse_code>
            <merchant_code>DARUNFA</merchant_code>
            <ranges>
                <delivery_ranges_d_t_o>
                    <range>
                        <lng_lat>
                            <lng>119.377607</lng>
                            <lat>26.056302</lat>
                        </lng_lat>
                    </range>
                    <dock_code>UDTCLSHN00137</dock_code>
                    <dock_name>xx站点</dock_name>
                </delivery_ranges_d_t_o>
            </ranges>
            <merchant_warehouse_code>DRF5072</merchant_warehouse_code>
        </data>
        <success>true</success>
        <error_code>DELIVERY_DOCK_NOT_EXIST</error_code>
        <error_msg>配送站范围有误</error_msg>
    </result>
</alibaba_tc_compass_delivery_ranges_get_response>

{
    "alibaba_tc_compass_delivery_ranges_get_response":{
        "result":{
            "data":{
                "service_type":"WAVE_ARRIVE",
                "nc_warehouse_code":"DRF5072",
                "merchant_code":"DARUNFA",
                "ranges":{
                    "delivery_ranges_d_t_o":[
                        {
                            "range":{
                                "lng_lat":[
                                    {
                                        "lng":"119.377607",
                                        "lat":"26.056302"
                                    }
                                ]
                            },
                            "dock_code":"UDTCLSHN00137",
                            "dock_name":"xx站点"
                        }
                    ]
                },
                "merchant_warehouse_code":"DRF5072"
            },
            "success":true,
            "error_code":"DELIVERY_DOCK_NOT_EXIST",
            "error_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.tc.compass.delivery.ranges.get (范围变动内容查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈