接口说明

卖家或第三方平台通过该接口可查询卖家退货订单信息，返回符合查询条件下的退货订单信息列表。方便得到退货商品、数量等用于后继二次售卖出库。退货订单包含了：

RMA退货订单
无RMA退货订单
出库派送失败订单

接口名称

rma.returnGoodsOrder.queryReturnOderList

请求说明

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

请求入参

名称	类型	必填	说明	示例
returnGoodsOrderNo	String(32)	N	WINIT订单号-退货	RT16000013812852CN
expressNo	String(32)	N	退货运单号仓库收到退货包裹扫描的运单号（1）RMA退货：卖家填写的客户退货运单号（2）无RMA退货：买家退货包裹的退货运单号（3）派送失败：原出库单的运单号/某些供应商（DPD）的更换的退货运单号
outboundOrderNo	String(32)	N	出库订单号，WINIT原出库的出库单
customerOrderNo	String(32)	N	客户订单号
rmaNo	String(32)	N	RMA
originCode	String(32)	N	创建分类 NR：仓库创建 OR：出库单启动退货
warehouseCode	String()	N	退货仓库
OderStartDatetime	Date(10)	Y	退货订单创建时间(From)	2018-06-8
OderEndDatetime	Date(10)	Y	退货订单创建时间(To)	2018-06-8
pageParams	Object	Y	分页参数
– pageSize	Integer(11)	Y	每页显示数量，最大值200
– pageNo	Integer(11)	Y	页码，默认1

请求示例

{
    "action": "rma.returnGoodsOrder.queryReturnOderList",
    "app_key": "rebecca",
    "client_id": "NDA1ZTQYNDMTYWVJNS00NGFILWI0ZJITMGYYZDM3MJLKMTU5",
    "client_sign": "DEF3965C4ACB12F5D76B48307F88F020",
    "data": {
        "returnGoodsOrderNo": "RT16000000005910CN",
        "expressNo": "",
        "outboundOrderNo": "",
        "rmaNo": "",
        "customerOrderNo": "",
        "destroyOutboundOrder": "",
        "originCode": "",
        "warehouseCode": "",
        "OderStartDatetime": "2023-12-08",
        "OderEndDatetime": "2023-12-08",
        "pageParams": {
            "pageSize": 20,
            "pageNo": 1
        }
    },
    "format": "json",
    "language": "zh_CN",
    "platform": "WIN01",
    "sign": "3A0274891A35687EBCEC6E810D21CDF2",
    "sign_method": "md5",
    "timestamp": "2015-06-16 001926",
    "version": "1.0"
}

返回出参

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

名称	类型	必传	说明	示例
pageParams	Object	Y	分页信息
pageNo	Integer	Y	当前页
pageSize	Integer	Y	分页大小
totalCount	Integer	Y	总记录数
list	Array	Y	订单列表
returnGoodsOrderNo	String	Y	WINIT订单号-退货
expressNo	String	Y	实际扫描跟踪号仓库扫描的跟踪号
customerExpressNo	String	Y	客户退货跟踪号卖家下RMA退货单的跟踪号或Return label服务抓取的跟踪号
mdImageList	Array	N	退货面单地址文件当使用WinitReturn Label服务，已抓单后返回地址解析说明参考：https://bytedance.feishu.cn/wiki/GbhDwlp0fiSH2VkmvqBcZO8Lnzd
outboundOrderNo	String	Y	出库订单号
sellerOrderNo	String	Y	卖家订单号
qtyItemNum	Number	Y	单品数量
rmaNo	String	Y	RMA
isReturnLabel	String	Y	是否ReturnLabel	N
retrunReason	String	Y	退货原因 DF：派送失败 BR:客户退货
status	String	Y	状态 PD：草稿 OD：已下单 LC：已抓单 PC：已揽收 RE：已收件 WP：客户待处理 HI：仓库处理中 OC：已完成 CD：已取消 VO：已作废 STOP：已终止
warehouseCode	String	Y	退货仓库
buyername	String	Y	买家
createDate	Date	Y	创建时间(YYYY-MM-DD HH:MM:SS)	yyyy-MM-dd HH:mm:ss
completeTime	Date	N	订单完成时间　　订单内商品仓库收货后的实际处理完成时间，基于订单内最后一个处理的单品的实际处理策略取值，策略为拍照暂存则为暂存完成时间，策略为直接上架则为上架完成时间，策略为销毁则为销毁完成时间。	yyyy-MM-dd HH:mm:ss
processTime	Date	N	订单处理时间　　针对暂存订单用户首次创建增值时间	yyyy-MM-dd HH:mm:ss
allVasOrderCompletedTime	Date	N	订单增值处理完成时间　　订单内所有增值处理完成时间	yyyy-MM-dd HH:mm:ss
handleStrategy	String	N	退货策略 NS：拍照暂存 SA：直接上架 DE：销毁 WI：Winit检查上架注：创建退货单时用户填写值	SA
shelveMethod	String	N	退货处理方式 GOOD_SA：良品上架 DEFECTIVE_SA：不良品上架 DE：销毁注：创建退货单时用户填写值	GOOD_SA
orderGoodsList	Array	Y	下单商品明细，仅有RMA订单派送失败和无RMA订单无下单明细
– merchandiseCode	String	Y	商品编码
– merchandiseSerno	String	Y	商品条码
– specification	String	Y	规格
– originalMerchandiseCode	String	Y	原商品编码
– originalMerchandiseSerno	String	Y	原商品条码
– itemSerno	String	Y	单品条码
– ownerCode	String	Y	货主编码
– skuCodeThird	String	Y	第三方编码
– confirmQty	Int	Y	数量
– skuType	varchar	Y	SKU类型 SINGLE：单一产品 SUITE：套装产品 BOX：箱产品
– standardPartsNum	Int	Y	库存标准单元件数
– merchandiseGrade	String	Y	商品等级（良品/不良品） GOOD：良品 DEFECTIVE：不良品
– nameCn	String	Y	中文名称
– nameEn	String	Y	英文名称
– confirmWidth	BigDecimal	Y	核实宽
– confirmLength	BigDecimal	Y	核实长
– confirmHeight	BigDecimal	Y	核实高
– confirmVolume	BigDecimal	Y	核实体积
– confirmWeight	BigDecimal	Y	核实重量
– managementType	String	Y	商品管理方式 SI：单品管理 SKU：商品管理
– handleMethod	String	Y	处理方式，已停用 SA：直接上架 NS：新品拍照上架 DE：销毁
– handleStrategy	String	N	退货策略 NS：拍照暂存 SA：直接上架 DE：销毁 WI：Winit检查上架注：创建退货单时用户填写值
– shelveMethod	String	N	退货处理方式 GOOD_SA：良品上架 DEFECTIVE_SA：不良品上架 DE：销毁注：创建退货单时用户填写值
shelveGoodsList	Array	Y	上架商品明细
– merchandiseCode	String	Y	商品编码
– merchandiseSerno	String	Y	商品条码
– specification	String	Y	规格
– originalMerchandiseCode	String	Y	原商品编码
– originalMerchandiseSerno	String	Y	原商品条码
– itemSerno	String	Y	单品条码
– ownerCode	String	Y	货主编码
– skuCodeThird	String	Y	第三方编码
– confirmQty	Int	Y	数量
– skuType	varchar	Y	SKU类型 SINGLE：单一产品 SUITE：套装产品 BOX：箱产品
– standardPartsNum	Int	Y	库存标准单元件数
– merchandiseGrade	String	Y	商品等级（良品/不良品） GOOD：良品 DEFECTIVE：不良品
– nameCn	String	Y	中文名称
– nameEn	String	Y	英文名称
– confirmWidth	decimal(16,2)	Y	核实宽
– confirmLength	decimal(16,2)	Y	核实长
– confirmHeight	decimal(16,2)	Y	核实高
– confirmVolume	decimal(16,2)	Y	核实体积
– confirmWeight	decimal(16,2)	Y	核实重量
– managementType	String	Y	商品管理方式 SI：单品管理 SKU：商品管理
– handleMethod	String	Y	处理方式，已停用 SA：直接上架 NS：新品拍照上架 DE：销毁
– handleStrategy	String	Y	退货策略 NS：拍照暂存 SA：直接上架 DE：销毁 WI：Winit检查上架注：仓库实际信息
– shelveMethod	String	N	退货处理方式 GOOD_SA：良品上架 DEFECTIVE_SA：不良品上架 DE：销毁注：仓库实际信息，暂存未处理时不会返回
–imageList	Array	N	退货仓库拍照图片地址当退货策略=拍照暂存回传，地址解析说明参考：https://bytedance.feishu.cn/wiki/GbhDwlp0fiSH2VkmvqBcZO8Lnzd
– inventoryAttribute	Array	N	库存属性返回多组tagName，tagValue stockOrg库存组织编码、stockType库存类型2B或2C、stockOwner库存货主

返回示例

{
    "code": "0",
    "msg": "操作成功",
    "data": {
        "pageParams": {
            "pageNo": 1,
            "pageSize": 20,
            "totalCount": 1
        },
        "list": [
            {
                "outboundOrderNo": "WO0000084535",
        "customerExpressNo": "9985473210489",
        "sellerOrderNo": "1428543289948930650",
                "expressNo": "9985473210489",
                "completeTime": "2023-12-08 16:10:11",
                "orderGoodsList": [
                    {
                        "originalMerchandiseSerno": null,
                        "merchandiseGrade": null,
                        "standardPartsNum": 1,
                        "confirmQty": 1,
                        "skuCodeThird": null,
                        "merchandiseSerno": "M010000000001695223",
                        "ownerCode": null,
                        "specification": "",
                        "nameCn": "655 USB-C Hub (8-in-1)",
                        "confirmWidth": 5,
                        "nameEn": "655 USB-C Hub (8-in-1)",
                        "skuType": "SINGLE",
                        "confirmLength": 7,
                        "managementType": "SKU",
                        "confirmHeight": 3,
                        "confirmVolume": 0.000105,
                        "handleMethod": "WI",
                        "confirmWeight": 0.23,
                        "inventoryAttribute": [],
                        "merchandiseCode": "A8382021",
                        "itemSerno": null,
                        "originalMerchandiseCode": null
                    }
                ],
                "shelveGoodsList": [
                    {
                        "originalMerchandiseSerno": null,
                        "merchandiseGrade": "GOOD",
                        "standardPartsNum": 1,
                        "confirmQty": 1,
                        "skuCodeThird": null,
                        "merchandiseSerno": "M010000000001695223",
                        "ownerCode": null,
                        "specification": null,
                        "nameCn": "655 USB-C Hub (8-in-1)",
                        "confirmWidth": 14.1,
                        "nameEn": "655 USB-C Hub (8-in-1)",
                        "skuType": "SINGLE",
                        "confirmLength": 20.6,
                        "managementType": "SKU",
                        "confirmHeight": 2.5,
                        "confirmVolume": 0.00072615,
                        "handleMethod": "GOOD_SA",
                        "confirmWeight": 0.213,
                        "inventoryAttribute": [],
                        "merchandiseCode": "A8382021",
                        "imageList": [
                        "http://127.0.0.1:9999",
                        "http://127.0.0.1:9999/file",
                        "http://127.0.0.1:9999/file"
                        ],
                        "itemSerno": null,
                        "originalMerchandiseCode": null
                    }
                ],
                "mdImageList": [
                    "http://127.0.0.1:9999",
                    "http://127.0.0.1:9999/file",
                    "http://127.0.0.1:9999/file"
                ],
                "qtyItemNum": 1,
                "buyerName": "anita zhou",
                "warehouseCode": "US0001",
                "isReturnLabel": "N",
                "returnGoodsOrderNo": "RT16000000005910CN",
                "destroyOutboundOrder": null,
                "retrunReason": "BR",
                "originCode": "OR",
                "rmaNo": "9443591",
                "status": "OC",
                "createDate": "2023-12-08 12:00:58"
            }
        ]
    }
}

关键词

查询退货订单列表
rma.returnGoodsOrder.queryReturnOderList