Aller au contenu

Clients

Un client, c’est une fiche dans le répertoire du restaurant : noms, coordonnées, marqueurs propres au restaurant et historique de visites compté. C’est le même objet que ?expand=guest intègre dans une réservation ou une entrée de liste d’attente.

Les deux points de terminaison demandent la portée guests:read, et une clé qui ne l’a pas reçoit un 403 insufficient_scope quoi qu’elle porte par ailleurs. Les champs sont sur L’objet client.

Point de terminaison Ce qu’il fait
GET /v1/guests Liste les fiches, de la plus récente à la plus ancienne, filtrables avec updated_since et email ou phone.
GET /v1/guests/{id} Récupère une fiche par son identifiant gst_….

Cette ressource est en lecture seule. Les fiches sont créées par le restaurant, par le widget de réservation et comme effet de bord de POST /v1/reservations ; aucun point de terminaison ici n’en écrit.

Quand le restaurant fusionne deux fiches, le gst_… absorbé se résout toujours et renvoie la fiche survivante, sous l’identifiant de cette survivante. Un identifiant que vous avez stocké ne casse donc jamais, et le signe de la fusion est que l’id renvoyé diffère de celui que vous avez envoyé. Un webhook guest.merged l’annonce au moment où elle a lieu.