Guide · Clients

Rechercher ou mettre à jour un client.

La recherche permet de retrouver une fiche et son identifiant public avant de consulter ou remplacer ses informations modifiables.

Procédure

1. Normaliser les données saisies

   Validez l’email et le téléphone côté site avant l’appel.

2. Rechercher un client

   Utilisez GET /v1/customers/search avec les critères disponibles et matchMode=exact. Une absence de résultat renvoie une liste vide ; plusieurs résultats nécessitent une vérification avant rattachement.

3. Consulter la fiche

   GET /v1/customers/{customerId} retourne le détail du client sélectionné.

4. Remplacer une fiche explicitement

   PUT /v1/customers/{customerId} suit une sémantique de remplacement : envoyez tous les champs attendus.

Rechercher par email

curl --get "https://api.hbjo-online.com/v1/customers/search" \
  --data-urlencode "email=alice.martin@example.com" \
  --data-urlencode "matchMode=exact" \
  -H "Authorization: Bearer $TOKEN"

Remplacer les informations modifiables

curl -X PUT "https://api.hbjo-online.com/v1/customers/$CUSTOMER_ID" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d @customer.json

{
  "typeCustomer": "individual",
  "firstName": "Alice",
  "lastName": "Martin",
  "email": "alice.martin@example.com",
  "billingDifferentAddress": false,
  "communication": "email",
  "phoneCommunication": false,
  "emailCommunication": true,
  "personalInformations": true,
  "shopId": "shop_01HZX8K5M6"
}

Scopes nécessaires

Lecture : customers:read et customers:pii:read. Écriture : customers:write et customers:pii:write.