版本比较

标识

  • 该行被添加。
  • 该行被删除。
  • 格式已经改变。

描述


获取退件单数据,最多查询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
List300O订单号
referenceNoList
List300O订单参考号


请求样例


客户参考号样例:

{
    "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

-

废弃字段

返回样例

...

Short

退件类型 (0:尾程退件;1:FBA退仓;2:买家退件)

typeMsgString
退件类型名称

warehouseCode

String

仓库代码

statusShort
订单状态(0:已创建;1:已接收;2:已入库;3:已取消;4:已到仓;5:下单异常;6:入库异常)
statusMsgString
订单状态名称
correlationReferenceNoString
原始订单参考号
fbaReturnNoString
FBA退货计划单号
fbaReturnIdString
FBA订单ID
etaDate
预计到达时间
returnReasonString
退件原因
remarkString
备注
lastMailTypeShort
运输方式(1:快递单; 2:陆运单)
expressNoListArray

快递单号

rmaNumberString
第三方单号
putAwayDateDate
上架时间
dateCreatedDate
创建时间
dateModifiedDate
更新时间
productListArray
商品列表
serviceNameString
退件服务名称
serviceCodeString
退件服务代码
senderAddressObject
发件人地址


productList参数

字段名

数据类型

最大长度

描述

sku

String

商品编码

productCountInteger

数量

handleTypeShort
处理方式(0:重新上架;1:退回国内;2:不良品;3:销毁;4:待检查;5:换标;6:产品升级)
handleTypeMsgString
处理方式名称
goodProductCountInteger
处理结果数量(良品)
defectiveProductCountInteger
处理结果数量(不良品)


senderAddress参数

contactNameString255M联系人姓名
contactPhoneString255M联系人电话
contantEmailString255O联系人邮箱
companyNameString255O联系人公司
countryString2M国家二字码
stateString128O州(省)
cityString128M

城市

districtString128O
postcodeString32O邮编
addressLine1String512M地址1
addressLine2String512O地址2
addressLine3String512O地址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":""
}