Kunden-API

Erstellen, abfragen, aktualisieren und loeschen Sie Kunden in Ihrem Shop.

Endpunkte

GET

/customers

customers:read

Eine paginierte Liste von Kunden abrufen.

GET

/customers/:id

customers:read

Einen einzelnen Kunden anhand seiner ID abrufen.

POST

/customers

customers:write

Einen neuen Kunden erstellen.

PUT

/customers/:id

customers:write

Einen bestehenden Kunden aktualisieren. Teilaktualisierungen werden unterstuetzt.

DELETE

/customers/:id

customers:write

Weiches Loeschen eines Kunden. Der Datensatz kann innerhalb von 30 Tagen wiederhergestellt werden.

Feldreferenz

Feld	Typ	Erforderlich	Beschreibung
id	string	Nein	Eindeutige Kunden-ID (schreibgeschuetzt)
name	string	Ja	Vollstaendiger Name des Kunden
email	string	Ja	E-Mail-Adresse des Kunden
phone	string	Nein	Telefonnummer mit Laendervorwahl
createdAt	datetime	Nein	ISO 8601 Zeitstempel (schreibgeschuetzt)
updatedAt	datetime	Nein	ISO 8601 Zeitstempel (schreibgeschuetzt)

Abfrageparameter (Liste)

Feld	Typ	Erforderlich	Beschreibung
page	integer	Nein	Seitennummer (Standard: 1)
limit	integer	Nein	Eintraege pro Seite (Standard: 20, Maximum: 100)
q	string	Nein	Nach Kundenname oder E-Mail suchen

Beispiel

Kunden mit Paginierung auflisten

bash

curl "https://api.mercozy.com/api/v1/external/customers?page=1&limit=20" \
  -H "X-API-Key: mk_live_xxxxx"

Einen Kunden erstellen

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"
  }'

Beispielantwort

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"
  }
}