Menu
Menu có năm cấp độ theo thứ tự phân cấp sau:
Collections
Categories
Items
Modifier Groups
Modifiers
Các quy tắc được áp dụng:
Đối tượng | Quy tắc |
Category | Số lượng tối đa cho Category được phép cho một Collection là 100 |
Category | Giới hạn ký tự cho Category Name là 60 |
Item | Số Item tối đa được phép trong một Category là 300 |
Item | Giới hạn ký tự cho Item Name là 60 |
Item | Giới hạn ký tự cho Item Description là 250 |
Item | Tỉ lệ khung hình của Image Photo là 1:1 |
Item | Dung lượng ảnh của Image Photo không được vượt quá 500kb |
ModifierGroup | Số ModifierGroup tối đa trong 1 Item là 30 |
ModifierGroup | Giới hạn ký tự cho ModifierGroup Name là 60 |
ModifierGroup | ModifierGroup có thể được cài đặt là tuỳ chọn hoặc bắt buộc |
Modifier | Số Modifier tối đa trong 1 ModifierGroup là 60 |
Modifier | Giới hạn ký tự cho Modifier Name là 40 |
getGet menu
get
{{api-endpoint}}/menu/categories
Request
Response
Request
Headers
Authorization
required
string
Query Parameters
merchantId
required
string
ID của merchant mà bạn muốn lấy menu
Response
200: OK
{"status": "success","code": 0,"data": {"merchantId": "21546a75-b602-4407-b6a0-86a225c32745","partnerMerchantId": null,"partnerOutletId": null,"currency": {"code":"VND","symbol":"đ"},"collections": [{"id": "e0614177-1693-4ed8-b1b1-65e7ccaaa817","sortIndex": 0,"categories": [{"id": "f222336e-f01c-4143-878e-2dda1a166bb5","name": "trà trái cây nhật bản","sortIndex": 0,"availableStatus": true,"items": [{"id": "b8fac661-dbb0-44f4-9396-9548ee60fbda","name": "Trà chanh 1","sortIndex": 0,"availableStatus": false,"takeawayAllowance": false,"price": 20000,"description": "","photos": [],"modifierGroups": []}]},{"id": "57685b5f-2a28-47f5-8927-890a1c5e3965","name": "Trà creamy","sortIndex": 0,"availableStatus": false,"items": [{"id": "4d983f8d-bd41-40fe-851c-1ee9bc5c2a65","name": "Trà ô long kem sữa","sortIndex": 0,"availableStatus": false,"takeawayAllowance": false,"price": 0,"description": "","photos": [],"modifierGroups": [{"name": "Toppings","sortIndex": 0,"availableStatus": true,"selectionRangeMin": 0,"selectionRangeMax": 0,"modifiers": [{"id": "ce163205-dfcb-4d07-9bce-77af0ae83b33","name": "pulding socola","sortIndex": 0,"availableStatus": true,"price": 5000},{"id": "6ff6dfc1-0f89-421c-85d9-0bf491d6d5cb","name": "pudding xoài","sortIndex": 0,"availableStatus": true,"price": 5000},{"id": "92c99345-008f-4749-b61c-f9b5dd811dea","name": "Trân châu trắng","sortIndex": 0,"availableStatus": true,"price": 8000},{"id": "bf1101dd-a6b0-480a-b2fd-d76eddf05754","name": "Trân châu đen","sortIndex": 0,"availableStatus": true,"price": 5000},{"id": "7040ea54-da27-4041-8934-b9e8c75a6072","name": "pudding trứng","sortIndex": 0,"availableStatus": true,"price": 5000}]},{"name": "Sizes","sortIndex": 0,"availableStatus": true,"selectionRangeMin": 1,"selectionRangeMax": 1,"modifiers": [{"id": "2c67a65b-320b-4d74-a8a0-5dc58cacbf97","name": "M","sortIndex": 0,"availableStatus": true,"price": 35000},{"id": "3a6d35eb-e20c-42a8-b9b9-bbb931a33ea7","name": "L","sortIndex": 0,"availableStatus": true,"price": 42000}]},{"name": "mức đường","sortIndex": 0,"availableStatus": true,"selectionRangeMin": 0,"selectionRangeMax": 0,"modifiers": [{"id": "ae4374ff-0b3e-480b-8ea0-d9f97747f72f","name": "30%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "acd81cb7-bc39-4cb2-b964-43f9dc593b33","name": "50%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "823fc3f1-a885-43c0-bce7-736d8936e717","name": "70%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "216241d7-771c-4803-b06d-f70eee947398","name": "100%","sortIndex": 0,"availableStatus": true,"price": 0}]},{"name": "Mức đá","sortIndex": 0,"availableStatus": true,"selectionRangeMin": 0,"selectionRangeMax": 0,"modifiers": [{"id": "279befdb-7f3c-49fb-ae17-7a9869613421","name": "30%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "259e79d0-fabe-42f6-bdd9-3a1cd1e550e3","name": "50%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "1d27f6ca-9b30-4975-9cee-bfec501d1479","name": "70%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "a64443bc-beb5-42eb-a79d-08fb960f25eb","name": "100%","sortIndex": 0,"availableStatus": true,"price": 0}]}]},{"id": "2b537d3a-7317-4c84-b620-93af30be0705","name": "Trà xanh kem sữa","sortIndex": 0,"availableStatus": false,"takeawayAllowance": false,"price": 0,"description": "","photos": [],"modifierGroups": [{"name": "Toppings","sortIndex": 0,"availableStatus": true,"selectionRangeMin": 0,"selectionRangeMax": 0,"modifiers": [{"id": "6ff6dfc1-0f89-421c-85d9-0bf491d6d5cb","name": "pudding xoài","sortIndex": 0,"availableStatus": true,"price": 5000},{"id": "ce163205-dfcb-4d07-9bce-77af0ae83b33","name": "pulding socola","sortIndex": 0,"availableStatus": true,"price": 5000},{"id": "92c99345-008f-4749-b61c-f9b5dd811dea","name": "Trân châu trắng","sortIndex": 0,"availableStatus": true,"price": 8000},{"id": "bf1101dd-a6b0-480a-b2fd-d76eddf05754","name": "Trân châu đen","sortIndex": 0,"availableStatus": true,"price": 5000},{"id": "7040ea54-da27-4041-8934-b9e8c75a6072","name": "pudding trứng","sortIndex": 0,"availableStatus": true,"price": 5000}]},{"name": "Sizes","sortIndex": 0,"availableStatus": true,"selectionRangeMin": 1,"selectionRangeMax": 1,"modifiers": [{"id": "35e31db6-7043-4490-a352-b3ca199ab615","name": "M","sortIndex": 0,"availableStatus": true,"price": 25000},{"id": "1b4bbbeb-d8db-411b-ab99-37e4a369bf5f","name": "L","sortIndex": 0,"availableStatus": true,"price": 42000}]},{"name": "mức đường","sortIndex": 0,"availableStatus": true,"selectionRangeMin": 0,"selectionRangeMax": 0,"modifiers": [{"id": "ae4374ff-0b3e-480b-8ea0-d9f97747f72f","name": "30%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "acd81cb7-bc39-4cb2-b964-43f9dc593b33","name": "50%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "823fc3f1-a885-43c0-bce7-736d8936e717","name": "70%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "216241d7-771c-4803-b06d-f70eee947398","name": "100%","sortIndex": 0,"availableStatus": true,"price": 0}]},{"name": "Mức đá","sortIndex": 0,"availableStatus": true,"selectionRangeMin": 0,"selectionRangeMax": 0,"modifiers": [{"id": "279befdb-7f3c-49fb-ae17-7a9869613421","name": "30%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "259e79d0-fabe-42f6-bdd9-3a1cd1e550e3","name": "50%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "1d27f6ca-9b30-4975-9cee-bfec501d1479","name": "70%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "a64443bc-beb5-42eb-a79d-08fb960f25eb","name": "100%","sortIndex": 0,"availableStatus": true,"price": 0}]}]},{"id": "b85f196a-4d6f-49d4-8385-d3418201a4fa","name": "Trà nhài kem sữa","sortIndex": 0,"availableStatus": false,"takeawayAllowance": false,"price": 0,"description": "","photos": [],"modifierGroups": [{"name": "Toppings","sortIndex": 0,"availableStatus": true,"selectionRangeMin": 0,"selectionRangeMax": 0,"modifiers": [{"id": "bf1101dd-a6b0-480a-b2fd-d76eddf05754","name": "Trân châu đen","sortIndex": 0,"availableStatus": true,"price": 5000},{"id": "6ff6dfc1-0f89-421c-85d9-0bf491d6d5cb","name": "pudding xoài","sortIndex": 0,"availableStatus": true,"price": 5000},{"id": "92c99345-008f-4749-b61c-f9b5dd811dea","name": "Trân châu trắng","sortIndex": 0,"availableStatus": true,"price": 8000},{"id": "7040ea54-da27-4041-8934-b9e8c75a6072","name": "pudding trứng","sortIndex": 0,"availableStatus": true,"price": 5000},{"id": "ce163205-dfcb-4d07-9bce-77af0ae83b33","name": "pulding socola","sortIndex": 0,"availableStatus": true,"price": 5000}]},{"name": "Sizes","sortIndex": 0,"availableStatus": true,"selectionRangeMin": 1,"selectionRangeMax": 1,"modifiers": [{"id": "b80f84d5-fc28-4e3a-9173-e0f8ffcc5bb2","name": "M","sortIndex": 0,"availableStatus": true,"price": 35000},{"id": "9f6471ba-dee5-498d-a408-9db14a4f6ca2","name": "L","sortIndex": 0,"availableStatus": true,"price": 42000}]},{"name": "mức đường","sortIndex": 0,"availableStatus": true,"selectionRangeMin": 0,"selectionRangeMax": 0,"modifiers": [{"id": "ae4374ff-0b3e-480b-8ea0-d9f97747f72f","name": "30%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "acd81cb7-bc39-4cb2-b964-43f9dc593b33","name": "50%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "823fc3f1-a885-43c0-bce7-736d8936e717","name": "70%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "216241d7-771c-4803-b06d-f70eee947398","name": "100%","sortIndex": 0,"availableStatus": true,"price": 0}]},{"name": "Mức đá","sortIndex": 0,"availableStatus": true,"selectionRangeMin": 0,"selectionRangeMax": 0,"modifiers": [{"id": "279befdb-7f3c-49fb-ae17-7a9869613421","name": "30%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "259e79d0-fabe-42f6-bdd9-3a1cd1e550e3","name": "50%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "1d27f6ca-9b30-4975-9cee-bfec501d1479","name": "70%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "a64443bc-beb5-42eb-a79d-08fb960f25eb","name": "100%","sortIndex": 0,"availableStatus": true,"price": 0}]}]},{"id": "aa960d1a-0fe9-489e-b9d2-7e4e9ddd527f","name": "Trà xanh xoài","sortIndex": 0,"availableStatus": false,"takeawayAllowance": false,"price": 0,"description": "","photos": [],"modifierGroups": [{"name": "Toppings","sortIndex": 0,"availableStatus": true,"selectionRangeMin": 0,"selectionRangeMax": 0,"modifiers": [{"id": "bf1101dd-a6b0-480a-b2fd-d76eddf05754","name": "Trân châu đen","sortIndex": 0,"availableStatus": true,"price": 5000},{"id": "92c99345-008f-4749-b61c-f9b5dd811dea","name": "Trân châu trắng","sortIndex": 0,"availableStatus": true,"price": 8000},{"id": "6ff6dfc1-0f89-421c-85d9-0bf491d6d5cb","name": "pudding xoài","sortIndex": 0,"availableStatus": true,"price": 5000},{"id": "7040ea54-da27-4041-8934-b9e8c75a6072","name": "pudding trứng","sortIndex": 0,"availableStatus": true,"price": 5000},{"id": "ce163205-dfcb-4d07-9bce-77af0ae83b33","name": "pulding socola","sortIndex": 0,"availableStatus": true,"price": 5000}]},{"name": "Sizes","sortIndex": 0,"availableStatus": true,"selectionRangeMin": 1,"selectionRangeMax": 1,"modifiers": [{"id": "67b310e2-5869-47ae-b3d4-baea08349d2b","name": "M","sortIndex": 0,"availableStatus": true,"price": 35000},{"id": "54044f38-7a6d-42bb-8102-55b76a7a1afe","name": "L","sortIndex": 0,"availableStatus": true,"price": 42000}]},{"name": "mức đường","sortIndex": 0,"availableStatus": true,"selectionRangeMin": 0,"selectionRangeMax": 0,"modifiers": [{"id": "ae4374ff-0b3e-480b-8ea0-d9f97747f72f","name": "30%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "acd81cb7-bc39-4cb2-b964-43f9dc593b33","name": "50%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "823fc3f1-a885-43c0-bce7-736d8936e717","name": "70%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "216241d7-771c-4803-b06d-f70eee947398","name": "100%","sortIndex": 0,"availableStatus": true,"price": 0}]},{"name": "Mức đá","sortIndex": 0,"availableStatus": true,"selectionRangeMin": 0,"selectionRangeMax": 0,"modifiers": [{"id": "279befdb-7f3c-49fb-ae17-7a9869613421","name": "30%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "259e79d0-fabe-42f6-bdd9-3a1cd1e550e3","name": "50%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "1d27f6ca-9b30-4975-9cee-bfec501d1479","name": "70%","sortIndex": 0,"availableStatus": true,"price": 0},{"id": "a64443bc-beb5-42eb-a79d-08fb960f25eb","name": "100%","sortIndex": 0,"availableStatus": true,"price": 0}]}]}]},]}],"updatedTime": "0001-01-01T00:00:00"}}
400: Bad Request
{"status": "failure","code": -1,"msg": "Missing params","data": ["The merchantId field is required."]}
postNotification
post
{{api-endpoint}}/menu/notification
Gọi khi có bất kỳ thay đổi nào ở menu
Request
Response
Request
Query Parameters
merchantId
required
string
Response
200: OK
{"status": "success","code": 0,"msg": "OK","data": " Trigger at 2020-11-04T17:13:40.3828020Z"}