API
取消退货订单
更新时间: 2024-11-08 15:47:16 访问次数:6864

接口说明

卖家或第三方平台通过该接口可取消退货订单,并返回是否操作成功。

使用场景

退货单只允许订单状态为草稿、已下单状态的有RMA退货入库单取消

有RMA退货入库单其他状态及无RMA、派送失败退货入库单目前暂不支持取消

接口名称

rma.returnGoodsOrder.voidOrder

请求说明

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

请求入参

名称 类型 必填 说明 示例
returnGoodsOrderNos Array Y 退货订单号

请求示例

  1. {
  2. "action": "rma.returnGoodsOrder.voidOrder",
  3. "app_key": "rebecca",
  4. "client_id": "ODJKMDU1YZCTYJQ5YY00ZWZLLTK5N2QTOWY4MZI5OGMWNDG2",
  5. "client_sign": "A3CCBAC316A58027E3FE47512248A5DB",
  6. "data": {
  7. "returnGoodsOrderNos": [
  8. "RT16000000000274CN", "RT16000000000262CN"
  9. ]
  10. },
  11. "format": "json",
  12. "language": "zh_CN",
  13. "platform": "OWNERERP",
  14. "sign": "9C599CDCF3C2AEB2096F034CD3543B1E",
  15. "sign_method": "md5",
  16. "timestamp": "2015-06-16 001926",
  17. "version": "1.0"
  18. }

返回出参

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

名称 类型 必传 说明 示例
successCount Number Y 作废成功订单数量
failedCount Number Y 作废失败订单数量
results Array Y 结果列表
returnGoodsOrder String() Y 退货订单号
result String(1) Y 作废结果,Y/N
reason String() Y 失败原因

返回示例

  1. {
  2. "code": "0",
  3. "msg": "操作成功",
  4. "data": {
  5. "failedCount": 0,
  6. "successCount": 2,
  7. "results": [
  8. {
  9. "organizationId": null,
  10. "createdby": null,
  11. "created": null,
  12. "updatedby": null,
  13. "updated": null,
  14. "isActive": null,
  15. "isDelete": null,
  16. "returnGoodsOrder": "RT16000000000274CN",
  17. "result": "Y",
  18. "reason": null
  19. },
  20. {
  21. "organizationId": null,
  22. "createdby": null,
  23. "created": null,
  24. "updatedby": null,
  25. "updated": null,
  26. "isActive": null,
  27. "isDelete": null,
  28. "returnGoodsOrder": "RT16000000000262CN",
  29. "result": "Y",
  30. "reason": null
  31. }
  32. ]
  33. }
  34. }