淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
rcv_shipment_query	RcvShipmentQuery	可选			查询单号必须传一个
└ approval_finish_start_time Date 可选 2019-12-30 12:00:00 和approval_finishl_end_time必须成对使用 └ approval_finishl_end_time Date 可选 2019-12-30 12:00:00 和approval_finish_start_time必须成对使用 └ rcv_ids Number [] 可选 [] 接收单ID └ create_start_time Date 可选 2019-12-30 12:00:00 和create_end_time必须成对使用 └ rcv_type String 可选 RECEIVE 接收单类型：RECEIVE/RETURN └ rcv_numbers String [] 可选 ["RT1000034582"] 接收单号 └ status_list String [] 可选 [] 接收单状态非必填，只传status查询不到数据：审批中AUDITING/审批完成FINISH/暂存SAVE/撤回WITHDRAW/拒绝REFUSED └ delivery_ids Number [] 可选 [] 发货单ID └ po_numbers String [] 可选 [] PO单号 └ is_new_data Boolean 可选 true 是否需要查询老数据,默认查询新+老数据传true 只查新数据 └ create_end_time Date 可选 2019-12-30 12:00:00 和create_start_time必须成对使用 └ is_need_amount_returned Boolean 可选 true 退货金额

名称	类型	示例值	描述
result	ActionResult	1	获取url的出参
content RcvTopDTO [] 1 结果内容 └ ceres Boolean true 是否是ceres数据 └ creator String 56771 创建人 └ delivery_id Number 100230929 发货单ID └ ext String {\"bizType\": \"CMALL\", \"isNeedCustoms\": \"false\"} 扩展信息 └ gmt_create Date 1594888575000 创建日期 └ gmt_modified Date 1594888575000 修改日期 └ id Number 11006357752 接收单ID └ parent_rsh_id Number null 父事务（接收行） └ rcv_date Date 1594888574000 接收日期 └ rcv_number String RT1000035192 接收单号 rcv_shipment_items RcvShipmentItemDto [] 1 接收行明细 attachments AttachmentTopDto [] 1 附件信息 └ file_size Number 5287 文件大小 └ id String b89c09351197f3e3ad80fba137abd5fabccb31d01da640e8555e80cd1d3fa6323668db95943a49d417938ca6d5355df6 id └ name String images (5).jpg 附件名称 └ preview_url String /aecp/logic/file/review?fixateEncrypt=true&id=b89c09351197f3e3ad80fba137abd5fabccb31d01da640e8555e80cd1d3fa6323668db95943a49d417938ca6d5355df6 预览 └ type String rcvInvoiceFile 类型：验收材料文件类型acceptanceMaterials / 发票材料文件类型rcvInvoiceFile └ upload_time Date null 上传时间 uploader AliEmployee null 上传者 └ name String 1 1 └ nick_name String 1 1 └ work_no String 1 1 └ url String http://elbrus-10000-daily.oss-cn-hangzhou.aliyuncs.com/purInfra/images%20%285%29_20200709153727509.jpg?Expires=1626493501&OSSAccessKeyId=LTAIIXH04e5H8MaW&Signature=qrLOt1L4lWmx%2BBj9AKC4D6GrBcI%3D 附件地址 └ biz_code String PO200017107 业务单号 └ biz_id String 451698036 业务id └ biz_type String ORDER 业务类型 └ category_code String IA05 采购类目代码 └ category_use String ZD_YTGZ 用途code └ company_code String 45 公司编码 └ creator String null 创建人 └ currency_code String CNY 币种 └ deductions_amount String 0 扣款金额 └ delivery_by_detail Boolean false 是否发货明细 └ delivery_item_id Number 100849489 发货行ID └ demander String 56771 实际需求方工号 └ detail_by_asset_management Boolean false 是否按资产管理 └ evaluate_month_end Date 2019-12-12 10:00:00 费用归属结束月份 └ evaluate_month_start Date 2019-12-12 10:00:00 费用归属起始月份 └ expense_month Date 2019-12-12 10:00:00 费用归属日期 └ gmt_approval_finish Date 2019-12-12 10:00:00 审批通过时间 └ gmt_create Date 1594280356000 创建日期 └ gmt_modified Date 1594280356000 修改日期 └ id Number 100849478 接收行ID └ item_ext String {\"poId\": 451698036, \"isAap\": false, \"isTypeCto\": \"n\", \"isGstRelated\": \"n\", \"isWhtRelated\": \"n\", \"isStructureItemAap\": false, \"autoAccruedWriteoff\": \"n\"} 行的扩展信息 └ item_id String 200015112 订单明细ID └ line_num Number 1 行号 └ order_type String AMOUNT 购买方式：QUANTITY / AMOUNT └ parent_rsh_id Number null 父事务（接收行） └ purchase_org_id Number 1051 采购组织 └ quantity_accept String 100 验收数量/金额 └ quantity_received String 100 接收/退货数量/金额 └ rcv_date Date 2019-12-12 10:00:00 接收/退货日期 └ rcv_shipment_id Number 9542637856 接收单ID └ receiver String 56771 收货人工号 └ remark String OZ-接收详情描述 └ status String AUDITING 接收单状态 └ structure_item_aap Boolean null 是否在结构化录入收货（原 amp） └ tax_code String null 税码 └ tax_rate String 0.0025 税率 └ tenant_id String null 租户ID └ unit_price String 1 单价 └ uom String cny 计价单位 └ amount_returned BigDecimal 1 退货金额 └ rcv_type String RECEIVE 接收单类型 └ remark String 接收详情描述描述 └ source_type String null 来源 └ supplier_id Number 628 供应商id └ tenant_id String 10000 租户ID └ error_code String null 错误code └ error_level Number null 错误级别 └ error_msg String null 错误信息 └ success Boolean true 是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaPurRcvGetRequest req = new AlibabaPurRcvGetRequest();
AlibabaPurRcvGetRequest.RcvShipmentQuery obj1 = new AlibabaPurRcvGetRequest.RcvShipmentQuery();
obj1.setApprovalFinishStartTime(StringUtils.parseDateTime("2019-12-30 12:00:00"));
obj1.setApprovalFinishlEndTime(StringUtils.parseDateTime("2019-12-30 12:00:00"));
obj1.setRcvIds(new Long[] {  };
);
obj1.setCreateStartTime(StringUtils.parseDateTime("2019-12-30 12:00:00"));
obj1.setRcvType("RECEIVE");
obj1.setRcvNumbers(""RT1000034582"");
obj1.setStatusList("");
obj1.setDeliveryIds(new Long[] {  };
);
obj1.setPoNumbers("");
obj1.setIsNewData(true);
obj1.setCreateEndTime(StringUtils.parseDateTime("2019-12-30 12:00:00"));
obj1.setIsNeedAmountReturned(true);
req.setRcvShipmentQuery(obj1);
AlibabaPurRcvGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaPurRcvGetRequest req = new AlibabaPurRcvGetRequest();
AlibabaPurRcvGetRequest.RcvShipmentQueryDomain obj1 = new AlibabaPurRcvGetRequest.RcvShipmentQueryDomain();
obj1.ApprovalFinishStartTime = DateTime.Parse(2019-12-30 12:00:00");
obj1.ApprovalFinishlEndTime = DateTime.Parse(2019-12-30 12:00:00");
obj1.RcvIds = new long[] {  };
;
obj1.CreateStartTime = DateTime.Parse(2019-12-30 12:00:00");
obj1.RcvType = "RECEIVE";
obj1.RcvNumbers = ""RT1000034582"";
obj1.StatusList = "";
obj1.DeliveryIds = new long[] {  };
;
obj1.PoNumbers = "";
obj1.IsNewData = true;
obj1.CreateEndTime = DateTime.Parse(2019-12-30 12:00:00");
obj1.IsNeedAmountReturned = true;
req.RcvShipmentQuery_ = obj1;
AlibabaPurRcvGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaPurRcvGetRequest;
$rcv_shipment_query = new RcvShipmentQuery;
$rcv_shipment_query->approval_finish_start_time="2019-12-30 12:00:00";
$rcv_shipment_query->approval_finishl_end_time="2019-12-30 12:00:00";
$rcv_shipment_query->rcv_ids="[]";
$rcv_shipment_query->create_start_time="2019-12-30 12:00:00";
$rcv_shipment_query->rcv_type="RECEIVE";
$rcv_shipment_query->rcv_numbers="[\"RT1000034582\"]";
$rcv_shipment_query->status_list="[]";
$rcv_shipment_query->delivery_ids="[]";
$rcv_shipment_query->po_numbers="[]";
$rcv_shipment_query->is_new_data="true";
$rcv_shipment_query->create_end_time="2019-12-30 12:00:00";
$rcv_shipment_query->is_need_amount_returned="true";
$req->setRcvShipmentQuery(json_encode($rcv_shipment_query));
$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.pur.rcv.get' \
-d 'partner_id=apidoc' \
-d 'sign=BA67314A4FFF1AD5206E66369E663E33' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-16+20%3A10%3A34' \
-d 'v=2.0' \
-d 'rcv_shipment_query=null'

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

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

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

XML示例
JSON示例

<alibaba_pur_rcv_get_response>
    <result>
        <content>
            <rcv_top_d_t_o>
                <ceres>true</ceres>
                <creator>56771</creator>
                <delivery_id>100230929</delivery_id>
                <ext>{\&quot;bizType\&quot;: \&quot;CMALL\&quot;, \&quot;isNeedCustoms\&quot;: \&quot;false\&quot;}</ext>
                <gmt_create>1594888575000</gmt_create>
                <gmt_modified>1594888575000</gmt_modified>
                <id>11006357752</id>
                <parent_rsh_id>null</parent_rsh_id>
                <rcv_date>1594888574000</rcv_date>
                <rcv_number>RT1000035192</rcv_number>
                <rcv_shipment_items>
                    <rcv_shipment_item_dto>
                        <attachments>
                            <attachment_top_dto>
                                <file_size>5287</file_size>
                                <id>b89c09351197f3e3ad80fba137abd5fabccb31d01da640e8555e80cd1d3fa6323668db95943a49d417938ca6d5355df6</id>
                                <name>images (5).jpg</name>
                                <preview_url>/aecp/logic/file/review?fixateEncrypt=true&amp;id=b89c09351197f3e3ad80fba137abd5fabccb31d01da640e8555e80cd1d3fa6323668db95943a49d417938ca6d5355df6</preview_url>
                                <type>rcvInvoiceFile</type>
                                <upload_time>null</upload_time>
                                <uploader>
                                    <name>1</name>
                                    <nick_name>1</nick_name>
                                    <work_no>1</work_no>
                                </uploader>
                                <url>http://elbrus-10000-daily.oss-cn-hangzhou.aliyuncs.com/purInfra/images%20%285%29_20200709153727509.jpg?Expires=1626493501&amp;OSSAccessKeyId=LTAIIXH04e5H8MaW&amp;Signature=qrLOt1L4lWmx%2BBj9AKC4D6GrBcI%3D</url>
                            </attachment_top_dto>
                        </attachments>
                        <biz_code>PO200017107</biz_code>
                        <biz_id>451698036</biz_id>
                        <biz_type>ORDER</biz_type>
                        <category_code>IA05</category_code>
                        <category_use>ZD_YTGZ</category_use>
                        <company_code>45</company_code>
                        <creator>null</creator>
                        <currency_code>CNY</currency_code>
                        <deductions_amount>0</deductions_amount>
                        <delivery_by_detail>false</delivery_by_detail>
                        <delivery_item_id>100849489</delivery_item_id>
                        <demander>56771</demander>
                        <detail_by_asset_management>false</detail_by_asset_management>
                        <evaluate_month_end>2019-12-12 10:00:00</evaluate_month_end>
                        <evaluate_month_start>2019-12-12 10:00:00</evaluate_month_start>
                        <expense_month>2019-12-12 10:00:00</expense_month>
                        <gmt_approval_finish>2019-12-12 10:00:00</gmt_approval_finish>
                        <gmt_create>1594280356000</gmt_create>
                        <gmt_modified>1594280356000</gmt_modified>
                        <id>100849478</id>
                        <item_ext>{\&quot;poId\&quot;: 451698036, \&quot;isAap\&quot;: false, \&quot;isTypeCto\&quot;: \&quot;n\&quot;, \&quot;isGstRelated\&quot;: \&quot;n\&quot;, \&quot;isWhtRelated\&quot;: \&quot;n\&quot;, \&quot;isStructureItemAap\&quot;: false, \&quot;autoAccruedWriteoff\&quot;: \&quot;n\&quot;}</item_ext>
                        <item_id>200015112</item_id>
                        <line_num>1</line_num>
                        <order_type>AMOUNT</order_type>
                        <parent_rsh_id>null</parent_rsh_id>
                        <purchase_org_id>1051</purchase_org_id>
                        <quantity_accept>100</quantity_accept>
                        <quantity_received>100</quantity_received>
                        <rcv_date>2019-12-12 10:00:00</rcv_date>
                        <rcv_shipment_id>9542637856</rcv_shipment_id>
                        <receiver>56771</receiver>
                        <remark>OZ-接收详情</remark>
                        <status>AUDITING</status>
                        <structure_item_aap>null</structure_item_aap>
                        <tax_code>null</tax_code>
                        <tax_rate>0.0025</tax_rate>
                        <tenant_id>null</tenant_id>
                        <unit_price>1</unit_price>
                        <uom>cny</uom>
                        <amount_returned>1</amount_returned>
                    </rcv_shipment_item_dto>
                </rcv_shipment_items>
                <rcv_type>RECEIVE</rcv_type>
                <remark>接收详情描述</remark>
                <source_type>null</source_type>
                <supplier_id>628</supplier_id>
                <tenant_id>10000</tenant_id>
            </rcv_top_d_t_o>
        </content>
        <error_code>null</error_code>
        <error_level>null</error_level>
        <error_msg>null</error_msg>
        <success>true</success>
    </result>
</alibaba_pur_rcv_get_response>

{
    "alibaba_pur_rcv_get_response":{
        "result":{
            "content":{
                "rcv_top_d_t_o":[
                    {
                        "ceres":true,
                        "creator":"56771",
                        "delivery_id":100230929,
                        "ext":"{\\\"bizType\\\": \\\"CMALL\\\", \\\"isNeedCustoms\\\": \\\"false\\\"}",
                        "gmt_create":"1594888575000",
                        "gmt_modified":"1594888575000",
                        "id":11006357752,
                        "parent_rsh_id":null,
                        "rcv_date":"1594888574000",
                        "rcv_number":"RT1000035192",
                        "rcv_shipment_items":{
                            "rcv_shipment_item_dto":[
                                {
                                    "attachments":{
                                        "attachment_top_dto":[
                                            {
                                                "file_size":5287,
                                                "id":"b89c09351197f3e3ad80fba137abd5fabccb31d01da640e8555e80cd1d3fa6323668db95943a49d417938ca6d5355df6",
                                                "name":"images (5).jpg",
                                                "preview_url":"\/aecp\/logic\/file\/review?fixateEncrypt=true&id=b89c09351197f3e3ad80fba137abd5fabccb31d01da640e8555e80cd1d3fa6323668db95943a49d417938ca6d5355df6",
                                                "type":"rcvInvoiceFile",
                                                "upload_time":"null",
                                                "uploader":{
                                                    "name":"1",
                                                    "nick_name":"1",
                                                    "work_no":"1"
                                                },
                                                "url":"http:\/\/elbrus-10000-daily.oss-cn-hangzhou.aliyuncs.com\/purInfra\/images%20%285%29_20200709153727509.jpg?Expires=1626493501&OSSAccessKeyId=LTAIIXH04e5H8MaW&Signature=qrLOt1L4lWmx%2BBj9AKC4D6GrBcI%3D"
                                            }
                                        ]
                                    },
                                    "biz_code":"PO200017107",
                                    "biz_id":"451698036",
                                    "biz_type":"ORDER",
                                    "category_code":"IA05",
                                    "category_use":"ZD_YTGZ",
                                    "company_code":"45",
                                    "creator":"null",
                                    "currency_code":"CNY",
                                    "deductions_amount":"0",
                                    "delivery_by_detail":false,
                                    "delivery_item_id":100849489,
                                    "demander":"56771",
                                    "detail_by_asset_management":false,
                                    "evaluate_month_end":"2019-12-12 10:00:00",
                                    "evaluate_month_start":"2019-12-12 10:00:00",
                                    "expense_month":"2019-12-12 10:00:00",
                                    "gmt_approval_finish":"2019-12-12 10:00:00",
                                    "gmt_create":"1594280356000",
                                    "gmt_modified":"1594280356000",
                                    "id":100849478,
                                    "item_ext":"{\\\"poId\\\": 451698036, \\\"isAap\\\": false, \\\"isTypeCto\\\": \\\"n\\\", \\\"isGstRelated\\\": \\\"n\\\", \\\"isWhtRelated\\\": \\\"n\\\", \\\"isStructureItemAap\\\": false, \\\"autoAccruedWriteoff\\\": \\\"n\\\"}",
                                    "item_id":"200015112",
                                    "line_num":1,
                                    "order_type":"AMOUNT",
                                    "parent_rsh_id":null,
                                    "purchase_org_id":1051,
                                    "quantity_accept":"100",
                                    "quantity_received":"100",
                                    "rcv_date":"2019-12-12 10:00:00",
                                    "rcv_shipment_id":9542637856,
                                    "receiver":"56771",
                                    "remark":"OZ-接收详情",
                                    "status":"AUDITING",
                                    "structure_item_aap":null,
                                    "tax_code":"null",
                                    "tax_rate":"0.0025",
                                    "tenant_id":"null",
                                    "unit_price":"1",
                                    "uom":"cny",
                                    "amount_returned":"1"
                                }
                            ]
                        },
                        "rcv_type":"RECEIVE",
                        "remark":"接收详情描述",
                        "source_type":"null",
                        "supplier_id":628,
                        "tenant_id":"10000"
                    }
                ]
            },
            "error_code":"null",
            "error_level":null,
            "error_msg":"null",
            "success":true
        }
    }
}

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.pur.rcv.get (接收单查询外部接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ