API
创建退货订单
更新时间: 2022-09-28 01:01:53 访问次数:9513

接口说明

通过该接口可创建退货订单,得到退货订单号。
1、RMA退货:买家提出退货时,卖家或第三方平台创建退货订,提交退货运单号、退货目的仓、退货商品的sku和数量等信息,万邑通返回退货订单号。
2、无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则必填
winitProductCode String() N 退货渠道PSC
(1)不需要ReturnLabel服务时,无需入参
(2)需要ReturnLabel服务时,需要入参指定渠道PSC
查询退货渠道/派送方式
expressNo String() N 买家退货运单号
选择ReturnLabel服务时,无需入参
supplierName String N 买家退货运单供应商
选择ReturnLabel服务时,无需入参
查看供应商列表
warehouseCode String() Y 退货目的仓库
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出库时,必填。用于向供应商获取ReturnLabel面单

packageWidth Decimal N 包裹宽
非WINIT出库时,必填。用于向供应商获取ReturnLabel面单

packageHeight Decimal N 包裹高
非WINIT出库时,必填。用于向供应商获取ReturnLabel面单

packageWeight Decimal N 包裹重量
非WINIT出库时,必填。用于向供应商获取ReturnLabel面单

ownerCode String() N 退货货主编码
特殊客户入参,一般不入参
ReturnGoodsList Array Y 退货商品列表
–|productCode String() Y 商品编码,sku
非WINIT出库时,商品化管理的商品,需要在商品注册时维护第三方商品编码,确保仓库收到实物时能够扫描识别。

–|productNum Number Y 商品数量
–|specification String() N 规格
–|productionBatch String() N 产品批次号
当是批次管理的商品,并且批次属性是以下类型时,必须指定产品批次号
PDPB:生产日期+产品批次号
EDPB:失效日期+产品批次号

–|batchDate String() N 批次日期
当是批次管理的商品,并基于不同的批次属性,指定对应的日期。
PD:生产日期
ED:失效日期
PDPB:生产日期
EDPB:失效日期
ID:入库日期
yyyy-MM-dd
–|handleMethod String() Y 批处理方式
SA:直接上架
NS:新品拍照上架
DE:销毁
WI:WINIT检查上架(使用该服务需要联系销售开通权限)
–|shelveMethod String() N 直接上架处理方式
GOOD_SA:良品上架
DEFECTIVE_SA:不良品上架
注:不传默认良品上架
–|goodMethod String() O 良品处理方式,当handleMethod为WI时,填写
SA:直接上架

–|defectiveMethod String() O 不良品处理方式,当handleMethod为WI时,填写
SA:直接上架
NS:新品拍照上架
DE:销毁

–|itemCodeList Array N 退货单品条码列表
–|–|itemCode String() N 退货单品条码
(1)非WINIT出库时,单品化管理的商品,需要下单时提供单品条码,确保仓库收到实物时能够扫描识别。

–|–|handleMethod String() N 处理方式
SA:直接上架
NS:新品拍照上架
DE:销毁

请求示例

  1. {
  2. "action":"rma.returnGoodsOrder.createReturnGoodsOrder",
  3. "app_key":"rebecca",
  4. "data":{
  5. "winitProductCode":"OSF521006534",
  6. "isWinitOutbound":"N",
  7. "warehouseCode":"US0001",
  8. "customerOrderNo":"",
  9. "outboundOrderNo":"",
  10. "userInfoSource":"IRI",
  11. "expressNo":"",
  12. "VATNo":"",
  13. "name":"shane bellingham",
  14. "email":"123567890@qq.com",
  15. "phone":"0419 666990",
  16. "country":"United States",
  17. "state":"US",
  18. "houseNo":"test",
  19. "city":"Radeburg",
  20. "postcode":"01471",
  21. "address1":"Unti",
  22. "address2":"TEST11",
  23. "packageLength":"11.22",
  24. "packageWidth":"11.12",
  25. "packageHeight":"11.12",
  26. "packageWeight":"0.61",
  27. "ReturnGoodsList":[
  28. {
  29. "defectiveMethod":"DE",
  30. "goodMethod":"SA",
  31. "handleMethod":"WI",
  32. "itemCodeList":[
  33. {
  34. "handleMethod":"SA",
  35. "itemCode":"S50006200041141111"
  36. }
  37. ],
  38. "productCode":"auto_cargo_002",
  39. "productNum":"1",
  40. "specification":""
  41. }
  42. ]
  43. },
  44. "format":"json",
  45. "language":"zh_cn",
  46. "platform":"GFS",
  47. "sign":"00000000000000000000000000000000",
  48. "sign_method":"md5",
  49. "timestamp":"2021-08-18 001926",
  50. "version":"1.0"
  51. }

返回出参

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

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

返回示例

1.下单成功

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

2.下单失败

  1. {
  2. "code": "02050240094",
  3. "msg": "当前出库订单[WO0969339140]已生成退货订单,可退货商品数量不足",
  4. "data": ""
  5. }
  6. {
  7. "code": "02050240099",
  8. "msg": "若填写单品列表,列表内单品数量须等于退货数量",
  9. "data": ""
  10. }
  11. {
  12. "code": "02050240097",
  13. "msg": "出库单号:[WO1033768582]状态不支持作废",
  14. "data": ""
  15. }
  16. {
  17. "code": "02050240098",
  18. "msg": "存在已退货单品,创建退货订单失败",
  19. "data": ""
  20. }
  21. {
  22. "code": "02050240124",
  23. "msg": "商品编码不存在",
  24. "data": ""
  25. }
  26. {
  27. "code": "02010250344",
  28. "msg": "退货单品的处理方式不能为空",
  29. "data": ""
  30. }