淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
ins_lock_user_qwyfx_equity_request	InsLockUserQwyfxEquityRequest	可选			下单请求参数
└ company_code String 必须 CAINIAO 物流公司编码 └ biz_type String 必须 YFX_WYG_DISCOUNT 全网运费险业务码写死 └ out_logistics_no String 必须 23433443 物流单号-如果是菜鸟，则是菜鸟订单号 └ out_biz_no String 必须 2022092106230710386966_1663728676891 幂等单号 └ user_id String 必须 2233443 用户id └ image_url String 可选 /ds/sfd 图片路径 reserve_time LogisticsReserveTime 必须快递员上门预约时间 └ start_time Date 必须 2022-01-01 00:00:00 快递员上门预约开始时间 └ end_time Date 必须 2023-01-01 00:00:00 快递员上门预约结束时间 └ logistics_mail_no String 可选 23433443 承运物流单号 └ biz_data String 必须 {"goodsKinds":"衣帽鞋服"} 下单业务字段 └ equity_id String 必须 2343343 权益id └ post_type String 必须 HOME_DELIVERY 寄件类型：上门取件:HOME_DELIVERY,服务点寄件:STATION,快递寄柜寄件:EXPRESS_BOX └ pay_status String 可选 0 支付状态 └ origin_fee Number 必须 1800 线路原价 └ alipay_user_id String 可选 2088 支付宝id └ entrance String 必须 CAINIAO 寄件渠道 sender LogisticsAddress 必须寄件地址 └ area_code String 必须 330481 地址编码 └ address String 必须浙江省金华市东阳市吴宁街道吴宁镇竹园路详细地址 └ name String 必须张三姓名 └ phone String 必须 1234567855 联系方式 └ province String 必须浙江省省 └ city String 必须金华市市 └ area String 必须东阳市区/县 receiver LogisticsAddress 必须收件地址 └ area_code String 必须 330481 地址编码 └ address String 必须浙江省金华市东阳市吴宁街道吴宁镇竹园路详细地址 └ name String 必须李四姓名 └ phone String 必须 1234567856 联系方式 └ province String 必须浙江省省 └ area String 必须东阳市区/县 └ city String 必须金华市市 └ agreement_fee Number 必须 1200 线路协议价 └ goods_kinds String 必须衣服物品类型 └ user_type String 必须 TAOBAO 用户类型：TAOBAO,ALIPAY └ dispute_id Number 可选 1232343 逆向退货id └ biz_order_id Number 可选 12343443 订单id └ auth_type String 必须 NUMBER 认证码类型:{"NUMBER":"数字码","QR_CODE": "二维码","NONE"："不需要"} └ auth_code String 必须 873745 认证码

名称	类型	示例值	描述
qwyfx_success	Boolean	true	是否调用成功
qwyfx_error_code	String	-1	错误码
model	InsLockUserQwyfxEquityResponse		物流下单返回
└ logistics_no String 20234334 物流下单蚂蚁业务单号
error_msg	String	-1	错误信息
is_success	Boolean	true	是否调用成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlipayBaoxianQwyfxEquityLockRequest req = new AlipayBaoxianQwyfxEquityLockRequest();
AlipayBaoxianQwyfxEquityLockRequest.InsLockUserQwyfxEquityRequest obj1 = new AlipayBaoxianQwyfxEquityLockRequest.InsLockUserQwyfxEquityRequest();
obj1.setCompanyCode("CAINIAO");
obj1.setBizType("YFX_WYG_DISCOUNT");
obj1.setOutLogisticsNo("23433443");
obj1.setOutBizNo("2022092106230710386966_1663728676891");
obj1.setUserId("2233443");
obj1.setImageUrl("/ds/sfd");
AlipayBaoxianQwyfxEquityLockRequest.LogisticsReserveTime obj2 = new AlipayBaoxianQwyfxEquityLockRequest.LogisticsReserveTime();
obj2.setStartTime(StringUtils.parseDateTime("2022-01-01 00:00:00"));
obj2.setEndTime(StringUtils.parseDateTime("2023-01-01 00:00:00"));
obj1.setReserveTime(obj2);
obj1.setLogisticsMailNo("23433443");
obj1.setBizData("{\"goodsKinds\":\"衣帽鞋服\"}");
obj1.setEquityId("2343343");
obj1.setPostType("HOME_DELIVERY");
obj1.setPayStatus("0");
obj1.setOriginFee(1800L);
obj1.setAlipayUserId("2088");
obj1.setEntrance("CAINIAO");
AlipayBaoxianQwyfxEquityLockRequest.LogisticsAddress obj3 = new AlipayBaoxianQwyfxEquityLockRequest.LogisticsAddress();
obj3.setAreaCode("330481");
obj3.setAddress("浙江省金华市东阳市吴宁街道吴宁镇竹园路");
obj3.setName("张三");
obj3.setPhone("1234567855");
obj3.setProvince("浙江省");
obj3.setCity("金华市");
obj3.setArea("东阳市");
obj1.setSender(obj3);
AlipayBaoxianQwyfxEquityLockRequest.LogisticsAddress obj4 = new AlipayBaoxianQwyfxEquityLockRequest.LogisticsAddress();
obj4.setAreaCode("330481");
obj4.setAddress("浙江省金华市东阳市吴宁街道吴宁镇竹园路");
obj4.setName("李四");
obj4.setPhone("1234567856");
obj4.setProvince("浙江省");
obj4.setArea("东阳市");
obj4.setCity("金华市");
obj1.setReceiver(obj4);
obj1.setAgreementFee(1200L);
obj1.setGoodsKinds("衣服");
obj1.setUserType("TAOBAO");
obj1.setDisputeId(1232343L);
obj1.setBizOrderId(12343443L);
obj1.setAuthType("NUMBER");
obj1.setAuthCode("873745");
req.setInsLockUserQwyfxEquityRequest(obj1);
AlipayBaoxianQwyfxEquityLockResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlipayBaoxianQwyfxEquityLockRequest req = new AlipayBaoxianQwyfxEquityLockRequest();
AlipayBaoxianQwyfxEquityLockRequest.InsLockUserQwyfxEquityRequestDomain obj1 = new AlipayBaoxianQwyfxEquityLockRequest.InsLockUserQwyfxEquityRequestDomain();
obj1.CompanyCode = "CAINIAO";
obj1.BizType = "YFX_WYG_DISCOUNT";
obj1.OutLogisticsNo = "23433443";
obj1.OutBizNo = "2022092106230710386966_1663728676891";
obj1.UserId = "2233443";
obj1.ImageUrl = "/ds/sfd";
AlipayBaoxianQwyfxEquityLockRequest.LogisticsReserveTimeDomain obj2 = new AlipayBaoxianQwyfxEquityLockRequest.LogisticsReserveTimeDomain();
obj2.StartTime = DateTime.Parse(2022-01-01 00:00:00");
obj2.EndTime = DateTime.Parse(2023-01-01 00:00:00");
obj1.ReserveTime= obj2;
obj1.LogisticsMailNo = "23433443";
obj1.BizData = "{\"goodsKinds\":\"衣帽鞋服\"}";
obj1.EquityId = "2343343";
obj1.PostType = "HOME_DELIVERY";
obj1.PayStatus = "0";
obj1.OriginFee = 1800L;
obj1.AlipayUserId = "2088";
obj1.Entrance = "CAINIAO";
AlipayBaoxianQwyfxEquityLockRequest.LogisticsAddressDomain obj3 = new AlipayBaoxianQwyfxEquityLockRequest.LogisticsAddressDomain();
obj3.AreaCode = "330481";
obj3.Address = "浙江省金华市东阳市吴宁街道吴宁镇竹园路";
obj3.Name = "张三";
obj3.Phone = "1234567855";
obj3.Province = "浙江省";
obj3.City = "金华市";
obj3.Area = "东阳市";
obj1.Sender= obj3;
AlipayBaoxianQwyfxEquityLockRequest.LogisticsAddressDomain obj4 = new AlipayBaoxianQwyfxEquityLockRequest.LogisticsAddressDomain();
obj4.AreaCode = "330481";
obj4.Address = "浙江省金华市东阳市吴宁街道吴宁镇竹园路";
obj4.Name = "李四";
obj4.Phone = "1234567856";
obj4.Province = "浙江省";
obj4.Area = "东阳市";
obj4.City = "金华市";
obj1.Receiver= obj4;
obj1.AgreementFee = 1200L;
obj1.GoodsKinds = "衣服";
obj1.UserType = "TAOBAO";
obj1.DisputeId = 1232343L;
obj1.BizOrderId = 12343443L;
obj1.AuthType = "NUMBER";
obj1.AuthCode = "873745";
req.InsLockUserQwyfxEquityRequest_ = obj1;
AlipayBaoxianQwyfxEquityLockResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlipayBaoxianQwyfxEquityLockRequest;
$ins_lock_user_qwyfx_equity_request = new InsLockUserQwyfxEquityRequest;
$ins_lock_user_qwyfx_equity_request->company_code="CAINIAO";
$ins_lock_user_qwyfx_equity_request->biz_type="YFX_WYG_DISCOUNT";
$ins_lock_user_qwyfx_equity_request->out_logistics_no="23433443";
$ins_lock_user_qwyfx_equity_request->out_biz_no="2022092106230710386966_1663728676891";
$ins_lock_user_qwyfx_equity_request->user_id="2233443";
$ins_lock_user_qwyfx_equity_request->image_url="/ds/sfd";
$reserve_time = new LogisticsReserveTime;
$reserve_time->start_time="2022-01-01 00:00:00";
$reserve_time->end_time="2023-01-01 00:00:00";
$ins_lock_user_qwyfx_equity_request->reserve_time = $reserve_time;
$ins_lock_user_qwyfx_equity_request->logistics_mail_no="23433443";
$ins_lock_user_qwyfx_equity_request->biz_data="{\"goodsKinds\":\"衣帽鞋服\"}";
$ins_lock_user_qwyfx_equity_request->equity_id="2343343";
$ins_lock_user_qwyfx_equity_request->post_type="HOME_DELIVERY";
$ins_lock_user_qwyfx_equity_request->pay_status="0";
$ins_lock_user_qwyfx_equity_request->origin_fee="1800";
$ins_lock_user_qwyfx_equity_request->alipay_user_id="2088";
$ins_lock_user_qwyfx_equity_request->entrance="CAINIAO";
$sender = new LogisticsAddress;
$sender->area_code="330481";
$sender->address="浙江省金华市东阳市吴宁街道吴宁镇竹园路";
$sender->name="张三";
$sender->phone="1234567855";
$sender->province="浙江省";
$sender->city="金华市";
$sender->area="东阳市";
$ins_lock_user_qwyfx_equity_request->sender = $sender;
$receiver = new LogisticsAddress;
$receiver->area_code="330481";
$receiver->address="浙江省金华市东阳市吴宁街道吴宁镇竹园路";
$receiver->name="李四";
$receiver->phone="1234567856";
$receiver->province="浙江省";
$receiver->area="东阳市";
$receiver->city="金华市";
$ins_lock_user_qwyfx_equity_request->receiver = $receiver;
$ins_lock_user_qwyfx_equity_request->agreement_fee="1200";
$ins_lock_user_qwyfx_equity_request->goods_kinds="衣服";
$ins_lock_user_qwyfx_equity_request->user_type="TAOBAO";
$ins_lock_user_qwyfx_equity_request->dispute_id="1232343";
$ins_lock_user_qwyfx_equity_request->biz_order_id="12343443";
$ins_lock_user_qwyfx_equity_request->auth_type="NUMBER";
$ins_lock_user_qwyfx_equity_request->auth_code="873745";
$req->setInsLockUserQwyfxEquityRequest(json_encode($ins_lock_user_qwyfx_equity_request));
$resp = $c->execute($req);

XML示例
JSON示例

<alipay_baoxian_qwyfx_equity_lock_response>
    <qwyfx_success>true</qwyfx_success>
    <qwyfx_error_code>-1</qwyfx_error_code>
    <model>
        <logistics_no>20234334</logistics_no>
    </model>
    <error_msg>-1</error_msg>
    <is_success>true</is_success>
</alipay_baoxian_qwyfx_equity_lock_response>

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>

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

保险API

alipay.baoxian.qwyfx.equity.lock (用户用户全网运费险下单锁定)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ