CRMKhách hàng
Customer Object Schema
Chi tiết các trường dữ liệu của một object `Customer`.
Customer Object Schema
Đây là cấu trúc dữ liệu chuẩn của một khách hàng trong hệ thống. Một số trường có thể ẩn tùy vào quyền hạn hoặc bối cảnh API.
| Trường | Kiểu | Mô tả |
|---|---|---|
id | integer | ID duy nhất của khách hàng. |
customer_type_id | integer | ID loại khách hàng. |
code | string | Mã khách hàng. |
full_name | string | Họ và tên. |
gender | integer | Giới tính (1: Nữ, 3: Nam, 5: Khác, 7: Không xác định). |
birthday | string | Ngày sinh (định dạng DD/MM/YYYY). |
email | string | Địa chỉ email. |
phone | string | Số điện thoại. |
address | string | Địa chỉ chính. |
region_id | integer | ID Tỉnh/Thành phố. |
sub_region_id | integer | ID Quận/Huyện. |
sub_sub_region_id | integer | ID Phường/Xã. |
salutation | string | Danh xưng (VD: Anh, Chị). |
address_line_2 | string | Địa chỉ bổ sung. |
delivery_note | string | Ghi chú giao hàng. |
legacy_province_name, legacy_district_name, legacy_ward_name | string | Tên Tỉnh/Quận/Phường theo địa giới cũ (nếu có). |
avatar_file_id_list | array | Danh sách ID file ảnh đại diện. |
avatar_file_list | array | Danh sách đối tượng File chi tiết của ảnh đại diện. |
price_policy_id | integer | ID chính sách giá được áp dụng cho khách hàng này. |
count_order | integer | Tổng số đơn hàng đã mua. |
point | integer | Điểm tích lũy hiện tại. |
money | integer | Tổng số tiền đã chi tiêu. |
group | integer | Nhóm khách hàng (0: Consumer, 1: VIP, 3: Wholesale, 5: Distributor, 7: Collaborator). |
group_status | integer | Trạng thái nhóm (xem bảng Group Status). |
representative_name | string | Tên người đại diện (Nhà phân phối/CTV). |
representative_id | string | CCCD/MST người đại diện. |
representative_file_id_list | array | Danh sách ID file giấy tờ người đại diện. |
representative_file_list | array | Danh sách File Object giấy tờ người đại diện. |
attribute_detail | array | Giá trị các thuộc tính mở rộng của khách hàng. |
is_company | integer | 1 nếu là khách hàng doanh nghiệp, 0 nếu cá nhân. |
tax_buyer_name | string | Tên người mua hàng trên hóa đơn VAT. |
tax_buyer_address | string | Địa chỉ trên hóa đơn VAT. |
tax_buyer_phone | string | Số điện thoại trên hóa đơn VAT. |
tax_buyer_email | string | Email nhận hóa đơn VAT. |
tax_buyer_account_bank | string | Ngân hàng trên hóa đơn VAT. |
tax_buyer_account_number | string | Số tài khoản trên hóa đơn VAT. |
tax_buyer_tax_number | string | Mã số thuế. |
date_created | integer | Thời gian tạo (Unix timestamp). |
date_modified | integer | Thời gian cập nhật (Unix timestamp). |
date_first_ordered | integer | Thời gian đặt đơn đầu tiên (Unix timestamp). |
date_last_ordered | integer | Thời gian đặt đơn gần nhất (Unix timestamp). |
date_last_login | integer | Thời gian đăng nhập gần nhất (Unix timestamp). |
Lưu ý
Trên Storefront API, trường password luôn là "---"; các trường nội bộ như tag, internal_name, internal_note được che thành "***".
Group & Status Constants
Customer Group
| Value | Constant | Mô tả |
|---|---|---|
0 | GROUP_CONSUMER | Khách hàng lẻ thông thường. |
1 | GROUP_VIP_MEMBER | Thành viên VIP. |
3 | GROUP_WHOLESALE | Khách mua sỉ. |
5 | GROUP_DISTRIBUTOR | Nhà phân phối (Cần duyệt). |
7 | GROUP_COLLABORATOR | Cộng tác viên / KOC (Cần duyệt). |
Group Status
| Value | Constant | Mô tả |
|---|---|---|
0 | NONE | Mặc định cho khách lẻ. |
1 | PENDING | Đang chờ quản trị viên duyệt (thường áp dụng khi đăng ký làm Đại lý/CTV). |
3 | APPROVED | Đã duyệt. |
5 | REJECTED | Từ chối. |