文档中心 > API类目 > 物流API

taobao.logistics.express.modify.appoint (快递改约api)

商家通过此api操作修改物流单，交易单的收货人地址、收货人联系方式、预约配送日期

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
express_modify_appoint_top_request	ExpressModifyAppointTopRequestDto	必须			改约请求对象
└ sc_date Date 可选 2018-01-01 11:11:11 应到达日期 └ sub_trade_ids String [] 必须 11,22 子交易单号 └ trade_id String 必须 111 交易号 └ seller_id Number 必须 111 卖家Id └ receiver_mobile String 可选 133333333 收货人电话 └ os_date Date 可选 2018-01-01 11:11:11 改约日期 └ receiver_name String 可选张三收货人姓名 └ feature String 可选 a=1;b=2; 扩展字段 └ out_order_code String 可选 11111 外部订单号 └ receiver_address String 可选浙江杭州西湖区雷峰塔收货人地址

响应参数

名称	类型	示例值	描述
result	SingleResultDto		调用结果
└ is_retry Boolean false 是否需要重试 result ExpressModifyAppointTopResponseDto 业务返回结果 └ success Boolean true 是否执行成功 └ order_code String 1111111 订单号 └ error_desc String 快递改约信息不能都为空错误描述 └ trace_id String 11111 调用码 └ error_code String EXPRESS_MODIFY_APPOINT_PARAM_ALL_NULL 错误编码 └ is_idempotent Boolean false 是否幂等 └ success Boolean true 是否调用成功

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsExpressModifyAppointRequest req = new LogisticsExpressModifyAppointRequest();
LogisticsExpressModifyAppointRequest.ExpressModifyAppointTopRequestDto obj1 = new LogisticsExpressModifyAppointRequest.ExpressModifyAppointTopRequestDto();
obj1.setScDate(StringUtils.parseDateTime("2018-01-01 11:11:11"));
obj1.setSubTradeIds("11,22");
obj1.setTradeId("111");
obj1.setSellerId(111L);
obj1.setReceiverMobile("133333333");
obj1.setOsDate(StringUtils.parseDateTime("2018-01-01 11:11:11"));
obj1.setReceiverName("张三");
obj1.setFeature("a=1;b=2;");
obj1.setOutOrderCode("11111");
obj1.setReceiverAddress("浙江杭州西湖区雷峰塔");
req.setExpressModifyAppointTopRequest(obj1);
LogisticsExpressModifyAppointResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<logistics_express_modify_appoint_response>
    <result>
        <is_retry>false</is_retry>
        <result>
            <success>true</success>
            <order_code>1111111</order_code>
        </result>
        <error_desc>快递改约信息不能都为空</error_desc>
        <trace_id>11111</trace_id>
        <error_code>EXPRESS_MODIFY_APPOINT_PARAM_ALL_NULL</error_code>
        <is_idempotent>false</is_idempotent>
        <success>true</success>
    </result>
</logistics_express_modify_appoint_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工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

物流API

taobao.logistics.express.modify.appoint (快递改约api)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ