1. 属性模块API
API URL
post {HTTP(S)地址}/api/{version}/property
1.1. 自定义栏位列表查询接口
1.1.1. SERVICE_TYPE
CUSTOMER_FIELD_QUERY
1.1.2. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| tableName | Y | String | SYS_ITEM | SYS_ITEM：系统商品自定义栏位； SYS_ORDER：订单自定义栏位； SYS_ODO：出库单自定义栏位； SYS_ASN：入库单自定义栏位。 |
| columType | N | String | NUMBER | 筛选不同填入类型的自定义栏位 NUMBER：数字； DATE：日期； STRING：字符串； SELECT：下拉框。 |
| columName | N | String | 生产日期 | 用户自己定义的栏位名称 |
| required | N | Number | 1 | 是否只查询必填栏位 1:true;0:false |
| isQuery | N | Number | 1 | 是否只查询支持查询的栏位 1:true;0:false |
| isShow | N | Number | 1 | 是否只查询支持列配置的栏位 1:true;0:false |
1.1.3. 返回参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| errorCode | Y | String | “DATA_INPUT_ERROR” | 错误码 |
| errorMsg | Y | String | “输入参数不对” | 业务错误信息 |
| state | Y | String | success | 请求结果 |
| total | Y | Number | 100 | 总条数 |
| result | Y | List |
店铺信息,详情查看下表 |
CustomeField(自定义栏位)
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| id | N | Long | 3 | 自定义栏位的ID,用于创建订单等使用 |
| tableName | Y | String | SYS_ITEM | SYS_ITEM：系统商品自定义栏位； SYS_ORDER：订单自定义栏位； SYS_ODO：出库单自定义栏位； SYS_ASN：入库单自定义栏位。 |
| columType | Y | String | NUMBER | 筛选不同填入类型的自定义栏位 NUMBER：数字； DATE：日期； STRING：字符串； SELECT：下拉框。 |
| columName | Y | String | 生产日期 | 用户自己定义的栏位名称 |
| defaultValue | N | String | "1970/01/01"(无双引号) | 自定义栏位默认值 |
| candidateValue | N | String | ["1970/01/01","1970/01/02"] | 下拉框的候选值 |
| remark | N | String | 上架日期区分于出厂日期 | 备注 |
| required | N | Integer | 1 | 是否只查询必填栏位 1:true;0:false |
| isQuery | N | Integer | 1 | 是否只查询支持查询的栏位 1:true;0:false |
| isShow | N | Integer | 1 | 是否只查询支持列配置的栏位 1:true;0:false |
请求示例:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/property' \
--form 'appId="TEST"' \
--form 'serviceType="CUSTOMER_FIELD_QUERY"' \
--form 'bizParam="{
\"tableName\":\"SYS_ITEM\"
}"' \
--form 'timestamp="1731742317"' \
--form 'sign="96ce268994dbe73ff49b7f5412be6c67"'
返回示例:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"candidateValue\":[],\"columCode\":1,\"columName\":\"商品有效期\",\"columType\":\"DATE\",\"id\":17,\"isDeleted\":0,\"isQuery\":0,\"isShow\":0,\"required\":0,\"tableName\":\"SYS_ITEM\"},{\"candidateValue\":[],\"columCode\":2,\"columName\":\"商品产地\",\"columType\":\"STRING\",\"id\":16,\"isDeleted\":0,\"isQuery\":1,\"isShow\":1,\"required\":0,\"tableName\":\"SYS_ITEM\"},{\"candidateValue\":[\"1\",\"2\",\"3\",\"123\"],\"columCode\":3,\"columName\":\"测试单选栏位\",\"columType\":\"SELECT\",\"id\":47,\"isDeleted\":0,\"isQuery\":0,\"isShow\":0,\"required\":0,\"tableName\":\"SYS_ITEM\"},{\"candidateValue\":[],\"columCode\":5,\"columName\":\"货值\",\"columType\":\"DATE\",\"id\":26,\"isDeleted\":0,\"isQuery\":0,\"isShow\":1,\"required\":0,\"tableName\":\"SYS_ITEM\"},{\"candidateValue\":[],\"columCode\":6,\"columName\":\"产品编码\",\"columType\":\"STRING\",\"id\":33,\"isDeleted\":0,\"isQuery\":1,\"isShow\":0,\"required\":0,\"tableName\":\"SYS_ITEM\"},{\"candidateValue\":[],\"columCode\":7,\"columName\":\"123\",\"columType\":\"STRING\",\"id\":40,\"isDeleted\":0,\"isQuery\":1,\"isShow\":0,\"required\":0,\"tableName\":\"SYS_ITEM\"},{\"candidateValue\":[],\"columCode\":10,\"columName\":\"地区账套\",\"columType\":\"STRING\",\"id\":27,\"isDeleted\":0,\"isQuery\":0,\"isShow\":0,\"required\":0,\"tableName\":\"SYS_ITEM\"},{\"candidateValue\":[],\"columCode\":11,\"columName\":\"单箱条码\",\"columType\":\"STRING\",\"id\":28,\"isDeleted\":0,\"isQuery\":0,\"isShow\":0,\"required\":0,\"tableName\":\"SYS_ITEM\"},{\"candidateValue\":[],\"columCode\":12,\"columName\":\"规格型号\",\"columType\":\"STRING\",\"id\":29,\"isDeleted\":0,\"isQuery\":0,\"isShow\":0,\"required\":0,\"tableName\":\"SYS_ITEM\"}],\"state\":\"success\",\"total\":9}",
"requestId": "e5ef0eb6-962a-4ce3-b339-eddec2b245fc"
}