Booking
Description
訂位。
Resource
POST /v1/order/booking
Authorization
採用 OAuth 2.0 Bearer Token，詳細使用流程請參考 Auth Login。
Request Body Parameters
| Name | Type | Description |
|---|---|---|
| id | string | 訂單編號，第一次訂位時不用帶 (optional) |
| store | Store | 訂位門市 |
| customer | Customer | 消費者資訊 |
| placed_at | string | 提交時間 EXAMPLE "2020-01-01 15:16:54" |
| reservation_time | string | 預定時間 EXAMPLE "2020-01-01 15:16:54" |
| person_count | Person Count | 人數 |
| special_instructions | string | 特殊要求 (optional) 備註：限制100個字 |
| external_id | string | 外部編號 (optional) |
| payments | Payment[] | 付款資訊 (optional) |
Request Body Parameters - Store
| Name | Type | Description |
|---|---|---|
| id | string | 門市代碼 |
| name | string | 門市名稱 |
| sale_store_id | string | 銷售門市代碼 (optional) |
Request Body Parameters - Customer
| Name | Type | Description |
|---|---|---|
| id | string | 會員編號 (optional) |
| name | string | 姓名 |
| mobile | string | 手機號碼 |
| string | 信箱 |
Request Body Parameters - Person Count
| Name | Type | Description |
|---|---|---|
| adult | integer | 大人 |
| child | integer | 小孩 |
Request Body Parameters - Payment
| Name | Type | Description |
|---|---|---|
| type | Payment | 付款方式 |
| payment_amount | integer | 支付金額 |
| customize | Customize | 自定義金流 (optional) *若type為CUSTOMIZE需必填 |
Request Body Parameters - Customize
| name | type |
|---|---|
| id | 自定義金流代碼 |
| name | 自定義金流名稱 |
Request Body Parameters - Payment Instruction
| type | name |
|---|---|
| LINE_PAY | LINE Pay |
| PI_PAY | Pi Pay |
| CREDIT_CARD | 信用卡 |
| EASY_CARD | 悠遊卡 |
| CASH | 臨櫃結帳 |
| MWD_PAY | 麥味登Pay |
| Easy_Wallet | 悠遊付 |
| APPLE_PAY | Apple Pay |
| GOOGLE_PAY | Google Pay |
| NCCC_EASY_CARD | NCCC悠遊卡 |
| NCCC_IPASS | NCCC一卡通 |
| NCCC_ICASH | NCCC iCash |
| NCCC_HAPPY_CASH | NCCC有錢卡 |
| CASH_CAR | 現金 |
| CHARGE_CARD | 簽帳 |
| MOTORCADE | 車隊 |
| CREDIT_CARD_CAR | 信用卡 |
| CTBC_CARD | 中信卡 |
| BARCODE_PAY | 條碼支付 |
| TAIWAN_PAY | 台灣 Pay |
| JkoPay | 街口支付 |
| CUSTOMIZE | 自定義金流 |
| TK01 | 門票折抵 |
| HAO_SPEED | 全家外送自取 |
| EC | EC |
| HSA_EXTRA | 異質POS |
| PX_PAY | 全支付 |
| CASH_ON_DELIVERY | 貨到付款 |
| NEWEB_PAY | 藍新金流 |
| CASH_MODULE | 現金模組 |
| I_CASH_PAY | 愛金卡支付 |
| DD_PAY | 信用卡(DD_PAY) |
Request Example
{
"store": {
"id": "A01",
"name": "台南店",
"sale_store_id": ""
},
"customer": {
"id": "",
"name": "王大明",
"mobile": "0987654321",
"email": "[email protected]"
},
"placed_at": "2023-02-24 16:00:00",
"reservation_time": "2023-02-28 12:00:00",
"person_count": {
"adult": 5,
"child": 1
},
"special_instructions": "",
"external_id": ""
}
Response Body Parameters
| Name | Type | Description |
|---|---|---|
| id | string | 訂單編號 |
Response
{
"id": "A012005010001"
}