Clients

Les clients sont créés automatiquement lorsqu’ils passent commande dans votre boutique, y compris via l’API Checkout. Chaque client est spécifique à votre boutique et possède son propre profil avec des informations de contact, un historique d’achats et un accès aux produits.

Votre boutique a un seul client par adresse e-mail. Les e-mails sont enregistrés en minuscules et comparés sans tenir compte de la casse : un acheteur qui saisit John@Example.com puis john@example.com est le même client. Chaque nouveau paiement avec cet e-mail met à jour le prénom, le nom et le numéro de téléphone du client. Les clients dupliqués par le passé ont été fusionnés dans l’enregistrement le plus ancien : son ID est conservé, les ventes des doublons lui sont rattachées, et les ID des doublons fusionnés renvoient 404.

Objet Client

Un objet client contient les informations suivantes :

{
  "id": "cus_abc123xyz",
  "name": "John Doe",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john@example.com",
  "avatar_url": "https://cdn.chariow.com/avatars/abc123.jpg",
  "phone": {
    "number": "+1 234 567 890",
    "country": {
      "name": "United States",
      "code": "US",
      "alpha_3_code": "USA",
      "dial_code": "+1",
      "currency": "USD",
      "flag": "🇺🇸"
    }
  },
  "store": {
    "id": "str_xyz789",
    "name": "My Digital Store",
    "logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
    "url": "https://mystore.chariow.link"
  },
  "created_at": "2025-01-15T10:30:00+00:00",
  "updated_at": "2025-01-20T14:45:00+00:00"
}

Propriétés du Client

Propriété	Type	Description
`id`	string	Identifiant unique du client avec le préfixe `cus_`
`name`	string	Nom complet (combinaison du prénom et du nom)
`first_name`	string	Prénom du client
`last_name`	string	Nom de famille du client
`email`	string	Adresse e-mail du client
`avatar_url`	string	URL de l’image d’avatar du client
`phone`	object	Numéro de téléphone avec les informations du pays
`store`	object	Boutique à laquelle appartient le client
`created_at`	string	Horodatage ISO 8601 de la date de création du client
`updated_at`	string	Horodatage ISO 8601 de la dernière mise à jour du client

Liste des Clients

Récupérez tous les clients de votre boutique :

curl -X GET "https://api.chariow.com/v1/customers" \
  -H "Authorization: Bearer sk_live_your_api_key"

const response = await fetch('https://api.chariow.com/v1/customers', {
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key'
  }
});

const result = await response.json();

import requests

response = requests.get(
    'https://api.chariow.com/v1/customers',
    headers={'Authorization': 'Bearer sk_live_your_api_key'}
)

customers = response.json()['data']

Paramètres de Requête

Paramètre	Type	Description
`per_page`	integer	Nombre de clients par page (par défaut : 10, de 1 à 100)
`cursor`	string	Curseur pour la pagination (utilisez `next_cursor` de la réponse précédente)
`search`	string	Recherche par prénom, nom, e-mail ou numéro de téléphone
`from`	string	Clients créés à partir de cette date incluse (format Y-m-d)
`to`	string	Clients créés jusqu’à cette date incluse (format Y-m-d)
`period`	string	Raccourci de plage de dates, à la place de `from` et `to` : `today`, `yesterday`, `last7days`, `last30days`, `thisWeek`, `lastWeek`, `thisMonth`, `lastMonth`, `thisYear`, `lastYear`

start_date et end_date ne sont pas pris en charge et sont ignorés sans erreur, ce qui renvoie les clients de toutes les dates. Utilisez from et to.

Recherche de Clients

Recherchez des clients par prénom, nom, e-mail ou numéro de téléphone :

curl -X GET "https://api.chariow.com/v1/customers?search=john" \
  -H "Authorization: Bearer sk_live_your_api_key"

Filtrage par Plage de Dates

Récupérez les clients créés dans une plage de dates spécifique :

curl -X GET "https://api.chariow.com/v1/customers?from=2025-01-01&to=2025-01-31" \
  -H "Authorization: Bearer sk_live_your_api_key"

Exemple de Réponse

{
  "data": [
    {
      "id": "cus_abc123xyz",
      "name": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john@example.com",
      "avatar_url": "https://cdn.chariow.com/avatars/abc123.jpg",
      "phone": {
        "number": "+1 234 567 890",
        "country": {
          "name": "United States",
          "code": "US",
          "alpha_3_code": "USA",
          "dial_code": "+1",
          "currency": "USD",
          "flag": "🇺🇸"
        }
      },
      "store": {
        "id": "str_xyz789",
        "name": "My Digital Store",
        "logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
        "url": "https://mystore.chariow.link"
      },
      "created_at": "2025-01-15T10:30:00+00:00",
      "updated_at": "2025-01-20T14:45:00+00:00"
    }
  ],
  "pagination": {
    "per_page": 10,
    "next_cursor": "eyJpZCI6NTB9",
    "prev_cursor": null,
    "has_more_pages": true
  }
}

Récupération d’un Client Unique

Récupérez un client spécifique par son ID public :

curl -X GET "https://api.chariow.com/v1/customers/cus_abc123" \
  -H "Authorization: Bearer sk_live_your_api_key"

const response = await fetch('https://api.chariow.com/v1/customers/cus_abc123', {
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key'
  }
});

const result = await response.json();

Cycle de Vie du Client

Client Créé

Un dossier client est créé lors de son premier passage en caisse, avant la confirmation du paiement. Un acheteur qui abandonne le paiement figure donc quand même parmi vos clients.

Achat Enregistré

Chaque achat est lié au profil du client.

Accès Accordé

Le client reçoit l’accès à ses produits achetés (téléchargements, cours, licences).

Accès au Portail

Les clients peuvent accéder au portail client pour consulter leurs achats et téléchargements.

Cas d’Usage Courants

Intégration CRM

Synchronisez les clients avec votre CRM en récupérant les nouveaux clients à l’aide de filtres de date :

// Récupérer les clients créés au cours des dernières 24 heures
const today = new Date().toISOString().split('T')[0];
const yesterday = new Date(Date.now() - 86400000).toISOString().split('T')[0];

const response = await fetch(
  `https://api.chariow.com/v1/customers?from=${yesterday}&to=${today}`,
  { headers: { 'Authorization': 'Bearer sk_live_your_api_key' }}
);

const result = await response.json();
// Synchroniser result.data avec votre CRM

Marketing par E-mail

Ajoutez des clients à vos listes de diffusion en fonction de leurs achats :

// Obtenir les détails du client pour la liste de diffusion
const response = await fetch(
  'https://api.chariow.com/v1/customers/cus_abc123xyz',
  { headers: { 'Authorization': 'Bearer sk_live_your_api_key' }}
);

const result = await response.json();

await addToMailingList({
  email: result.data.email,
  firstName: result.data.first_name,
  lastName: result.data.last_name,
  tags: ['customer', 'purchased']
});

Recherche de Client

Recherchez un client par e-mail lorsqu’il contacte le support :

curl -X GET "https://api.chariow.com/v1/customers?search=customer@example.com" \
  -H "Authorization: Bearer sk_live_your_api_key"

Le paramètre de recherche correspond aux champs prénom, nom, e-mail et numéro de téléphone.

Rapports Mensuels

Générez des rapports mensuels d’acquisition de clients à l’aide de filtres de date :

curl -X GET "https://api.chariow.com/v1/customers?from=2025-01-01&to=2025-01-31&per_page=100" \
  -H "Authorization: Bearer sk_live_your_api_key"

Cela récupère tous les clients créés en janvier 2025.

Ressources Associées

Guide des Ventes

Consultez l’historique des achats des clients

Guide des Licences

Gérez les licences des clients

API Clients

Consultez la référence complète de l’API Clients

Introduction

Guides

Intégration MCP

Intégration n8n

Resources

Objet Client

Propriétés du Client

Liste des Clients

Paramètres de Requête

Recherche de Clients

Filtrage par Plage de Dates

Exemple de Réponse

Récupération d’un Client Unique

Cycle de Vie du Client

Cas d’Usage Courants

Ressources Associées

Guide des Ventes

Guide des Licences

API Clients

​Objet Client

​Propriétés du Client

​Liste des Clients

​Paramètres de Requête

​Recherche de Clients

​Filtrage par Plage de Dates

​Exemple de Réponse

​Récupération d’un Client Unique

​Cycle de Vie du Client

​Cas d’Usage Courants

​Ressources Associées

Guide des Ventes

Guide des Licences

API Clients

Objet Client

Propriétés du Client

Liste des Clients

Paramètres de Requête

Recherche de Clients

Filtrage par Plage de Dates

Exemple de Réponse

Récupération d’un Client Unique

Cycle de Vie du Client

Cas d’Usage Courants

Ressources Associées