Nhảy tới nội dung

Lấy danh sách Trang đang quản lý

HTTP Request:

GET /v2/business-pages


Header:

Tham sốKiểuBắt buộcMô tả
AuthorizationStringAuthorization: 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ểuBắt buộcMô tả
phoneNumberStringThông tin Số điện thoại đang quản lý BP
pageSizeNumberSố lượng dữ liệu trả ra
pageNumberNumberSố 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ểuMô tả
statusNumberMã lỗi tham khảo đầy đủ tại Mã lỗi
messageStringMô tả lỗi
dataJson ObjectDữ liệu trả về

Thuộc tính Data trong Response:

Tham sốKiểuMô tả
contentList Object JsonDanh sách Trang Doanh nghiệp
totalPagesNumberTổng số trang phân trang
totalElementsNumberTổng số phần tử
numberOfElementsNumberTổng số phần tử trong trang hiện tại

Data của từng content:

Tham sốKiểuMô tả
idNumberBusiness Page ID
nameStringTên Trang Doanh nghiệp của bạn
ratingNumberĐiểm đánh giá của Trang (Thang điểm 5)
ratingCountNumberSố lượt đánh giá của Trang
typeNumberLoại Trang Doanh nghiệp:
- 1 : Store
- 2 : Brand
operatingStatusStringTrạ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
hotlineStringSố điện thoại hotline
logoUrlStringHình Logo
fullAddressStringĐịa chỉ
latitudeNumberVị trí định vị
longitudeNumberVị trí định vị
avgPriceNumberĐơn giá trung bình
avgUnitStringĐơn vị 1 món:
- DISH : 1 phần
- PAX : 1 người
paymentMethodsListDanh 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
representativesListDanh sách người đại diện cho Trang
categoriesListDanh sách danh mục sản phẩm mà Trang có
descriptionStringMô tả Trang

Data của từng paymentMethods:

Tham sốKiểuMô tả
idNumberId phương thức thanh toán
nameStringTên phương thức thanh toán
urlStringLink hình ảnh phương thức thanh toán
selectedBooleanTrang 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ểuMô tả
idNumberId người đại diên
phoneNumberStringSĐT người đại diện (đã masked)
typeStringLoại người đại diện
- OWNER : Chủ sở hữu
- MANAGER : Quản lí

Data của từng categories:

Tham sốKiểuMô tả
idNumberId danh mục sản phẩm
nameStringTên danh mục sản phẩm