1. Custom Field API
API URL
post {HTTP(S)host}/api/{version}/property
1.1. Custom Field Query List
1.1.1. SERVICE_TYPE
CUSTOMER_FIELD_QUERY
1.1.2. Request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| tableName | Y | String | SYS_ITEM | SYS_ITEM： System sku Custom Field ； SYS_ORDER： Order Custom Field ； SYS_ODO： Outbound order Custom Field ； SYS_ASN： Inbound order Custom Field 。 |
| columType | N | String | NUMBER | Custom Field type: NUMBER,DATE,STRING,SELECT。 |
| columName | N | String | Date of manufacture | The name of the field defined by the user |
| required | N | Number | 1 | Whether to query only Require field: 1:true;0:false |
| isQuery | N | Number | 1 | Whether to query only the field that support the query : 1:true;0:false |
| isShow | N | Number | 1 | Specifies whether to query only the columns that support column configurations: 1:true;0:false |
1.1.3. Reponse
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| errorCode | Y | String | “DATA_INPUT_ERROR” | Error Code |
| errorMsg | Y | String | “The input of Params is incorrect” | Business Error Messages |
| state | Y | String | success | Response State |
| total | Y | Number | 100 | Total num |
| result | Y | List |
Shop For details, see the table below |
CustomeField(Custom Field )
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| id | N | Long | 3 | The ID of a Custom Field, which is used to create orders, etc |
| tableName | Y | String | SYS_ITEM | SYS_ITEM： System sku Custom Field ； SYS_ORDER： Order Custom Field ； SYS_ODO： Outbound order Custom Field ； SYS_ASN： Inbound order Custom Field 。 |
| columType | Y | String | NUMBER | Filter for custom fields NUMBER for different fill types：number; DATE; STRING; SELECT。 |
| columName | Y | String | Date of manufacture | The name of the field defined by the user |
| defaultValue | N | String | 1970/01/01 | Custom Field Default value |
| candidateValue | N | String | ["1970/01/01","1970/01/02"] | Candidate value for the drop-down box |
| remark | N | String | The shelf date is distinguished from the date of manufacture | Description |
| required | N | Integer | 1 | Whether to query only the required fields 1:true;0:false |
| isQuery | N | Integer | 1 | Whether to query only the columns that support the query 1:true;0:false |
| isShow | N | Integer | 1 | Specifies whether to query only the columns that support column configurations 1:true;0:false |
Request:
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"'
Response:
{
"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"
}