Thêm mới khách hàng

Endpoint

POST /v1/customers

Quyền: customer.manage hoặc order.pos

Body Parameters

Tên	Kiểu	Bắt buộc	Mô tả
`company_id`	int	Có	ID công ty
`creator_id`	int	Có	ID người tạo
`full_name`	string	Có	Tên đầy đủ
`customer_type_id`	int		ID nhóm khách hàng
`code`	string		Mã khách hàng (chỉ chấp nhận a-z, A-Z, 0-9, _, -, .)
`birthday`	string		Ngày sinh (DD/MM/YYYY)
`address`	string		Địa chỉ
`region_id`	int		ID Tỉnh/Thành phố
`sub_region_id`	int		ID Quận/Huyện
`sub_sub_region_id`	int		ID Phường/Xã
`email`	string		Email
`phone`	string		Số điện thoại (≥ 8 ký tự số)
`gender`	int		Giới tính (1: Nữ, 3: Nam, 5: Khác, 7: Chưa xác định)
`salutation`	string		Danh xưng
`address_line_2`	string		Địa chỉ phụ
`delivery_note`	string		Ghi chú giao hàng
`legacy_province_name`	string		Tên tỉnh/thành cũ
`legacy_district_name`	string		Tên quận/huyện cũ
`legacy_ward_name`	string		Tên phường/xã cũ
`avatar_file_id_list`	array		Danh sách ID file avatar
`note`	string		Ghi chú
`internal_name`	string		Tên nội bộ
`internal_note`	string		Ghi chú nội bộ
`source`	int		Nguồn khách hàng
`zalo_id`	string		ID Zalo
`facebook_id`	string		ID Facebook
`instagram_id`	string		ID Instagram
`tiktok_id`	string		ID TikTok
`shopee_id`	string		ID Shopee
`telegram_id`	string		ID Telegram
`price_policy_id`	int		ID chính sách giá
`tax_buyer_name`	string		Tên người mua hàng (hóa đơn)
`tax_buyer_address`	string		Địa chỉ (hóa đơn)
`tax_buyer_phone`	string		SĐT (hóa đơn)
`tax_buyer_email`	string		Email (hóa đơn)
`tax_buyer_account_bank`	string		Ngân hàng (hóa đơn)
`tax_buyer_account_number`	string		Số tài khoản (hóa đơn)
`tax_buyer_tax_number`	string		Mã số thuế
`tag`	string		Tag (ngăn cách bằng dấu phẩy)
`ignore_auto_upgrade`	int		Bỏ qua tự động nâng cấp hạng (1: Có)
`is_company`	int		Là công ty (1: Có)
`group`	int		Nhóm đối tác (0: Khách lẻ, 1: VIP, 3: Bán sỉ, 5: NPP, 7: CTV)
`group_status`	int		Trạng thái đối tác (0: None, 1: Pending, 3: Approved, 5: Rejected)
`group_moderator_id`	int		ID người quản lý đối tác
`group_moderator_note`	string		Ghi chú của người quản lý
`representative_name`	string		Tên người đại diện
`representative_id`	string		Mã/CMND người đại diện
`representative_file_id_list`	array		Danh sách ID file giấy tờ đại diện
`group_data`	array		Dữ liệu mở rộng theo nhóm đối tác
`attribute_detail`	array		Chi tiết thuộc tính động

Ví dụ JSON

{
    "company_id": 10311,
    "creator_id": 1,
    "full_name": "Nguyễn Văn A",
    "customer_type_id": 1,
    "code": "KH001",
    "birthday": "01/01/1990",
    "address": "123 Đường ABC",
    "region_id": 8881,
    "sub_region_id": 888101,
    "sub_sub_region_id": 88810101,
    "email": "[email protected]",
    "phone": "0901234567",
    "gender": 3,
    "salutation": "Anh",
    "address_line_2": "",
    "delivery_note": "",
    "legacy_province_name": "",
    "legacy_district_name": "",
    "legacy_ward_name": "",
    "avatar_file_id_list": [],
    "note": "Khách hàng thân thiết",
    "internal_name": "",
    "internal_note": "",
    "source": 0,
    "zalo_id": "",
    "facebook_id": "",
    "instagram_id": "",
    "tiktok_id": "",
    "shopee_id": "",
    "telegram_id": "",
    "price_policy_id": 0,
    "tax_buyer_name": "",
    "tax_buyer_address": "",
    "tax_buyer_phone": "",
    "tax_buyer_email": "",
    "tax_buyer_account_bank": "",
    "tax_buyer_account_number": "",
    "tax_buyer_tax_number": "",
    "tag": "vip,loyal",
    "ignore_auto_upgrade": 0,
    "is_company": 0,
    "group": 0,
    "group_status": 0,
    "group_moderator_id": 0,
    "group_moderator_note": "",
    "representative_name": "",
    "representative_id": "",
    "representative_file_id_list": [],
    "group_data": [],
    "attribute_detail": []
}

Response Schema

HTTP 201 - JSON Object

Trả về object Customer vừa tạo.

Error Codes

HTTP	Code	Mô tả
403	`error_forbidden`	Không có quyền thao tác
422	`error_company_id_required`	ID công ty không được để trống
422	`error_company_id_notfound`	ID công ty không tìm thấy
422	`error_user1_id_required`	ID người tạo không được để trống
422	`error_user_id_notfound`	ID người tạo không tìm thấy
422	`error_fullname_required`	Thiếu tên khách hàng
422	`error_code_invalid`	Mã khách hàng không hợp lệ
422	`error_code_exists`	Mã khách hàng đã tồn tại
422	`error_email_exists`	Email đã tồn tại
422	`error_email_invalid`	Email không hợp lệ
422	`error_phone_exists`	Số điện thoại đã tồn tại
422	`error_phone_invalid`	Số điện thoại không hợp lệ
422	`error_birthday_format_invalid`	Định dạng ngày sinh sai
422	`error_birthday_invalid`	Ngày sinh không hợp lệ
500	`error_add`	Lỗi khi thêm mới

Thêm mới khách hàng

Endpoint

Body Parameters

Ví dụ JSON

Response Schema

HTTP 201 - JSON Object

Error Codes

On this page