淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
txpAreaDTO	TxpCommunityAreaDTO	必须			入参DTO
└ unitId String 必须 1234 单元id └ unitName String 必须 1单元单元名称 └ buildingId String 必须 1234 栋id └ buildingName String 必须 1栋栋名称 └ communityId String 必须 1234 社区id └ communityName String 必须西溪北苑社区名称 └ storeId String 必须 1234 门店id └ provinceName String 必须浙江省省名称 └ provinceCode String 必须 1234 省code └ cityName String 必须杭州市城市名称 └ cityCode String 必须 1234 城市code └ areaName String 必须余杭区区域名称 └ areaCode String 必须 1234 区域code └ townName String 必须五常街道街道名称 └ townCode String 必须 1234 街道code └ address String 必须 xxxx 详细地址 └ sellerId String 必须 1234 商家id └ bizCode String 必须 txp 业务code └ outId String 必须 1234 外键id(中台的id) └ gmtCreate String 必须 xxx 创建时间 └ gmtModified String 必须 xxx 修改时间 └ attributes String 必须 xxx 扩展字段 └ version String 必须 0 版本号 └ isDeleted String 必须 n 是否删除 └ creatorId String 必须 1234 创建人id └ modifierId String 必须 1234 修改人id └ creatorName String 必须张三创建人名称 └ modifierName String 必须张三修改人名称 └ status String 必须 init 状态

名称	类型	示例值	描述
resultDTO	TopResult		对象
└ code String xxx code └ success Boolean true 是否成功 └ msg String xxx 信息 └ data String xxx 数据

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

QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
AlibabaAscpTxpAreaCreateRequest req = new AlibabaAscpTxpAreaCreateRequest();
AlibabaAscpTxpAreaCreateRequest.TxpCommunityAreaDTO obj1 = new AlibabaAscpTxpAreaCreateRequest.TxpCommunityAreaDTO();
obj1.setUnitId("1234");
obj1.setUnitName("1单元");
obj1.setBuildingId("1234");
obj1.setBuildingName("1栋");
obj1.setCommunityId("1234");
obj1.setCommunityName("西溪北苑");
obj1.setStoreId("1234");
obj1.setProvinceName("浙江省");
obj1.setProvinceCode("1234");
obj1.setCityName("杭州市");
obj1.setCityCode("1234");
obj1.setAreaName("余杭区");
obj1.setAreaCode("1234");
obj1.setTownName("五常街道");
obj1.setTownCode("1234");
obj1.setAddress("xxxx");
obj1.setSellerId("1234");
obj1.setBizCode("txp");
obj1.setOutId("1234");
obj1.setGmtCreate("xxx");
obj1.setGmtModified("xxx");
obj1.setAttributes("xxx");
obj1.setVersion("0");
obj1.setIsDeleted("n");
obj1.setCreatorId("1234");
obj1.setModifierId("1234");
obj1.setCreatorName("张三");
obj1.setModifierName("张三");
obj1.setStatus("init");
req.setTxpAreaDTO(obj1);
AlibabaAscpTxpAreaCreateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAscpTxpAreaCreateRequest req = new AlibabaAscpTxpAreaCreateRequest();
AlibabaAscpTxpAreaCreateRequest.TxpCommunityAreaDTODomain obj1 = new AlibabaAscpTxpAreaCreateRequest.TxpCommunityAreaDTODomain();
obj1.UnitId = "1234";
obj1.UnitName = "1单元";
obj1.BuildingId = "1234";
obj1.BuildingName = "1栋";
obj1.CommunityId = "1234";
obj1.CommunityName = "西溪北苑";
obj1.StoreId = "1234";
obj1.ProvinceName = "浙江省";
obj1.ProvinceCode = "1234";
obj1.CityName = "杭州市";
obj1.CityCode = "1234";
obj1.AreaName = "余杭区";
obj1.AreaCode = "1234";
obj1.TownName = "五常街道";
obj1.TownCode = "1234";
obj1.Address = "xxxx";
obj1.SellerId = "1234";
obj1.BizCode = "txp";
obj1.OutId = "1234";
obj1.GmtCreate = "xxx";
obj1.GmtModified = "xxx";
obj1.Attributes = "xxx";
obj1.Version = "0";
obj1.IsDeleted = "n";
obj1.CreatorId = "1234";
obj1.ModifierId = "1234";
obj1.CreatorName = "张三";
obj1.ModifierName = "张三";
obj1.Status = "init";
req.TxpAreaDTO_ = obj1;
AlibabaAscpTxpAreaCreateResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAscpTxpAreaCreateRequest;
$txpAreaDTO = new TxpCommunityAreaDTO;
$txpAreaDTO->unit_id="1234";
$txpAreaDTO->unit_name="1单元";
$txpAreaDTO->building_id="1234";
$txpAreaDTO->building_name="1栋";
$txpAreaDTO->community_id="1234";
$txpAreaDTO->community_name="西溪北苑";
$txpAreaDTO->store_id="1234";
$txpAreaDTO->province_name="浙江省";
$txpAreaDTO->province_code="1234";
$txpAreaDTO->city_name="杭州市";
$txpAreaDTO->city_code="1234";
$txpAreaDTO->area_name="余杭区";
$txpAreaDTO->area_code="1234";
$txpAreaDTO->town_name="五常街道";
$txpAreaDTO->town_code="1234";
$txpAreaDTO->address="xxxx";
$txpAreaDTO->seller_id="1234";
$txpAreaDTO->biz_code="txp";
$txpAreaDTO->out_id="1234";
$txpAreaDTO->gmt_create="xxx";
$txpAreaDTO->gmt_modified="xxx";
$txpAreaDTO->attributes="xxx";
$txpAreaDTO->version="0";
$txpAreaDTO->is_deleted="n";
$txpAreaDTO->creator_id="1234";
$txpAreaDTO->modifier_id="1234";
$txpAreaDTO->creator_name="张三";
$txpAreaDTO->modifier_name="张三";
$txpAreaDTO->status="init";
$req->setTxpAreaDTO(json_encode($txpAreaDTO));
$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=qimen.alibaba.ascp.txp.area.create' \
-d 'partner_id=apidoc' \
-d 'sign=9CB1972FCFC55F8E0916955B9D6108C8' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-15+14%3A47%3A58' \
-d 'v=2.0' \
-d 'txpAreaDTO=null'

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

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

req.txpAreaDTO="数据结构示例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,"qimen.alibaba.ascp.txp.area.create");
add_param(pRequest,"txpAreaDTO","数据结构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',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('qimen.alibaba.ascp.txp.area.create', {
	'txpAreaDTO':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<resultDTO>
    <code>xxx</code>
    <success>true</success>
    <msg>xxx</msg>
    <data>xxx</data>
</resultDTO>

{
    "resultDTO":{
        "code":"xxx",
        "success":true,
        "msg":"xxx",
        "data":"xxx"
    }
}

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

qimen.alibaba.ascp.txp.area.create (区域创建)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ