Member API

API quản lý thành viên

get
Lấy thông tin thành viên của một địa điểm

{{base_url}}/customers_location
Cho phép lấy thông tin thành viên của một địa điểm (shop, cửa hàng, nhà hàng...) theo số điện thoại
Request
Response
Request
Headers
Authorization
required
string
Bearer <access_token>
Query Parameters
shop_id
optional
string
id địa điểm
pos_id
optional
string
i​d địa điểm
phone
required
string
Số điện thoại
Response
200: OK
Lấy thành công thông tin thành viên
{
"status": 200,
"message": "Customer info",
"data": {
"_id": "5d8c353a7c857b43b4eff3ae",
"age_range": "",
"year_birthday": "1996",
"home_town": "Ha Noi",
"twitter": "",
"gender": "1",
"created_at": "26-09-2019",
"fb_id": "152134088",
"phone": "0945350398",
"birthday": "05-30",
"facebook": "https://vi-vn.facebook.com/nextifyvn",
"address": "Phao Dai Lang",
"relationship_status": "Chua ket hon",
"client_mac": [],
"email": "[email protected]",
"name": "Ly Tu Quang Thang",
"updated_at": "26-09-2019"
}
401: Unauthorized
access_token không tồn tại
{
"status_code": "401",
"message": "access_token not found! Please contact Nextify at [email protected] for help"
}
404: Not Found
pos_id does không tồn tại
{
"status": 404,
"status_code": 404,
"message": "Customer not found!"
}

Lưu ý:

  • Bắt buộc phải truyền shop_id hoặc pos_id

  • Lấy shop_id qua Merchant API

curl -X GET \
'{{ base_url }}/customers_location?shop_id={{ shop_id }}&phone={{ phone }}' \
-H 'Authorization: Bearer {{ access_token }}'

get
Lấy thông tin thành viên của Merchant

{{ base_url }}/customers
Cho phép lấy thông tin thành viên của Merchant theo số điện thoại
Request
Response
Request
Headers
Authorization
required
string
Bearer <access_token>
Query Parameters
merchant_id
required
string
id merchant
phone
required
string
số điện thoai
Response
200: OK
Thành công
{
"status": 200,
"message": "Customer info",
"data": {
"_id": "5d8c353a7c857b43b4eff3ae",
"age_range": "",
"year_birthday": "1996",
"home_town": "Ha Noi",
"twitter": "",
"gender": "1",
"created_at": "26-09-2019",
"fb_id": "152134088",
"phone": "0945350398",
"birthday": "05-30",
"facebook": "https://vi-vn.facebook.com/nextifyvn",
"address": "Phao Dai Lang",
"relationship_status": "Chua ket hon",
"client_mac": [],
"email": "[email protected]",
"name": "Ly Tu Quang Thang",
"updated_at": "26-09-2019"
}

Lưu ý:

- Lấy merchant_id qua Partner API

curl -X GET \
'{{ base_url }}/customers?merchant_id={{ merchant_id }}&phone={{ phone }}' \
-H 'Authorization: Bearer {{ access_token }}'

post
Tạo mới thành viên

{{base_url}}/customers_location
Cho phép tạo mới thành viên vào một địa điểm
Request
Response
Request
Headers
Authorization
required
string
Bearer <access_token>
Content-Type
required
string
application/json
Query Parameters
pos_id
required
string
id địa điểm
Body Parameters
name
required
string
Họ và tên
phone
optional
string
Số điện thoại
email
optional
string
Email
company
optional
string
Công ty
company_role
optional
string
Vị trí trong công ty
gender
optional
string
Giới tính (nam: 1, nữ: 2)
birthday
optional
string
Sinh nhật (mm-dd)
year_birthday
optional
string
Năm sinh
address
optional
string
Địa chỉ
note
optional
string
id facebook
facebook
optional
string
Link facebook cá nhân
twitter
optional
string
Link twitter cá nhân
Response
200: OK
Tạo mới thành công
{
"status": 200,
"status_code": 200,
"message": "Success!"
}
400: Bad Request
Sai dữ liệu truyền vào
{
"status": 400,
"status_code": 400,
"message": "Wrong data!"
}
401: Unauthorized
access_token không tồn tại
{
"status_code": "401",
"message": "access_token not found! Please contact Nextify at [email protected] for help"
}
404: Not Found
pos_id không tồn tại
{
"status": 404,
"status_code": 404,
"message": "pos_id does not exist!"
}
409: Conflict
Thành viên đã tồn tại
{
"status": 409,
"status_code": 409,
"message": "Customer already exist!"
}

Lưu ý:

- Bắt buộc phải truyền vào phone hoặc email

put
Thay đổi thông tin thành viên

{{base_url}}/customers_location
Request
Response
Request
Headers
Authorization
required
string
Bearer <access_token>
Content-Type
required
string
application/json
Query Parameters
pos_id
required
string
id địa điểm
phone
required
string
Số điện thoại
Body Parameters
name
optional
string
Họ và tên
email
optional
string
Email
gender
optional
string
Giới tính (nam: 1, nữ: 2)
relationship_status
optional
string
Trạng thái hôn nhân
birthday
optional
string
Sinh nhật (mm-dd)
year_birthday
optional
string
Năm sinh
home_town
optional
string
Quê quán
address
optional
string
Địa chỉ
fb_id
optional
string
id facebook
facebook
optional
string
Link facebook cá nhân
twitter
optional
string
Link twitter cá nhân
Response
200: OK
Thay đổi thông tin khách hàng thành công
{
"status": 200,
"status_code": 200,
"message": "Success!"
}
400: Bad Request
Sai dữ liệu truyền vào
{
"status": 400,
"status_code": 400,
"message": "Wrong data!"
}
401: Unauthorized
access_token không tồn tại
{
"status_code": "401",
"message": "access_token not found! Please contact Nextify at [email protected] for help"
}
404: Not Found
Khách hàng chưa tồn tại, vui lòng tạo mới khách hàng
{
"status": 404,
"status_code": 404,
"message": "Customer not found! Please create new customer!"
}

post
Tạo mới thành viên ( theo địa chỉ mac )

{{ base_url }}/customers_mac
cho phép tạo mới thành viên tại một địa điểm
Request
Response
Request
Headers
Authorization
required
string
Bearer <access_token>
Content-Type
required
string
application/json
Query Parameters
gateway_mac
required
string
địa chỉ MAC thiết bị của địa điểm
Body Parameters
name
optional
string
họ và tên người dùng
email
required
string
địa chỉ email người dùng
address
optional
string
địa chỉ người dùng
phone
required
string
số điện thoại người dùng
client_mac
required
string
địa chỉ MAC của người dùng
Response
200: OK

post
Tạo tag cho khách hàng

{{base_url}}/customers/tags
Cho phép tạo và chỉnh sửa tag cho khách hàng
Request
Response
Request
Headers
Authorization
required
string
Bearer <access_token>
Query Parameters
merchant_id_app
required
string
id merchant
phone
required
string
Số điện thoại khách hàng
tag_id
required
string
id tag ( danh sách tag trong phần tag API )
Response
200: OK