# 退货退款订单添加


开发之前需拥有一个腾讯数据接入数据源 (dataSourceId),可将 dataSourceId 理解为数据的集合。创建一个数据源后,所有接口传输数据时都可重复使用。


# 请求地址

域名/data-api/v1/return_order/add


# 请求方法

POST


# 请求参数

参数名 样例 描述
app_id abc 分配的app_id
nonce 61794670f155b 随机字符串
sign sha256 签名算法
timestamp 1569232087 请求时间戳(秒级)
signature aee30792812d7b09ba7d3aa67c24e16c6a7ea81282ac728ad5966dd1b3eef6d5 签名结果

# 请求体类型

application/json


# 请求体参数

名称
类型
必填
描述
dataSourceIdstringY数据源id(create方法返回的data.dataSource.id)
ordersarrayY订单列表 数组最大长度 50
external_return_order_idstringY商家退货/退款单号
external_order_idstringY关联的订单号
reason_typeinteger退货/退款原因类型,1:商品原因;2:物流原因;3:服务原因;4:其他原因
reasonstring退货/退款原因详情,与退款/退款原因类型对应,如 商品与页面描述不符;发货太慢;商家拒绝提供服务;自己不想要了
return_create_timestringY货退款单创建时间,unix时间戳 字段长度为 13 字节
return_numintegerY该笔退货退款单的商品数量
return_amountfloatY该笔退货退款单的商品退款金额,单位元,保留 2 位小数
return_freight_amountfloatY运费退款金额,单位元,保留 2 位小数注:运费为0时,传0
return_order_amountfloatY该笔退货退款单的退款金额,单位元,保留 2 位小数注:商品退款金额+运费退款金额=订单金额
return_order_statusstringY退货退款单状态,传1290(退货退款完成)
status_change_timestringY状态变更时间,unix毫秒级时间
return_goods_infoarrayY主订单商品信息,数组类型,每个sku存一个数组单位
external_sku_idstringYsku 编号
sku_name_chinesestringYsku 名称
is_giftinteger是否赠品,0代表非赠品,1代表赠品
external_spu_idstringYsku 所属 spu 编号,若无 spu,传输内容请与 external_sku_id 保持一致
spu_name_chinesestringYspu 名称,若无 spu,传输内容请与 sku_name_chinese 保持一致
return_goods_numintegerY退货商品数量
return_goods_amountfloatY退货商品金额,单位元,保留 2 位小数

# 请求体示例

{
    "dataSourceId":"SOURCE_01",
    "orders":[
        {
            "external_return_order_id":"RETURN_ORDER_2888811",
            "external_order_id":"ORDER_2888811",
            "return_create_time":"1607148404000",
            "return_num":1,
            "return_amount":30,
            "return_freight_amount":10,
            "return_order_amount":40,
            "return_order_status":"1290",
            "status_change_time":"1607148404000",
            "return_goods_info":[
                {
                    "external_sku_id":"SKUID_334333",
                    "sku_name_chinese":"商品名称",
                    "is_gift":0,
                    "external_spu_id":"SPU_23211",
                    "spu_name_chinese":"SPU名称",
                    "return_goods_amount":30,
                    "return_goods_num":1
                }
            ]
        }
    ]
}

# 应答体结构

名称
类型
描述
retcodeinteger返回码
errmsgstring错误信息
datajson object响应内容

# 应答示例

{
  "retcode":0,
  "errmsg":"",
  "data": {}
}



# 常见FAQ

问:创建数据仓库时返回retcode: 16 errmsg: data_source_already_exist,该如何处理?

答:该返回代表该接口已创建过数据仓库,请使用获取有数数据仓库接口获取已创建好的 dataSourceId 。


问:退货退款订单状态很多,该传哪些状态?

答:必传的订单状态有 1290 退货退款完成即可。


问:订单同步的时效性要求是?

答:订单要求实时上报(5分钟内)。


更多疑问,可前往常见问题清单。