描述

获取退件单数据，最多查询300个

路径

HTTP Verb	URL
POST	/api/supplier-service/v1/b2c/returnOrderList

请求头样例

POST /api/supplier-service/v1/b2c/orderList HTTP/1.1

Host: http://cfs-qa.etowertech.com/
Content-Type: application/json
Accept: application/json
Authorization:WallTech etotest8xkIIphLnbkjRACNj4P:pc9H97D-_b2_TSCVvNj81A
X-WallTech-Date:Tue, 02 Aug 2022 06:43:37 GMT

...

请求字段

字段名	数据类型	最大长度	必填性	描述
orderNoList	List	300	O	订单号
referenceNoList	List	300	O	订单参考号

请求样例

客户参考号样例：

{
"referenceNoList": [
"EC03142 "Q20241128001",
"555555555"
]
}

系统订单号样例：

{
"orderNoList": [
"C12283230314000003O "R15319241128000001O",
"R7317220609000006O"
]
}

...

返回参数

字段名	数据类型	最大长度

必填性

描述

referenceNoList

referenceNo

请求参数

String

订单的客户参考号

客户参考号

orderNoList

orderNo

请求参数

String

订单的系统订单号

	系统订单号
dateCreated

-

Date		订单创建时间
shipperId

orderNo

Integer

-

发货人id

系统订单号

type

platformRefNo-平台参考号platformSource-平台来源（见附件表：平台名称）

originOrderNo

-

原系统订单号

originReferenceNo

-

原客户参考号

transactionAmount-交易金额transactionCurrency-交易币种

outboundDate

-

出库时间

submissionDate提交时间cancelDate-取消时间cancelResult-取消结果abnormalCauses-异常原因

packingDetails

-

装箱明细

forecastProductCount

-

商品预报数量

productCount

-

商品实际出库数量

sku

-

商品编码

skuNameEn

-

商品英文名

skuNameLocal

-

商品中文名

referenceNo

-

客户参考号

serviceName

-

服务名称

keepShipService-锁定选用服务shipmentCarrier-承运商shipmentService-承运服务

shipperName

-

发货人名称

shipperWarehouseCode

-

发货仓库代码

status

-

订单状态

0：已创建

1：已接收

2：下单异常

3：拦截中

4：已取消

5：已出库

6：已废弃

7：出库异常

statusMsg

-

订单状态文本信息

totalForecastProductCount

-

订单总商品预报数量

totalProductCount

-

订单实际总商品数量

serialNumber-商品序列号：多个序列号会拼接展示

totalVolume

-

总体积

totalVolumeUnit

-

体积单位

totalWeight

-

总重量

totalWeightUnit

-

重量单位

trackingNo

-

追踪号

packageActualBillingWeight

-

实际计费重量(KG)

packageActualWeight

-

实际包裹重量(KG)

packageActualVolume

-

实际包裹体积(CBM)

packageHeight

-

包裹高度(CM)

packageLength

-

包裹长度(CM)

packageWidth

-

包裹宽度(CM)

remark

-

订单备注

code

-

编码内容

errors

-

报错

message

-

返回信息

messageId

-

信息编码

success

-

成功响应

warnList

-

废弃字段

未拆单成功样例：

代码块

{
    "code": "0",
    "data": [
        {
            "abnormalCauses": "测试异常原因",
            "cancelDate": "2023-03-30 15:44:18",
            "cancelResult": "取消不成功",
            "dateCreated": "2022-12-15 17:34:05",
            "keepShipService": true,
            "orderNo": "C12283221215000056O",
            "originOrderNo": "",
            "originReferenceNo": "",
            "outboundDate": "2022-12-15 17:34:10",
            "packageActualBillingWeight": 2.000,
            "packageActualVolume": 0.010,
            "packageActualWeight": "",
            "packageHeight": 15.000,
            "packageLength": 15.000,
            "packageWidth": 35.000,
            "packingDetails": [
                {
                    "forecastProductCount": "2",
                    "productCount": "2",
                    "serialNumber": "",
                    "sku": "SKG(TEST)",
                    "skuNameEn": "SKG",
                    "skuNameLocal": "SKG颈部按摩器"
                }
            ],
            "platformRefNo": "vmrkorp-w",
            "platformSource": "eBay",
            "referenceNo": "WY_00001",
            "remark": "",
            "serviceName": "DHL_UK",
            "shipmentCarrier": "",
            "shipmentService": "",
            "shipperName": "XZ12",
            "shipperWarehouseCode": "GBPGO",
            "status": 5,
            "statusMsg": "Outbound",
            "totalForecastProductCount": "2",
            "totalProductCount": "2",
            "totalVolume": 0.002,
            "totalVolumeUnit": "cbm",
            "totalWeight": 2.000,
            "totalWeightUnit": "KG",
            "trackingNo": "ER2313",
            "transactionAmount": 12.330,
            "transactionCurrency": "45.55"
        }
    ],
    "errors": "",
    "message": "",
    "messageId": "",
    "success": true,
    "warnList": ""
}

未拆单失败样例：

代码块
{ "code": "0", "data": [], "errors": "", "message": "", "messageId": "", "success": true, "warnList": "" }

拆单成功样例：

代码块

{
    "code": "0",
    "data": [
        {
            "abnormalCauses": "",
            "cancelDate": "",
            "cancelResult": "",
            "dateCreated": "2023-03-14 11:28:07",
            "keepShipService": false,
            "orderNo": "C12283230314000005O",
            "originOrderNo": "C12283230314000003O",
            "originReferenceNo": "EC03142",
            "outboundDate": "",
            "packageActualBillingWeight": "",
            "packageActualVolume": "",
            "packageActualWeight": "",
            "packageHeight": "",
            "packageLength": "",
            "packageWidth": "",
            "packingDetails": [
                {
                    "forecastProductCount": "4",
                    "productCount": "",
                    "sku": "wine bottle opener",
                    "skuNameEn": "wine bottle opener",
                    "skuNameLocal": "红酒开瓶器"
                }
            ],
            "platformRefNo": "",
            "platformSource": "eBay",
            "referenceNo": "EC03142-2",
            "remark": "REMARK",
            "serviceName": "PUROLATOR_GROUND",
            "shipmentCarrier": "",
            "shipperName": "XZ12",
            "shipperWarehouseCode": "CATESTWH",
            "status": 0,
            "statusMsg": "Created",
            "totalForecastProductCount": "4",
            "totalProductCount": "0",
            "totalVolume": 0.002,
            "totalVolumeUnit": "cbm",
            "totalWeight": 2.000,
            "totalWeightUnit": "KG",
            "trackingNo": "",
            "transactionAmount": 100.000,
            "transactionCurrency": "CNY"
        },
        {
            "abnormalCauses": "",
            "cancelDate": "",
            "cancelResult": "",
            "dateCreated": "2023-03-14 11:26:39",
            "keepShipService": false,
            "orderNo": "C12283230314000003O",
            "originOrderNo": "C12283230314000003O",
            "originReferenceNo": "EC03142",
            "outboundDate": "",
            "packageActualBillingWeight": "",
            "packageActualVolume": "",
            "packageActualWeight": "",
            "packageHeight": "",
            "packageLength": "",
            "packageWidth": "",
            "packingDetails": [
                {
                    "forecastProductCount": "3",
                    "productCount": "",
                    "sku": "cushion",
                    "skuNameEn": "cushion",
                    "skuNameLocal": "坐垫"
                }
            ],
            "platformRefNo": "",
            "platformSource": "eBay",
            "referenceNo": "EC03142-1",
            "remark": "REMARK",
            "serviceName": "PUROLATOR_GROUND",
            "shipmentCarrier": "",
            "shipperName": "XZ12",
            "shipperWarehouseCode": "CATESTWH",
            "status": 0,
            "statusMsg": "Created",
            "totalForecastProductCount": "3",
            "totalProductCount": "0",
            "totalVolume": 0.075,
            "totalVolumeUnit": "cbm",
            "totalWeight": 6.000,
            "totalWeightUnit": "KG",
            "trackingNo": "",
            "transactionAmount": 100.000,
            "transactionCurrency": "CNY"
        }
    ],
    "errors": "",
    "message": "",
    "messageId": "",
    "success": true,
    "warnList": ""
}

拆单失败样例：

代码块
{ "code": "0", "data": [], "errors": "", "message": "", "messageId": "", "success": true, "warnList": "" }

...

Short		退件类型（0:尾程退件;1:FBA退仓;2:买家退件）
typeMsg	String		退件类型名称
warehouseCode	String		仓库代码
status	Short		订单状态（0:已创建;1:已接收;2:已入库;3:已取消;4:已到仓;5:下单异常;6:入库异常）
statusMsg	String		订单状态名称
correlationReferenceNo	String		原始订单参考号
fbaReturnNo	String		FBA退货计划单号
fbaReturnId	String		FBA订单ID
eta	Date		预计到达时间
returnReason	String		退件原因
remark	String		备注
lastMailType	Short		运输方式（1:快递单; 2:陆运单）
expressNoList	Array		快递单号
rmaNumber	String		第三方单号
putAwayDate	Date		上架时间
dateCreated	Date		创建时间
dateModified	Date		更新时间
productList	Array		商品列表
serviceName	String		退件服务名称
serviceCode	String		退件服务代码
senderAddress	Object		发件人地址

productList参数

字段名	数据类型	描述
sku	String	商品编码
productCount	Integer	数量
handleType	Short	处理方式（0:重新上架;1:退回国内;2:不良品;3:销毁;4:待检查;5:换标;6:产品升级）
handleTypeMsg	String	处理方式名称
goodProductCount	Integer	处理结果数量（良品）
defectiveProductCount	Integer	处理结果数量（不良品）

senderAddress参数

contactName	String	255	M	联系人姓名
contactPhone	String	255	M	联系人电话
contantEmail	String	255	O	联系人邮箱
companyName	String	255	O	联系人公司
country	String	2	M	国家二字码
state	String	128	O	州(省)
city	String	128	M	城市
district	String	128	O	区
postcode	String	32	O	邮编
addressLine1	String	512	M	地址1
addressLine2	String	512	O	地址2
addressLine3	String	512	O	地址3

返回样例

代码块

{
	"code":"0",
	"data":[
		{
			"correlationReferenceNo":"",
			"eta":"",
			"expressNoList":"",
			"fbaReturnId":"333333",
			"fbaReturnNo":"111111",
			"lastMailType":2,
			"lastMailTypeMsg":"Land",
			"orderNo":"R7317220609000006O",
			"productList":[],
			"putAwayDate":"",
			"referenceNo":"555555555",
			"remark":"",
			"returnReason":"",
			"rmaNumber":"cv",
			"shipperId":7317,
			"status":1,
			"statusMsg":"Accepted",
			"thirdCreatedTime":"",
			"type":1,
			"typeMsg":"FBA Return",
			"warehouseCode":"Alex-AU"
		},
		{
			"correlationReferenceNo":"QQ20230009",
			"eta":"",
			"expressNoList":[
				"78789798798"
			],
			"fbaReturnId":"",
			"fbaReturnNo":"",
			"lastMailType":1,
			"lastMailTypeMsg":"Express",
			"orderNo":"R15319241128000001O",
			"productList":[
				{
					"defectiveProductCount":0,
					"goodProductCount":1,
					"handleType":0,
					"handleTypeMsg":"Re-Launch",
					"productCount":1,
					"sku":"QQ001"
				},
				{
					"defectiveProductCount":1,
					"goodProductCount":0,
					"handleType":2,
					"handleTypeMsg":"Defective",
					"productCount":1,
					"sku":"QQ001"
				}
			],
			"putAwayDate":"2024-11-28 14:32:18",
			"referenceNo":"Q20241128001",
			"remark":"",
			"returnReason":"",
			"rmaNumber":"",
			"shipperId":15319,
			"status":2,
			"statusMsg":"Complete",
			"thirdCreatedTime":"",
			"type":2,
			"typeMsg":"Buyer Return",
			"warehouseCode":"Lynn001"
		}
	],
	"errors":"",
	"message":"",
	"messageId":"",
	"success":true,
	"warnList":""
}

页面树结构

版本比较

旧版本 1

新版本当前版本

标识

描述

路径

请求头样例

请求字段

请求样例

返回参数

返回样例

页面树结构

页面历史

版本比较

旧版本 1

新版本 当前版本

标识

描述

路径

请求头样例

请求字段

请求样例

返回参数

返回样例

新版本当前版本