当前位置: API文档
wms.stockin.Refund.queryWithDetail(退货入库单查询)
1.1 接口描述:获取ERP的退货入库单单据信息 |
1.2 适用版本:客户端 V1.5.4.3及以上版本 |
1.3 增量获取:支持 |
1.4 时间跨度:start_time和end_time最大跨度为30天。 |
1.5注意事项:【权限校验】:仓库权限,店铺权限 本接口中涉及到用户隐私的字段数据仅自有平台及线下平台订单返回。具体字段详情见下面表格; |
字段描述 | 字段名 |
客户网名 | nick_name |
客户姓名 | customer_name |
2.1 举例说明:财务系统、SAP、数据分析等系统的对接 |
环境 | HTTP地址 |
---|---|
测试环境 | http://47.92.239.46/openapi |
正式环境 | http://wdt.wangdian.cn/openapi |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
卖家账号 | sid | String | 是 | 卖家账号, 由旺店通分配 | |
接口账号 | key | String | 是 | 由旺店通分配appkey, 在发送的数据中对应 key 字段,获取方式点击这里 | |
盐 | salt | String | 是 | 由旺店通分配appsecret,是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt. | |
接口名称 | method | String | 是 | 调用的接口名称 | |
版本号 | v | String | 是 | 1.0 | |
秒级时间戳 | timestamp | int | 是 | 秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。 | |
签名 | sign | String | 是 | 签名 | |
分页大小 | page_size | int | 否 | 分页大小,分页查询必传 | |
分页编号 | page_no | int | 否 | 分页编号,分页查询必传,标准接口page_no从0开始 | |
是否计算查询结果的总条数 | calc_total | int | 否 | 是否计算查询结果的总条数, 需要计算则1, 否则填0 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
查询参数 | params | Map<String, Object> | y | 查询参数 | |
分页 | pager | pager | y | 分页 |
params
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
仓库编号 | warehouse_no | String | 40 | n | 仓库编号 |
入库单号 | stockin_no | String | 20 | n | 入库单号 |
退换单号 | refund_no | String | 40 | n | 退换单号 |
店铺编号 | shop_nos | String | 255 | n | 多个编号间使用英文逗号分隔 |
入库单状态 | status | String | 255 | n | 英文逗号拼接的状态值: 10=已取消;20=编辑中;30=待审核/待处理;80=已完成 |
时间条件类型 | time_type | Int | 1 | n | 查询的时间条件类型, 0:修改时间; 1:入库时间 不传默认为0 |
开始时间 | start_time | String | 40 | y | 起始时间, yyyy-MM-dd HH:mm:ss格式 |
结束时间 | end_time | String | 40 | y | 结束时间, yyyy-MM-dd HH:mm:ss格式 |
是否使用从库查询 | is_slave | boolean | 1 | n | 使用:true 不使用:false (仅对开通从库配置客户生效) |
是否返回sn信息 | need_sn | boolean | 1 | n | 返回:true 不返回:false |
pager
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
分页大小 | page_size | Int | 4 | n | 分页大小 |
页号 | page_no | Int | 4 | n | 从0开始 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
状态码 | status | Int | y | 返回0为正常 | |
错误信息 | message | String | n | 无错误信息不返回 | |
退货入库单信息 | data | Map<String, Object> | n | 退货入库信息 |
响应参数说明示例值或者格式、具体含义、使用方法及注意事项(如隐私数据仅自有平台及线下平台返回,其他平台均不返回)
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
单据数据 | order | List<Map<String, Object>> | y | 入库单相关数据 | |
总数 | total_count | Int | 11 | n | 查询条件总数单据 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
入库单号 | order_no | String | 40 | y | 入库单号 |
入库单状态 | status | Int | 4 | y | 入库单状态 10:已取消;20:编辑中;30:待处理/待审核;80:已完成 |
关联类型 | attach_type | Int | 4 | N | 关联类型 0:手动关联;1:强制关联;2:拆分关联;3:自动关联(客户端为空不返回) |
仓库编号 | warehouse_no | String | 40 | y | 仓库编号 |
仓库名称 | warehouse_name | String | 64 | y | 仓库名称 |
制单时间 | created_time | String | 40 | y | 入库单创建时间(毫秒级时间戳,例如:1631861379000) |
备注 | remark | String | 255 | y | 备注 |
分销商昵称 | fenxiao_nick | String | 40 | y | 分销商昵称 |
入库人 | operator_name | String | 40 | y | 入库人 |
入库人id | operator_id | Int | y | 入库人id | |
物流方式 | logistics_type | Int | 6 | y | 物流方式,点击查看物流代码表 |
物流公司 | logistics_name | String | 40 | y | 物流公司名称 |
物流单号 | logistics_no | String | 40 | y | 物流单号 |
物流id | logistics_id | Int | 6 | y | 物流公司唯一键 |
审核时间 | check_time | String | 40 | y | 审核时间(毫秒级时间戳,例如:1631861379000) |
退换单号 | refund_no | String | 40 | y | 退换单号 |
货品数量 | goods_count | Decimal(19,4) | y | 货品数量 | |
退换单实际退款金额 | actual_refund_amount | Decimal(19,4) | y | 退换单实际退款金额 | |
客户编码 | customer_no | String | 40 | y | 客户编码 |
退货人姓名 | customer_name | String | 100 | y | 退货人姓名(仅自有平台及线下平台返回,其他平台均不返回) |
客户网名 | nick_name | String | 100 | y | 客户网名(仅自有平台及线下平台返回,其他平台均不返回) |
店铺名称 | shop_name | String | 128 | y | 店铺名称 |
店铺编号 | shop_no | String | 20 | y | 店铺编号 |
店铺备注 | shop_remark | String | 255 | y | 店铺备注 |
标记名称 | flag_name | String | 32 | y | 标记名称(退换单标记) |
系统订单编号 | trade_no_list | String | 255 | y | 系统订单编号,若为多个以“,”分割,超长会被截取 |
原始订单 | tid_list | String | 255 | y | 原始单号,若为多个以“,”分割,超长会被截取 |
退换单id | src_order_id | Int | 11 | y | 退换单主键 |
入库单id | stockin_id | Int | 11 | y | 入库单id |
店铺平台id | shop_platform_id | Int | 6 | y | 店铺平台id,点击文档查看平台id对照表 |
子平台id | sub_platform_id | Int | 6 | y | 子平台id |
店铺id | shop_id | Int | 6 | y | 店铺唯一键 |
仓库id | warehouse_id | Int | 40 | y | 仓库唯一键 |
入库单总成本 | total_price | Decimal(19,4) | y | 入库单总成本 子单明细total_cost的总和 | |
货品入库总数量 | total_goods_stockin_num | Decimal(19,4) | y | 货品入库总数量 | |
退换单状态 | process_status | Int | 4 | y | 10:已取消;20:待审核;30:已审核;40:已推送;80:已结算;85:待过账;86:已过账;87:成本确认;90:已完成 |
修改时间 | modified | String | 40 | y | 退货入库单修改时间, 样例: 2020-04-23 14:55:08 |
审核人 | check_operator_name | String | 40 | y | 审核人 |
审核人id | check_operator_id | Int | y | 审核人id | |
退换说明 | reason | String | 40 | y | 退换说明 |
退换说明id | reason_id | Int | y | 退换说明id | |
入库总金额 | refund_amount | Decimal(19,4) | y | 入库单明细退款金额之和 | |
调整数量 | adjust_num | Decimal(19,4) | y | 调整数量 | |
wms业务单号 | wms_code | String | 50 | y | wms业务单号 |
创建时间 | created | String | y | 创建时间 | |
标记id | flag_id | Int | 6 | y | 标记id(入库单标记id) |
货品类型数量 | goods_type_count | Int | 6 | y | 货品类型数量 |
退换单编号 | src_order_no | String | 40 | y | 退换单编号 |
便签条数 | note_count | Int | 6 | y | 便签条数 |
源预入库单号 | prop3 | String | 255 | Y | 预入库单拆分前的预入库单号 |
业务单类型 | src_order_type | Int | 4 | y | 业务单类型,固定12 |
入库单明细 | details_list | List<Map<String, Object>> | y | 入库单明细 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
入库单明细id(主键) | rec_id | Int | 11 | 是 | 入库单明细ID(主键) |
入库单id | stockin_id | Int | 11 | 是 | 入库单ID |
退换单明细id | refund_detail_id | String | 100 | 是 | 退换单明细id,id之间用逗号分隔 |
数量 | num | Decimal(19,4) | 是 | 数量 | |
总成本 | total_cost | Decimal(19,4) | 是 | 总成本=明细数量*成本(以系统配置决定是实际成本/计划成本) | |
备注 | remark | String | 255 | 是 | 备注 |
调整后数量 | right_num | Decimal(19,4) | 是 | 调整后数量 | |
货品名称 | goods_name | String | 255 | 是 | 货品名称 |
货品编码 | goods_no | String | 40 | 是 | 货品编码 |
货品id | goods_id | Int | 是 | 货品唯一键 | |
商品id | spec_id | Int | 是 | 单品唯一键 | |
商家编码 | spec_no | String | 40 | 是 | 商家编码 |
是否残次品 | defect | boolean | 1 | 是 | 默认为非残次品 |
单品自定义属性1 | prop1 | String | 100 | 是 | 单品自定义属性1(来源货品档案) |
单品自定义属性2 | prop2 | String | 100 | 是 | 单品自定义属性2(来源货品档案) |
单品自定义属性3 | prop23 | String | 100 | 是 | 单品自定义属性3(来源货品档案) |
单品自定义属性4 | prop4 | String | 100 | 是 | 单品自定义属性4(来源货品档案) |
单品自定义属性5 | prop5 | String | 100 | 是 | 单品自定义属性5(来源货品档案) |
单品自定义属性6 | prop6 | String | 100 | 是 | 单品自定义属性6(来源货品档案) |
规格名称 | spec_name | String | 100 | 是 | 规格名称 |
规格码 | spec_code | String | 40 | 是 | 规格码 |
品牌编号 | brand_no | String | 32 | 是 | 品牌编号 |
品牌名称 | brand_name | String | 64 | 是 | 品牌名称 |
辅助单位 | goods_unit | String | 20 | 是 | 辅助单位(入库单对应的辅助单位) |
物流名称 | logistics_name | String | 40 | 是 | 物流名称 |
物流单号 | logistics_no | String | 40 | 是 | 物流单号 |
仓库id | warehouse_id | Int | 40 | 是 | 仓库唯一键 |
退换单id | src_order_id | Int | 6 | 是 | 退换单主键 |
物流id | logistics_id | Int | 6 | 是 | 物流公司唯一键 |
单位 | base_unit_name | String | 20 | 是 | 基本单位 |
批次号 | batch_no | String | 40 | 是 | 批次号 |
有效期 | expire_date | String | 40 | 是 | 有效期,样例: 2020-04-20 00:00:00 |
生产日期 | production_date | String | 40 | 是 | 生产日期 |
货位 | position_no | String | 20 | 是 | 货位 |
预期数量 | expect_num | Decimal(19,4) | 是 | 预期数量 | |
入库数量 | stockin_num | Decimal(19,4) | 是 | 入库数量 | |
入库单明细成本价 | checked_cost_price | Decimal(19,4) | 是 | 入库单明细成本价 | |
退款金额 | refund_amount | Decimal(19,4) | 是 | 退换管理明细货品价格*入库数量 | |
sn序列号信息 | sn_list | String | 255 | 是 | 当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 | Int | 11 | 是 | 批次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 |
退换单明细 | refund_order_detail_list | List<Map<String, Object>> | 是 | 退换单明细 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
退换单明细id | refund_order_id | Int | 11 | 是 | 退换单明细id |
入库单明细id | stockin_order_detail_id | Int | 11 | 是 | 入库单明细id |
价格 | price | Decimal(19,4) | 是 | 价格(退换单明细价格字段) | |
商家编码 | spec_no | String | 40 | 是 | 商家编码 |
实际入库数量 | stockin_num | Decimal(19,4) | 是 | 实际入库数量 | |
入库数量 | refund_order_stockin_num | 是 | 退换单明细中记录的入库数量, 在和中间表关联失败时数量为0 | ||
原始子单号 | oid | String | 40 | 是 | 通过中间表关联到的退换单明细中的oid, 关联不到的情况下值为空串 |
JSON | { "status": 100, "message": "仓库不存在" } |