Materiales

8 artículos Maxim Por Maxim

Materiales

Materiales: las materias primas y los componentes con los que se fabrican tus productos. A través de la API puedes crearlos, editarlos y eliminarlos, obtener la lista y los datos de un material, y actualizar las existencias en los almacenes. 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/materials/add Crea un material v1/materials/edit Modifica un material v1/materials/delete Elimina un material v1/materials/update_stock Establece las existencias en un almacén v1/materials/get_list Devuelve los materiales de un almacén v1/materials/get_entry Devuelve los datos de un material v1/materials/get_stocks Devuelve las existencias de los materiales en todos los almacenes

Crear un material

Crea un material. El material aparece en el almacén storage_id y en los almacenes que guardan todos los materiales o sus categorías. v1/materials/add.php Parámetros Campo Tipo Obligatorio Descripción name string Sí Nombre unit string Sí Unidad de medida, un código de Unidades de medida storage_id int Sí Almacén donde se crean las existencias sku string No SKU price float No Precio por unidad. Por defecto 0 stock float No Existencias iniciales en el almacén storage_id. Por defecto 0 minimum float No Existencias mínimas en el almacén storage_id. Por defecto 0 notes string No Notas categories array No Categorías: objetos con id o name suppliers array No Proveedores: objetos con id Una categoría se puede pasar por nombre: si no existe, se crea. Los ID de las categorías y los proveedores existentes los devuelven v1/categories/get_list y v1/suppliers/get_list. La unicidad del SKU no se comprueba. Ejemplo de solicitud { "name": "Tablón de roble", "sku": "M010", "unit": "m3", "price": 130000, "storage_id": 3998, "stock": 2.5, "minimum": 0.5, "categories": [{ "id": 12 }, { "name": "Herrajes" }], "suppliers": [{ "id": 45 }] } Ejemplo de respuesta { "success": true, "material_id": 2051 } Errores Error Motivo No name in input Falta un campo obligatorio (en lugar de name, el nombre del campo) Name must not be empty Nombre vacío Unit not found Unidad de medida desconocida, o una unidad solo para recursos Storage ID not found Almacén no encontrado o eliminado Invalid price value. Must be a number El valor no es un número, p. ej. "12,5" (igual para stock y minimum) Category 12 not found Categoría no encontrada Supplier not found or access denied Proveedor no encontrado o eliminado

Editar un material

Modifica un material. Solo se cambian los campos que envías, el resto se queda como estaba. v1/materials/edit.php Parámetros Campo Tipo Obligatorio Descripción material_id int Sí ID del material name string No Nombre sku string No SKU unit string No Unidad de medida price float No Precio por unidad notes string No Notas minimum float No Existencias mínimas en el almacén storage_id storage_id int Con minimum Almacén donde se cambian las existencias mínimas categories array No Categorías: objetos con id o name. Reemplazan las actuales por completo suppliers array No Proveedores: objetos con id. Reemplazan los actuales por completo Ejemplo de solicitud { "material_id": 2051, "price": 135000, "minimum": 1, "storage_id": 3998 } Ejemplo de respuesta { "success": true } Errores Error Motivo No material_id in input Falta material_id Material not found or access denied Material no encontrado o eliminado Name must not be empty Se envió un nombre vacío Unit not found Unidad de medida desconocida Unit cannot be changed to another unit group: the material is used in components of products Cambio del grupo de unidad de un material usado en los componentes de un producto No storage_id in input Se envió minimum sin storage_id Material is not stored in storage location 3998, so its minimum cannot be set there El material no figura en ese almacén Invalid price value. Must be a number El valor no es un número (igual para minimum) Category 12 not found Categoría no encontrada Supplier not found or access denied Proveedor no encontrado o eliminado

Eliminar un material

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

Actualizar las existencias de un material

Fija las existencias de un material en un almacén. Se envían las existencias finales, no el cambio: Controlata crea un ajuste por la diferencia entre las existencias actuales y las nuevas. v1/materials/update_stock.php Parámetros Campo Tipo Obligatorio Descripción material_id int Sí ID del material storage_id int Sí ID del almacén stock float Sí Existencias nuevas notes string No Notas del ajuste Ejemplo de solicitud { "material_id": 2051, "storage_id": 3998, "stock": 4.2, "notes": "Inventario en el almacén" } Ejemplo de respuesta { "success": true } Errores Error Motivo No stock in input Falta un campo obligatorio (en lugar de stock, el nombre del campo) Material not found or access denied Material no encontrado o eliminado Storage ID not found Almacén no encontrado o eliminado Invalid stock value. Must be a number Las existencias no son un número, p. ej. "" o "4,2"

Obtener la lista de materiales

Devuelve los materiales que figuran en un almacén (incluidos los que tienen existencias cero), ordenados por nombre. Los materiales archivados también se incluyen. v1/materials/get_list.php Parámetros Campo Tipo Obligatorio Descripción storage_id int Sí ID del almacé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 materials con los campos del material y sus existencias en el almacén storage_id: Campo Tipo Descripción id int ID del material name string Nombre sku string SKU unit string Unidad de medida, un código de Unidades de medida price float Precio por unidad notes string Notas archived int 1 si el material está archivado stock float Existencias en el almacén storage_id minimum float Existencias mínimas en el almacén storage_id planned float Cambio de existencias por operaciones en estado Planificado. null si no hay ninguna categories array Categorías del material: objetos con id y name suppliers array Proveedores del material: objetos con id y name El campo total contiene el número total de materiales del almacén. Ejemplo de solicitud { "storage_id": 3998, "limit": 100, "offset": 0 } Ejemplo de respuesta { "success": true, "materials": [ { "id": 2051, "name": "Tablón de roble", "sku": "M010", "price": 135000, "notes": "", "archived": 0, "stock": 4.2, "minimum": 1, "planned": null, "unit": "m3", "categories": [ { "id": 12, "name": "Madera" } ], "suppliers": [ { "id": 45, "name": "Maderas García" } ] } ], "total": 1 } Errores Error Motivo No storage_id in input Falta storage_id Storage ID not found Almacén no encontrado o eliminado Invalid limit value. Must be between 1 and 1000 limit no válido Offset requires limit se envió offset sin limit

Obtener los datos de un material

Devuelve los datos de un material y sus existencias en un almacén. v1/materials/get_entry.php Parámetros Campo Tipo Obligatorio Descripción material_id int Sí ID del material storage_id int Sí ID del almacén El material se devuelve solo si figura en el almacén storage_id. Las existencias en todos los almacenes a la vez las devuelve v1/materials/get_stocks. Respuesta Un objeto material con los campos del material, sus existencias en el almacén storage_id, sus categorías y proveedores. Las categorías y los proveedores de la respuesta se pueden enviar a v1/materials/edit sin cambios. Campo Tipo Descripción id int ID del material name string Nombre sku string SKU unit string Unidad de medida, un código de Unidades de medida price float Precio por unidad notes string Notas archived int 1 si el material está archivado stock float Existencias en el almacén storage_id minimum float Existencias mínimas en el almacén storage_id planned float Cambio de existencias por operaciones en estado Planificado. null si no hay ninguna categories array Categorías del material: objetos con id y name suppliers array Proveedores del material: objetos con id y name Ejemplo de solicitud { "material_id": 2051, "storage_id": 3998 } Ejemplo de respuesta { "success": true, "material": { "id": 2051, "name": "Tablón de roble", "sku": "M010", "price": 135000, "notes": "", "archived": 0, "stock": 4.2, "minimum": 1, "planned": null, "unit": "m3", "categories": [ { "id": 12, "name": "Madera" } ], "suppliers": [ { "id": 45, "name": "Maderas García" } ] } } Errores Error Motivo No material_id in input Falta un campo obligatorio (en lugar de material_id, el nombre del campo) Storage ID not found Almacén no encontrado o eliminado Material not found or access denied Material no encontrado, eliminado o que no figura en el almacén

Existencias de los materiales por almacén

Devuelve las existencias de los materiales en todos los almacenes en una sola lista: una fila por cada par «material, almacén» donde el material figura. v1/materials/get_stocks.php Parámetros Campo Tipo Obligatorio Descripción material_ids array No ID de los materiales. Sin ellos se devuelven todos los materiales storage_ids array No Solo estos almacenes. Sin ellos, todos los almacenes limit int No Tamaño de página, de 1 a 1000 offset int No Cuántos registros omitir Las filas se ordenan por ID de material y de almacén. Los materiales y almacenes eliminados no se incluyen. Ejemplo de solicitud { "material_ids": [2051, 2052] } Ejemplo de respuesta { "success": true, "stocks": [ { "material_id": 2051, "storage_id": 3998, "stock": 4.2, "minimum": 1, "planned": null }, { "material_id": 2051, "storage_id": 4002, "stock": 0, "minimum": 0, "planned": 1.5 } ], "total": 2 } Errores Error Motivo Material_ids is not an array material_ids no se envió como array Storage_ids is not an array storage_ids no se envió como array Storage ID not found Almacén no encontrado o eliminado Invalid limit value. Must be between 1 and 1000 limit no válido