Customers API - Thêm khách hàng
API thực hiện lưu thông tin khách hàng vào hệ thống
Các thông tin cấu hình cần thiết:
| Tên |
Mô tả |
| CompanyCode |
Mã nhà hàng lấy |
| AccessToken |
Chuỗi token xác thực |
Để lấy các thông tin trên xem bài viết account/login
About
| URL |
Phiên bản |
Thay đổi |
| graphapi.CUKCUK.vn |
1.0 |
|
| graphapi.CUKCUK.vn |
1.1 |
Thêm Id chi nhánh cần thêm khách hàng |
Schemes
Endpoints
api/v1/customers/
POST
Thêm mới khách hàng
Expected Response Types
| HttpCode |
ServiceResult.ErrorType |
Mô tả |
| 401 |
|
Chuỗi AccessToken hết hạn hoặc không hợp lệ cần phải gọi cấp phát lại |
| 200 |
1 |
Tham số không hợp lệ null or empty |
| 200 |
2 |
Mã nhà hàng không tồn tại |
| 200 |
6 |
Tham số ngày giờ không hợp lệ (01/01/1753 - 31/12/9999) |
| 200 |
7 |
Thiết lập kết nối CUKCUK đang ở trạng thái ngắt, không thể lấy dữ liệu |
| 200 |
100 |
Lỗi nội bộ API Graph |
| 200 |
102 |
Request bị từ chối, do có request cùng loại đang xử lý. Vui lòng chờ xử lý xong hoặc chờ request đang xử lý timeout thì gọi lại. |
| 200 |
200 |
Thông tin số điện thoại hoặc mã khách hàng đã tồn tại, không thể thêm mới. |
Parameters
| Name |
In |
Description |
Required? |
Type |
| param |
body |
Đối tượng thêm mới khách hàng |
true |
Customer |
| Name |
In |
Description |
Required? |
Type |
| Authorization |
header |
Header key cấu hình AccessToken (dạng Bearer AccessToken) |
true |
string |
| CompanyCode |
header |
Header key cấu hình mã nhà hàng CompanyCode |
true |
string |
Ví dụ:
CompanyCode: demoquanviet
Authorization: Bearer utFYFHGRrnz-JWVCViIjy4k3CtKWOJDBY6wvL5X_5k9jm14tLIP6qPgCXdupERxyv78hWzSAF_rtK1RRAbtwc-M96sUIzFQ4bSfeY_2xYCzmZBTPNKbohxMHDbR2F4eeNk_dM_7B5Zod8-qGhT7LDwtE_23cuRWeK_qWkYHk2rMiqJM-vd9dYHANtq4OVI-Y8fYZ4B_Q_wPvsZl6svkSNLX2RQygFMOccGsC_G3dv1MbUf2KWjOHcr_SBPH66jQPs8V3CbZ_Eywo7vShkqdenhvNqdNOg9Gl56tybzW4YfcAvmYMUUOEuc7-ffyHfUnE
Content Types Produced
| Produces |
| application/json |
Content Types Consumed
| Consumes |
| application/json |
Response
Trả về đối tượng ServiceResult với ServiceResult.Data là Customer
với thông tin Customer.Code, Customer.Id do hệ thống CUKCUK sinh.
Example
Ví dụ gửi tham số gọi tới api
JSON Customer
{
"Code": "KH000010",
"Name": "Nguyễn Văn A",
"Tel": "03423546412",
"Birthday": "1998-11-25T00:00:00",
"Address": "Trần Quốc Vượng, Dịch Vọng Hậu, Cầu Giấy, Hà Nội",
"Description": "",
"Inactive": false
}
Hệ thống sẽ trả về ServiceResult với Data là Array<Customer>
JSON response
Trường hợp: Thông tin số điện thoại và mã khách hàng chưa tồn tại trong hệ thống
{
"Code": 200,
"Data": [
{
"Id": "0f330970-d4e4-47d6-b8bb-bbff89415c21",
"Code": "KH000010",
"Name": "Nguyễn Văn A",
"Tel": "03423546412",
"Birthday": "1998-11-25T00:00:00",
"Address": "Trần Quốc Vượng, Dịch Vọng Hậu, Cầu Giấy, Hà Nội",
"Description": "",
"Inactive": false
}
],
"Total": 0,
"Success": true
}
Trường hợp: Thông tin số điện thoại và mã khách hàng đã tồn tại trong hệ thống
{
"Code": 200,
"ErrorType": 200,
"ErrorMessage": "Mã khách hàng KH000010 hoặc số điện thoại 03423546412 đã tồn tại",
"Data": [
{
"Id": "e7a9139f-5c81-4464-b460-7d892866d6da",
"Code": "KH000010",
"Name": "Nguyễn Văn B",
"Tel": "03423546412",
"Address": "Trần Quốc Vượng, Dịch Vọng Hậu, Cầu Giấy, Hà Nội",
"Description": "",
"Inactive": false
}
],
"Total": 0,
"Success": false
}
Definitions
Customer Definition
| Property |
Type |
Format |
Bắt buộc (*) |
Mô tả |
| Id |
string |
guid |
|
Id khách hàng |
| BranchId |
string |
guid |
|
Id chi nhánh |
| OriginalBranchId |
string |
guid |
|
Id chi nhánh gốc (cho đối tác tự quản lý) |
| Code |
string |
|
|
Mã khách hàng |
| Name |
string |
|
* |
Tên khách hàng |
| CustomerCategoryID |
string |
guid |
|
Id nhóm khách hàng CUKCUK |
| CustomerCategoryName |
string |
|
|
Tên nhóm khách hàng |
| Tel |
string |
|
* |
Số điện thoại |
| Address |
string |
|
|
Địa chỉ (số nhà, phố..) |
| Email |
string |
|
|
Email |
| Description |
string |
|
|
Ghi chú khách hàng |
| IdentifyNumber |
string |
|
|
Số ID nhân dân |
| Birthday |
string |
datetime |
|
Ngày sinh (ISODate) |
| Inactive |
bool |
|
|
Ngừng theo dõi (true: ngừng theo dõi, false: theo dõi) |
| OldNumberCard |
string |
|
|
Số thẻ cũ |
| CardStartDate |
string |
datetime |
|
Ngày phát hành thẻ (ISODate) |
| CardExpireDate |
string |
datetime |
|
Ngày hết hạn thẻ (ISODate) |
ServiceResult Definition
| Property |
Type |
Format |
Mô tả |
| Code |
int |
|
Mã lỗi HttpCode (200, 500...) |
| ErrorType |
int |
|
Loại lỗi |
| ErrorMessage |
string |
|
Thông tin lỗi |
| Success |
bool |
|
True - không có lỗi logic xảy ra |
| Data |
string |
object |
Dữ liệu trả về |
| Total |
interger |
|
Tổng số bản ghi khi lấy dữ liệu phân trang |
ErrorType Definition
| HttpCode |
ServiceResult.ErrorType |
Mô tả |
| 401 |
|
Chuỗi AccessToken hết hạn hoặc không hợp lệ cần phải gọi cấp phát lại |
| 200 |
0 |
Không có lỗi |
| 200 |
1 |
Tham số không hợp lệ null or empty |
| 200 |
2 |
Mã nhà hàng không tồn tại |
| 200 |
3 |
Mã Appid không tồn tại trên hệ thống |
| 200 |
4 |
Chuỗi thông tin chữ ký đăng nhập không hợp lệ, timeout |
| 200 |
5 |
Tham số lấy phân trang vượt quá số lượng cấu hình cho phép (max 100) |
| 200 |
6 |
Tham số ngày giờ không hợp lệ (01/01/1753 - 31/12/9999) |
| 200 |
7 |
Thiết lập kết nối CUKCUK đang ở trạng thái ngắt, không thể lấy dữ liệu |
| 200 |
200 |
Thông tin số điện thoại hoặc mã khách hàng đã tồn tại, không thể thêm mới. |
| HttpCode |
ServiceResult.ErrorType |
Mô tả |
| 200 |
100 |
Lỗi nội bộ API Graph |
| 200 |
102 |
Request bị từ chối, do có request cùng loại đang xử lý. Vui lòng chờ xử lý xong hoặc chờ request đang xử lý timeout thì gọi lại.
Ví dụ: Khi đang gọi api login mà api chưa trả về dữ liệu lại tiếp tục gọi request login này sẽ trả về lỗi này. |