Proveedores

6 artículos Maxim Por Maxim

Proveedores

Proveedores: las empresas y las personas a las que compras materiales y productos. A través de la API puedes crearlos, editarlos y eliminarlos, y obtener la lista y los datos de un proveedor. 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/suppliers/add Crea un proveedor v1/suppliers/edit Modifica un proveedor v1/suppliers/delete Elimina un proveedor v1/suppliers/get_list Devuelve los proveedores de la empresa v1/suppliers/get_entry Devuelve los datos de un proveedor

Crear un proveedor

Crea un proveedor. v1/suppliers/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 string No Dirección agreement string No Acuerdo manager_name string No Responsable manager_post string No Puesto del responsable notes string No Notas Un proveedor también se puede crear junto con una compra, consulta v1/purchases/add. Ejemplo de solicitud { "name": "Maderas García", "email": "ventas@maderasgarcia.com", "phone": "+34 915 000 222", "address": "C/ del Puerto 8, Barcelona", "agreement": "N.º 7 del 15/02/2026", "manager_name": "Óscar Ruiz", "manager_post": "Director" } Ejemplo de respuesta { "success": true, "supplier_id": 45 } 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 proveedor

Modifica un proveedor. Solo se cambian los campos que envías, el resto se queda como estaba. v1/suppliers/edit.php Parámetros Campo Tipo Obligatorio Descripción supplier_id int Sí ID del proveedor name string No Nombre email string No Correo electrónico phone string No Teléfono address string No Dirección 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 { "supplier_id": 45, "email": "mayoreo@maderasgarcia.com", "notes": "Entregas los martes" } Ejemplo de respuesta { "success": true } Errores Error Motivo No supplier_id in input Falta supplier_id Supplier not found or access denied Proveedor 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 proveedor

Elimina un proveedor. v1/suppliers/delete.php Parámetros Campo Tipo Obligatorio Descripción supplier_id int Sí ID del proveedor Ejemplo de solicitud { "supplier_id": 45 } Ejemplo de respuesta { "success": true } Errores Error Motivo No supplier_id in input Falta supplier_id Supplier not found or access denied Proveedor no encontrado o ya eliminado

Obtener la lista de proveedores

Devuelve los proveedores de la empresa, ordenados por nombre. Los proveedores eliminados no se incluyen. v1/suppliers/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 suppliers con los campos del proveedor. El campo total contiene el número total de proveedores. Campo Tipo Descripción id int ID del proveedor name string Nombre email string Correo electrónico phone string Teléfono address string Dirección 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, "suppliers": [ { "id": 46, "name": "Suministros Herrajes", "email": "hardware@example.com", "phone": "+34 931 000 170", "address": "C/ Paz 14, Sevilla", "agreement": "", "manager_name": "", "manager_post": "", "notes": "" }, { "id": 45, "name": "Maderas García", "email": "mayoreo@maderasgarcia.com", "phone": "+34 915 000 222", "address": "C/ del Puerto 8, Barcelona", "agreement": "N.º 7 del 15/02/2026", "manager_name": "Óscar Ruiz", "manager_post": "Director", "notes": "Entregas los martes" } ], "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 proveedor

Devuelve los datos de un proveedor. v1/suppliers/get_entry.php Parámetros Campo Tipo Obligatorio Descripción supplier_id int Sí ID del proveedor Un proveedor eliminado no se devuelve. Respuesta Un objeto supplier con los campos del proveedor. Los campos de la respuesta se pueden enviar a v1/suppliers/edit sin cambios, añadiendo supplier_id. Campo Tipo Descripción id int ID del proveedor name string Nombre email string Correo electrónico phone string Teléfono address string Dirección agreement string Acuerdo manager_name string Responsable manager_post string Puesto del responsable notes string Notas Ejemplo de solicitud { "supplier_id": 45 } Ejemplo de respuesta { "success": true, "supplier": { "id": 45, "name": "Maderas García", "email": "mayoreo@maderasgarcia.com", "phone": "+34 915 000 222", "address": "C/ del Puerto 8, Barcelona", "agreement": "N.º 7 del 15/02/2026", "manager_name": "Óscar Ruiz", "manager_post": "Director", "notes": "Entregas los martes" } } Errores Error Motivo No supplier_id in input Falta supplier_id Supplier not found or access denied Proveedor no encontrado o eliminado