API de Clientes

Crea, consulta, actualiza y elimina clientes de tu tienda.

Endpoints
GET

/customers

customers:read

Obtener una lista paginada de clientes.

GET

/customers/:id

customers:read

Obtener un cliente por su ID.

POST

/customers

customers:write

Crear un nuevo cliente.

PUT

/customers/:id

customers:write

Actualizar un cliente existente. Se admiten actualizaciones parciales.

DELETE

/customers/:id

customers:write

Eliminacion suave de un cliente. El registro puede restaurarse en 30 dias.

Referencia de Campos
CampoTipoObligatorioDescripción

id

string

No

Identificador unico del cliente (solo lectura)

name

string

Sí

Nombre completo del cliente

email

string

Sí

Correo electronico del cliente

phone

string

No

Numero de telefono con codigo de pais

createdAt

datetime

No

Marca de tiempo ISO 8601 (solo lectura)

updatedAt

datetime

No

Marca de tiempo ISO 8601 (solo lectura)

Parametros de Consulta (Lista)
CampoTipoObligatorioDescripción

page

integer

No

Numero de pagina (predeterminado: 1)

limit

integer

No

Elementos por pagina (predeterminado: 20, maximo: 100)

q

string

No

Buscar por nombre o correo del cliente

Ejemplo
Listar clientes con paginacion
bash
curl "https://api.mercozy.com/api/v1/external/customers?page=1&limit=20" \
  -H "X-API-Key: mk_live_xxxxx"
Crear un cliente
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"
  }'
Ejemplo de Respuesta
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"
  }
}