当前位置: API文档
wms.stockout.Base.search(出库单查询)
1.接口说明
1.1 接口描述:获取ERP非销售类型出库单单据信息 |
1.2 适用版本:客户端 V1.5.5.2及以上版本 |
1.3 增量获取:支持增量获取 |
1.4 时间跨度:起止时间跨度不超过60分钟 |
1.5 注意事项:【权限校验】:仓库权限 |
2.调用场景
2.1举例说明:SAP、线下ERP、SRM、SCM等系统对接 |
3.请求参数说明
3.1 请求地址
环境 | HTTP地址 |
---|---|
测试环境 | http://47.92.239.46/openapi |
正式环境 | http://wdt.wangdian.cn/openapi |
3.2 公共请求参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
卖家账号 | sid | String | Y | 卖家账号, 由旺店通分配 | |
接口账号 | key | String | Y | 由旺店通分配appkey, 在发送的数据中对应 key 字段,获取方式点击这里 | |
盐 | salt | String | Y | 由旺店通分配appsecret,是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt. | |
接口名称 | method | String | Y | 调用的接口名称 | |
版本号 | v | String | Y | 1.0 | |
秒级时间戳 | timestamp | int | Y | 秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。 | |
签名 | sign | String | Y | 签名 | |
分页大小 | page_size | int | N | 分页大小,分页查询必传 | |
分页编号 | page_no | int | N | 分页编号,分页查询必传,标准接口page_no从0开始 | |
是否计算查询结果的总条数 | calc_total | int | N | 是否计算查询结果的总条数, 需要计算则1, 否则填0 |
3.3 业务请求参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
查询参数 | params | Map<String, Object> | Y | 查询参数 | |
分页 | pager | Pager | Y | 分页 |
params
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
开始时间 | start_time | String | 40 | Y | 修改时间,时间格式 YYYY-MM-DD HH:MM:SS |
结束时间 | end_time | String | 40 | Y | 修改时间,时间格式 YYYY-MM-DD HH:MM:SS |
单据类型 | order_type | Byte | N | 2:调拨出库 4:盘点出库 5:生产出库 8:正残转换出库 9:jit出库 14:采购退货 21:其它出库 24:外仓调整出库 34:初始化出库 | |
状态 | status | Byte | N | 5:已取消 10:待放回 48:未确认 50:待审核 51:缺货 53:wms已接单 54:获取面单 58:档口锁定 60:待分配 61:排队中 63:待补货 65:待处理 70:待发货 73:爆款锁定 75:待拣货 77:拣货中 79:已拣货 90:延时发货 110:已完成 | |
仓库编号 | warehouse_no | String | 40 | N | 仓库编号 |
源单号 | src_order_no | String | 40 | N | 源单号 |
出库单号 | stockout_no | String | 40 | N | 出库单号,传入单号可不传时间 |
pager
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
分页大小 | page_size | Int | 4 | N | 分页大小 |
页号 | page_no | Int | 4 | N | 从0开始 |
4.响应参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
状态码 | status | Int | Y | 返回0为正常 | |
错误信息 | message | String | Y | 无错误信息不返回 | |
单据数据 | data | Map<String, Object> | Y | 出库单相关数据 |
data
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
单据数据 | order_list | List<Map<String, Object>> | Y | 出库单相关数据 | |
总数 | total_count | Int | 11 | N | 查询条件总单据数 |
order_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
预估邮费 | calc_post_cost | Decimal(19,4) | Y | 预估邮费 | |
预估重量 | calc_weight | Decimal(19,4) | Y | 预估重量 | |
审核时总成本 | checked_goods_total_cost | Decimal(19,4) | Y | 审核时总成本 | |
发货状态 | consign_status | Int | 11 | Y | 发货状态 1:已验货 2:已称重 16:已拣货 32:电子面单回传 64:已分拣 128:配送清单打印 4096:订单回告 |
发货时间 | consign_time | String | Y | 发货时间 | |
创建时间 | created | String | Y | 创建时间 | |
其他出库自定义子类别 | custom_type | Int | 6 | Y | 其他出库自定义子类别 |
错误信息 | error_info | String | 255 | Y | 错误信息 |
货品数量 | goods_count | Decimal(19,4) | Y | 货品数量 | |
货品种类数量 | goods_type_count | Int | Y | 货品种类数量 | |
物流公司编号 | logistics_company_no | String | Y | 物流公司编号 | |
物流id | logistics_id | Int | 11 | Y | 物流id |
物流公司名称 | logistics_name | String | Y | 物流公司名称 | |
物流单号 | logistics_no | String | 40 | Y | 物流单号 |
物流类型 | logistics_type | Short | Y | 物流类型,点击查看物流代码表 | |
最后修改时间 | modified | String | Y | 最后修改时间 | |
操作员id | operator_id | Int | 11 | Y | 操作员id |
操作员 | operator_name | String | 50 | Y | 操作员 |
收件人城市 | receiver_city | Int | 11 | Y | 收件人城市,点击查看城市代码表 |
收件人国家 | receiver_country | Int | 6 | Y | 收件人国家,点击查看城市代码表 |
收件人区 | receiver_district | Int | 11 | Y | 收件人区,点击查看城市代码表 |
收件人省 | receiver_province | Int | 11 | Y | 收件人省,点击查看城市代码表 |
收件人邮编 | receiver_zip | String | 20 | Y | 收件人邮编 |
备注 | remark | String | 255 | Y | 备注 |
源单id | src_order_id | Int | 11 | Y | 源单id |
源单单号 | src_order_no | String | 40 | Y | 源单单号 |
单据类型 | src_order_type | Byte | Y | 单据类型 2:调拨出库 4:盘点出库 5:生产出库 8:正残转换出库 14:采购退货 21:其它出库 24:外仓调整出库 | |
出库单状态 | status | Byte | Y | 出库单状态 5:已取消 10:待放回 48:未确认 50:待审核 51:缺货 53:wms已接单 54:获取面单 58:档口锁定 60:待分配 61:排队中 63:待补货 65:待处理 70:待发货 73:爆款锁定 75:待拣货 77:拣货中 79:已拣货 90:延时发货 110:已完成 | |
出库单id | stockout_id | Int | Y | 出库单id | |
出库单号 | stockout_no | String | 40 | Y | 出库单号 |
仓库id | warehouse_id | Short | Y | 仓库id | |
仓库编号 | warehouse_no | String | 40 | Y | 仓库编号 |
仓库类型 | warehouse_type | Byte | Y | 仓库类型 1:普通仓 2:自流转 3:奇门 4:京东沧海 6:抖音云仓 125:代发 126:分销 | |
称重邮资 | weigh_post_cost | Decimal(19,4) | Y | 称重邮资 | |
重量 | weight | Decimal(19,4) | Y | 重量 | |
出库明细 | detail_list | List<Map<String, Object>> | Y | 出库明细 |
detail_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
批次id | batch_id | Int | 11 | Y | 批次id |
批次号 | batch_no | String | 40 | Y | 批次号 |
批次备注 | batch_remark | String | 128 | Y | 批次备注 |
品牌名称 | brand_name | String | 64 | Y | 品牌名称 |
品牌编号 | brand_no | String | 32 | Y | 品牌编号 |
审核时成本 | checked_cost_price | Decimal(19,4) | Y | 审核时成本 | |
货品id | goods_id | Int | 11 | Y | 货品id |
货品名称 | goods_name | String | 255 | Y | 货品名称 |
货品编号 | goods_no | String | 40 | Y | 货品编号 |
货品类型 | goods_type | Byte | 4 | Y | 货品类型 0:其他 1:销售货品 2:原料 3:包材 4:周转材料 5:虚拟产品 6:固定资产 8:入库装箱 9:周期送货品 |
是否包装 | is_package | boolean | Y | 是否包装 | |
数量 | num | Decimal(19,4) | Y | 数量 | |
货位id | position_id | Int | 11 | Y | 货位id |
货位编号 | position_no | String | 20 | Y | 货位编号 |
明细rec_id | rec_id | Int | 11 | Y | 明细rec_id |
明细备注 | remark | String | 255 | Y | 明细备注 |
扫描类型 | scan_type | Byte | 4 | Y | 0:未验货 5:图片验货 |
规格编码 | spec_code | String | 40 | Y | 规格编码 |
单品id | spec_id | Int | 11 | Y | 单品id |
规格名称 | spec_name | String | 100 | Y | 规格名称 |
商家编码 | spec_no | String | 40 | Y | 商家编码 |
出库单id | stockout_id | Int | 11 | Y | 出库单id |
单位名称 | unit | String | 20 | Y | 优先取单品单位,为空则取货品单位 |
单位id | unit_id | Short | Y | 单位id | |
有效期 | expire_date | String | Y | 有效期 | |
重量 | weight | Decimal(19,4) | Y | 重量 | |
源单明细id | src_order_detail_id | Int | 11 | Y | 源单明细id |
创建时间 | created | String | 40 | Y | 创建时间 |
修改时间 | modified | String | 40 | Y | 修改时间 |
单位换算系数 | unit_ratio | Decimal(19,4) | Y | 单位换算系数 | |
辅助单位 | aux_unit_name | String | 20 | Y | 辅助单位 |
辅助单位id | aux_unit_id | Int | Y | 辅助单位id |
5.请求示例
json格式请求报文 | [ { "end_time": "2023-01-11 18:18:21", "start_time": "2023-01-11 17:18:21" } ] |
php 请求示例 | <?php header("Content-Type: text/html; charset=UTF-8"); date_default_timezone_set("Asia/Shanghai"); $client = new WdtErpClient("url", "wdtapi3", "appkey", "secret") $params = new stdClass(); $params->start_time = '2023-01-11 17:18:21'; $params->end_time = '2023-01-19 18:18:21'; $pager = new Pager(1, 0, true); $data = $client->pageCall("wms.stockout.Base.search", $pager, $params); ?> |
JAVA | |
C# |
6.响应示例
6.1正常响应示例
json | { "status": 0, "data": { "total_count": 1, "order_list": [{ "logistics_name": "", "consign_time": "2023-04-24 10:08:11", "warehouse_type": 1, "error_info": "", "custom_type": 0, "receiver_city": 0, "operator_id": 585, "detail_list": [{ "rec_id": 2852889, "stockout_id": 1637150, "spec_id": 1, "spec_no": "wangdiantong", "num": 1, "brand_no": "ffl", "brand_name": "发发拉", "goods_name": "wangdiantong", "goods_no": "wangdiantong", "spec_name": "暂无", "spec_code": "LL ", "checked_cost_price": 5, "weight": 0.2, "remark": "", "unit_id": 31, "unit_ratio": 33, "aux_unit_id": 577, "batch_no": "", "batch_remark": "", "goods_type": 1, "position_id": -8, "position_no": "销退质检", "goods_id": 1, "batch_id": 0, "is_package": false, "scan_type": 0, "src_order_detail_id": 0, "unit": "口", "aux_unit_name": "锅", "expire_date": "", "created": "2023-04-24 10:08:11", "modified": "2023-04-24 10:08:11" }], "goods_type_count": 1, "remark": "", "goods_count": 1, "calc_post_cost": 0, "stockout_id": 1637150, "src_order_no": "ZC202304240001", "logistics_id": 0, "receiver_zip": "", "warehouse_no": "wdtapi3-test", "checked_goods_total_cost": 5, "modified": "2023-04-24 10:08:11", "receiver_country": 0, "calc_weight": 0, "logistics_type": -1, "receiver_province": 0, "logistics_no": "", "src_order_id": 260, "created": "2023-04-24 10:08:11", "stockout_no": "CH2023042427", "src_order_type": 8, "receiver_district": 0, "weight": 0, "logistics_company_no": "", "operator_name": "aaa", "weigh_post_cost": 0, "warehouse_id": 624, "status": 110, "consign_status": 0 }] } } |
6.2异常响应示例
json | { "message": "您的查询时间过宽,查询时间不能大于60分钟", "status": 100 } |