当前位置: API文档

sales_refund_push.php(创建原始退款单)

¥标准

1.接口说明

1.1 接口描述:销售订单(包括发货前和发货后)退款或退货单据推送至ERP。注:销售订单的售后换货订单此接口推送“退货类型”退款单,换出订单“trade_push.php”推送  
1.2 适用版本:网页版            
1.3 调用建议:批量推送的退款单据,每次不超过10单

1.4 注意事项:推送的原始退款单对应的销售订单必须在旺店通ERP内已经存在,否则无法生成系统售后单并进行处理。 注:仅支持自有/其他平台店铺     

2.调用场景

   2.1 自研商城、分销系统、全渠道等系统对接

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境https://openapi.ali.huice.cc/openapi/sales_refund_push.php
正式环境https://openapi.huice.com/openapi/sales_refund_push.php

   3.2 公共请求参数

名称字段类型长度
必须描述
卖家账号sidString
购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。
接口账号appkeyString
本开放平台“自助对接”功能模块内自助申请,获取方式点击这里
时间戳timestampint
北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。
签名signString
API输入参数签名结果,签名算法介绍单击这里

   3.3 业务请求参数

名称字段类型长度
必须描述
退款单节点api_refund_listdata[ ]
请求参数的1级数据节点,包含平台售后订单所有属性信息的数据节点,节点下数据字段详见下述“api_refund_list”

  api_refund_list

名称字段类型长度必须描述
平台IDplatform_idsmallint6输入固定值127
店铺idshop_idint

代表店铺所有属性的唯一id,用于店铺区分,在旺店通ERP【绑定店铺】界面查看

店铺编号shop_novarchar50代表店铺所有属性的唯一编码,用于店铺区分,在旺店通ERP【绑定店铺】界面查看,如果与shop_id同时传输,shop_no字段优先级更高
平台销售订单号tidvarchar

平台订单单号(与推送trade_push的tid保持一致

对应旺店通ERP内原始单号)

平台退款/退货单号refund_novarchar40平台退款/退货单单号,保证唯一
平台售后类型typeint

type=1:退款(未发货退款);type=2:退货退款

 type=4 退款不退货 

平台售后状态statusvarchar

可选值:1 已取消 2 申请退款,3 等待退货(卖家同意后)

  4 等待收货(买家发货后)5 退款成功 

7 拒绝买家退货待买家修改

8 卖家发出换货商品待买家签收
退款金额refund_feedecimal19,4退款金额
买家昵称buyer_nickvarchar100买家昵称(不传该字段,默认取原始订单上客户网名)
单据创建时间refund_timedatetime
单据创建时间,时间格式:yyyy-MM-dd HH:mm:ss
退款原因reasonvarchar255退款原因
备注descvarchar255备注
物流单号logistics_novarchar40

物流单号(如需维护退货物流单号

,与logistics_name物流公司名称同时使用)

物流公司名称logistics_namevarchar40物流公司名称
售后子订单order_listdata[]
售后子订单

   order_list


名称字段类型长度必须描述
平台订单子订单编号oidvarchar40

平台订单子订单编号(与推送trade_push的oid保持一致

,对应旺店通ERP内原始子订单编号)可推送部分子订单

退货货品数量numdecimal(19,4)

退货货品数量(如果是type=1 退款 

  4 退款不退货类型,此处代表退款数量)


4.响应参数

   4.1 公共响应参数

名称字段
类型长度
必须描述
错误码
codeint
返回码,0成功,非0失败
错误信息messagevarchar
返回信息
新增条数
new_countint
新增条数
更新条数chg_countint
更新条数

   

  5.请求示例


PHP
<?php
    require_once("../WdtClient.php");
    $c = new WdtClient;
    $c->sid = '';
    $c->appkey = '';
    $c->appsecret = "";
    $c->gatewayUrl = 'https://openapi.ali.huice.cc/openapi/sales_refund_push.php';
 
    $api_refund_list = array( 
	   array( 
				"tid" => "20095888033751005",
				"shop_id" => "332",
				"platform_id" => 127,
				"refund_no" => "202603240001",   
				"type" =>2 ,//2:退货退款
				"status" =>2,// 2 申请退款
				"refund_fee" => "16",
				"logistics_name"  => "邮政国内小包",
				"logistics_no"=>"YZGNXB202603240001",
				"buyer_nick" => "33",
				"refund_time" => "2026-03-24 00:00:08",
				"reason" => "不想要了",
				"desc" => "北京",
				"order_list" => array(
					array(
						"oid" => "19987739173003077",
						"num" =>1
					),
					array(
						"oid" => "12090008317300b",
						"num" =>1
					)
				
				)
			)
    );
 
    $c->putApiParam('api_refund_list',json_encode($api_refund_list,JSON_UNESCAPED_UNICODE));
    $json = $c->wdtOpenApi();
    var_dump($json);
?>
JAVA
C#
python

6.响应示例

   6.1 正常响应示例 

JSON
{
    "code": 0,
    "message": "",
    "new_count": 1,
    "chg_count": 0
}

   6.2 异常响应示例

JSON
{
    "code": 5040,
    "message": "推送订单信息错误,错误内容:售后单关联的原始单不存在,要推送售后单,也就是 给到的tid 必须在旺店通系统中存在"
}




常用工具