Clientes
Por Maxim
Por Maxim
Clientes
Clientes: las empresas y las personas a las que vendes tus productos. A través de la API puedes crearlos, editarlos y eliminarlos, y obtener la lista y los datos de un cliente. Las rutas de los métodos se indican respecto a la dirección base de la API; las reglas comunes a todos los métodos (autorización, formato de las solicitudes, edición parcial, paginación) se describen en Descripción general de la API y Reglas generales. Métodos Método Qué hace v1/customers/add Crea un cliente v1/customers/edit Modifica un cliente v1/customers/delete Elimina un cliente v1/customers/get_list Devuelve los clientes de la empresa v1/customers/get_entry Devuelve los datos de un cliente
Crear un cliente
Crea un cliente. v1/customers/add.php Parámetros Campo Tipo Obligatorio Descripción name string Sí Nombre email string No Correo electrónico phone string No Teléfono address_legal string No Dirección fiscal address_real string No Dirección de entrega agreement string No Acuerdo manager_name string No Responsable manager_post string No Puesto del responsable notes string No Notas Un cliente también se puede crear junto con una venta, consulta v1/orders/add. Ejemplo de solicitud { "name": "Patio del Mueble", "email": "pedidos@patiomueble.com", "phone": "+34 912 345 678", "address_legal": "C/ Mayor 5, Madrid", "address_real": "C/ Almacén 12, Madrid", "agreement": "N.º 15 del 10/01/2026", "manager_name": "Pedro Gómez", "manager_post": "Director general" } Ejemplo de respuesta { "success": true, "customer_id": 512 } Errores Error Motivo No name in input name falta o es null Name must not be empty Nombre vacío Name must be a string name se envió como array u objeto
Editar un cliente
Modifica un cliente. Solo se cambian los campos que envías, el resto se queda como estaba. v1/customers/edit.php Parámetros Campo Tipo Obligatorio Descripción customer_id int Sí ID del cliente name string No Nombre email string No Correo electrónico phone string No Teléfono address_legal string No Dirección fiscal address_real string No Dirección de entrega agreement string No Acuerdo manager_name string No Responsable manager_post string No Puesto del responsable notes string No Notas Para vaciar un campo, envía una cadena vacía. Enviar null deja el campo sin cambios, como si no se hubiera enviado. Ejemplo de solicitud { "customer_id": 512, "phone": "+34 912 000 111", "address_real": "C/ Fábrica 3, Madrid" } Ejemplo de respuesta { "success": true } Errores Error Motivo No customer_id in input Falta customer_id Customer not found or access denied Cliente no encontrado o eliminado Name must not be empty Se envió un nombre vacío Name must be a string name se envió como array u objeto
Eliminar un cliente
Elimina un cliente. v1/customers/delete.php Parámetros Campo Tipo Obligatorio Descripción customer_id int Sí ID del cliente Ejemplo de solicitud { "customer_id": 512 } Ejemplo de respuesta { "success": true } Errores Error Motivo No customer_id in input Falta customer_id Customer not found or access denied Cliente no encontrado o ya eliminado
Obtener la lista de clientes
Devuelve los clientes de la empresa, ordenados por nombre. Los clientes eliminados no se incluyen. v1/customers/get_list.php Parámetros Campo Tipo Obligatorio Descripción limit int No Tamaño de página, de 1 a 1000 offset int No Cuántos registros omitir Sin limit se devuelve toda la lista. Consulta la paginación en Reglas generales. Respuesta Un array customers con los campos del cliente. El campo total contiene el número total de clientes. Campo Tipo Descripción id int ID del cliente name string Nombre email string Correo electrónico phone string Teléfono address_legal string Dirección fiscal address_real string Dirección de entrega agreement string Acuerdo manager_name string Responsable manager_post string Puesto del responsable notes string Notas Ejemplo de solicitud { "limit": 100, "offset": 0 } Ejemplo de respuesta { "success": true, "customers": [ { "id": 513, "name": "Ana García", "email": "anna@example.com", "phone": "+34 600 123 456", "address_legal": "", "address_real": "C/ Bauman 20, Valencia", "agreement": "", "manager_name": "", "manager_post": "", "notes": "" }, { "id": 512, "name": "Patio del Mueble", "email": "pedidos@patiomueble.com", "phone": "+34 912 345 678", "address_legal": "C/ Mayor 5, Madrid", "address_real": "C/ Almacén 12, Madrid", "agreement": "N.º 15 del 10/01/2026", "manager_name": "Pedro Gómez", "manager_post": "Director general", "notes": "" } ], "total": 2 } Errores Error Motivo Invalid limit value. Must be between 1 and 1000 limit no válido Invalid offset value. Must be 0 or greater offset no válido Offset requires limit se envió offset sin limit
Obtener los datos de un cliente
Devuelve los datos de un cliente. v1/customers/get_entry.php Parámetros Campo Tipo Obligatorio Descripción customer_id int Sí ID del cliente Un cliente eliminado no se devuelve. Respuesta Un objeto customer con los campos del cliente. Los campos de la respuesta se pueden enviar a v1/customers/edit sin cambios, añadiendo customer_id. Campo Tipo Descripción id int ID del cliente name string Nombre email string Correo electrónico phone string Teléfono address_legal string Dirección fiscal address_real string Dirección de entrega agreement string Acuerdo manager_name string Responsable manager_post string Puesto del responsable notes string Notas Los archivos del cliente no se envían ni se devuelven por la API. Ejemplo de solicitud { "customer_id": 512 } Ejemplo de respuesta { "success": true, "customer": { "id": 512, "name": "Patio del Mueble", "email": "pedidos@patiomueble.com", "phone": "+34 912 345 678", "address_legal": "C/ Mayor 5, Madrid", "address_real": "C/ Almacén 12, Madrid", "agreement": "N.º 15 del 10/01/2026", "manager_name": "Pedro Gómez", "manager_post": "Director general", "notes": "" } } Errores Error Motivo No customer_id in input Falta customer_id Customer not found or access denied Cliente no encontrado o eliminado