Định nghĩa dữ liệu
1. Thông Tin API
- Endpoint:
/api/v6.1/quote/custom_fields - Method:
GET - Authentication: Yêu cầu
X-API-KEY - Header:
X-API-KEY: <your_api_key>
2. Tham số Request
2.1. Fields
| Trường | Kiểu dữ liệu | Mô tả |
|---|---|---|
id | integer | Định danh |
field_name | string | Tên trường |
field_description | string | Mô tả trường |
field_htmltype | string | Loại trường |
2.2. Filtering (Lọc dữ liệu)
| Trường | Hỗ trợ | Kiểu dữ liệu | Mô tả |
|---|---|---|---|
id | eq, in | integer | Định danh |
valid | is, in | integer | Hợp lệ hay không |
2.3. Sorting (Sắp xếp dữ liệu)
| Trường | Hướng |
|---|---|
id | asc, desc |
2.4. Pagination (Phân trang)
| Tham số | Kiểu dữ liệu | Mô tả |
|---|---|---|
limit | integer | Số bản ghi cần lấy |
offset | integer | Số bản ghi cần bỏ qua |
3. Response Mẫu
{
"data": [
{
"id": 109,
"field_name": "b1",
"field_description": "B1",
"field_htmltype": "textinput"
},
{
"id": 110,
"field_name": "b2",
"field_description": "B2",
"field_htmltype": "textinput"
}
],
"has_more": false,
"offset": 0,
"limited": 20,
"sorted": {
"field_order": "ASC"
}
}
4. Mô Tả Trường Dữ Liệu
| Trường | Kiểu dữ liệu | Mô tả |
|---|---|---|
id | integer | Định danh trường dữ liệu |
field_name | string | Tên trường (dùng làm key khi truyền custom_fields) |
field_description | string | Mô tả hiển thị của trường |
field_htmltype | string | Loại trường (textinput, select, datetime, ...) |
5. Ghi Chú
- API này dùng để lấy danh sách các trường dữ liệu tùy chỉnh (custom fields) của module Báo giá.
- Giá trị
field_nameđược sử dụng làm key khi truyềncustom_fieldstrong API thêm mới hoặc sửa báo giá.