API thực hiện lấy danh sách khuyến mại theo chi nhánh. Phân trang tối đa 100 bản ghi trên một trang
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
Schemes
Endpoints
POST
Lấy danh sách khuyến mại phân trang
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 |
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 |
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 |
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. |
Parameters
| 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à Array<Promotion>
tổng số khuyến mại có trong hệ thống qua ServiceResult.Total
Example
Ví dụ gửi tham số gọi tới api
JSON PromotionsPagingRequestParam
{
"Page": 1,
"Limit": 10,
"BranchId": "994c6fe5-da83-441b-a0e8-57a6fed98fb2",
"LastSyncDate": "2020-05-04T09:28:55.854Z"
}
Hệ thống sẽ trả về ServiceResult với Data là Array<Promotion>
JSON response
{
"Code": 200,
"Data": [
{
"Id": "44a7dff6-5c52-4581-a7f2-a6e556d992a4",
"Name": "khai trương chi nhánh",
"Description": "",
"Type": 4,
"FromDate": "2021-04-01T00:00:00+07:00",
"ToDate": "2021-04-30T00:00:00+07:00",
"Monday": false,
"Tuesday": false,
"Wednesday": false,
"Thursday": false,
"Friday": false,
"Saturday": false,
"Sunday": false,
"DiscountRate": 0.0,
"DiscountAmount": 0.0,
"Object": 1,
"Condition": 0,
"ConditionType": 1,
"ApplyType": 2,
"BuyItemCondition": 0,
"GiftItemCondition": 0,
"DiscountItemType": 1,
"IsAutoApply": false,
"IsApplyForNoPromotion": false,
"IsLimitedQuantity": false,
"LimitedQuantity": 0,
"IsCreated": false,
"IsPublish": false
},
{
"Id": "4e79689f-9f66-486a-91da-5c71457859fb",
"Name": "Ngày hội cafe",
"Description": "",
"Type": 4,
"FromDate": "2021-04-30T00:00:00+07:00",
"ToDate": "2021-05-01T00:00:00+07:00",
"Monday": false,
"Tuesday": false,
"Wednesday": false,
"Thursday": false,
"Friday": false,
"Saturday": false,
"Sunday": false,
"DiscountRate": 0.0,
"DiscountAmount": 0.0,
"Object": 1,
"Condition": 0,
"ConditionType": 1,
"ApplyType": 2,
"BuyItemCondition": 0,
"GiftItemCondition": 0,
"DiscountItemType": 1,
"IsAutoApply": true,
"IsApplyForNoPromotion": false,
"IsLimitedQuantity": false,
"LimitedQuantity": 0,
"IsCreated": false,
"IsPublish": false
},
{
"Id": "859143a4-8ae6-4ee2-be72-4cdfa5e8a564",
"Name": "Tặng bia say mê",
"Description": "",
"Type": 1,
"FromDate": "2021-04-01T00:00:00+07:00",
"ToDate": "2021-04-30T00:00:00+07:00",
"Monday": true,
"Tuesday": true,
"Wednesday": true,
"Thursday": true,
"Friday": true,
"Saturday": true,
"Sunday": true,
"FromTime": "2021-04-09T08:00:00+07:00",
"ToTime": "2021-04-09T22:00:00+07:00",
"FromTimeAsInt": 480,
"ToTimeAsInt": 1320,
"DiscountRate": 0.0,
"DiscountAmount": 0.0,
"Object": 1,
"Condition": 0,
"ConditionType": 0,
"ConditionAmount": 0.0,
"ApplyType": 2,
"BuyItemCondition": 0,
"GiftItemCondition": 0,
"DiscountItemType": 0,
"IsAutoApply": false,
"IsApplyForNoPromotion": false,
"IsLimitedQuantity": false,
"LimitedQuantity": 0,
"IsCreated": false,
"IsPublish": false
}
],
"Total": 3,
"Success": true
}
Definitions
Tham số lấy dữ liệu chi nhánh nhà hàng
| Property |
Type |
Format |
Mô tả |
| Page |
int |
|
Số trang lấy dữ liệu |
| Limit |
int |
|
Số bản ghi lấy trên 1 trang (max 100) |
| BranchID |
string |
guid |
Id chi nhánh cần lấy, truyền null để lấy dữ liệu toàn bộ chi nhánh |
| LastSyncDate |
datetime |
guid |
Mốc thời gian lấy dữ liệu |
| Property |
Type |
Format |
Mô tả |
| Id |
string |
guid |
Id khuyến mại |
| Name |
string |
|
Tên khuyến mại |
| Description |
string |
|
Mô tả |
| Type |
int |
|
Loại khuyến mại, xem tại đây |
| FromDate |
datetime |
|
Từ ngày |
| ToDate |
datetime |
|
Đến ngày |
| FromTime |
datetime |
|
Thời gian bắt đầu trong ngày, giá trị null là áp dụng cả ngày |
| ToTime |
datetime |
|
Thời gian kết thúc trong ngày, giá trị null là áp dụng cả ngày |
| FromTimeAsInt |
int |
|
Thời gian kết thúc trong ngày (dạng int), giá trị null là áp dụng cả ngày |
| ToTimeAsInt |
int |
|
Thời gian kết thúc trong ngày (dạng int), giá trị null là áp dụng cả ngày |
| Monday |
bool |
|
Áp dụng vào ngày thứ hai |
| Tuesday |
bool |
|
Áp dụng vào ngày thứ ba |
| Wednesday |
bool |
|
Áp dụng vào ngày thứ tư |
| Thursday |
bool |
|
Áp dụng vào ngày thứ năm |
| Friday |
bool |
|
Áp dụng vào ngày thứ sáu |
| Saturday |
bool |
|
Áp dụng vào ngày thứ bảy |
| Sunday |
bool |
|
Áp dụng vào ngày chủ nhật |
| DiscountRate |
decimal |
|
Phần trăm khuyến mại, giá trị null nếu khuyến mại không áp dụng theo phần trăm |
| DiscountAmount |
decimal |
|
Số tiền khuyến mại, giá trị null nếu khuyến mại không áp dụng theo số tiền |
| Object |
int |
|
Đối tượng được áp dụng khuyến mại, xem tại đây |
| MemberLevelID |
string |
guid |
Id hạng thẻ được áp dụng, trường hợp đối tượng áp dụng khuyến mại theo hạng thẻ |
| CustomerCategoryID |
string |
guid |
Id nhóm khách hàng được áp dụng, trường hợp đối tượng áp dụng khuyến mại theo nhóm khách hàng |
| ConditionType |
int |
|
Điều kiện áp dụng khuyến mại, xem tại đây |
| ConditionAmount |
decimal |
|
Số tiền tối thiểu để được áp dụng khuyến mại, trường hợp điều kiện áp dụng khuyến mại theo thanh toán |
| ApplyType |
int |
|
Loại áp dụng khuyến mại, xem tại đây |
| BuyItemCondition |
int |
|
Điều kiện món mua, xem tại đây |
| GiftItemCondition |
int |
|
Điều kiện món tặng, xem tại đây |
| DiscountItemType |
int |
|
Khuyến mại theo món ăn/nhóm thực đơn, dùng cho khuyến mại giảm giá món ăn, xem tại đây |
| IsAutoApply |
bool |
|
Tự động áp dụng khuyến mại khi thanh toán |
| IsApplyForNoPromotion |
bool |
|
Chỉ áp dụng cho món chưa có khuyến mại |
| IsLimitedQuantity |
bool |
|
Có giới hạn số lượng của món khuyến mại trong ngày hay không |
| LimitedQuantity |
int |
|
Số lượng món giới hạn trong ngày |
| IsCreated |
bool |
|
Số lượng món giới hạn trong ngày |
| IsPublishCouponCode |
bool |
|
Số lượng món giới hạn trong ngày |
| Giá trị |
Mô tả |
| 0 |
Không xác định |
| 1 |
Tặng món |
| 2 |
Mua N tặng M |
| 3 |
Giảm giá hóa đơn |
| 4 |
Giảm giá món ăn |
| Giá trị |
Mô tả |
| 0 |
Không xác định |
| 1 |
Toàn bộ khách hàng |
| 2 |
Khách hàng có sinh nhật trong tháng |
| 3 |
Khách hàng có sinh nhật trong ngày |
| 4 |
Áp dụng theo hạng thẻ |
| 5 |
Áp dụng theo nhóm khách hàng |
| Giá trị |
Mô tả |
| 0 |
Không xác định |
| 1 |
Không có điều kiện |
| 2 |
Điều kiện thanh toán |
| 3 |
Điều kiện số lượng |
ApplyType Definition
| Giá trị |
Mô tả |
| 0 |
Không xác định |
| 1 |
Tất cả |
| 2 |
Một vài nhà hàng xác định |
BuyItemCondition Definition
| Giá trị |
Mô tả |
| 0 |
Mua 1 món cụ thể |
| 1 |
Mua một món ăn trong nhóm |
GiftItemCondition Definition
| Giá trị |
Mô tả |
| 0 |
Tặng một 1 món trong danh sách (Hoặc món A, hoặc món B) |
| 1 |
Tặng tất cả các món trong danh sách (Tặng cả A và B) |
DiscountItemType Definition
| Giá trị |
Mô tả |
| 0 |
Không xác định |
| 1 |
Khuyến mại theo món ăn |
| 2 |
Khuyến mại theo nhóm thực đơn |
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 |
| Environment |
string |
|
Môi trường triển khai của api |
| Data |
string |
object |
Dữ liệu trả về client |
| Total |
int |
|
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 |
| 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. |