淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
contract_base_info_extend_outer_str	String	必须	{"counterId":"HZ01-A0061"}		查询合同入参

名称	类型	示例值	描述
is_async	Boolean	false	是否同步
success_flag	Boolean	false	成功标志
err_message	String	错误信息	报错信息
result_code	String	500	服务内部报错
datalist	ContractBaseInfoExtendOuterDto []	{is_filter_promotion_section:false, store_no:HZ01}	对应DTO:ContractBaseInfoExtendOuterDto
└ is_filter_promotion_section Boolean false 是否过滤一页纸 └ discount_id_list String [] [1123,3454] 子合同号列表 contract_brand_discount_info_list ContractBrandDiscountInfoOuterDto [] [{contract_id:343},{contract_id:7655}] 品牌信息列表 └ contract_id Number 12344 合同id └ brand_id String 23123 品牌id └ three_level_kind_code String 化妆品-》兰蔻三级业种 └ main_flag Number true 是否主品牌 └ commod_type_flag Number false 是否按商品区分 └ discount_flag Number true 是否按折扣区分 └ version Number 1 版本 discount_detail_list ContractBrandDiscountInfoDetailDto [] [{discount_type:1},{discount_type:0}] 品牌扣率详情列表 └ discount_type Number 1 折扣类型 └ commod_tye String 0 商品类型 └ commod_tye_name String 化妆品商品类型名称 └ star_discount String 0.34 开始折扣 └ end_discount String 0.89 结束折扣 └ discount String 0.9 扣率 └ rate String 0.23 税率 └ memo String 备注备注 └ discount_id String 21244 子合同号 └ index_promotion Number 1 排序 └ main_flag Number 1 是否是主扣率 └ contract_id Number 123112 合同id └ contract_code String 342231 合同编号 └ cooper_way Number 0 经营方式 └ supplier_code String 0124 供应商编号 └ store_no String HZ01 门店编号 └ business_entity_code String 0123 经营主体code └ origin_contract_code String 21244232 原始合同号 └ origin_contract_id String 123442 原合同的合同id └ origin_version Number 2 原合同的合同版本 └ counter_id String 1234 专柜id └ origin_store_no String HZ01 原始门店号 └ last_change_effect_date Date 2019-07-23 上次变更生效日期 └ department_id String 002 营业部门 └ contract_start_date Date 2019-01-01 合同开始日期 └ contract_end_date Date 2019-09-12 合同结束日期 └ template_id Number 123 合同模板id └ rent_free_start_date Date 2019-01-01 合同免租开始日期 └ rent_free_end_date Date 2019-01-05 合同免租结束日期 └ sigin_date Date 2019-01-23 签订日期 └ version Number 1 版本 └ start_discount_point_flag Number 1 起折点标志 └ start_discount_point String 0.23 起折点 pay_clause ContractPayClauseDto {type:1,full_amont:23} 支付条款DTO:ContractPayClauseDTO └ type Number 1 类型 └ full_amont Number 450 满额金额 └ settlement_amount Number 26 结算金额 └ memo String 备注备注 minimum_guarantee ContractMinimumGuaranteesDto {type:1,amount:340} 销售保底 └ type Number 1 类型 └ amount Number 460 金额 └ change_effect_date Date 2019-01-23 变更生效日期 └ change_clause_url String [{"key": "file/1563259597983_假装有图片.jpg", "name": "假装有图片.jpg"}] 变更条款补充url └ virtual_shop_flag Number 1 虚拟/常规/多经铺位标志 └ memo String 备注备注 rescind_info ContractRescindInfoDto {constructionContact:“tom”} 解约信息 └ rescind_date Date 2019-01-23 解约日期 └ construction_date Date 2019-01-23 施工日期 └ construction_contact String 王五施工联系人 └ construction_contact_mobile String 18909812376 施工联系人手机号 └ business_risk_flag Number 3 有无法务/财务/业务风险 1:有风险 0:无风险 └ integral_base_point Number 1 积分基点 └ contract_end_date_lt Date 2019-01-23 小于合同结束日期 └ contract_start_date_gt Date 2019-01-23 大于合同开始日期 └ contract_id_lt Number 102342 小于contractId └ attributes String {name:"tom"} 预留拓展JSON字符串 └ attr_map String {name:"tom"} map └ id Number 12234 主键 └ gmt_create Date 2019-01-23 创建日期 └ gmt_modified Date 2019-01-23 修改日期 └ start Number 10 分页开始index └ limit Number 10 每页记录数 └ order_by String id 排序 └ gmt_create_gt Date 2019-01-23 创建日期 └ gmt_create_lt Date 2019-01-23 修改日期 └ gmt_modified_gt Date 2019-01-23 创建日期 └ gmt_modified_lt Date 2019-01-23 修改日期 └ main_discount_id String 10248 主品牌，主子合同号 └ store_name String "杭州城西店" 门店名称 └ department_name String "营业一部" 部门名称 └ region_name String "化妆品" 区域名称 └ sign_company_name String "杭州银泰百货有限公司" 签约主体名称 └ supplier_name String "耐克有限公司" 供应商名称 └ main_three_level_kind_name String "奢侈品" 三级业种名称 └ counter_name String "耐克" 专柜名称 └ main_brand_name String "耐克" 主品牌名称 └ main_brand_name_en String “NIKE” 主品牌英文名称

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMosContractInfoGetallcontractRequest req = new AlibabaMosContractInfoGetallcontractRequest();
req.setContractBaseInfoExtendOuterStr("{\"counterId\":\"HZ01-A0061\"}");
AlibabaMosContractInfoGetallcontractResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaMosContractInfoGetallcontractRequest req = new AlibabaMosContractInfoGetallcontractRequest();
req.ContractBaseInfoExtendOuterStr = "{\"counterId\":\"HZ01-A0061\"}";
AlibabaMosContractInfoGetallcontractResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaMosContractInfoGetallcontractRequest;
$req->setContractBaseInfoExtendOuterStr("{\"counterId\":\"HZ01-A0061\"}");
$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=alibaba.mos.contract.info.getallcontract' \
-d 'partner_id=apidoc' \
-d 'sign=7FCD9F231A48638FCD9A5F415A2B3CA8' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-10-26+05%3A47%3A39' \
-d 'v=2.0' \
-d 'contract_base_info_extend_outer_str=%7B%5C%22counterId%5C%22%3A%5C%22HZ01-A0061%5C%22%7D'

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

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

req.contract_base_info_extend_outer_str="{\"counterId\":\"HZ01-A0061\"}"
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,"alibaba.mos.contract.info.getallcontract");
add_param(pRequest,"contract_base_info_extend_outer_str","{\"counterId\":\"HZ01-A0061\"}");
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('alibaba.mos.contract.info.getallcontract', {
	'contract_base_info_extend_outer_str':'{\"counterId\":\"HZ01-A0061\"}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_mos_contract_info_getallcontract_response>
    <is_async>false</is_async>
    <success_flag>false</success_flag>
    <err_message>错误信息</err_message>
    <result_code>500</result_code>
    <datalist>
        <contract_base_info_extend_outer_dto>
            <is_filter_promotion_section>false</is_filter_promotion_section>
            <discount_id_list>
                <string>[1123</string>
                <string>3454]</string>
            </discount_id_list>
            <contract_brand_discount_info_list>
                <contract_brand_discount_info_outer_dto>
                    <contract_id>12344</contract_id>
                    <brand_id>23123</brand_id>
                    <three_level_kind_code>化妆品-》兰蔻</three_level_kind_code>
                    <main_flag>true</main_flag>
                    <commod_type_flag>false</commod_type_flag>
                    <discount_flag>true</discount_flag>
                    <version>1</version>
                    <discount_detail_list>
                        <contract_brand_discount_info_detail_dto>
                            <discount_type>1</discount_type>
                            <commod_tye>0</commod_tye>
                            <commod_tye_name>化妆品</commod_tye_name>
                            <star_discount>0.34</star_discount>
                            <end_discount>0.89</end_discount>
                            <discount>0.9</discount>
                            <rate>0.23</rate>
                            <memo>备注</memo>
                            <discount_id>21244</discount_id>
                            <index_promotion>1</index_promotion>
                            <main_flag>1</main_flag>
                        </contract_brand_discount_info_detail_dto>
                    </discount_detail_list>
                </contract_brand_discount_info_outer_dto>
            </contract_brand_discount_info_list>
            <contract_id>123112</contract_id>
            <contract_code>342231</contract_code>
            <cooper_way>0</cooper_way>
            <supplier_code>0124</supplier_code>
            <store_no>HZ01</store_no>
            <business_entity_code>0123</business_entity_code>
            <origin_contract_code>21244232</origin_contract_code>
            <origin_contract_id>123442</origin_contract_id>
            <origin_version>2</origin_version>
            <counter_id>1234</counter_id>
            <origin_store_no>HZ01</origin_store_no>
            <last_change_effect_date>2019-07-23</last_change_effect_date>
            <department_id>002</department_id>
            <contract_start_date>2019-01-01</contract_start_date>
            <contract_end_date>2019-09-12</contract_end_date>
            <template_id>123</template_id>
            <rent_free_start_date>2019-01-01</rent_free_start_date>
            <rent_free_end_date>2019-01-05</rent_free_end_date>
            <sigin_date>2019-01-23</sigin_date>
            <version>1</version>
            <start_discount_point_flag>1</start_discount_point_flag>
            <start_discount_point>0.23</start_discount_point>
            <pay_clause>
                <type>1</type>
                <full_amont>450</full_amont>
                <settlement_amount>26</settlement_amount>
                <memo>备注</memo>
            </pay_clause>
            <minimum_guarantee>
                <type>1</type>
                <amount>460</amount>
            </minimum_guarantee>
            <change_effect_date>2019-01-23</change_effect_date>
            <change_clause_url>[{&quot;key&quot;: &quot;file/1563259597983_假装有图片.jpg&quot;, &quot;name&quot;: &quot;假装有图片.jpg&quot;}]</change_clause_url>
            <virtual_shop_flag>1</virtual_shop_flag>
            <memo>备注</memo>
            <rescind_info>
                <rescind_date>2019-01-23</rescind_date>
                <construction_date>2019-01-23</construction_date>
                <construction_contact>王五</construction_contact>
                <construction_contact_mobile>18909812376</construction_contact_mobile>
                <business_risk_flag>3</business_risk_flag>
            </rescind_info>
            <integral_base_point>1</integral_base_point>
            <contract_end_date_lt>2019-01-23</contract_end_date_lt>
            <contract_start_date_gt>2019-01-23</contract_start_date_gt>
            <contract_id_lt>102342</contract_id_lt>
            <attributes>{name:&quot;tom&quot;}</attributes>
            <attr_map>{name:&quot;tom&quot;}</attr_map>
            <id>12234</id>
            <gmt_create>2019-01-23</gmt_create>
            <gmt_modified>2019-01-23</gmt_modified>
            <start>10</start>
            <limit>10</limit>
            <order_by>id</order_by>
            <gmt_create_gt>2019-01-23</gmt_create_gt>
            <gmt_create_lt>2019-01-23</gmt_create_lt>
            <gmt_modified_gt>2019-01-23</gmt_modified_gt>
            <gmt_modified_lt>2019-01-23</gmt_modified_lt>
            <main_discount_id>10248</main_discount_id>
            <store_name>&quot;杭州城西店&quot;</store_name>
            <department_name>&quot;营业一部&quot;</department_name>
            <region_name>&quot;化妆品&quot;</region_name>
            <sign_company_name>&quot;杭州银泰百货有限公司&quot;</sign_company_name>
            <supplier_name>&quot;耐克有限公司&quot;</supplier_name>
            <main_three_level_kind_name>&quot;奢侈品&quot;</main_three_level_kind_name>
            <counter_name>&quot;耐克&quot;</counter_name>
            <main_brand_name>&quot;耐克&quot;</main_brand_name>
            <main_brand_name_en>“NIKE”</main_brand_name_en>
        </contract_base_info_extend_outer_dto>
    </datalist>
</alibaba_mos_contract_info_getallcontract_response>

{
    "alibaba_mos_contract_info_getallcontract_response":{
        "is_async":false,
        "success_flag":false,
        "err_message":"错误信息",
        "result_code":"500",
        "datalist":{
            "contract_base_info_extend_outer_dto":[
                {
                    "is_filter_promotion_section":false,
                    "discount_id_list":{
                        "string":[
                            "[1123",
                            "3454]"
                        ]
                    },
                    "contract_brand_discount_info_list":{
                        "contract_brand_discount_info_outer_dto":[
                            {
                                "contract_id":12344,
                                "brand_id":"23123",
                                "three_level_kind_code":"化妆品-》兰蔻",
                                "main_flag":true,
                                "commod_type_flag":false,
                                "discount_flag":true,
                                "version":1,
                                "discount_detail_list":{
                                    "contract_brand_discount_info_detail_dto":[
                                        {
                                            "discount_type":1,
                                            "commod_tye":"0",
                                            "commod_tye_name":"化妆品",
                                            "star_discount":"0.34",
                                            "end_discount":"0.89",
                                            "discount":"0.9",
                                            "rate":"0.23",
                                            "memo":"备注",
                                            "discount_id":"21244",
                                            "index_promotion":1,
                                            "main_flag":1
                                        }
                                    ]
                                }
                            }
                        ]
                    },
                    "contract_id":123112,
                    "contract_code":"342231",
                    "cooper_way":0,
                    "supplier_code":"0124",
                    "store_no":"HZ01",
                    "business_entity_code":"0123",
                    "origin_contract_code":"21244232",
                    "origin_contract_id":"123442",
                    "origin_version":2,
                    "counter_id":"1234",
                    "origin_store_no":"HZ01",
                    "last_change_effect_date":"2019-07-23",
                    "department_id":"002",
                    "contract_start_date":"2019-01-01",
                    "contract_end_date":"2019-09-12",
                    "template_id":123,
                    "rent_free_start_date":"2019-01-01",
                    "rent_free_end_date":"2019-01-05",
                    "sigin_date":"2019-01-23",
                    "version":1,
                    "start_discount_point_flag":1,
                    "start_discount_point":"0.23",
                    "pay_clause":{
                        "type":1,
                        "full_amont":450,
                        "settlement_amount":26,
                        "memo":"备注"
                    },
                    "minimum_guarantee":{
                        "type":1,
                        "amount":460
                    },
                    "change_effect_date":"2019-01-23",
                    "change_clause_url":"[{\"key\": \"file\/1563259597983_假装有图片.jpg\", \"name\": \"假装有图片.jpg\"}]",
                    "virtual_shop_flag":1,
                    "memo":"备注",
                    "rescind_info":{
                        "rescind_date":"2019-01-23",
                        "construction_date":"2019-01-23",
                        "construction_contact":"王五",
                        "construction_contact_mobile":"18909812376",
                        "business_risk_flag":3
                    },
                    "integral_base_point":1,
                    "contract_end_date_lt":"2019-01-23",
                    "contract_start_date_gt":"2019-01-23",
                    "contract_id_lt":102342,
                    "attributes":"{name:\"tom\"}",
                    "attr_map":"{name:\"tom\"}",
                    "id":12234,
                    "gmt_create":"2019-01-23",
                    "gmt_modified":"2019-01-23",
                    "start":10,
                    "limit":10,
                    "order_by":"id",
                    "gmt_create_gt":"2019-01-23",
                    "gmt_create_lt":"2019-01-23",
                    "gmt_modified_gt":"2019-01-23",
                    "gmt_modified_lt":"2019-01-23",
                    "main_discount_id":"10248",
                    "store_name":"\"杭州城西店\"",
                    "department_name":"\"营业一部\"",
                    "region_name":"\"化妆品\"",
                    "sign_company_name":"\"杭州银泰百货有限公司\"",
                    "supplier_name":"\"耐克有限公司\"",
                    "main_three_level_kind_name":"\"奢侈品\"",
                    "counter_name":"\"耐克\"",
                    "main_brand_name":"\"耐克\"",
                    "main_brand_name_en":"“NIKE”"
                }
            ]
        }
    }
}

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.mos.contract.info.getallcontract (alibaba.mos.contract.info.getallcontract)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ