Lấy danh sách Trang đang quản lý
HTTP Request:
GET /v2/business-pages
Header:
| Tham số | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
| Authorization | String | Authorization: Bearer {{token}} Với token lấy từ Xác thực và uỷ quyền truy cập tài nguyên BP |
Query Param:
| Tham số | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
| phoneNumber | String | Thông tin Số điện thoại đang quản lý BP | |
| pageSize | Number | Số lượng dữ liệu trả ra | |
| pageNumber | Number | Số thứ tự phân trang |
Example response:
{
"status": 0,
"message": "Success",
"data": {
"content": [
{
"id": 0,
"name": "String",
"rating": 0,
"ratingCount": 0,
"type": 0,
"operatingStatus": "VERIFIED",
"hotline": "String",
"logoUrl": "String",
"fullAddress": "String",
"latitude": 0,
"longitude": 0,
"avgPrice": 0,
"avgUnit": "DISH",
"paymentMethods": [
{
"id": 0,
"name": "String",
"url": "String",
"selected": true
}
],
"representatives": [
{
"id": 0,
"phoneNumber": "076****687",
"type": "OWNER"
}
],
"categories": [
{
"id": 0,
"name": "String"
}
],
"description": "String"
}
],
"totalPages": 0,
"totalElements": 0,
"numberOfElements": 0
}
}
Cấu trúc Response:
| Tham số | Kiểu | Mô tả |
|---|---|---|
| status | Number | Mã lỗi tham khảo đầy đủ tại Mã lỗi |
| message | String | Mô tả lỗi |
| data | Json Object | Dữ liệu trả về |
Thuộc tính Data trong Response:
| Tham số | Kiểu | Mô tả |
|---|---|---|
| content | List Object Json | Danh sách Trang Doanh nghiệp |
| totalPages | Number | Tổng số trang phân trang |
| totalElements | Number | Tổng số phần tử |
| numberOfElements | Number | Tổng số phần tử trong trang hiện tại |
Data của từng content:
| Tham số | Kiểu | Mô tả |
|---|---|---|
| id | Number | Business Page ID |
| name | String | Tên Trang Doanh nghiệp của bạn |
| rating | Number | Điểm đánh giá của Trang (Thang điểm 5) |
| ratingCount | Number | Số lượt đánh giá của Trang |
| type | Number | Loại Trang Doanh nghiệp: - 1 : Store - 2 : Brand |
| operatingStatus | String | Trạng thái mức độ tương tác của Merchant với Trang Doanh nghiệp mình đang sở hữu: - VERIFIED - ACTIVATED - IDLE - NEED_ENGAGE - TEMPORARILY_CLOSED - CLOSED |
| hotline | String | Số điện thoại hotline |
| logoUrl | String | Hình Logo |
| fullAddress | String | Địa chỉ |
| latitude | Number | Vị trí định vị |
| longitude | Number | Vị trí định vị |
| avgPrice | Number | Đơn giá trung bình |
| avgUnit | String | Đơn vị 1 món: - DISH : 1 phần - PAX : 1 người |
| paymentMethods | List | Danh sách phương thức thanh toán. Nếu Trang có phương thức thanh toán nào, thì field selected = true |
| representatives | List | Danh sách người đại diện cho Trang |
| categories | List | Danh sách danh mục sản phẩm mà Trang có |
| description | String | Mô tả Trang |
Data của từng paymentMethods:
| Tham số | Kiểu | Mô tả |
|---|---|---|
| id | Number | Id phương thức thanh toán |
| name | String | Tên phương thức thanh toán |
| url | String | Link hình ảnh phương thức thanh toán |
| selected | Boolean | Trang Doanh nghiệp có sử dụng phương thức thanh toán này |
Data của từng representatives:
| Tham số | Kiểu | Mô tả |
|---|---|---|
| id | Number | Id người đại diên |
| phoneNumber | String | SĐT người đại diện (đã masked) |
| type | String | Loại người đại diện - OWNER : Chủ sở hữu - MANAGER : Quản lí |
Data của từng categories:
| Tham số | Kiểu | Mô tả |
|---|---|---|
| id | Number | Id danh mục sản phẩm |
| name | String | Tên danh mục sản phẩm |