当前位置： API文档

wms.stockin.Refund.queryWithDetail（退货入库单查询）

¥标准

1.接口说明

1.1 接口描述：获取ERP的退货入库单单据信息
1.2 适用版本：客户端 V1.6.0.5及以上版本
1.3 增量获取：支持
1.4 时间跨度：start_time和end_time最大跨度为30天。

1.5注意事项：【权限校验】：仓库权限，店铺权限
为了达到保护用户隐私数据安全的目的，本接口不返回淘系、拼多多及系统供销平台数据，淘系相关平台规则点击这里，淘系及系统供销平台数据获取办法点击这里，拼多多请自行对接平台获取。

本接口中涉及到用户隐私的字段数据仅自有平台及线下平台订单返回。具体字段详情见下面表格；

字段描述字段名
客户网名nick_name
客户姓名customer_name

2.调用场景

2.1 举例说明：财务系统、SAP、数据分析等系统的对接

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境http://47.92.239.46/openapi
正式环境http://wdt.wangdian.cn/openapi

  3.2 公共请求参数

名称字段类型长度
必须描述
卖家账号sidString
是卖家账号, 由旺店通分配
接口账号keyString
是由旺店通分配appkey, 在发送的数据中对应 key 字段,获取方式点击这里
盐saltString
是由旺店通分配appsecret，是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt.
接口名称methodString
是调用的接口名称
版本号vString
是1.0
秒级时间戳timestampint
是秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。
签名signString
是签名
分页大小page_sizeint
否分页大小，分页查询必传
分页编号page_noint
否分页编号，分页查询必传，标准接口page_no从0开始
是否计算查询结果的总条数calc_totalint
否是否计算查询结果的总条数, 需要计算则1, 否则填0         

   3.3 业务请求参数

名称字段类型长度
必须描述
查询参数

params

Map<String, Object>
y

查询参数

分页pager
pager
y
分页

params

名称字段类型长度
必须描述
仓库编号

warehouse_no

String

40
n

仓库编号

入库单号

stockin_no

String20
n入库单号
退换单号refund_noString40n退换单号
店铺编号shop_nosString255
n多个编号间使用英文逗号分隔

入库单状态

statusString255n

英文逗号拼接的状态值:

10=已取消；20=编辑中；30=待审核/待处理；80=已完成

时间条件类型
time_type
Int
1n查询的时间条件类型, 0:修改时间; 1:入库时间 不传默认为0
开始时间

start_time

String40y

起始时间, yyyy-MM-dd HH:mm:ss格式

结束时间

end_time

String40y结束时间, yyyy-MM-dd HH:mm:ss格式
是否使用从库查询

is_slave

boolean1n

使用：true  不使用：false

（仅对开通从库配置客户生效）

是否返回sn信息

need_sn

boolean1n

返回：true

不返回：false

是否需要汇总数据
need_summary
bool
1
n

需要：true

不需要：false

默认false

是否需要国补信息need_gov_subsidy_infoboolean1
n

0：不需要

1：需要
默认0

是否仅获取库存记录fetch_stock_onlyInt1
n

0：否
1：是
默认0

平台idplatform_idInt1
n

平台id，详见平台代码表

pager

名称字段类型长度
必须描述
分页大小

page_size

Int4n

分页大小

页号

page_no

Int4n

从0开始

4.响应参数

名称字段类型长度
必须描述
状态码statusInt
y

返回0为正常

错误信息messageString
n无错误信息不返回
退货入库单信息dataMap<String, Object>
n退货入库信息

data

响应参数说明示例值或者格式、具体含义、使用方法及注意事项（如隐私数据仅自有平台及线下平台返回，其他平台均不返回）

名称字段类型长度
必须描述
单据数据

order

List<Map<String, Object>>


y

入库单相关数据

总数

total_count

Int

11n

查询条件总数单据

汇总数据
summary_data
List<warehouse_data>

y
汇总数据

order

名称字段类型长度
必须描述
入库单号

order_no

String40
y

入库单号

入库单状态statusInt
4
y

入库单状态

10:已取消；20:编辑中；30:待处理/待审核；80:已完成

关联类型attach_typeInt
4
N

关联类型

0:手动关联；1:强制关联；2:拆分关联；3:自动关联（客户端为空不返回）

仓库编号

warehouse_no

String

40
y

仓库编号

仓库名称

warehouse_name

String64
y仓库名称
制单时间created_timeString40
y入库单创建时间（毫秒级时间戳，例如：1631861379000）
备注remarkString255
y备注
分销商昵称fenxiao_nickString40y分销商昵称
入库人operator_nameString40y入库人
入库人idoperator_idInt
y入库人id

物流方式

logistics_type

Int6
y

物流方式，点击查看物流代码表

物流公司

logistics_name

String40y

物流公司名称

物流单号

logistics_no

String40
y

物流单号

物流id

logistics_id

Int6
y

物流公司唯一键

审核时间check_time
String40
y审核时间（毫秒级时间戳，例如：1631861379000）
退换单号

refund_no

String40
y

退换单号

货品数量

goods_count

Decimal(19,4)
y货品数量
退换单实际退款金额

actual_refund_amount

Decimal(19,4)
y退换单实际退款金额
客户编码

customer_no

String40
y客户编码
退货人姓名

customer_name

String100y退货人姓名（仅自有平台及线下平台返回，其他平台均不返回）
客户网名

nick_name

String100
y客户网名（仅自有平台及线下平台返回，其他平台均不返回）
店铺名称

shop_name

String128
y店铺名称
店铺编号

shop_no

String20
y店铺编号
店铺备注

shop_remark

String255
y店铺备注
标记名称

flag_name

String32
y标记名称（退换单标记）
系统订单编号

trade_no_list

String255y系统订单编号，若为多个以“，”分割，超长会被截取
原始订单

tid_list

String255y原始单号，若为多个以“，”分割，超长会被截取
退换单id

src_order_id

Int11y退换单主键
入库单id

stockin_id

Int11y入库单id
店铺平台id

shop_platform_id

Int6
y店铺平台id，点击文档查看平台id对照表
子平台id

sub_platform_id

Int6
y子平台id
店铺id

shop_id

Int6y店铺唯一键
仓库id

warehouse_id

Int40y仓库唯一键
入库单总成本

total_price

Decimal(19,4)
y

入库单总成本

子单明细total_cost的总和

货品入库总数量

total_goods_stockin_num

Decimal(19,4)
y货品入库总数量
退换单状态
process_statusInt4
y

10:已取消;20:待审核;30:已审核;40:已推送;80:已结算;85:待过账;86:已过账;87:成本确认;90:已完成

修改时间

modified

String40y

退货入库单修改时间, 样例: 2020-04-23 14:55:08

审核人check_operator_nameString40y审核人
审核人idcheck_operator_idInt
y审核人id
退换说明reasonString40y退换说明
退换说明idreason_idInt
y退换说明id
入库总金额
refund_amountDecimal(19,4)
y

入库单明细的（价格*入库数量）之和

调整数量adjust_numDecimal(19,4)
y

调整数量

wms业务单号wms_codeString50ywms业务单号
创建时间createdString
y

创建时间

标记idflag_idInt
6
y

标记id（入库单标记id）

货品类型数量goods_type_countInt
6
y

货品类型数量

退换单编号src_order_noString
40
y

退换单编号

便签条数note_countInt
6
y

便签条数

源预入库单号prop3String255Y预入库单拆分前的预入库单号
业务单类型src_order_typeInt
4
y

业务单类型，固定12

类型typeInt
4
y

2：退货退款

3：换货

货品退款金额sum_refund_amountDecimal(19,4)
y货品退款金额
关联时间contact_time

y关联时间（日志中第一次关联的时间）
分销商编码fenxiao_nick_noString
y分销商编码
退货货品金额

total_amount

Decimal(19,4)
y退货货品金额
虚拟仓编码vir_warehouse_noString
n
虚拟仓编码
虚拟仓名称vir_warehouse_nameString
n
虚拟仓名称

第三方分销商id

fenxiao_distributor_id

String
y

第三方分销商id（无值返回空字符串）

第三方分销商名称

fenxiao_distributor_name

String
y

第三方分销商名称（无值返回空字符串）

第三方订单类型

fenxiao_distributor_type

String
y

第三方订单类型（无值返回空字符串）

退换备注

refund_remark

String1024y

退换备注

最后入库时间

refund_last_stockin_time

String
y

对应退换单的最后入库时间

分销商别名

fenxiao_alias

String
n分销商别名（无值返回空字符串）
入库单明细

details_list

List<Map<String, Object>>


y入库单明细
国补信息

gov_subsidy_info

List<Map<String, Object>>


n国补信息
入库单标记名称
stockin_flag_nameString
y入库单标记名称
原始退款单号raw_refund_nosString
y原始退款单号，若为多个以“，”分割

summary_data

名称字段类型长度
必须描述
仓库编号warehouse_noString
是仓库编号
店铺维度分组汇总shop_dataList<shop_data>
是店铺维度分组汇总

shop_data

名称字段类型长度
必须描述
店铺编号
shop_noString
是店铺编号
单品数据汇总spec_dataList<spec_data>
是单品数据汇总

spec_data

名称字段类型长度
必须描述
商家编码
spec_noString80是商家编码
数量num
Decimal(19,4)
是数量
退款金额
total_refund_amount
Decimal(19,4)

退款金额

details_list

名称字段类型长度
必须描述
入库单明细id(主键)

rec_id

Int11是入库单明细ID（主键）
入库单id

stockin_id

Int11是入库单ID
退换单明细id

refund_detail_id

String

是退换单明细id,id之间用逗号分隔
数量

num

Decimal(19,4)
是数量（退货入库单明细节点的数量字段）
总成本total_costDecimal(19,4)
是总成本=明细数量*成本（以系统配置决定是实际成本/计划成本）
备注

remark

String255是

备注

调整后数量right_numDecimal(19,4)
是调整后数量
货品名称goods_nameString255是

货品名称

货品编码goods_no

String

40
是货品编码
货品idgoods_idInt
是货品唯一键
商品idspec_idInt
是单品唯一键
商家编码

spec_no

String80
是

商家编码

是否残次品

defect

boolean1
是

默认为非残次品

单品自定义属性1

prop1

String100
是

单品自定义属性1（来源货品档案）

单品自定义属性2

prop2

String100
是

单品自定义属性2（来源货品档案）

单品自定义属性3

prop3

String100
是

单品自定义属性3（来源货品档案）

单品自定义属性4

prop4

String100
是

单品自定义属性4（来源货品档案）

单品自定义属性5

prop5

String100
是

单品自定义属性5（来源货品档案）

单品自定义属性6

prop6

String100
是

单品自定义属性6（来源货品档案）

规格名称

spec_name

String100
是

规格名称

规格码

spec_code

String40是

规格码

品牌编号

brand_no

String32
是

品牌编号

品牌名称

brand_name

String64
是

品牌名称

辅助单位

goods_unit

String20
是

辅助单位（入库单对应的辅助单位）

物流名称

logistics_name

String40是

物流名称

物流单号

logistics_no

String40
是

物流单号

仓库id

warehouse_id

Int40是仓库唯一键
退换单id

src_order_id

Int6是退换单主键

物流id

logistics_id

Int6
是

物流公司唯一键

单位

base_unit_name

String20是基本单位
批次号

batch_no

String40是

批次号

有效期

expire_date

String40是

有效期，样例: 2020-04-20 00:00:00

生产日期
production_dateString40是生产日期
货位

position_no

String20是

货位

预期数量

expect_num

Decimal(19,4)
是预期数量
入库数量

stockin_num

Decimal(19,4)
是入库数量（关联其他数据出来的数量，如需按照ERP退货入库单明细中的数量取值，取num字段对应值即可）
入库单明细成本价

checked_cost_price

Decimal(19,4)
是

入库单明细成本价

退款总额refund_amountDecimal(19,4)
是退款总额（入库单明细节点的退款总额）
sn序列号信息

sn_list

String255
是

当need_sn=true时返回英文逗号分隔的sn

入库单位id

unit_id

Int
6
是

入库单位id

基本单位id

base_unit_id

Int
6
是基本单位id
库存明细id

org_stockin_detail_id

Int
11
是

库存明细id

批次id

batch_id

Int11
是

批次id

货位id

position_id

Int
11
是

货位id

有效期天数

validity_days

Int
6
是

有效期天数

辅助数量

num2

Decimal(19,4)
是

辅助数量

调整数量

adjust_num

Decimal(19,4)
是

调整数量

单位换算关系

unit_ratio

Decimal(19,4)
是

单位换算关系

最后修改时间

modified

String
40
是

最后修改时间

创建时间

created

String
40
是

创建时间

业务单类型

src_order_type

Int
4
是

业务单类型，固定12

自定义金额1customer_price1
Decimal(19,4)
是

单品自定义金额1

自定义金额2

customer_price2

Decimal(19,4)
是

单品自定义金额2

原始单号tidString255
是

原始单号，多个用英文逗号隔开

退款金额actual_refund_amountDecimal(19,4)
是

退款金额（入库单明细节点的退款金额）

原价original_priceDecimal(19,4)
是

原价（退换单明细的原价字段）

批次备注

batch_remark

String128
是

批次备注

条码

barcode

String50是

条码

退换单明细

refund_order_detail_list

List<Map<String, Object>>
是

退换单明细

gov_subsidy_info

名称字段类型长度
必须描述
原始单号tidString
是原始单号
原始子单号oidString
是原始子单号
公司主体名称

corp_entity_name

String
是公司主体名称

refund_order_detail_list

名称字段类型长度
必须描述
退换单明细id

refund_order_id

Int11是

退换单明细id

入库单明细id

stockin_order_detail_id

Int11是

入库单明细id

价格

price

Decimal(19,4)
是

价格（退换单明细价格字段）

商家编码

spec_no

String80是

商家编码

实际入库数量stockin_numDecimal(19,4)
是实际入库数量
订单类型trade_typeInt
是

通过中间表关联到的退换单明细中后关联订单，关联不到的情况下值为0

1：网店销售

2：线下订单

3：售后换货

4：批发业务

5：保修换新

6：保修完成

7：现款销售

8：分销

101~110：自定义1~10

入库数量refund_order_stockin_numDecimal(19,4)
是退换单明细中记录的入库数量, 在和中间表关联失败时数量为0
原始子单号

oid

String40是

通过中间表关联到的退换单明细中的oid, 关联不到的情况下值为空串

原始单号

tid

String40是

原始单号

平台货品id

api_goods_id

String
否

平台货品id

平台规格idapi_spec_idString
否

平台规格id

平台货品名称api_goods_nameString
否

平台货品名称

平台规格名称api_spec_nameString
否

平台规格名称

退款总额

total_amount

Decimal(19,4)


是

退换单明细的退款总额

退款金额

refund_amount

Decimal(19,4)


是

退换单明细的退款金额

退款数量

refund_num

Decimal(19,4)


是

退款数量

分销原始单号

fenxiao_tid

String


否

分销原始单号

5.请求示例

Json格式请求报文
[{
"start_time": "2019-09-01 00:00:00",
"end_time": "2019-10-01 23:59:59"
}]
PHP

<php
header("Content-Type: text/html; charset=UTF-8");
date_default_timezone_set("Asia/Shanghai");
require_once('wdtsdk.php');
 
$client = new WdtErpClient("url", "wdtapi3", "appkey", "secret");
 
$paraMap = new stdClass();
$paraMap->start_time = "2019-09-01 00:00:00";
$paraMap->end_time = "2019-10-01 23:59:59";
 
 
$pager = new Pager(1, 0, true);
$response = $client->pageCall("wms.stockin.Refund.queryWithDetail",$pager, $paraMap);
 
?>

JAVA

C#

CURL
curl --location 'http://47.92.239.46/openapi?key=wdtapi3-test9&method=wms.stockin.Refund.queryWithDetail&salt=136787110023126585465b366becff09&sid=wdtapi3&timestamp=454600875&v=1.0&sign=cdad22b9c6c471146c307f0e597bd7a6&page_no=0&page_size=200&calc_total=1' \
--header 'Content-Type: application/json' \
--data '[{
"start_time": "2019-09-01 00:00:00",
"end_time": "2019-10-01 23:59:59"
}]'

6.响应示例

  6.1 正常响应示例 

JSON

{
    "status": 0,
    "data": {
        "summary_data": [
            {
                "warehouse_no": "wdtapi3-test",
                "shop_data": [
                    {
                        "spec_data": [
                            {
                                "num": 2,
                                "spec_no": "wangdiantong",
                                "total_refund_amount": 0
                            }
                        ],
                        "shop_no": "wdtapi3-test"
                    }
                ]
            }
        ],
        "total_count": 1,
        "order": [
            {
                "logistics_name": "无",
                "details_list": [
                    {
                        "stockin_id": 55185,
                        "num": 2,
                        "remark": "",
                        "right_num": 2,
                        "rec_id": 202147,
                        "goods_name": "wangdiantong",
                        "goods_no": "wangdiantong",
                        "spec_no": "wangdiantong",
                        "defect": false,
                        "prop2": "",
                        "spec_name": "wangdiantong",
                        "spec_code": "wangdiantong",
                        "batch_no": "",
                        "brand_no": "BRAND",
                        "brand_name": "无",
                        "unit_id": 0,
                        "base_unit_id": 37,
                        "expire_date": "",
                        "position_no": "销退暂存",
                        "logistics_id": 0,
                        "logistics_no": "",
                        "src_order_id": 57759,
                        "warehouse_id": 311,
                        "goods_id": 1,
                        "spec_id": 1,
                        "expect_num": 10,
                        "org_stockin_detail_id": 201850,
                        "batch_id": 0,
                        "position_id": -5,
                        "validity_days": 0,
                        "num2": 2,
                        "adjust_num": 0,
                        "unit_ratio": 1,
                        "modified": "2024-08-30 17:38:45",
                        "created": "2024-08-30 17:38:35",
                        "src_order_type": 12,
                        "prop1": "",
                        "prop3": "",
                        "prop4": "",
                        "prop5": "",
                        "prop6": "",
                        "custom_price1": 0,
                        "custom_price2": 0,
                        "tid": "20240830001",
                        "refund_order_detail_list": [
                            {
                                "refund_order_id": 60180,
                                "stockin_order_detail_id": 202147,
                                "spec_no": "wangdiantong",
                                "stockin_num": 2,
                                "oid": "AD202408300004",
                                "trade_type": 2,
                                "refund_order_stockin_num": 2,
                                "price": 29.98
                            }
                        ],
                        "goods_unit": "无",
                        "base_unit_name": "KG",
                        "logistics_name": "无",
                        "total_cost": 0.2366,
                        "checked_cost_price": 0.1167,
                        "refund_amount": 59.96,
                        "refund_detail_id": "60180",
                        "production_date": "",
                        "stockin_num": "2.0000"
                    }
                ],
                "fenxiao_nick": "",
                "reason": "无",
                "operator_id": 502,
                "refund_no": "TK2408300021",
                "adjust_num": 0,
                "shop_remark": "ljcs",
                "modified": "2024-08-30 17:38:45",
                "shop_no": "wdtapi3-test",
                "check_operator_name": "aaa2",
                "seq_no": 1,
                "created_time": 1725010715000,
                "stockin_id": 55185,
                "customer_no": "KH201709190002",
                "src_order_id": 57759,
                "created": "2024-08-30 17:38:35",
                "trade_no_list": "JY202408300111",
                "shop_name": "wdtapi3-test",
                "shop_platform_id": 127,
                "shop_id": "290",
                "warehouse_name": "wdtapi3-test",
                "actual_refund_amount": 299.8,
                "nick_name": "aaa",
                "process_status": 30,
                "status": 80,
                "check_time": 1725010725000,
                "order_no": "RK2024083013",
                "flag_id": 0,
                "tid_list": "20240830001",
                "goods_type_count": 1,
                "remark": "",
                "sub_platform_id": 0,
                "goods_count": 2,
                "flag_name": "",
                "logistics_id": 0,
                "src_order_no": "TK2408300021",
                "warehouse_no": "wdtapi3-test",
                "check_operator_id": 502,
                "refund_amount": 59.96,
                "note_count": 0,
                "total_price": 0.2366,
                "logistics_no": "",
                "src_order_type": 12,
                "reason_id": 0,
                "prop3": "",
                "operator_name": "aaa2",
                "total_goods_stockin_num": "2.0000",
                "customer_name": "",
                "warehouse_id": 311
            }
        ]
    }
}

   6.2 异常响应示例

JSON
{
"status": 100,
"message": "仓库不存在"
}


常用工具