Sviluppatori

Incassare le prenotazioni da un altro punto vendita

Lascia che un punto vendita esterno legga quanto fa una prenotazione e rimandi indietro la vendita, così la prenotazione si completa.

Cos'è

Il passaggio dell'incasso è un solo indirizzo con due chiamate: GET e POST /api/v1/{slug}/appointments/{id}/checkout. GET restituisce quanto fa la prenotazione: ogni servizio ed extra con il suo lineId e chi l'ha fatto, il prezzo, gli sconti, le righe delle imposte, l'acconto già pagato e dueCents, che è esattamente quanto incassare. POST registra la vendita fatta dal tuo punto vendita, completa la prenotazione e le collega la vendita, usando lo stesso codice di incasso del punto vendita di Bookatu.

Perché ti aiuta

Nessuno batte una visita due volte, e la prenotazione, la vendita, quanto viene accreditato allo staff e i soldi tornano in Bookatu come se l'avesse incassata il suo punto vendita. L'invio è idempotente sul tuo externalSaleId, quindi un nuovo tentativo dopo una connessione caduta restituisce replayed: true e non scrive nulla.

Come si usa

  1. 1Titolari e amministratori creano la chiave in Settings, poi API & monitoring, sotto API keys. In What this key may do, spunta entrambe le caselle sulla riga Checkout at another point of sale: See what a booking comes to at checkout (checkout:read) e Check bookings out from another point of sale (checkout:write). Vanno attivate apposta, e una chiave creata prima che esistessero i permessi per chiave non le ha mai. Chi crea la chiave deve poter vedere il calendario di tutti (per checkout:read) e modificare il calendario (per checkout:write). Aggiungi See bookings (bookings:read) per elencare le prenotazioni del giorno con GET /appointments, e See clients (customers:read) se il tuo punto vendita ha bisogno di nome, email e telefono del cliente. Senza, il cliente arriva solo con il suo id.
  2. 2Invia la chiave come Authorization: Bearer in ogni chiamata. Chiama GET /api/v1/{slug}/appointments/{id}/checkout e batti le sue righe. checkout.allowed dice se la prenotazione si può incassare ora, e checkout.blocked dà il motivo: not_live, deposit_pending, already_checked_out o invoiced. invoiced vuol dire che la prenotazione è su una fattura e si paga lì, quindi non incassare soldi per lei al tuo punto vendita.
  3. 3Incassa i soldi, poi fai una POST allo stesso indirizzo con { externalSaleId, source, amountCents, currency, tender, tipCents, tipSplit, lines }. externalSaleId è l'id della vendita nel tuo punto vendita. source dà il nome del tuo punto vendita, come front_desk_pos (di default è external e non può mai essere bookatu). amountCents deve essere uguale a dueCents. currency è facoltativo ma deve essere quella dell'attività. tender è card, cash o other. lines, nella forma [{ lineId, staffId }], accredita una riga a qualcun altro.
  4. 4Inviare di nuovo lo stesso externalSaleId dallo stesso punto vendita restituisce la vendita originale con replayed: true. I rifiuti non scrivono nulla e danno un motivo: 400 card_number (externalSaleId o source sembra un numero di carta, che non viene mai accettato); 409 amount_mismatch (con expectedCents), already_checked_out, external_sale_used, lines_changed (rileggi l'incasso), not_live, deposit_pending o invoiced (la prenotazione si paga sulla sua fattura); 422 currency o tip_split; 503 mentre il passaggio dell'incasso è ancora in fase di attivazione per l'attività.
  5. 5Per essere avvisato di ogni incasso, aggiungi un webhook nella scheda Webhooks della stessa pagina e spunta booking.checked_out sotto Only if you tick it. Non viene mai inviato a un endpoint che riceve tutti gli eventi. Scatta anche per gli incassi al punto vendita di Bookatu (sale.source bookatu), con lo stesso contenuto di GET e il cliente solo con il suo id.
  6. 6Il riferimento completo, con ogni campo ed esempio, è nella documentazione per sviluppatori su /developers#checkout-handoff, e in markdown su /developers.md.

Was this helpful?

Non hai trovato quello che cercavi?

Contatta l'assistenza oppure vai alle domande frequenti.