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

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
pr_query_dto	PrQueryDTO	可选			pr查询入参
└ need_file Boolean 可选 true 是否需要附件信息 └ status_list String [] 可选 null 状态 └ source_type_list String [] 可选 null 来源类型 └ pr_item_id_list Number [] 可选 null PR行ID,如果传了prItemIdList并且needItem=true，返回结果时这些itemId对应PR下的所有item，不只是这些itemId对应的item └ pr_number_list String [] 可选 null PR编号 └ exclude_pr_number_list String [] 可选 null 排除的PR编号 └ pr_id_list Number [] 可选 null PRID └ source_value_list String [] 可选 null 来源值 └ need_finance_distribution Boolean 可选 true 是否需要财务分摊信息 └ need_item Boolean 可选 true 是否需要item信息 └ requestor String 可选 110711 需求方 └ applicant String 可选 1 申请人 └ need_surplus_amount Boolean 可选 true 是否需要剩余金额信息 └ need_custom_info Boolean 可选 true 是否需要定制信息

名称	类型	示例值	描述
result	ActionResult	null	获取url的出参
└ success Boolean true 是否成功 └ error_code String 500 码值 contents PrTopResponseDTO [] null 返回内容 └ applicant String 知示申请人 └ requestor String 早霞实际需求方 └ pr_number String PR200293 PR编号 └ security_id String 123werwr2 加密ID └ id Number fsdsf234 id └ company_code String 487 公司CODE └ source_type String 2 来源类型 └ source_value String 3 来源值 └ status String 成功状态 └ purchase_org_id Number 19976 采购组织ID └ currency_code String 1390 PR行上币种一致返回，如果PR行币种不一致不返回 └ simplified_process Boolean true 过程 └ need_approval Boolean true 是否需要审批 └ amount String 100000 PR行上币种一致返回，如果PR行币种不一致不返回 └ submit_date Date 2020-01-22 02:22:11 提交日期 └ edit_url String https://baidu.com 编辑页URL └ detail_url String https://baidu.com 详情页URL └ associated_existing_pr String PR10092 关联的PR └ tenant_id Number 10001 租户ID └ purchase_type String 1 采购类型，如生产采购 └ ext String null 扩展信息 pr_items PrItemTopResponseDTO [] null PR采购项 └ id Number 23423 id └ source_type String null 来源类型 └ source_value String null 来源值 └ item_type String null 物料类别,如采购件、制造件 └ item_code String null 物料编码,如MPN,skuId └ item_name String null 采购需求名称 └ item_description String null 采购需求说明 └ category_code String null 采购类别CODE └ category_use String null 采购用途CODE └ acceptance_standard String null 验收标准 └ uom String null 单位 └ unit_price String 2.00 单价 └ quantity Number 300 数量,废弃，数量支持小数，请用quantityDecimal └ quantity_decimal String null 数量 └ amount String 200000 金额 └ currency_code String null 币种 └ need_date_start Date 2020-01-22 02:22:11 期望到货日期开始 └ need_date_end Date 2020-01-22 02:22:11 期望到货日期结束 └ buyer String null 采购员 └ address_id Number null 收货地址ID └ address_info String null 收货地址描述 └ receiver String null 收货人 └ purchase_org_id Number null 采购组织ID └ purchase_requisition_id Number PR10084 PRID └ goods_quotation_id Number 2323 商品id └ address_ext String 杭州市余杭区地址扩展信息 └ sku_id Number 1001 skuId └ gmt_create Date 2020-01-22 02:22:11 创建日期 └ remark String 你好呀备注 └ status String null 状态 └ project_id Number 1009 项目ID └ budget_id Number 1009 预算项ID └ line_number Number 111 行号 └ product_id Number 111 产品ID └ is_designated_supplier String null 是否指定供应商 └ designated_supplier String null 供应商 └ pur_type String null 采购方式，如目录采购 └ tenant_id Number 1222 租户ID └ supplier_id Number 1222 供应商ID └ contract_code String afd1234234324 合同编号 └ tax_rate String 1.01 税率 └ item_attr_info String null 规格属性 └ po_unit_price String 20000 创建PO单价 └ ext String null 扩展信息 └ is_pr_by_detail Boolean true 是否有结构化数据 finance_distribution_list FinanceDistributionTopDTO [] null 财务分摊信息 └ id Number 11132 id └ biz_id Number 1 bizId └ allocation_amount String 10000 金额 └ allocation_quantity String 10000 数量 └ unit_price String 10000 价格 └ total_amount String 199999 总共金额 └ total_quantity String 19999 总共数量 └ allocation_value String 333 允许值 └ item_description String 这件很好描述 └ parent_distribution_id Number 4 父id └ acct_ccid Number 12 ccid └ source_id Number 122 来源id └ currency_code String 1 现在code └ order_type String 3 开单方式 └ surplus_amount_max String 100.00 PR行剩余金额的总和 └ surplus_amount_sum String 30.00 PR行剩余最的大金额 └ category_use_name String 默认规则采购用途中文描述 └ category_name String IT 采购类目中文描述 └ buyer_name String 嘻嘻采购员名称 └ cancel_amount String 20.00 PR行已作废金额 files AecpFile [] null 附件 └ id String 1 id └ name String 1 名称 └ url String https://www.baidi.com url路径 └ preview_url String https://www.baidi.com previewUrl uploader AliEmployee null 员工 └ work_no String wb8073453 工号 └ name String 李红名称 └ nick_name String 红红昵称 └ upload_time Date 2020-01-22 02:22:11 更新时间 └ amount_available String 50.00 PR可用金额 └ status_desc String 审批完成审批状态描述 └ ou_name String 蚂蚁 OU名称 └ ou_code String Z69 OU编码 person_list PersonDTO [] 当前审批人信息 └ work_no String 123456 工号 └ user_name String 张三(test) 名称（花名） └ error_msg String 错误了错误信息 └ error_level Number 3 错误信息级别

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaPrQueryRequest req = new AlibabaPrQueryRequest();
AlibabaPrQueryRequest.PrQueryDTO obj1 = new AlibabaPrQueryRequest.PrQueryDTO();
obj1.setNeedFile(true);
obj1.setStatusList("null");
obj1.setSourceTypeList("null");
obj1.setPrItemIdList(new Long[] { null };
);
obj1.setPrNumberList("null");
obj1.setExcludePrNumberList("null");
obj1.setPrIdList(new Long[] { null };
);
obj1.setSourceValueList("null");
obj1.setNeedFinanceDistribution(true);
obj1.setNeedItem(true);
obj1.setRequestor("110711");
obj1.setApplicant("1");
obj1.setNeedSurplusAmount(true);
obj1.setNeedCustomInfo(true);
req.setPrQueryDto(obj1);
AlibabaPrQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaPrQueryRequest req = new AlibabaPrQueryRequest();
AlibabaPrQueryRequest.PrQueryDTODomain obj1 = new AlibabaPrQueryRequest.PrQueryDTODomain();
obj1.NeedFile = true;
obj1.StatusList = "null";
obj1.SourceTypeList = "null";
obj1.PrItemIdList = new long[] { null };
;
obj1.PrNumberList = "null";
obj1.ExcludePrNumberList = "null";
obj1.PrIdList = new long[] { null };
;
obj1.SourceValueList = "null";
obj1.NeedFinanceDistribution = true;
obj1.NeedItem = true;
obj1.Requestor = "110711";
obj1.Applicant = "1";
obj1.NeedSurplusAmount = true;
obj1.NeedCustomInfo = true;
req.PrQueryDto_ = obj1;
AlibabaPrQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaPrQueryRequest;
$pr_query_dto = new PrQueryDTO;
$pr_query_dto->need_file="true";
$pr_query_dto->status_list="null";
$pr_query_dto->source_type_list="null";
$pr_query_dto->pr_item_id_list="null";
$pr_query_dto->pr_number_list="null";
$pr_query_dto->exclude_pr_number_list="null";
$pr_query_dto->pr_id_list="null";
$pr_query_dto->source_value_list="null";
$pr_query_dto->need_finance_distribution="true";
$pr_query_dto->need_item="true";
$pr_query_dto->requestor="110711";
$pr_query_dto->applicant="1";
$pr_query_dto->need_surplus_amount="true";
$pr_query_dto->need_custom_info="true";
$req->setPrQueryDto(json_encode($pr_query_dto));
$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.pr.query' \
-d 'partner_id=apidoc' \
-d 'sign=8BF769C87A12D39BF0DBFF4D114D95E1' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-19+22%3A23%3A18' \
-d 'v=2.0' \
-d 'pr_query_dto=null'

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

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

req.pr_query_dto=""
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.pr.query");
add_param(pRequest,"pr_query_dto","数据结构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('alibaba.pr.query', {
	'pr_query_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_pr_query_response>
    <result>
        <success>true</success>
        <error_code>500</error_code>
        <contents>
            <pr_top_response_d_t_o>
                <applicant>知示</applicant>
                <requestor>早霞</requestor>
                <pr_number>PR200293</pr_number>
                <security_id>123werwr2</security_id>
                <id>fsdsf234</id>
                <company_code>487</company_code>
                <source_type>2</source_type>
                <source_value>3</source_value>
                <status>成功</status>
                <purchase_org_id>19976</purchase_org_id>
                <currency_code>1390</currency_code>
                <simplified_process>true</simplified_process>
                <need_approval>true</need_approval>
                <amount>100000</amount>
                <submit_date>2020-01-22 02:22:11</submit_date>
                <edit_url>https://baidu.com</edit_url>
                <detail_url>https://baidu.com</detail_url>
                <associated_existing_pr>PR10092</associated_existing_pr>
                <tenant_id>10001</tenant_id>
                <purchase_type>1</purchase_type>
                <ext>null</ext>
                <pr_items>
                    <pr_item_top_response_d_t_o>
                        <id>23423</id>
                        <source_type>null</source_type>
                        <source_value>null</source_value>
                        <item_type>null</item_type>
                        <item_code>null</item_code>
                        <item_name>null</item_name>
                        <item_description>null</item_description>
                        <category_code>null</category_code>
                        <category_use>null</category_use>
                        <acceptance_standard>null</acceptance_standard>
                        <uom>null</uom>
                        <unit_price>2.00</unit_price>
                        <quantity>300</quantity>
                        <quantity_decimal>null</quantity_decimal>
                        <amount>200000</amount>
                        <currency_code>null</currency_code>
                        <need_date_start>2020-01-22 02:22:11</need_date_start>
                        <need_date_end>2020-01-22 02:22:11</need_date_end>
                        <buyer>null</buyer>
                        <address_id>null</address_id>
                        <address_info>null</address_info>
                        <receiver>null</receiver>
                        <purchase_org_id>null</purchase_org_id>
                        <purchase_requisition_id>PR10084</purchase_requisition_id>
                        <goods_quotation_id>2323</goods_quotation_id>
                        <address_ext>杭州市余杭区</address_ext>
                        <sku_id>1001</sku_id>
                        <gmt_create>2020-01-22 02:22:11</gmt_create>
                        <remark>你好呀</remark>
                        <status>null</status>
                        <project_id>1009</project_id>
                        <budget_id>1009</budget_id>
                        <line_number>111</line_number>
                        <product_id>111</product_id>
                        <is_designated_supplier>null</is_designated_supplier>
                        <designated_supplier>null</designated_supplier>
                        <pur_type>null</pur_type>
                        <tenant_id>1222</tenant_id>
                        <supplier_id>1222</supplier_id>
                        <contract_code>afd1234234324</contract_code>
                        <tax_rate>1.01</tax_rate>
                        <item_attr_info>null</item_attr_info>
                        <po_unit_price>20000</po_unit_price>
                        <ext>null</ext>
                        <is_pr_by_detail>true</is_pr_by_detail>
                        <finance_distribution_list>
                            <finance_distribution_top_d_t_o>
                                <id>11132</id>
                                <biz_id>1</biz_id>
                                <allocation_amount>10000</allocation_amount>
                                <allocation_quantity>10000</allocation_quantity>
                                <unit_price>10000</unit_price>
                                <total_amount>199999</total_amount>
                                <total_quantity>19999</total_quantity>
                                <allocation_value>333</allocation_value>
                                <item_description>这件很好</item_description>
                                <parent_distribution_id>4</parent_distribution_id>
                                <acct_ccid>12</acct_ccid>
                                <source_id>122</source_id>
                                <currency_code>1</currency_code>
                            </finance_distribution_top_d_t_o>
                        </finance_distribution_list>
                        <order_type>3</order_type>
                        <surplus_amount_max>100.00</surplus_amount_max>
                        <surplus_amount_sum>30.00</surplus_amount_sum>
                        <category_use_name>默认规则</category_use_name>
                        <category_name>IT</category_name>
                        <buyer_name>嘻嘻</buyer_name>
                        <cancel_amount>20.00</cancel_amount>
                    </pr_item_top_response_d_t_o>
                </pr_items>
                <files>
                    <aecp_file>
                        <id>1</id>
                        <name>1</name>
                        <url>https://www.baidi.com</url>
                        <preview_url>https://www.baidi.com</preview_url>
                        <uploader>
                            <work_no>wb8073453</work_no>
                            <name>李红</name>
                            <nick_name>红红</nick_name>
                        </uploader>
                        <upload_time>2020-01-22 02:22:11</upload_time>
                    </aecp_file>
                </files>
                <amount_available>50.00</amount_available>
                <status_desc>审批完成</status_desc>
                <ou_name>蚂蚁</ou_name>
                <ou_code>Z69</ou_code>
                <person_list>
                    <person_d_t_o>
                        <work_no>123456</work_no>
                        <user_name>张三(test)</user_name>
                    </person_d_t_o>
                </person_list>
            </pr_top_response_d_t_o>
        </contents>
        <error_msg>错误了</error_msg>
        <error_level>3</error_level>
    </result>
</alibaba_pr_query_response>

{
    "alibaba_pr_query_response":{
        "result":{
            "success":true,
            "error_code":"500",
            "contents":{
                "pr_top_response_d_t_o":[
                    {
                        "applicant":"知示",
                        "requestor":"早霞",
                        "pr_number":"PR200293",
                        "security_id":"123werwr2",
                        "id":fsdsf234,
                        "company_code":"487",
                        "source_type":"2",
                        "source_value":"3",
                        "status":"成功",
                        "purchase_org_id":19976,
                        "currency_code":"1390",
                        "simplified_process":true,
                        "need_approval":true,
                        "amount":"100000",
                        "submit_date":"2020-01-22 02:22:11",
                        "edit_url":"https:\/\/baidu.com",
                        "detail_url":"https:\/\/baidu.com",
                        "associated_existing_pr":"PR10092",
                        "tenant_id":10001,
                        "purchase_type":"1",
                        "ext":"null",
                        "pr_items":{
                            "pr_item_top_response_d_t_o":[
                                {
                                    "id":23423,
                                    "source_type":"null",
                                    "source_value":"null",
                                    "item_type":"null",
                                    "item_code":"null",
                                    "item_name":"null",
                                    "item_description":"null",
                                    "category_code":"null",
                                    "category_use":"null",
                                    "acceptance_standard":"null",
                                    "uom":"null",
                                    "unit_price":"2.00",
                                    "quantity":300,
                                    "quantity_decimal":"null",
                                    "amount":"200000",
                                    "currency_code":"null",
                                    "need_date_start":"2020-01-22 02:22:11",
                                    "need_date_end":"2020-01-22 02:22:11",
                                    "buyer":"null",
                                    "address_id":null,
                                    "address_info":"null",
                                    "receiver":"null",
                                    "purchase_org_id":null,
                                    "purchase_requisition_id":PR10084,
                                    "goods_quotation_id":2323,
                                    "address_ext":"杭州市余杭区",
                                    "sku_id":1001,
                                    "gmt_create":"2020-01-22 02:22:11",
                                    "remark":"你好呀",
                                    "status":"null",
                                    "project_id":1009,
                                    "budget_id":1009,
                                    "line_number":111,
                                    "product_id":111,
                                    "is_designated_supplier":"null",
                                    "designated_supplier":"null",
                                    "pur_type":"null",
                                    "tenant_id":1222,
                                    "supplier_id":1222,
                                    "contract_code":"afd1234234324",
                                    "tax_rate":"1.01",
                                    "item_attr_info":"null",
                                    "po_unit_price":"20000",
                                    "ext":"null",
                                    "is_pr_by_detail":true,
                                    "finance_distribution_list":{
                                        "finance_distribution_top_d_t_o":[
                                            {
                                                "id":11132,
                                                "biz_id":1,
                                                "allocation_amount":"10000",
                                                "allocation_quantity":"10000",
                                                "unit_price":"10000",
                                                "total_amount":"199999",
                                                "total_quantity":"19999",
                                                "allocation_value":"333",
                                                "item_description":"这件很好",
                                                "parent_distribution_id":4,
                                                "acct_ccid":12,
                                                "source_id":122,
                                                "currency_code":"1"
                                            }
                                        ]
                                    },
                                    "order_type":"3",
                                    "surplus_amount_max":"100.00",
                                    "surplus_amount_sum":"30.00",
                                    "category_use_name":"默认规则",
                                    "category_name":"IT",
                                    "buyer_name":"嘻嘻",
                                    "cancel_amount":"20.00"
                                }
                            ]
                        },
                        "files":{
                            "aecp_file":[
                                {
                                    "id":"1",
                                    "name":"1",
                                    "url":"https:\/\/www.baidi.com",
                                    "preview_url":"https:\/\/www.baidi.com",
                                    "uploader":{
                                        "work_no":"wb8073453",
                                        "name":"李红",
                                        "nick_name":"红红"
                                    },
                                    "upload_time":"2020-01-22 02:22:11"
                                }
                            ]
                        },
                        "amount_available":"50.00",
                        "status_desc":"审批完成",
                        "ou_name":"蚂蚁",
                        "ou_code":"Z69",
                        "person_list":{
                            "person_d_t_o":[
                                {
                                    "work_no":"123456",
                                    "user_name":"张三(test)"
                                }
                            ]
                        }
                    }
                ]
            },
            "error_msg":"错误了",
            "error_level":3
        }
    }
}

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

信息平台-采购

alibaba.pr.query (pr查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈