Skip to content

Checkout

Description

inline 結帳。

Resource

POST /v1/inline/reservation/checkout

Authorization

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

Request Body Parameters

Name Type Description
store_id string 門市編號
reservation_id string 預訂單編號
order Order 訂單資料
patron_left boolean 是否離席
(option)

Request Body Parameters - Order

Name Type Description
id string 訂單編號
tax_id string 統一編號
(option)
amount float 訂單金額
discount boolean 是否有折扣
(option)
subtotal float 小計
不包含稅、其他費用、折扣額
(option)
discount_amount float 折扣金額
(option)
tax float 稅額
(option)
service_fee float 服務費
(option)
tips float 小費
(option)
other_fee float 其他費用
上面未列出的任何其他費用
(option)
paid boolean 是否已付款
(option)
provider_id string 第三方供應商編號
(option)
items Item 訂單項目列表
(option)

Request Body Parameters - Item

Name Type Description
line_item_number integer 編號
從 1 開始編號,不可重複
(option)
parent_line_item_number integer 父項編號
如果該項目已是父項,則填 null
(option)
type string 類型
ALLOWED VALUES:
  • ITEM
  • MODIFIER
(option)
name string 名稱
quantity float 數量
允許到小數點後2位
value float 小計
(option)
note string 備註
(option)
third_party_item_id string 第三方 POS 系統上項目編號
(option)

Request Example

{
  "store_id": "A001",
  "reservation_id": "-O2boxDTTI0lrSCYEKSY",
  "order": {
    "id": "3b8fb758-eb71-4db6-8f6b-bd09ac4d2cdf",
    "tax_id": "24436074",
    "amount": 100.0,
    "discount": false,
    "subtotal": 100.0,
    "discount_amount": 0.0,
    "tax": 0.0,
    "service_fee": 0.0,
    "tips": 0.0,
    "other_fee": 0.0,
    "paid": true,
    "provider_id": "wixtar",
    "items": [
      {
        "line_item_number": 4948,
        "type": "ITEM",
        "name": "可樂",
        "quantity": 2.0,
        "value": 100.0,
        "note": "string",
        "third_party_item_id": "UC0000211"
      }
    ]
  },
  "patron_left": false
}

Response Example

204 No Content