Seat Patrons
Description
入座
Resource
PATCH /v1/inline/reservation
Authorization
採用 OAuth 2.0 Bearer Token，詳細使用流程請參考 Auth Login。
Request Body Parameters
| Name | Type | Description |
|---|---|---|
| store_id | string | 商店代號 |
| reservation_id | string | 預約單編號 |
| reservation_time | string | 預約時間 (optional) *若要帶請帶與建立現場客API參數(create_time)相同的數值 |
| group_size | string | 團體大小 (optional) |
| number_of_kids | string | 兒童數量 (optional) *不含high_chairs (optional) |
| number_of_kid_chairs | string | 嬰兒座椅數量 (optional) |
Request Example
{
"store_id": "TW101",
"reservation_id": "string",
"reservation_time": 1556593585092,
"group_size": 2,
"number_of_kids": 2,
"number_of_kid_chairs": 2
}
Response Body Parameters
| Name | Type | Description |
|---|---|---|
| id | string | 訂位 id |
| branch | object | 分店描述 |
| company | object | 品牌描述 |
| reservation_link | string | 訂位資訊連結，可直接連到訂位資訊頁 |
| branch_id | string | 餐廳分店 id |
| company_id | string | 餐廳品牌 id |
| customer_note | string | 客人備註 |
| estimated_ready_time | integer | 候位預計等侯時間，訂位 = 0 |
| note | string | 餐廳備註內容 |
| group_size | integer | 訂位大人人數 |
| number_of_kid_chairs | integer | 訂位小孩人數 |
| number_of_kid_sets | integer | 訂位兒童椅數量 |
| third_party_member | Third Party Member | 第三方服務成員資訊 (optional) |
| contact | Contact | 聯絡人資訊 |
| customer | Customer | 顧客資訊 |
| reservation_time | string | 訂位時間 in unix timestamp |
| type | string | 類型，可能為訂位、候位、現場客 |
| state | string | 目前狀態 |
| state_change_time | string | 狀態修改時間 |
| serial_number | string | 候位序號，訂位為空 |
| canceled_by | string | 由誰取消，客人或是平板 |
| cancel_reason | string | 是否為 no show 取消 |
| create_time | string | 訂位建立時間 in unix timestamp |
| created_from | string | 由誰建立訂位，若由第三方 api 則為 provider id |
| position_in_line | string | 候位順序，僅在候位狀態下有效。注意此值僅在呼叫 /v2/reservation/{reservationId} 時正確。 |
| third_party_note | string | 第三方服務的備註內容 (非客人提供的備註) |
Response Body Parameters - Third Party Member
| Name | Type | Description |
|---|---|---|
| id | string | 顧客編號 |
| provider_id | string | 提供者的ID |
| type | string | 顧客標記 |
| name | string | 顧客名稱 |
| phone_number | string | 顧客電話號碼 |
| string | 顧客電子信箱 | |
| gender | integer | 顧客性別 |
| language | string | 顧客語言 |
| note | string | 第三方成員的備註內容 |
| avatar | string | 第三方成員的頭像URL |
| metadata | object | 第三方成員的附加數據 |
| updated_time | integer | 第三方成員資訊更新時間 in unix timestamp |
| create_time | integer | 第三方成員資訊建立時間 in unix timestamp |
Response Body Parameters - Contact
| Name | Type | Description |
|---|---|---|
| customer_id | string | 聯絡人的顧客編號 |
| name | string | 聯絡人的名稱 |
| gender | string | 聯絡人的性別 |
| language | string | 聯絡人的語言 |
| string | 聯絡人的電子郵件 | |
| phone | string | 聯絡人的電話號碼 |
| total_picked_up_orders | integer | 聯絡人總共領取的訂單數量 |
Response Body Parameters - Customer
| Name | Type | Description |
|---|---|---|
| id | string | 顧客編號 (optional) |
| name | string | 顧客名稱 (optional) |
| name_parts | Name Parts | 姓名詳細資訊 (optional) |
| phone_number | string | 電話號碼 (optional) |
| string | 電子信箱 (optional) |
|
| gender | integer | 性別 |
| title | Title | 稱謂 (optional) |
| language | string | 語言 |
| total_picked_up_orders | integer | 顧客總共領取的訂單數量 |
Response Body Parameters - Name Parts
| Name | Type | Description |
|---|---|---|
| family_name | string | 姓氏 (optional) |
| given_name | string | 名字 (optional) |
| phonetic_family_name | string | 姓氏的拼音或音標 (optional) |
| phonetic_given_name | string | 名字的拼音或音標 (optional) |
Response Body Parameters - Title
| Name | Type | Description |
|---|---|---|
| id | integer | 稱謂編號 (optional) |
| value | string | 顯示稱謂 (optional) |
Response
Status-Code: 200
Reponse Example
{
"id": "-O31dtsV6CSHdDojZOss",
"branch_id": "-O-sa3ydC8UBlTLoPSV5",
"company_id": "-O-sa3lfrtVqBB_g3Tlp:inline-staging-2a466",
"group_size": 1,
"number_of_kid_chairs": 1,
"number_of_kid_sets": 0,
"reservation_time": 1556593585092,
"serial_number": "",
"state": "seated",
"state_change_time": 1556593585092,
"created_time": 1556593585092,
"created_from": "wixtar",
"position_in_line": 999,
"dinner_time": 0,
"customer": {
"customer_id": "string",
"gender": "female",
"language": "zh-tw",
"name": "里賢治 さと けんじ",
"email": "[email protected]",
"phone": "+8860912345678"
},
"type": "walk-in"
}