淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
validity_period_sync_req_dto	ValidityPeriodSyncReqDTO	可选			请求体
└ supplier_id Number 必须 111 供应商ID items ValidityPeriodItem [] 必须 [{"sub_items":[{"produce_date":"2020-11-01","quantity":10,"expire_date":"2023-11-01","produce_no":"10001"}],"sc_item_name":"货品123","sc_item_id":"123","barcode":"123","manufacturer":"某某制药","approval_number":"国药准字Z123","specification":"5支/盒"}] 请求明细 └ sc_item_name String 可选货品123 货品名称 sub_items ValidityPeriodSubItem [] 必须 [{ "produce_date": "2020-11-01", "quantity": 10, "expire_date": "2023-11-01", "produce_no": "10001" }] 请求子明细 └ produce_date String 必须 2020-11-01 生产日期 └ quantity Number 必须 10 数量 └ expire_date String 必须 2023-11-01 失效日期 └ produce_no String 必须 1001 生产批号 └ specification String 必须 5支/盒规格 └ sc_item_id Number 必须 123 货品ID └ approval_number String 必须国药准字Z123 批准文号 └ barcode String 必须 123 条码 └ manufacturer String 必须某某制药生产企业 └ store_code String 必须 ABC123 仓库编码

名称	类型	示例值	描述
trace_id	String	123	链路跟踪id, 用于排查问题
can_retry	Boolean	false	请求是否可重试
succ	Boolean	true	当前请求是否成功-所有明细都成功才算成功
error_no	String	ALIHEALTH.BC.4000	错误编码, 编码以"ALIHEALTH.BC.5"开头时表示当前品仓的操作处于未知状态, 后继可通过同样的请求流水号来获取最终结果
error_msg	String	系统异常	错误描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthBcItemPeriodSyncRequest req = new AlibabaAlihealthBcItemPeriodSyncRequest();
AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodSyncReqDTO obj1 = new AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodSyncReqDTO();
obj1.setSupplierId(111L);
List<AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodItem> list3 = new ArrayList<AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodItem>();
AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodItem obj4 = new AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodItem();
list3.add(obj4);
obj4.setScItemName("货品123");
List<AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodSubItem> list7 = new ArrayList<AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodSubItem>();
AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodSubItem obj8 = new AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodSubItem();
list7.add(obj8);
obj8.setProduceDate("2020-11-01");
obj8.setQuantity(10L);
obj8.setExpireDate("2023-11-01");
obj8.setProduceNo("1001");
list5.setSubItems(list7);
obj4.setSpecification("5支/盒");
obj4.setScItemId(123L);
obj4.setApprovalNumber("国药准字Z123");
obj4.setBarcode("123");
obj4.setManufacturer("某某制药");
obj1.setItems(list3);
obj1.setStoreCode("ABC123");
req.setValidityPeriodSyncReqDto(obj1);
AlibabaAlihealthBcItemPeriodSyncResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthBcItemPeriodSyncRequest req = new AlibabaAlihealthBcItemPeriodSyncRequest();
AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodSyncReqDTODomain obj1 = new AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodSyncReqDTODomain();
obj1.SupplierId = 111L;
List<AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodItemDomain> list3 = new List<AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodItemDomain>();
AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodItemDomain obj4 = new AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodItemDomain();
list3.Add(obj4);
obj4.ScItemName = "货品123";
List<AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodSubItemDomain> list6 = new List<AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodSubItemDomain>();
AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodSubItemDomain obj7 = new AlibabaAlihealthBcItemPeriodSyncRequest.ValidityPeriodSubItemDomain();
list6.Add(obj7);
obj7.ProduceDate = "2020-11-01";
obj7.Quantity = 10L;
obj7.ExpireDate = "2023-11-01";
obj7.ProduceNo = "1001";
obj4.SubItems= list6;
obj4.Specification = "5支/盒";
obj4.ScItemId = 123L;
obj4.ApprovalNumber = "国药准字Z123";
obj4.Barcode = "123";
obj4.Manufacturer = "某某制药";
obj1.Items= list3;
obj1.StoreCode = "ABC123";
req.ValidityPeriodSyncReqDto_ = obj1;
AlibabaAlihealthBcItemPeriodSyncResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthBcItemPeriodSyncRequest;
$validity_period_sync_req_dto = new ValidityPeriodSyncReqDTO;
$validity_period_sync_req_dto->supplier_id="111";
$items = new ValidityPeriodItem;
$items->sc_item_name="货品123";
$sub_items = new ValidityPeriodSubItem;
$sub_items->produce_date="2020-11-01";
$sub_items->quantity="10";
$sub_items->expire_date="2023-11-01";
$sub_items->produce_no="1001";
$items->sub_items = $sub_items;
$items->specification="5支/盒";
$items->sc_item_id="123";
$items->approval_number="国药准字Z123";
$items->barcode="123";
$items->manufacturer="某某制药";
$validity_period_sync_req_dto->items = $items;
$validity_period_sync_req_dto->store_code="ABC123";
$req->setValidityPeriodSyncReqDto(json_encode($validity_period_sync_req_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.alihealth.bc.item.period.sync' \
-d 'partner_id=apidoc' \
-d 'sign=6D14205B00A6BADCBC5505EA383B016C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-24+16%3A09%3A42' \
-d 'v=2.0' \
-d 'validity_period_sync_req_dto=null'

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

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

req.validity_period_sync_req_dto="数据结构示例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,"alibaba.alihealth.bc.item.period.sync");
add_param(pRequest,"validity_period_sync_req_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.alihealth.bc.item.period.sync', {
	'validity_period_sync_req_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_bc_item_period_sync_response>
    <trace_id>123</trace_id>
    <can_retry>false</can_retry>
    <succ>true</succ>
    <error_no>ALIHEALTH.BC.4000</error_no>
    <error_msg>系统异常</error_msg>
</alibaba_alihealth_bc_item_period_sync_response>

{
    "alibaba_alihealth_bc_item_period_sync_response":{
        "trace_id":"123",
        "can_retry":false,
        "succ":true,
        "error_no":"ALIHEALTH.BC.4000",
        "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.alihealth.bc.item.period.sync (代销品效期同步)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ