Create Walk In Reservation

Description

建立現場客

Resource

POST /v1/inline/reservation

Authorization

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

Request Body Parameters

Name	Type	Description
store_id	string	商店代號
customer	Customer	顧客資訊 (optional)
reservation	Reservation	定位資訊
tables	[string]	預定顯示名稱

Request Body Parameters - Customer

Name	Type	Description
id	string	顧客編號 (optional)
name	string	顧客名稱 (optional)
name_parts	Name Parts	姓名詳細資訊 (optional)
phone_number	string	電話號碼 (optional)
email	string	電子信箱 (optional)
gender	integer	性別
title	Title	稱謂 (optional)
language	string	語言

Request 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)

Request Body Parameters - Title

Name	Type	Description
id	integer	稱謂編號 (optional)
value	string	顯示稱謂 (optional)

Request Body Parameters - Reservation

Name	Type	Description
group_size	integer	團體大小
kids	integer	兒童數量 (optional) *不含high_chairs
high_chairs	integer	嬰兒座椅數量 (optional)
created_time	integer	建立時間戳記
dining_time	integer	用餐時間戳記 (optional)
created_from	string	建立來源 *目前請填wixtar，否則後續會有API呼叫問題
third_party_member	object	第三方成員資訊 (optional)

Request Body Parameters - Third Party Member

Name	Type	Description
id	string	顧客編號
provider_id	string	提供者的ID
type	string	顧客標記
name	string	顧客名稱
phone_number	string	顧客電話號碼
email	string	顧客電子信箱
gender	integer	顧客性別
language	string	顧客語言

Request Example

{
  "store_id": "TW101",
  "customer": {
    "id": "string",
    "name": "string",
    "name_parts": {
      "family_name": "里",
      "given_name": "賢治",
      "phonetic_family_name": "さと",
      "phonetic_given_name": "けんじ"
    },
    "phone_number": "+8860912345678",
    "email": "[email protected]",
    "gender": 1,
    "title": {
      "id": 1,
      "value": "Dr."
    },
    "language": "zh-tw"
  },
  "reservation": {
    "group_size": 1,
    "kids": 0,
    "high_chairs": 0,
    "created_time": 1556593585092,
    "dining_time": 0,
    "created_from": "string",
    "third_party_member": {
      "id": "string",
      "provider_id": "inline",
      "type": "vip",
      "name": "string",
      "phone_number": "+8860912345678",
      "email": "[email protected]",
      "gender": 1,
      "language": "zh-tw"
    }
  },
  "tables": [
    "string"
  ]
}

Response

Status-Code: 200

Response Body Parameters

Name	Type	Description
reservation_id	string	顧客編號
reservation_link	string	提供者的ID

status-Code: 400

Reposne Example

200

{
  "reservation_id": "reservation-id",
  "reservation_link": "https://iln.io/xxx123"
}

400
{
  "code": 500003,
  "message": "Third Party Provider is invalid",
  "reason": "Third Party Provider is invalid"
}