查询货品资料
接口:Prdt/List
【基本信息】
信息 | 值 | 备注 |
---|---|---|
接口名称 | 查询货品资料 | 分页查询货品资料,默认按EFF_DD倒序 |
请求状态 | POST | RESTful方式 |
接口路径 | http://localhost:23798/api/Prdt/List | 向服务器地址发送POST请求 |
远程模式 | http://www.linkerplus.com/api/ext_erp/Prdt/List | 远程模式向服务器地址发送POST请求,需要ERP注册号注册远程模式,并在Headers添加sn参数 |
【请求参数】
Headers
参数名称 | 是否必须 | 参数值 | 备注 |
---|---|---|---|
Content-Type | 是 | application/json | 用于指定数据的传输类型 |
LoginId | 是 | e835943e-55c2-4bf0-832d-6f4166592941 | 用户登录的LoginId,取用户登录或账套验证接口返回的LoginId |
sn | 否 | MGR_REST_1001 | 远程模式需添加sn参数,MGR_REST_+ERP注册号 |
Body
参数名称 | 类型 | 是否必须 | 参数值 | 备注 |
---|---|---|---|---|
CURRENT_PAGE | int | 是 | 1 | 当前页码,表示返回该页数据 |
PAGE_SIZE | int | 否 | 100 | 每页数据数量,默认【100】,值在【1-1000】中选择,传其它值会取默认值 |
USR_NO | string | 否 | 用户代号。账套验证的LoginId需添加USR_NO,用户登录的LoginId则无需添加USR_NO | |
FILTER | object | 否 | 见下方详细说明 | 过滤条件 |
ORDER_BY | object | 否 | 有值时:{"PRD_NO":"DESC","NAME":"ASC"} | 排序条件。按PRDT表中栏位自动匹配,为空时按EFF_DD倒序。 DESC:降序、ASC:升序 |
### FILTER ###
{
"START_DD": "", //查询EFF_DD大于该时间的数据(可用于同步货品资料数据),格式为yyyy-MM-dd 或 yyyy-MM-dd HH:mm:ss
"PRD_NO_B": "", //起始品号
"PRD_NO_E": "", //截止品号
"NAME": "", //品名,模糊匹配
"NAME_ENG": "", //英文品名,模糊匹配
"SPC": "", //规格,模糊匹配
"DO_CODE": "", //助记码,模糊匹配
"CHK_BAT": "", //是否启用批号管制。"T"、"F"
"CHK_NUM": "", //是否启用序列号管制。"T"、"F"
"CHK_TAX": "", //是否启用农副产品。"T"、"F"
"NOUSE_ID": "" //"T":已停用。 "F":未停用
}
【返回数据】
参数名称 | 类型 | 参数值 | 备注 |
---|---|---|---|
code | int | 0:表示查询成功。 1:表示查询失败。 | |
message | string | 执行信息 | |
result | object | 查询到的信息,JSON格式,具体信息参考下面调用范例 |
【调用范例】
请求:
{
"CURRENT_PAGE": 1, //必填,当前第几页
"PAGE_SIZE": 1, //选填,默认每页100,可传1-1000
"USR_NO": "ADMIN", //账套验证的LoginId需添加USR_NO,用户登录的LoginId则无需添加
"FILTER": {//选填
"START_DD": "", //查询EFF_DD大于该时间的数据(可用于同步货品资料数据),格式为yyyy-MM-dd 或 yyyy-MM-dd HH:mm:ss
"PRD_NO_B": "", //起始品号
"PRD_NO_E": "", //截止品号
"NAME": "", //品名,模糊匹配
"NAME_ENG": "", //英文品名,模糊匹配
"SPC": "", //规格,模糊匹配
"DO_CODE": "", //助记码,模糊匹配
"CHK_BAT": "", //是否启用批号管制。"T"、"F"
"CHK_NUM": "", //是否启用序列号管制。"T"、"F"
"CHK_TAX": "", //是否启用农副产品。"T"、"F"
"NOUSE_ID": "" //"T":已停用。 "F":未停用
},
"ORDER_BY": {} //选填,排序条件,按PRDT表栏位自动匹配,默认以EFF_DD倒序,使用此接口同步最新资料时,需记录第一页第一条数据的EFF_DD
}
返回:
{
"code":0,
"message":"查询成功。",
"result":{
"total": 256,
"total_page": 256,
"current_total": 1,
"current_page": 1,
"page_size": 1,
"has_pre": false,
"has_next": true,
"data": [
{
"PRD_NO": "A001",//货品代号
"SNM": "铁片",//简称
"IDX1": "",//中类代号
"UT": "片",//主单位
"UT1": "",//副单位
"DFU_UT": "1",//计量单位
"NAME": "铁片",//名称
"SPC": "",//规格
"KND": "4",//大类
"PK2_UT": "",//包装(一) 单位
"PK2_QTY": "1.00000000",//包装(一) 数量
"PK3_UT": "",//包装(二) 单位
"PK3_QTY": "1.00000000",//包装(二) 数量
"MRK": "",//品牌
"SUP1": "",//主供应商
"SUP2": "",//次供应商
"REM": "",//摘要
"PAK_UNIT": "",//包装单位
"PAK_EXC": "",//包装换算
"PAK_NW": "",//包装净重
"PAK_WEIGHT_UNIT": "",//包装净重单位
"PAK_GW": "",//包装毛重
"PAK_MEAST": "",//包装大小
"PAK_MEAST_UNIT": "",//包装大小单位
"STOP_ID": "",//停止使用
"NOUSE_DD": "",//货品停用日期
"FORMULA": "",//材积公式
"NAME_ENG": "",//英文名称
"CHK_BAT": "F",//批号管制否
"QTY_LOW": "",//批量
"WH": "",//预设仓库
"CHK_NUM": "F",//序列号管制否
"CHK_TAX": "F",//是农副产品
"VALID_DAYS": "",//有效天数
"DEP": "",//所属部门
"QTY_MIN": "",//安全存量
"QTY_MAX": "",//上限
"PRD_DD": "2020-11-16 0:00:00",//货品创建时间
"LOCK_STOCK_QTY": "F",//库存占用否
"LOCK_PRE_DAYS": "",//库存占用提前期
"CHK_YL": "",//余料管理否
"EFF_DD": "2020-11-16 13:59:44",//生效日期
"USR": "001",//录入员
"CHK_MAN": "001",//审核人
"CLS_DATE": "2020-11-16 0:00:00",//终审日期
"OBJ_TYPE": "",//所属分类
"PRD_CHK": "",//需检验
"CHK_MARK": "",//特征管制
"MARK_NO": "",//特征组
"PRD_ML": "",//倒冲领料
"DO_CODE": "tp",//助记码
"EP_MARK": "",//允许特征栏位为空
"MRK_NAME": "",//品牌名称
"RECORD_DD": "2020-11-16 13:59:44",//RECORD_DD
"UPR": "",//统一定价
"UP_SAL": "",//业务成本
"UPR_LEVEL1": "",//总代理价
"UPR_LEVEL2": "",//一级代理价
"UPR_LEVEL3": "",//二级代理价
"UPR_LEVEL4": "",//经销批发价
"UPR_LEVEL5": "",//一般客户价
"UP_MAX": "",//最高成本价
"UP_MIN": "",//最低售价
"UPR_TP": "",//会员价
"ZDY": ""//自定义字段
}
]
}
}
【备注】
必须在Headers里面传入用户登录或账套验证的LoginId。
使用该接口同步货品资料的建议
排序条件不用填,第一次调用后,记录第1页第一项数据的EFF_DD,作为下一次调用的FILTER中的START_DD的传值,若下一次调用有数据返回,则表示有货品数据更新或者新增,通过此方法可获取全部货品数据。
EFF_DD为空未审核数据不返回。
自定义字段与普通字段一样的方式返回,自定义字段区分用户。
接口:Prdt/GetPrdtCus
【基本信息】
信息 | 值 | 备注 |
---|---|---|
接口名称 | 查询货品的与客户厂商资料 | 查询货品的与客户厂商资料 |
请求状态 | POST | RESTful方式 |
接口路径 | http://localhost:23798/api/Prdt/GetPrdtCus | 向服务器地址发送POST请求 |
远程模式 | http://www.linkerplus.com/api/ext_erp/Prdt/GetPrdtCus | 远程模式向服务器地址发送POST请求,需要ERP注册号注册远程模式,并在Headers添加sn参数 |
【请求参数】
Headers
参数名称 | 是否必须 | 参数值 | 备注 |
---|---|---|---|
Content-Type | 是 | application/json | 用于指定数据的传输类型 |
LoginId | 是 | e835943e-55c2-4bf0-832d-6f4166592941 | 用户登录的LoginId,取用户登录或账套验证接口返回的LoginId |
sn | 否 | MGR_REST_1001 | 远程模式需添加sn参数,MGR_REST_+ERP注册号 |
Body
参数名称 | 类型 | 是否必须 | 参数值 | 备注 |
---|---|---|---|---|
PRD_NO | string | 是 | 00000001 | 货品代号 |
SEARCH_INFO | array | 否 | 例如:[{"field":"VALID_DD","field_type":"datetime","operator":"range","value":["2023-11-01 00:00:00","2024-12-31 00:00:00"]}] | 过滤条件,关于field、operator、field_type、value的传值解释见下方SEARCH_INFO传值解释 |
SEARCH_INFO传值解释
field
:标准BOM表头(MF_BOM)栏位
field_type
:暂时只支持string、number、date、datetime类型
operator
:根据field_type的不同而不同,详细见下方表格
value
:根据field_type、operator的不同而不同,支持字符串和数组
1、field_type:"string" 时operator、value的传值要求:
operator | value的格式 | 备注 |
---|---|---|
contain | string | value传字符串 |
in | array | value传字符串数组格式 |
not_in | array | value传字符串数组格式 |
range | array | value传字符串数组格式,数组且只有2个值 |
equal | string | value传字符串 |
not_equal | string | value传字符串 |
null | value传值自动忽略,可不传 | |
not_null | value传值自动忽略,可不传 |
2、field_type:"number" 时operator、value的传值要求:
operator | value的格式 | 备注 |
---|---|---|
equal | number | value传数值,等于 |
not_equal | number | value传数值,不等于 |
greater_than | number | value传数值,大于 |
less_than | number | value传数值,小于 |
greater_equal_than | number | value传数值,大于等于 |
less_equal_than | number | value传数值,小于等于 |
3、field_type:"date"、field_type:"datetime" 时operator、value的传值要求:
- date格式:
yyyy-MM-dd
- datetime格式:
yyyy-MM-dd HH:mm:ss
operator | value的格式 | 备注 |
---|---|---|
equal | string | value传数值,等于 |
null | value传值自动忽略,可不传 | |
not_null | value传值自动忽略,可不传 | |
range | array | value传字符串数组格式,数组且只有2个值,表示起止日期时间 |
today | value传值自动忽略,可不传。表示今天 | |
yesterday | value传值自动忽略,可不传。表示昨天 | |
last_7_days | value传值自动忽略,可不传。表示最近7天 | |
last_30_days | value传值自动忽略,可不传。表示最近30天 | |
this_week | value传值自动忽略,可不传。表示本周 | |
this_month | value传值自动忽略,可不传。表示本月 | |
this_quarter | value传值自动忽略,可不传。表示本季度 | |
this_year | value传值自动忽略,可不传。表示本年 | |
last_week | value传值自动忽略,可不传。表示上周 | |
last_month | value传值自动忽略,可不传。表示上月 | |
last_quarter | value传值自动忽略,可不传。表示上季度 | |
last_year | value传值自动忽略,可不传。表示去年 | |
on_or_after_today | value传值自动忽略,可不传。表示大于等于今天 | |
on_or_before_today | value传值自动忽略,可不传。表示小于等于今天 | |
after_today | value传值自动忽略,可不传。表示大于今天 | |
befor_today | value传值自动忽略,可不传。表示小于今天 | |
days_after_today | number | value传天数,如10,表示从今天到今天之后(10天)之间 |
days_before_today | number | value传天数,如10,表示从今天之前(10天)到今天之间 |
【返回数据】
参数名称 | 类型 | 参数值 | 备注 |
---|---|---|---|
code | int | 0:表示查询成功 | |
message | string | 执行信息 | |
result | object | 查询到的信息,JSON格式 |
【调用范例】
请求:
{
"PRD_NO": "00000001",
// SEARCH_INFO选传
"SEARCH_INFO": [
{
"field": "CUS_NO",
"operator": "contain",
"field_type": "string",
"value": "01"
}
]
}
返回:
{
"code": 0,
"message": "查询成功。",
"result": {
"data": [
{
"PRD_NO": "00000001",
"CUS_NO": "01",
"PRD_MARK": "",
"PRD_NO_SUP": "",
"UP_SPC": "0.0000",
"DIS_RTO": "",
"REM": "",
"PO_DAYS": "",
"QTY_LOW": "0.00",
"UNIT": "",
"UP_TW": "0.0000",
"PRD_NAME_SUP": "",
"LOSS": "",
"PO_RTO": "",
"RTO_TAX": "",
"DEF_FILE1": "",
"DEF_FILE2": "",
"VALID_DD": "",
"OTH_DD": "",
"QTY_DEF": "0.00",
"HX_LOSS": "",
"SPC_SUP": ""
},
{
"PRD_NO": "00000001",
"CUS_NO": "PJKH01",
"PRD_MARK": "",
"PRD_NO_SUP": "",
"UP_SPC": "0.0000",
"DIS_RTO": "",
"REM": "",
"PO_DAYS": "",
"QTY_LOW": "0.00",
"UNIT": "",
"UP_TW": "0.0000",
"PRD_NAME_SUP": "",
"LOSS": "",
"PO_RTO": "",
"RTO_TAX": "",
"DEF_FILE1": "",
"DEF_FILE2": "",
"VALID_DD": "",
"OTH_DD": "",
"QTY_DEF": "0.00",
"HX_LOSS": "",
"SPC_SUP": ""
}
]
}
}
【备注】
- 必须在Headers里面传入用户登录或账套验证的LoginId。