Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Group Login Partner Portal

List API that might be changes:

Please check if those API support query filter restaurant_id or not.

Sign In

Endpoint: /api/partner/v1/sign_in Current Response:

Dashboard

Make sure all of these API support restaurant_id filter? Endpoint: /api/partner/v1/staffs/show_profile /api/partner/v1/restaurants/view_store /api/partner/v1/dashboards?type=pending_bookings /api/partner/v1/dashboards?type=today_bookings /api/partner/v1/dashboards?type=upcoming_bookings /api/partner/v1/dashboards?type=this_month_bookings /api/partner/v1/dashboards?type=package /api/partner/v1/dashboards?type=voucher /api/partner/v1/dashboards?type=chart /api/partner/v1/dashboards?type=ratings

Bookings

Endpoint API: /api/partner/v1/reservations /api/partner/v1/reservations/email_owner_manager /api/partner/v1/reservations/packages /api/partner/v1/reservations/check_inventory_status /api/partner/v1/reservations/export

Vouchers

Endpoint: /api/partner/v1/vouchers/list /api/partner/v1/vouchers/export_vouchers_list /api/partner/v1/vouchers/history /api/partner/v1/vouchers/export_vouchers_history

Packages

Endpoint: /api/partner/v1/restaurant_packages /api/partner/v1/restaurant_packages/export /api/partner/v1/restaurant_packages/export for what?*

Allotment

Endpoint: /api/partner/v1/inventories /api/partner/v1/staffs/get_mongodb_auth_token

Billing

Endpoint: /api/partner/v1/bills /api/partner/v1/bills/export

Reviews

/api/partner/v1/reviews

Analytic

/api/partner/v1/staffs/show_profile /api/partner/v1/restaurants/view_store /api/partner/v1/analytics/charts_info Has restaurant_id: /api/partner/v1/analytics/rating_score /api/partner/v1/analytics/reviews_photos /api/partner/v1/analytics/package_comparison /api/partner/v1/analytics/party_size_comparison /api/partner/v1/analytics/existing_vs_new_customers /api/partner/v1/analytics/spending_per_covers /api/partner/v1/analytics/cancelled_bookings

Account Management > Store

Endpoint: /api/partner/v1/restaurants/view_store /api/partner/v1/cities /api/partner/v1/restaurants/restaurant_tags /api/partner/v1/districts

API CHANGES IN GROUP LOGIN

In response to the requirement for group login, adjustments are necessary on the API side. It's important to note that partners are not necessarily linked with restaurant ownership; they are customizable users associated with specific restaurants, known as staff members. These staff members can be assigned to one or multiple restaurants, granting them access accordingly.

In the context of login, a 'single login' refers to a staff member assigned to a single restaurant, while 'group login' indicates a staff member assigned to multiple restaurants.

Certain data sets may be difficult to collect or incompatible with multiple restaurant data. Consequently, certain endpoints may require the inclusion of a 'restaurant_id'

partner api that required params restaurant_id

inventories GET /api/partner/v1/inventories/undo GET /api/partner/v1/inventories/chart GET /api/partner/v1/inventories/edit_inventory POST /api/partner/v1/inventories/block PUT /api/partner/v1/inventories/update_inventory PUT /api/partner/v1/inventories/update_inventory_detail GET /api/partner/v1/inventories POST /api/partner/v1/inventories GET /api/partner/v1/inventories/:id

menu_sections POST /api/partner/v1/menu_sections/export GET /api/partner/v1/menu_sections

package_menus GET /api/partner/v1/package_menus

reservations POST /api/partner/v1/reservations/export GET /api/partner/v1/reservations/packages GET /api/partner/v1/reservations/check_inventory_status POST /api/partner/v1/reservations

restaurant_documents GET /api/partner/v1/restaurant_documents

restaurant_packages GET /api/partner/v1/restaurant_packages POST /api/partner/v1/restaurant_packages POST /api/partner/v1/restaurant_packages/duplicate POST /api/partner/v1/restaurant_packages/export GET /api/partner/v1/restaurant_packages/new_menu_list DELETE /api/partner/v1/restaurant_packages/destroy_all

restaurants GET /api/partner/v1/restaurants/view_store GET /api/partner/v1/restaurants/view_gallery PUT /api/partner/v1/restaurants/update_gallery PUT /api/partner/v1/restaurants/update_steps_verify POST /api/partner/v1/restaurants/create_documents

staffs GET /api/partner/v1/staffs POST /api/partner/v1/staffs PATCH /api/partner/vq1/staffs/:id PUT /api/partner/v1/staffs/:id DELETE /api/partner/v1/staffs/:id GET /api/partner/v1/staffs/show_profile

vouchers GET /api/partner/v1/vouchers/show_voucher_redeem POST /api/partner/v1/vouchers/redeem POST /api/partner/v1/vouchers/create_ticket_group POST /api/partner/v1/vouchers/export_vouchers_list POST /api/partner/v1/vouchers/export_vouchers_history PUT /api/partner/v1/vouchers/edit_voucher_redeem GET /api/partner/v1/vouchers/show_ticket_group PUT /api/partner/v1/vouchers/update_ticket_group DELETE /api/partner/v1/vouchers/delete_ticket_group POST /api/partner/v1/vouchers/duplicate_ticket_group

Currently for : PUT /api/partner/v1/vouchers/edit_voucher_redeem GET /api/partner/v1/vouchers/show_ticket_group PUT /api/partner/v1/vouchers/update_ticket_group DELETE /api/partner/v1/vouchers/delete_ticket_group POST /api/partner/v1/vouchers/duplicate_ticket_group implemented yet in vouchers.

Currently for : POST /api/partner/v1/restaurant_packages POST /api/partner/v1/restaurant_packages/duplicate GET /api/partner/v1/restaurant_packages/new_menu_list DELETE /api/partner/v1/restaurant_packages/destroy_all implemented yet in packages.

Currenty for : GET /api/partner/v1/staffs POST /api/partner/v1/staffs PATCH /api/partner/vq1/staffs/:id PUT /api/partner/v1/staffs/:id DELETE /api/partner/v1/staffs/:id GET /api/partner/v1/staffs/show_profile implemented yet in staff.