API Clients

Creez, consultez, mettez a jour et supprimez des clients de votre boutique.

Endpoints
GET

/customers

customers:read

Obtenir une liste paginee de clients.

GET

/customers/:id

customers:read

Obtenir un client par son ID.

POST

/customers

customers:write

Creer un nouveau client.

PUT

/customers/:id

customers:write

Mettre a jour un client existant. Les mises a jour partielles sont prises en charge.

DELETE

/customers/:id

customers:write

Suppression douce d'un client. L'enregistrement peut etre restaure sous 30 jours.

Reference des Champs
ChampTypeObligatoireDescription

id

string

Non

Identifiant unique du client (lecture seule)

name

string

Oui

Nom complet du client

email

string

Oui

Adresse e-mail du client

phone

string

Non

Numero de telephone avec indicatif pays

createdAt

datetime

Non

Horodatage ISO 8601 (lecture seule)

updatedAt

datetime

Non

Horodatage ISO 8601 (lecture seule)

Parametres de Requete (Liste)
ChampTypeObligatoireDescription

page

integer

Non

Numero de page (defaut : 1)

limit

integer

Non

Elements par page (defaut : 20, max : 100)

q

string

Non

Rechercher par nom ou e-mail du client

Exemple
Lister les clients avec pagination
bash
curl "https://api.mercozy.com/api/v1/external/customers?page=1&limit=20" \
  -H "X-API-Key: mk_live_xxxxx"
Creer un client
bash
curl -X POST "https://api.mercozy.com/api/v1/external/customers" \
  -H "X-API-Key: mk_live_xxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+1234567890"
  }'
Exemple de Reponse
json
{
  "data": {
    "id": "cust_abc123",
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+1234567890",
    "createdAt": "2025-12-15T10:30:00Z",
    "updatedAt": "2025-12-15T10:30:00Z"
  }
}