Thông tin chi tiết về tích hợp API

1. Đối tác Nhà hàng 

API hỗ trợ quản lý thông tin đối tác nhà hàng

  • Danh sách các đối tác nhà hàng

Phương thức này cho phép thu thập danh sách của tất cả các đối tác nhà hàng

danh sach MC

Kết quả phản hồi

merchant get

Ý nghĩa của các kết quả phản hồi

200 500

2. Đơn hàng

  • Đăng tải đơn hàng cho Đối tác nhà hàng

BAEMIN sẽ tự động gửi đơn hàng mới hoặc cập nhật trạng thái đơn hàng cho đối tác bằng cách sử dụng Webhook được cung cấp bởi đối tác.

Ví dụ: Yêu cầu gửi tới Endpoint Webhook của Đối tác

order publish

Ví dụ cho phản hồi từ phía đối tác như sau:

order publish 2

Các tham số có trong phần thân yêu cầu

Parameter

  • Thông tin chi tiết của đơn hàng

Phương thức này cho phép đối tác có được thông tin chi tiết về một đơn hàng dựa trên orderId.

get order 1

Kết quả phản hồi

order get

Ý nghĩa các kết quả phản hồi

200 500

  • Cập nhật trạng thái của đơn hàng

Phương thức này cho phép đối tác cập nhật trạng thái của một đơn hàng hiện có dựa trên orderId.

update order 1 1

Kết quả phản hồi

order put

Ý nghĩa các kết quả phản hồi

200 500 Updated

3. Thực đơn

Thực đơn đề cập đến danh sách cung cấp thông tin về các món ăn khác nhau được cung cấp trong cửa hàng và giá tiền tương ứng. Thực đơn cũng chứa tất cả các tùy chọn và giá tiền tương ứng của chúng.

  • Lấy thực đơn

Phương thức này cho phép lấy danh sách tất cả các thực đơn của đối tác

Kết quả phản hồi

menu get

Ý nghĩa các kết quả phản hồi

200 500

  • Tạo thực đơn

Phương thức cho phép đối tác tạo thực đơn mới

create menu 2

post menu

Kết quả phản hồi

menu post

Ý nghĩa các kết quả phản hồi

201 429

  • Cập nhật thực đơn

Phương thức cho phép đối tác cập nhật thực đơn nhà hàng

update menu 2

Kết quả phản hồi

menu put

Ý nghĩa các kết quả phản hồi

200 500 Updated

  • Xóa thực đơn

Phương thức cho phép xóa thực đơn nhà hàng

delete menu

Kết quả phản hồi

menu delete 1

Ý nghĩa các kết quả phản hồi

204 500

4. Section

Section được sử dụng để nhóm các thực đơn tương tự lại với nhau, giúp khách hàng có thể dễ dàng tìm thấy những gì nhóm thực đơn họ đang tìm kiếm.

  • Lấy Section

Phương thức này sẽ cho phép đối tác tạo section mới cho nhà hàng của mình

get section

Kết quả phản hồi

GIF Get section

Ý nghĩa các kết quả phản hồi

200 500

  • Tạo Section

Phương thức cho phép đối tác tạo section mới

create section

post section menu

Kết quả phản hồi

Tao Section GIF

Ý nghĩa các kết quả phản hồi

201 429

  • Cập nhật Section

Phương thức này cho phép đối tác cập nhật section nhà hàng

update section

update section put

Kết quả phản hồi

Update Section GIF

Ý nghĩa các kết quả phản hồi

200 500 Updated

  • Xóa Section

Phương thức cho phép đối tác xóa section trong thực đơn

delete section

Kết quả phản hồi

GIF Detete

Ý nghĩa các kết quả phản hồi

204 500