Get Reservation Data

Description

取得 inline 訂位單資料。

Resource

GET /v1/inline/reservation

Authorization

採用 OAuth 2.0 Bearer Token，詳細使用流程請參考 Auth Login。

Query Parameters

Name	Type	Description
store_id	string	門市編號
date	string	預訂單日期若沒指定則查詢今天更新的訂位單 (option)
reservation_id	string	預訂單編號 (option)

Request Example

GET /v1/inline/reservation?store_id=A001&date=2024-07-25&reservation_id=-O2boxDTTI0lrSCYEKSY

Response Body Parameters

Name	Type	Description
reservations	Reservation[]	訂位單列表

Response Body Parameters - Reservation

Name	Type	Description
id	string	訂位單編號
reservation_link	string	訂位單連結 (option)
customer_note	string	消費者備註 (option)
estimated_ready_time	string	候位預計等侯時間，訂位 = 0 (option)
note	string	餐廳備註內容 (option)
group_size	integer	大人人數
number_of_kid_chairs	integer	小孩人數 (option)
number_of_kid_sets	integer	兒童椅數量 (option)
third_party_member	Third Party Member	第三方會員資訊 (option)
contact	Contact	聯絡資訊 (option)
customer	Customer	消費者資訊 (option)
reservation_time	string	訂位時間 (option)
type	string	類型 ALLOWED VALUES: WAITING: 候位 BOOKING: 訂位 WALK_IN: 現場客 (option)
state	string	狀態 ALLOWED VALUES: WAITING: 候位 SEATED: 入座 CANCELLED: 已取消 (option)
state_change_time	string	狀態修改時間 (option)
serial_number	string	候位序號訂位為空 (option)
canceled_by	string	由誰取消，客人或是平板 ALLOWED VALUES: CUSTOMER: 消費者 HOST: 店家 (option)
cancel_reason	string	取消原因 ALLOWED VALUES: NO_SHOW: 餐點完成但無人取餐 (option)
created_time	string	訂位建立時間 (option)
created_from	string	由誰建立訂位，若由第三方 api 則為 provider id (option)
position_in_line	integer	在等待佇列中的順序 (option)
third_party_note	integer	第三方服務的備註內容 (非客人提供的備註) (option)

Response Body Parameters - Third Party Member

Name	Type	Description
id	string	第三方會員編號，串接方可帶入自己的編號
type	string	第三方會員類型，會顯示在平板上
provider	string	第三方會員提供者，建立時可不帶入 (option)
name	string	姓名
phone	string	電話 (option)
email	string	信箱 (option)
address	string	地址 (option)
gender	string	性別 ALLOWED VALUES: MALE: 男性 FEMALE: 女性 COMPANY: 公司
birthday	string	生日，會顯示在平板上 (option)
language	string	語言 (option)
note	string	備註，會顯示在平板上 (option)
avatar	string	大頭貼相片 URL，會顯示在平板上 (option)
metadata	string	將與此第三方成員一起附加和返回的其他 thirdPartyMember 元數據 (option)
updatedTime	string	更新時間 (option)
createdTime	string	創建時間 (option)

Response Body Parameters - Contact

Name	Type	Description
customer_id	string	消費者編號 (option)
name	string	名稱 (option)
gender	string	性別 (option)
language	string	語言 (option)
email	string	信箱 (option)
phone	string	電話號碼 (option)
total_picked_up_orders	integer	已完成的訂單總數 (option)

Response Body Parameters - Customer

Name	Type	Description
customer_id	string	消費者編號 (option)
name	string	名稱 (option)
gender	string	性別 (option)
language	string	語言 (option)
email	string	信箱 (option)
phone	string	電話號碼 (option)
total_picked_up_orders	integer	已完成的訂單總數 (option)

Response Example

{
  "reservations": [
    {
      "id": "string",
      "branch": {},
      "company": {},
      "reservation_link": "http://to/reservation",
      "customer_note": "string",
      "estimated_ready_time": "0",
      "note": "string",
      "group_size": 2,
      "number_of_kid_chairs": 1,
      "number_of_kid_sets": 1,
      "third_party_member": {
        "id": "member-id",
        "type": "vip",
        "provider": "facebook",
        "name": "Ken",
        "phone": "+886988111222",
        "email": "[email protected]",
        "address": "台北市中正區重慶南路一段122號",
        "gender": "MALE",
        "birthday": "1986-06-06",
        "language": "zh-tw",
        "note": "I am a note",
        "avatar": "https://example.com/avatar.jpg",
        "metadata": {},
        "updated_time": "2017-12-26 08:15:45.710",
        "created_time": "2017-12-26 08:15:45.710"
      },
      "contact": {
        "name": "inline customer",
        "gender": "MALE",
        "language": "zh",
        "email": "[email protected]",
        "phone": "+886111222333",
        "customer_id": "my-id",
        "total_picked_up_orders": 10
      },
      "customer": {
        "name": "inline customer",
        "gender": "MALE",
        "language": "zh",
        "email": "[email protected]",
        "phone": "+886111222333",
        "customer_id": "my-id",
        "total_picked_up_orders": 10
      },
      "reservation_time": "0",
      "type": "WAITING",
      "state": "WAITING",
      "state_change_time": "0",
      "serial_number": "string",
      "canceled_by": "CUSTOMER",
      "cancel_reason": "NO_SHOW",
      "created_time": "0",
      "created_from": "string",
      "position_in_line": 0,
      "third_party_note": "string"
    }
  ]
}