Saltearse al contenido

Clientes

Listar clientes

GET /api/v1/customers

Parámetros de query

ParámetroTipoDescripción
pagenúmeroPágina. Por defecto 1.
limitnúmeroPor página. Por defecto 20, máximo 100.
searchtextoBusca por nombre, email o teléfono.

Ejemplo

Ventana de terminal
curl "https://api.novity.com.ar/api/v1/customers?page=1&limit=20" \
-H "Authorization: Bearer nv_tu_api_key"

Respuesta

{
"data": [
{
"id": "cus_abc123",
"name": "Juan Pérez",
"status": "Active",
"loyaltyProgramId": "prog_xyz",
"tierName": "Oro"
}
],
"meta": {
"currentPage": 1,
"total": 342,
"hasNextPage": true,
"hasPreviousPage": false
}
}

Buscar un cliente

Busca un cliente por email o teléfono. Devuelve null si no existe.

GET /api/v1/customers/lookup

Parámetros de query

Al menos uno es obligatorio:

ParámetroDescripción
emailEmail del cliente.
phoneTeléfono del cliente (se normaliza según el país de la organización).

Ejemplo

Ventana de terminal
curl "https://api.novity.com.ar/api/v1/customers/[email protected]" \
-H "Authorization: Bearer nv_tu_api_key"

Obtener un cliente

GET /api/v1/customers/:customerId

Ejemplo

Ventana de terminal
curl https://api.novity.com.ar/api/v1/customers/cus_abc123 \
-H "Authorization: Bearer nv_tu_api_key"

Crear un cliente

Crea un cliente. Si ya existe un usuario con ese email o teléfono, lo asocia a tu organización en lugar de duplicarlo.

POST /api/v1/customers

Cuerpo

Se requiere email o teléfono (al menos uno):

CampoTipoDescripción
emailtextoEmail del cliente.
phoneNumbertextoTeléfono del cliente.
firstNametextoNombre.
lastNametextoApellido.

Ejemplo

Ventana de terminal
curl -X POST https://api.novity.com.ar/api/v1/customers \
-H "Authorization: Bearer nv_tu_api_key" \
-H "Content-Type: application/json" \
-d '{
"email": "[email protected]",
"firstName": "Juan",
"lastName": "Pérez"
}'

Errores

CódigoMensaje
400Se requiere email o número de teléfono
400El número de teléfono no es válido
400El email no tiene un formato válido