接口说明

通过该接口可创建退货订单，获取退货订单号。
1、有RMA（有预报）退货：买家提出退货时，卖家或第三方平台创建退货订，提交退货运单号、退货目的仓、退货商品的sku和数量等信息，万邑通返回退货订单号。
2、无RMA退货：卖家可参考无RMA（无预报）退货操作指引。
3、ReturnLabel 服务：

（1）WINIT出库：创建出库单后，根据出库单号创建退货订单，可调用查询returnlabel面单接口获取退货跟踪号及面单(或调用查询退货订单接口获取退货跟踪号)

（2）非WINIT出库：需提前注册商品信，并提供包裹箱单信息创建退货订单，可调用查询returnlabel面单接口获取退货跟踪号及面单(或调用查询退货订单接口获取退货跟踪号)

接口名称

rma.returnGoodsOrder.createReturnGoodsOrder

请求说明

请求内容	说明
URL	https://openapi.winit.com.cn/openapi/service
接口测试	https://sandboxopenapi.winit.com.cn/openapi/service
验证方法	Token,md5
格式	json
字符编码	UTF-8
http请求方式	http
请求数限制	默认每分钟1000，1000有需要可申请加大。

请求入参

名称	类型	必填	说明	示例
customerOrderNo	String()	N	客户订单号卖家自身管理需要的订单号
isWinitOutbound	String()	N	是否WINIT出库：Y/N （1）WINIT出库：创建出库单后，根据出库单号创建退货订单（2）非WINIT出库：仅支持ReturnLabel服务，需提前注册商品信，并提供包裹箱单信息创建退货订单	Y
outboundOrderNo	String()	O	出库单号，若isWinitOutbound是Y则必填	WO12213001
shippingNo	String()	O	出库单子单号，若出库单属于一单多子单则必填，	WO12213001A
winitProductCode	String()	N	退货渠道PSC （1）不需要ReturnLabel服务时，无需入参（2）需要ReturnLabel服务时，需要入参指定渠道PSC 查询退货渠道/派送方式
expressNo	String()	N	买家退货运单号选择ReturnLabel服务时，无需入参
supplierName	String	N	买家退货运单供应商选择ReturnLabel服务时，无需入参查看供应商列表
warehouseCode	String()	Y	退货目的仓库【Winit退货中心仓库编码】
VATNo	String()	N	VAT，退货到英国和德国时需要填写
userInfoSource	String()	O	发件人地址来源 ORI: 使用出库单的收件人信息 IRI: 录入退货人信息，选择非WINIT出库时，发件人地址来源只能是IRI
name	String()	Y	退货人名字 UserInfoSource为ORI时，系统默认出库单收件人信息，请勿入参
email	String()	N	退货人Email UserInfoSource为ORI时，系统默认出库单收件人信息，请勿入参
phone	String()	N	退货人电话 UserInfoSource为ORI时，系统默认出库单收件人信息，请勿入参
country	String()	Y	退货人国家 UserInfoSource为ORI时，系统默认出库单收件人信息，请勿入参
state	String()	N	退货人州省 UserInfoSource为ORI时，系统默认出库单收件人信息，请勿入参
city	String()	Y	退货人城市 UserInfoSource为ORI时，系统默认出库单收件人信息，请勿入参
postcode	String()	Y	退货人邮编 UserInfoSource为ORI时，系统默认出库单收件人信息，请勿入参
houseNo	String()	N	退货人门牌号 UserInfoSource为ORI时，系统默认出库单收件人信息，请勿入参
address1	String()	Y	退货人地址 UserInfoSource为ORI时，系统默认出库单收件人信息，请勿入参
address2	String()	N	退货人地址2 UserInfoSource为ORI时，系统默认出库单收件人信息，请勿入参
packageLength	Decimal	N	包裹长非WINIT出库时或 WINIT出库的出库单属于一单多包裹时，必填。用于向供应商获取ReturnLabel面单。
packageWidth	Decimal	N	包裹宽非WINIT出库时或 WINIT出库的出库单属于一单多包裹时，必填。用于向供应商获取ReturnLabel面单。
packageHeight	Decimal	N	包裹高非WINIT出库时或 WINIT出库的出库单属于一单多包裹时，必填。用于向供应商获取ReturnLabel面单。
packageWeight	Decimal	N	包裹重量非WINIT出库时或 WINIT出库的出库单属于一单多包裹时，必填。用于向供应商获取ReturnLabel面单。
ownerCode	String()	N	退货货主编码特殊客户入参，一般不入参
ReturnGoodsList	Array	Y	退货商品列表
– productCode	String()	Y	商品编码，sku 非WINIT出库时，商品化管理的商品，需要在商品注册时维护第三方商品编码，确保仓库收到实物时能够扫描识别。
– productNum	Number	Y	商品数量
– specification	String()	N	规格
– productionBatch	String()	0	产品批号当是批次管理的商品并且批次属性是以下类型时，必须指定产品批次号 PDPB：生产日期+产品批次号 EDPB：失效日期+产品批次号示例：某食品库存失效日期为 2030-08-01 产品批号为 AT001223	AT001223
– batchDate	String()	0	批次日期当是批次管理的商品，并基于不同的批次属性，指定对应的日期。 PD：生产日期 ED：失效日期 PDPB：生产日期+产品批次号 EDPB：失效日期+产品批次号 ID：入库日期使用生产日期作为批次属性则提供对应库存的生产日期比如：2024-12-12	2030-08-01
– handleMethod	String()	Y	商品退货策略，可选 SA：直接上架 NS：新品拍照上架 DE：销毁 WI：WINIT检查上架（使用该服务需要联系销售开通权限）
– shelveMethod	String()	N	退货策略=直接上架时，支持选择以下处理方式 GOOD_SA：良品上架加对应商品的良品库存 DEFECTIVE_SA：不良品上架加对应商品的不良品库存注：不传默认良品上架
– goodMethod	String()	O	检查结果为良品时的处理方式，可选 SA：直接上架当商品退货策略=检查上架（WI）时必填
– defectiveMethod	String()	O	检查结果为不良品时的处理方式，可选 SA：直接上架 DE：销毁当商品退货策略=检查上架（WI）时必填
– itemCodeList	Array	N	退货单品条码列表
– – itemCode	String()	N	退货单品条码 1）非WINIT出库时，单品化管理的商品，需要下单时可提供单品条码，确保仓库收到实物时能够扫描识别，降低识别为无主货风险； 2）WINIT出库可基于出库的单品信息提供
– – handleMethod	String()	N	单品的处理策略 SA：直接上架 NS：新品拍照上架 DE：销毁

请求示例

  {
    "action":"rma.returnGoodsOrder.createReturnGoodsOrder",
    "app_key":"rebecca",
    "data":{
        "winitProductCode":"OSF521006534",
        "isWinitOutbound":"N",
        "warehouseCode":"US0001",
        "customerOrderNo":"",
        "outboundOrderNo":"",
        "userInfoSource":"IRI",
        "expressNo":"",
        "VATNo":"",
        "name":"shane bellingham",
        "email":"123567890@qq.com",
        "phone":"0419 666990",
        "country":"United States",
        "state":"US",
        "houseNo":"test",
        "city":"Radeburg",
        "postcode":"01471",
        "address1":"Unti",
        "address2":"TEST11",
        "packageLength":"11.22",
        "packageWidth":"11.12",
        "packageHeight":"11.12",
        "packageWeight":"0.61",
        "ReturnGoodsList":[
            {
                "defectiveMethod":"DE",
                "goodMethod":"SA",
                "handleMethod":"WI",
                "itemCodeList":[
                    {
                        "handleMethod":"SA",
                        "itemCode":"S50006200041141111"
                    }
                ],
                "productCode":"auto_cargo_002",
                "productNum":"1",
                "specification":""
            }
        ]
    },
    "format":"json",
    "language":"zh_cn",
    "platform":"GFS",
    "sign":"00000000000000000000000000000000",
    "sign_method":"md5",
    "timestamp":"2021-08-18 001926",
    "version":"1.0"
}

返回出参

返回参数说明：正确的返回编码code：0及结果data，错误的返回错误码及错误信息msg。

名称	类型	必传	说明
returnGoodsOrderNo	String()	Y	WINIT订单号-退货订单号
rmaNo	String()	Y	RMA号
returnAddress	String()	Y	退货地址

返回示例

1.下单成功

{
   "code": "0",
   "msg": "操作成功",
   "data":    {
      "returnAddress": "Winit AU Trade Pty Ltd. Block A2, 391 Park Road #38977601 Regents Park New South Wales 2143 AU ",
      "rmaNo": "9742208",
      "returnGoodsOrderNo": "RT16000000000211CN"
   }
}

2.下单失败

{
   "code": "02050240094",
   "msg": "当前出库订单[WO0969339140]已生成退货订单，可退货商品数量不足",
   "data": ""
}
{
   "code": "02050240099",
   "msg": "若填写单品列表，列表内单品数量须等于退货数量",
   "data": ""
}
{
   "code": "02050240097",
   "msg": "出库单号:[WO1033768582]状态不支持作废",
   "data": ""
}
{
   "code": "02050240098",
   "msg": "存在已退货单品，创建退货订单失败",
   "data": ""
}
{
   "code": "02050240124",
   "msg": "商品编码不存在",
   "data": ""
}
{
   "code": "02010250344",
   "msg": "退货单品的处理方式不能为空",
   "data": ""
}

关键词

退货订单
创建退货订单
rma.returnGoodsOrder.createReturnGoodsOrder