CUKCUK API Order Online Help Page

Introduction

Provide a general description of your APIs here.

Location - Controller xử lý thông tin Quốc gia/vị trí

Method	API
GET	api/location/GetLocationsBykind?companyCode={companyCode}&kind={kind}&locationID={locationID} Get location theo kind và ID của location cha
GET	api/location/CheckFeature?featureCode={featureCode}

Voucher

Method	API
GET	api/Voucher/EgiftCardPublic?branchID={branchID}
GET	api/Voucher/GetVoucherByCode?voucherCode={voucherCode}&companyCode={companyCode}&branchID={branchID}&pinCode={pinCode}
GET	api/Voucher/ValidateGiftCard?voucherCode={voucherCode}&companyCode={companyCode}&branchID={branchID}&pinCode={pinCode}&isOnline={isOnline}
GET	api/Voucher/ValidateGiftCardOrderOnline?voucherCode={voucherCode}&companyCode={companyCode}&branchID={branchID}

Customer - Controller xử lý khách hàng

Method	API
GET	api/Customer/GetCustomerByTel?companyCode={companyCode}&tel={tel} Lấy thông tin khách hàng theo số điện thoại
GET	api/Customer/GetCustomerByTelOrderOnlineUS?tel={tel}&companyCode={companyCode}
GET	api/Customer/GetLoyaltyPromotionByCustomerID?customerID={customerID}
GET	api/Customer/GetCustomerLoyaltyPointByCustomerID?customerID={customerID}
GET	api/Customer/GetLoyaltyPromoCodeUnusedByCode?code={code}&customerID={customerID}

Order - Controller xử lý Order

Method	API
POST	api/Order/Booking?companyCode={companyCode} Action xử lý nhận order
POST	api/Order/ValidateInventoryItenOpenTimeSaleDish?companyCode={companyCode}
POST	api/Order/UpdateCart?companyCode={companyCode} Thực hiện cập nhật giỏ hàng
GET	api/Order/self-order/get-order?orderId={orderId}
GET	api/Order/GetOrderByTableID?branchId={branchId}&idTable={idTable}
POST	api/Order/self-order/update-cart?companyCode={companyCode}
POST	api/Order/self-order/update-table?companyCode={companyCode}
POST	api/Order/self-order/confirm-order?companyCode={companyCode}
POST	api/Order/self-order/confirm-ordernow?companyCode={companyCode}
POST	api/Order/self-order/cancel-order?companyCode={companyCode}
POST	api/Order/self-order/delete-item?itemId={itemId}&orderOnlineId={orderOnlineId}
POST	api/Order/self-order/request-servant?request={request}&companyCode={companyCode}
POST	api/Order/self-order/request-payment?companyCode={companyCode}
POST	api/Order/InitOrder?companyCode={companyCode}
GET	api/Order/GetCurrentOrder?companyCode={companyCode}
POST	api/Order/AddCart?companyCode={companyCode}&branchID={branchID} Thêm món ăn vào giỏ hàng
GET	api/Order/GetHistoryOnday?companyCode={companyCode}&tel={tel}&branchId={branchId} Lấy lịch sử orderonline và orderdetail theo ngày
POST	api/Order/OrderOnlineUS?companyCode={companyCode}
POST	api/Order/UpdateCartOrderOnlineUS?companyCode={companyCode}
GET	api/Order/OrderOnlineUS/GetOrder?orderId={orderId}
DELETE	api/Order/OrderOnlineUS/CancelOrder/{orderID}?companyCode={companyCode}
POST	api/Order/OrderOnlineUS/ValidateOrderBeforeSubmit
POST	api/Order?value={value}

BookingOnline

Method	API
POST	api/booking-online/booking?companyCode={companyCode}
POST	api/booking-online/GetListBookingTime?companyCode={companyCode}
POST	api/booking-online/GetListTableBooking?companyCode={companyCode}
GET	api/booking-online/GetCurrentBookingOnline?companyCode={companyCode}
POST	api/booking-online/UpdateBookingOnline?companyCode={companyCode}

OnlineTimeSchedule

Method	API
GET	api/OnlineTimeSchedule/GetMenuCategoryTimeSchedule?companyCode={companyCode}&branchID={branchID}
GET	api/OnlineTimeSchedule/GetOnlineTimeScheduleByBranch?companyCode={companyCode}&branchID={branchID}
GET	api/OnlineTimeSchedule/GetOnlineTimeScheduleReferenceByBranch?companyCode={companyCode}&branchID={branchID}

Payment - Xử lý thanh toán

Method	API
POST	api/Payment/CreateQrCode?companyCode={companyCode} Lấy mã QRCode
POST	api/Payment/QueryTransaction?companyCode={companyCode} Kiểm tra luồng thanh toán
POST	api/Payment/OpenPortal?companyCode={companyCode} Lấy link mở cổng thanh toán
POST	api/Payment/Ipay88CreateQrCode?companyCode={companyCode}
POST	api/Payment/Ipay88QueryTransaction?companyCode={companyCode}
POST	api/Payment/Ipay88CheckPaymentStatus?companyCode={companyCode}
POST	api/Payment/Ipay88CheckPaymentStatusForSeflOrder?companyCode={companyCode}
POST	api/Payment/Ipay88Request?companyCode={companyCode}&responseUrl={responseUrl}
POST	api/Payment/CreditCardRequest?companyCode={companyCode}
GET	api/Payment/TyroDirect
POST	api/Payment/TyroCreatePayRequest?companyCode={companyCode}
POST	api/Payment/TyroPaymentSuccess?companyCode={companyCode}
POST	api/Payment/TyroCreatePayRequestViaClient?companyCode={companyCode}
POST	api/Payment/PaypalRequest?companyCode={companyCode}
GET	api/Payment/ExchangeRate?currency={currency}&amount={amount}
POST	api/Payment/QRISCreateQrCode?companyCode={companyCode}
POST	api/Payment/QRISQueryTransaction?companyCode={companyCode}
POST	api/Payment/AdditionOutOfStock?companyCode={companyCode}
POST	api/Payment/VetifyCallback?companyCode={companyCode}
POST	api/Payment/PushToClinetIpay88
POST	api/Payment/GetInvoiceForTel?tel={tel}

SelfOrderUS

Method	API
POST	api/Order/SelfOrderUS/ValidateOrderBeforeSubmit
POST	api/Order/SelfOrderUS/InitOrder?companyCode={companyCode}
POST	api/Order/SelfOrderUS/UpdateCart?companyCode={companyCode}
POST	api/Order/SelfOrderUS/ConfirmOrder?companyCode={companyCode}
GET	api/Order/SelfOrderUS/getOrderInfoByTableSession?idTable={idTable}&branchID={branchID}&status={status}
GET	api/Order/SelfOrderUS/GetOrderByID?orderId={orderId}
GET	api/Order/SelfOrderUS/GetOrderByTableID?branchId={branchId}&idTable={idTable}
POST	api/Order/SelfOrderUS/CancelOrder?companyCode={companyCode}
POST	api/Order/SelfOrderUS/RequestServant
POST	api/Order/SelfOrderUS/CreditCardRequest?companyCode={companyCode}
GET	api/Order/TyroDirect
POST	api/Order/TyroCreatePayRequestViaClient?companyCode={companyCode}
POST	api/Order/SelfOrderUS/TyroCreatePayRequest?companyCode={companyCode}
POST	api/Order/SelfOrderUS/TyroPaymentSuccess?companyCode={companyCode}
POST	api/Order/SelfOrderUS/SaveCustomerInfo

InventoryItem - Controller xử lý vật tư hàng hóa

Method	API
GET	api/InventoryItem/GetAllInventoryItemCategory?companyCode={companyCode}&language={language}&branchID={branchID}&bookingType={bookingType}&openSaleDishIds={openSaleDishIds}
GET	api/InventoryItem/GetInventoryItemsTopSale?companyCode={companyCode}&branchID={branchID} Action xử lý lấy danh sách thực đơn bán chạy
GET	api/InventoryItem/getPageInventoryItemsByTag?companyCode={companyCode}&pageIndex={pageIndex}&limit={limit}&branchID={branchID}&tagID={tagID}&bookingType={bookingType}&openSaleDishIds={openSaleDishIds}
GET	api/InventoryItem/GetPageInventoryItemsByCategory?companyCode={companyCode}&pageIndex={pageIndex}&limit={limit}&branchID={branchID}&categoryID={categoryID}&hashTagID={hashTagID}&keySearch={keySearch}&bookingType={bookingType}&openSaleDishIds={openSaleDishIds}
GET	api/InventoryItem/GetInventoryItemDetailByID?companyCode={companyCode}&inventoryItemID={inventoryItemID}&bookingType={bookingType}
GET	api/InventoryItem/GetAllHashTag?companyCode={companyCode}&branchID={branchID}&bookingType={bookingType}
GET	api/InventoryItem/GetInventoryItemDetailByIDUS?companyCode={companyCode}&inventoryItemID={inventoryItemID}&bookingType={bookingType}
GET	api/InventoryItem/GetAllInventoryItemCategoryOrderOnlineUS?companyCode={companyCode}&language={language}&branchID={branchID}&bookingType={bookingType}
GET	api/InventoryItem/GetPageInventoryItemsByCategoryOrderOnlineUS?companyCode={companyCode}&pageIndex={pageIndex}&limit={limit}&branchID={branchID}&categoryID={categoryID}&hashTagID={hashTagID}&keySearch={keySearch}&bookingType={bookingType}
GET	api/InventoryItem/GetListSuggestItem?companyCode={companyCode}&branchID={branchID}
GET	api/InventoryItem/GetAllInventoryItemCategorySelfOrderUS?companyCode={companyCode}&language={language}&branchID={branchID}&bookingType={bookingType}
GET	api/InventoryItem/GetPageInventoryItemsByCategorySelfOrderUS?companyCode={companyCode}&pageIndex={pageIndex}&limit={limit}&branchID={branchID}&categoryID={categoryID}&hashTagID={hashTagID}&keySearch={keySearch}&bookingType={bookingType}
GET	api/InventoryItem/GetInventoryItemDetailByIDQROrderingUS?companyCode={companyCode}&inventoryItemID={inventoryItemID}&bookingType={bookingType}
GET	api/InventoryItem/GetActiveMenuBook?companyCode={companyCode}&branchID={branchID}
GET	api/InventoryItem/GetAllValidMenuBooks?companyCode={companyCode}&branchID={branchID}
GET	api/InventoryItem/GetInventoryItemCategoryByMenuBookID?menuBookID={menuBookID}
GET	api/InventoryItem/GetPageInventoryItemsByMenuBookAndCategory?menuBookID={menuBookID}&pageIndex={pageIndex}&limit={limit}&categoryID={categoryID}&keySearch={keySearch}
GET	api/InventoryItem/GetInventoryItemIdsByMenuBook?menuBookID={menuBookID}

Counpon - Controller xử lỹ mã ưu đãi

Method	API
POST	api/Counpon/AvailableCoupon?companyCode={companyCode} Hàm cập nhật trạng thái đã sử dụng mã ưu đãi
GET	api/Counpon/GetCouponByCode?couponCode={couponCode}&companyCode={companyCode} Lấy thông tin mã khuyến mại
POST	api/Counpon/RemoveCoupon?companyCode={companyCode} Xóa mã khuyến mại đang sử dụng
GET	api/Counpon/GetAllOrderOnlinePromotion?companyCode={companyCode}&branchID={branchID}
GET	api/Counpon/GetAllOrderOnlineLoyaltyPromotion?companyCode={companyCode}&branchID={branchID}
GET	api/Counpon/GetAllOrderOnlineLimitPromo?companyCode={companyCode}&branchID={branchID}
POST	api/Counpon/ValidateOrderOnlinePromotionUS?companyCode={companyCode}
POST	api/Counpon/ValidateOrderOnlineLoyaltyPromotionUS?companyCode={companyCode}
POST	api/Counpon/ValidateSelfOrderLoyaltyPromotionUS?companyCode={companyCode}
GET	api/Counpon/GetAllSelfOrderUSPromotion?companyCode={companyCode}&branchID={branchID}
GET	api/Counpon/GetAllSelfOrderUSLoyaltyPromotion?companyCode={companyCode}&branchID={branchID}
GET	api/Counpon/GetAllSelfOrderUSLimitPromo?companyCode={companyCode}&branchID={branchID}
POST	api/Counpon/ValidateSelfOrderPromotionUS?companyCode={companyCode}
POST	api/Counpon?branchID={branchID}

Area

Method	API
GET	api/Area/GetAllMapObjectByAreaID?areaID={areaID}
GET	api/Area/GetTreeArea?sort={sort}&node={node}&branchID={branchID}

Branch - Controller xử lý thông tin chi nhánh

Method	API
POST	api/Branch/SaveOpenTimeSaleDish
GET	api/Branch/GetListBranchInfo?companyCode={companyCode} API Lấy danh sách thông tin nhà hàng sử dụng order online
GET	api/Branch/self-order/branch-info?branchID={branchID}&companyCode={companyCode}
GET	api/Branch/self-order/branch-area?branchID={branchID}&companyCode={companyCode}
GET	api/Branch/booking-online/GetListBranchInfo?companyCode={companyCode}
GET	api/Branch/order-online-us/GetListBranchInfo
GET	api/Branch/order-online-us/branch-setting?branchID={branchID}
GET	api/Branch/order-online-us/restaurant-name