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

qimen.taobao.taotian.settle.bill.sync (淘天物流部结算账单同步)

官方退货结算账单同步服务商

公共参数

请求地址：

环境	HTTP请求地址
正式环境	http://qimen.api.taobao.com/router/qm
测试环境	http://qimen.api.taobao.com/router/qmtest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
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。
customerId	String	是	WMS颁发给用户的ID
sign_method	String	是	签名的摘要算法，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
id	Number	必须	123	最大长度：64	结算账单编号
bill_gmt_create	String	必须	2023-12-12 00:00:00	最大长度：64	账单创建时间
pay_time	String	可选	2023-12-12 00:00:00	最大长度：64	账单打款时间
order_gmt_create	String	可选	2023-12-12 00:00:00	最大长度：64	接单时间
order_no	String	必须	AX123	最大长度：64	结算业务单号
pay_sequence	String	可选	12334444	最大长度：128	结算打款单号
charge_amount	String	必须	9.9	最大长度：16	计费金额（元）
mail_no	String	必须	123	最大长度：64	快递运单号
fee_code	String	必须	HOME_RECYCLING_ASSIST_SERVICE	最大长度：64	费用项code
fee_name	String	必须	官方逆向收件服务费(有抛重)	最大长度：64	费用项名称
tax_rate	String	可选	0.3	最大长度：16	税率
package_weight	String	可选	500.12	最大长度：16	包裹重量(kg)
package_length	String	可选	20.12	最大长度：16	包裹长(cm)
package_width	String	可选	20.12	最大长度：16	包裹宽（cm）
package_heigh	String	可选	20.12	最大长度：16	包裹高(cm)
charge_weight	String	可选	800.22	最大长度：16	计费重量(kg)
receive_address_code	String	可选	110330	最大长度：64	收货地址code
receive_address_name	String	可选	浙江省杭州市西湖区XX	最大长度：256	收货地址code名称
send_address_code	String	可选	33333	最大长度：64	寄件地址code
send_address_name	String	可选	浙江省杭州市余杭区XX	最大长度：256	寄件地址名称
first_weight	String	可选	222.22	最大长度：16	首续重重量(kg)
first_weight_price	String	可选	1.2	最大长度：16	首续重单价(元)
second_weight	String	可选	888.22	最大长度：16	续重重量(kg)
second_weight_price	String	可选	2.2	最大长度：16	续重单价(元)
supplier_id	String	必须	877987	最大长度：64	服务商code
business_scene_code	String	必须	GFTH	最大长度：64	服务场景code
business_scene_name	String	必须	官方退货	最大长度：64	服务场景名称
charge_node_code	String	必须	take	最大长度：64	计费节点code
charge_node_name	String	可选	揽收	最大长度：64	计费节点名称
bill_type	String	必须	正常，调账	最大长度：16	账单类型
status	String	必须	打款成功	最大长度：16	状态
features	String	可选	key1=1;key2=3;key3=3;	最大长度：512	扩展字段

响应参数

名称	类型	示例值	描述
success	Boolean	true	系统成功失败 true\|false
error_message	String	操作失败	错误信息
error_code	String	10001	错误码
is_retry	Boolean	true	是否可重试

请求示例

{"order_no":"AX123","first_weight_price":"1.2","business_scene_code":"GFTH","order_gmt_create":"2023-12-12 00:00:00","mail_no":"123","tax_rate":"0.3","features":"key1=1;key2=3;key3=3;","package_heigh":"20.12","pay_sequence":"12334444","fee_code":"HOME_RECYCLING_ASSIST_SERVICE","package_length":"20.12","bill_type":"正常，调账","id":123,"bill_gmt_create":"2023-12-12 00:00:00","receive_address_name":"浙江省杭州市西湖区XX","charge_node_code":"take","business_scene_name":"官方退货","send_address_name":"浙江省杭州市余杭区XX","pay_time":"2023-12-12 00:00:00","fee_name":"官方逆向收件服务费(有抛重)","charge_weight":"800.22","package_width":"20.12","send_address_code":"33333","first_weight":"222.22","charge_node_name":"揽收","package_weight":"500.12","second_weight":"888.22","second_weight_price":"2.2","receive_address_code":"110330","supplier_id":"877987","charge_amount":"9.9","status":"打款成功"}

响应示例

{
    "success":true,
    "error_message":"操作失败",
    "error_code":"10001",
    "is_retry":true
}

验签示例

{"error_message":"Illegal request","success":"false","error_code":"sign-check-failure"}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部