当前位置: API文档
process.Bom.search(物料清单)
1.接口说明
| 1.1 接口描述:获取ERP物料清单数据 |
| 1.2 适用版本:客户端V1.4.3.4及以上版本 |
| 1.3 增量获取:支持 |
| 1.4 时间跨度:start_time与end_time起止时间跨度不超过30天 |
| 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 | N | 物料清单最后修改时间 |
| 结束时间 | end_time | String | 40 | N | 物料清单最后修改时间 |
| 物料清单编号 | bom_no | String | N | 物料清单编号为空时,时间条件必填 | |
| 是否展示已停用清单 | show_disabled | boolean | 1 | N | 是:true 否:false 默认false |
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
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
总数 | total_count | Int | 11 | Y | 查询条件总单据数 |
| 数据节点 | order_list | Map<String, Object> | Y | 数据节点 |
order_list
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
物料清单唯一键 | bom_id | Int | 11 | Y | 物料清单唯一键 |
| 物料清单编号 | bom_no | String | 64 | Y | 物料清单编号 |
| 物料清单名称 | bom_name | String | 255 | Y | 物料清单名称 |
| 操作人 | operator_name | String | 50 | Y | 操作人 |
| 操作人id | operator_id | Int | 11 | Y | 操作人id |
| 生产费用 | fee | Decimal(19,4) | Y | 生产费用 | |
| 备注 | remark | String | 1024 | Y | 备注 |
| 是否停用 | is_disabled | boolean | 1 | Y | 是否停用 是:true 否:false |
| 创建时间 | created | String | Y | 创建时间 格式: yyyy-MM-dd HH:mm:ss | |
最后修改时间 | modified | String | Y | 最后修改时间 格式: yyyy-MM-dd HH:mm:ss | |
成品列表 | product_list | List<Map<String,Object>> | Y | 成品列表 | |
原料列表 | material_list | List<Map<String,Object>> | Y | 原料列表 |
product_list
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
物料清单唯一键 | bom_id | Int | 11 | Y | 物料清单唯一键 |
物料清单明细唯一键 | bom_detail_id | Int | 11 | Y | 物料清单明细唯一键 |
| 数量 | num | Decimal(19,4) | Y | 数量 | |
是否为主物料清单 | is_master | boolean | 1 | Y | 是否主物料清单 是:true 否:false |
是否成品 | is_product | boolean | 1 | Y | 是否成品 是:true 否:false |
| 货品编号 | goods_no | String | 40 | Y | 货品编号 |
| 货品名称 | goods_name | String | 255 | Y | 货品名称 |
| 商家编码 | spec_no | String | 40 | Y | 商家编码 |
| 规格名称 | spec_name | String | 100 | Y | 规格名称 |
| 规格编码 | spec_code | String | 40 | Y | 规格编码 |
| 条码 | barcode | String | 50 | Y | 条码 |
| sn类型 | sn_type | byte | Y | 0:未启用 1:强sn 2:弱sn | |
| 零售价 | retail_price | Decimal(19,4) | Y | 单品零售价 | |
| 成本价 | cost | Decimal(19,4) | Y | 成本价 | |
总成本 | all_cost | Decimal(19,4) | Y | 总成本 | |
| 备注 | remark | String | 255 | Y | 备注 |
material_list
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
物料清单唯一键 | bom_id | Int | 11 | Y | 物料清单唯一键 |
物料清单明细唯一键 | bom_detail_id | Int | 11 | Y | 物料清单明细唯一键 |
| 数量 | num | Decimal(19,4) | Y | 数量 | |
是否为主物料清单 | is_master | boolean | 1 | Y | 是否主物料清单 是:true 否:false |
是否成品 | is_product | boolean | 1 | Y | 是否成品 是:true 否:false |
| 货品编号 | goods_no | String | 40 | Y | 货品编号 |
| 货品名称 | goods_name | String | 255 | Y | 货品名称 |
| 商家编码 | spec_no | String | 40 | Y | 商家编码 |
| 规格名称 | spec_name | String | 100 | Y | 规格名称 |
| 规格编码 | spec_code | String | 40 | Y | 规格编码 |
| 条码 | barcode | String | 50 | Y | 条码 |
| sn类型 | sn_type | byte | Y | 0:未启用 1:强sn 2:弱sn | |
| 零售价 | retail_price | Decimal(19,4) | Y | 单品零售价 | |
| 成本价 | cost | Decimal(19,4) | Y | 成本价 | |
总成本 | all_cost | Decimal(19,4) | Y | 总成本 | |
| 备注 | remark | String | 255 | Y | 备注 |
5.请求示例
| [
{
"start_time": "2022-12-01 00:00:00",
"end_time": "2022-12-24 00:00:00"
}
] |
| <?php
header("Content-Type: text/html; charset=UTF-8");
date_default_timezone_set("Asia/Shanghai");
$client = new WdtErpClient("url", "wdtapi3", "appkey", "secret")
$parMap = new stdClass();
$parMap->start_time = "2022-12-01 00:00:00";
$parMap->end_time = "2022-12-24 00:00:00";
$pager = new Pager(50, 0, true);
$data = $client->pageCall("process.Bom.search", $pager, $parMap);
?> |
6.响应示例
6.1正常响应示例
| {
"status": 0,
"data":
{
"total_count": 1,
"order_list":
[
{
"bom_id": 86,
"operator_name": "张卓",
"operator_id": 158,
"created": "2022-12-13 14:41:18",
"fee": 5.0000,
"is_disabled": false,
"material_list":
[
{
"bom_detail_id": 1475,
"bom_id": 86,
"num": 1.0000,
"is_product": false,
"is_master": false,
"remark": "",
"goods_no": "zz03",
"goods_name": "潮系男士短袖",
"spec_no": "zz0302",
"spec_name": "黑色S码",
"spec_code": "02",
"barcode": "zz0302",
"sn_type": 0,
"retail_price": 50.0000,
"cost": 0.0000,
"all_cost": 0.0000
},
{
"bom_detail_id": 1476,
"bom_id": 86,
"num": 1.0000,
"is_product": false,
"is_master": false,
"remark": "",
"goods_no": "zz02",
"goods_name": "潮洗男生夏凉裤",
"spec_no": "zz0202",
"spec_name": "黑色S码",
"spec_code": "02",
"barcode": "zz0202",
"sn_type": 0,
"retail_price": 60.0000,
"cost": 0.0000,
"all_cost": 0.0000
}
],
"modified": "2022-12-13 14:41:18",
"bom_no": "GP202212130001",
"remark": "",
"product_list":
[
{
"bom_detail_id": 1477,
"bom_id": 86,
"num": 1.0000,
"is_product": true,
"is_master": false,
"remark": "",
"goods_no": "090909",
"goods_name": "阿拉蕾 新品黄色",
"spec_no": "090909",
"spec_name": "黄色",
"spec_code": "",
"barcode": "",
"sn_type": 0,
"retail_price": 1.0000,
"cost": 0.0000,
"all_cost": 0.0000
}
],
"bom_name": "潮服一套"
}
]
}
} |
6.2异常响应示例
| {
"status": 100,
"message": "开始时间与结束时间间隔最大30天"
} |