別のPOSシステムから予約のお会計をする
外部のPOSシステムが予約の金額を読み取り、売上を送り返して、予約を完了にできるようにします。
どんな機能か
お会計の引き継ぎは、1つのアドレスに2つの呼び出しがあるものです。GET と POST /api/v1/{slug}/appointments/{id}/checkout です。GET は予約の金額を返します。メニューとオプションのそれぞれについて lineId と担当者、価格、割引、税の行、支払い済みのデポジット、そして受け取るべき金額ちょうどを示す dueCents です。POST は、お使いのPOSシステムで受け取った売上を記録し、予約を完了にして、売上を予約に結び付けます。BookatuのPOSレジと同じお会計の処理を使います。
どう役立つか
1回の来店を2回打つ人はいなくなり、予約、売上、スタッフの実績、お金が、BookatuのPOSレジで受け取ったときと同じようにBookatuでそろいます。POSTは externalSaleId について冪等なので、接続が切れたあとに再送しても replayed: true が返り、何も書き込まれません。
使い方
- 1オーナーと管理者は、「Settings」の「API & monitoring」にある「API keys」でキーを作ります。「What this key may do」の「Checkout at another point of sale」の行で、「See what a booking comes to at checkout (checkout:read)」と「Check bookings out from another point of sale (checkout:write)」の両方にチェックを入れます。これらはチェックを入れたときだけ付き、スコープ導入前に作られたキーには付きません。キーを作る人は、全員のカレンダーを見られること(checkout:read の場合)と、カレンダーを編集できること(checkout:write の場合)が必要です。GET /appointments でその日の予約を一覧にするには「See bookings (bookings:read)」を、POSシステムでお客様の名前、メールアドレス、電話番号が必要なら「See clients (customers:read)」も追加します。これがない場合、お客様はIDだけで届きます。
- 2毎回の呼び出しで、キーを Authorization: Bearer として送ります。GET /api/v1/{slug}/appointments/{id}/checkout を呼び出し、その行を打ちます。checkout.allowed は今その予約のお会計ができるかどうかを示し、checkout.blocked はその理由を not_live、deposit_pending、already_checked_out、invoiced のいずれかで示します。invoiced は予約が請求書に入っていてそちらで支払われるという意味なので、POSシステムでその代金を受け取らないでください。
- 3お金を受け取ったら、同じアドレスに { externalSaleId, source, amountCents, currency, tender, tipCents, tipSplit, lines } を POST します。externalSaleId は、POSシステム自身の売上IDです。source はPOSシステムの名前で、たとえば front_desk_pos です(省略すると external になり、bookatu にはできません)。amountCents は dueCents と等しくなければなりません。currency は省略できますが、指定する場合はお店の通貨でなければなりません。tender は card、cash、other のいずれかです。lines は [{ lineId, staffId }] の形で、行をほかの人の実績にします。
- 4同じPOSシステムから同じ externalSaleId をもう一度 POST すると、元の売上が replayed: true とともに返ります。拒否された場合は何も書き込まれず、次の理由が返ります。400 card_number(externalSaleId か source がカード番号のように見える場合で、これは決して受け付けません)。409 amount_mismatch(expectedCents 付き)、already_checked_out、external_sale_used、lines_changed(お会計をもう一度読み取ってください)、not_live、deposit_pending、invoiced(予約は請求書で支払われます)。422 currency または tip_split。503(お店でこの引き継ぎをまだ有効にしている途中の場合)。
- 5すべてのお会計の通知を受け取るには、同じページの「Webhooks」のカードでWebhookを追加し、「Only if you tick it」の下の booking.checked_out にチェックを入れます。すべてのイベントを受け取るエンドポイントには送られません。BookatuのPOSレジでのお会計(sale.source bookatu)でも送られ、内容は GET と同じで、お客様はIDだけです。
- 6すべての項目と例を含む完全なリファレンスは、開発者向けドキュメントの /developers#checkout-handoff にあり、/developers.md ではマークダウンで読めます。
Was this helpful?
お探しのものが見つかりませんでしたか?
サポートに問い合わせる または よくある質問をご覧ください.