Clientes
Listar clientes
GET /api/v1/customersParámetros de query
| Parámetro | Tipo | Descripción |
|---|---|---|
page | número | Página. Por defecto 1. |
limit | número | Por página. Por defecto 20, máximo 100. |
search | texto | Busca por nombre, email o teléfono. |
Ejemplo
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/lookupParámetros de query
Al menos uno es obligatorio:
| Parámetro | Descripción |
|---|---|
email | Email del cliente. |
phone | Teléfono del cliente (se normaliza según el país de la organización). |
Ejemplo
-H "Authorization: Bearer nv_tu_api_key"Obtener un cliente
GET /api/v1/customers/:customerIdEjemplo
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/customersCuerpo
Se requiere email o teléfono (al menos uno):
| Campo | Tipo | Descripción |
|---|---|---|
email | texto | Email del cliente. |
phoneNumber | texto | Teléfono del cliente. |
firstName | texto | Nombre. |
lastName | texto | Apellido. |
Ejemplo
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ódigo | Mensaje |
|---|---|
400 | Se requiere email o número de teléfono |
400 | El número de teléfono no es válido |
400 | El email no tiene un formato válido |