Documentación de la API de Controlata

Busque aquí los artículos o busque las categorías de abajo.

Navegar por tema

Encuentra guías, tutoriales y respuestas organizadas por categoría.

Artículos populares

Lo que otras personas están leyendo ahora mismo.

Materiales

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

Categorías

Crear una categoría

Crea una categoría de materiales, productos o recursos. v1/categories/add.php Parámetros Campo Tipo Obligatorio Descripción type string Sí Categoría de qué: «materials», «products» o «resources» name string Sí Nombre Una categoría nueva se coloca al final de la lista de categorías de este tipo. No hace falta crear la categoría de antemano. En el campo categories de v1/materials/add, v1/materials/edit, v1/products/add, v1/products/edit, v1/resources/add y v1/resources/edit puedes pasar una categoría como un objeto { name: ... } sin id: si aún no existe una categoría con ese nombre, se crea; si existe, se usa la existente. Ejemplo de solicitud { "type": "materials", "name": "Madera" } Ejemplo de respuesta { "success": true, "category_id": 14 } Errores Error Motivo No type in input Falta type Invalid type value. Must be one of: materials, products, resources type no válido No name in input Falta name Name must not be empty Nombre vacío Name must be a string name no es una cadena name is too long: maximum 200 characters Nombre de más de 200 caracteres

Proveedores

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

Productos

Obtener los datos de un producto

Devuelve los datos de un producto, sus existencias en un almacén y sus componentes. v2/products/get_entry.php Parámetros Campo Tipo Obligatorio Descripción product_id int Sí ID del producto storage_id int Sí ID del almacén El producto se devuelve solo si figura en el almacén storage_id. Las existencias en todos los almacenes a la vez las devuelve v1/products/get_stocks. Respuesta Un objeto product con los campos del producto, sus existencias en el almacén storage_id, sus categorías, proveedores, SKU alternativos y componentes. Campo Tipo Descripción id int ID del producto name string Nombre sku string SKU unit string Unidad de medida, un código de Unidades de medida price float Precio de venta por unidad cost float Coste por unidad batch_size float Tamaño del lote: la cantidad de producto para la que se indican los componentes notes string Notas archived int 1 si el producto 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 producto: objetos con id y name suppliers array Proveedores del producto: objetos con id y name alternative_sku array SKU alternativos: objetos con label y sku Además de estos campos, el objeto contiene los componentes: Campo Tipo Descripción materials array Materiales en los componentes products array Semielaborados en los componentes resources array Recursos en los componentes Campos de las líneas materials, products y resources: Campo Descripción id ID del material, producto o recurso name Nombre sku SKU. Solo en materiales y semielaborados type Tipo de cálculo del recurso. Solo en recursos (consulta Crear un recurso ) dynamic 1 si el precio o el porcentaje se indica en los componentes del producto. Solo en recursos base Base de cálculo de un recurso porcentual: cost o price. Solo en recursos amount_per_batch Cantidad por lote amount_per_unit Cantidad por unidad de producto: amount_per_batch / batch_size loss_percent Pérdidas, en porcentaje. Solo en materiales y semielaborados unit Unidad de medida. «%» en un recurso porcentual cost_per_unit Coste de la línea por unidad de producto cost_per_batch Coste de la línea por lote position Posición de la línea: común para materials y products, aparte para resources En un recurso del tipo tarifa fija con su precio en los componentes del producto, amount_per_batch contiene un importe, no una cantidad. cost_per_unit y cost_per_batch tienen en cuenta las pérdidas cuando loss_percent > 0. Las líneas de componentes, las categorías y los proveedores de la respuesta se pueden enviar a v1/products/edit sin cambios. Ejemplo de solicitud { "product_id": 3120, "storage_id": 3999 } Ejemplo de respuesta { "success": true, "product": { "id": 3120, "name": "Mesa de comedor", "sku": "P100", "price": 45000, "cost": 13604.25, "batch_size": 10, "notes": "", "archived": 0, "stock": 12, "minimum": 3, "planned": null, "unit": "ud", "categories": [ { "id": 21, "name": "Muebles" } ], "alternative_sku": [ { "label": "Shopify", "sku": "SH-P100" } ], "suppliers": [ { "id": 46, "name": "Mueblería S.L." } ], "materials": [ { "id": 2051, "name": "Tablón de roble", "sku": "M010", "amount_per_unit": 0.05, "amount_per_batch": 0.5, "loss_percent": 5, "unit": "m3", "cost_per_unit": 7087.5, "cost_per_batch": 70875, "position": 0 }, { "id": 2060, "name": "Tornillo 4x40", "sku": "M024", "amount_per_unit": 40, "amount_per_batch": 400, "loss_percent": 0, "unit": "ud", "cost_per_unit": 80, "cost_per_batch": 800, "position": 1 } ], "products": [ { "id": 312, "name": "Pata de mesa", "sku": "P012", "amount_per_unit": 4, "amount_per_batch": 40, "loss_percent": 0, "unit": "ud", "cost_per_unit": 3400, "cost_per_batch": 34000, "position": 2 } ], "resources": [ { "id": 57, "name": "Trabajo del carpintero", "type": "rate", "dynamic": 0, "base": null, "amount_per_unit": 3, "amount_per_batch": 30, "unit": "h", "cost_per_unit": 1800, "cost_per_batch": 18000, "position": 0 }, { "id": 58, "name": "Gastos generales", "type": "percent", "dynamic": 0, "base": "cost", "amount_per_unit": 10, "amount_per_batch": 10, "unit": "%", "cost_per_unit": 1236.75, "cost_per_batch": 12367.5, "position": 1 } ] } } Errores Error Motivo No product_id in input Falta un campo obligatorio (en lugar de product_id, el nombre del campo) Storage ID not found Almacén no encontrado o eliminado Product not found or access denied Producto no encontrado, eliminado o que no figura en el almacén Versión v1 El método v1/products/get_entry acepta los mismos parámetros y devuelve los mismos campos del producto. Solo cambia la representación de los componentes, así que usa v2 en las integraciones nuevas. Qué v1 v2 Componentes Un solo array components: materiales y semielaborados juntos Arrays separados materials, products y resources id en las líneas de componentes Con prefijo: «m-123» para un material, «p-45» para un semielaborado id numérico del elemento Reenviar líneas a add y edit No se puede sin cambios, los id con prefijo estorban Se puede tal cual Además, v1 devuelve campos internos que v2 omite: product.status y el status de las líneas de componentes (siempre 1) y product.percent (se calcula a partir de cost y price).

Producción

Editar una producción

Modifica una producción. Solo se cambian los campos que envías, el resto se queda como estaba. v1/production/edit.php Parámetros Campo Tipo Obligatorio Descripción production_id int Sí ID de la producción products array No Productos a fabricar: id o sku y amount, como en v1/production/add . Reemplazan los actuales por completo date string No Fecha de producción, YYYY-MM-DD name string No Nombre notes string No Notas produce_subproducts int No 1: producir los semielaborados junto con los productos, 0: descontarlos del almacén materials_storage_id int No Almacén del que se descuentan los materiales. 0: elegir automáticamente subproducts_storage_id int No Almacén del que se descuentan los productos usados. 0: elegir automáticamente products_storage_id int No Almacén al que entran los productos fabricados El estado no se cambia con este método; usa v1/production/update_status. El número no se puede cambiar. Ejemplo de solicitud { "production_id": 39978, "products": [ { "id": 512, "amount": 12 } ], "notes": "Añadidas dos mesas" } Ejemplo de respuesta { "success": true } Errores Error Motivo No production_id in input Falta production_id Production not found or access denied Producción no encontrada o eliminada Products of a production linked to a sale cannot be changed. Edit the sale instead Cambio de los productos de una producción bajo pedido No products in input Se envió un array products vacío Products is not an array products no es un array Product with id 512 not found Producto no encontrado o eliminado Amount must be greater than 0 for product with id 512 La cantidad no es un número o no es mayor que 0 tras redondear Storage ID is not set Se envió products_storage_id igual a 0, o un almacén vacío Storage ID not found Almacén no encontrado o eliminado Date is not a valid date in format YYYY-MM-DD Formato de fecha no válido Los demás errores de las líneas products son los mismos que en v1/production/add.

Producción

Eliminar una producción

Elimina una producción. v1/production/delete.php Parámetros Campo Tipo Obligatorio Descripción production_id int Sí ID de la producción La eliminación no se puede deshacer. Una producción bajo pedido (order_id mayor que 0) no se elimina con este método: desactiva la producción en la venta o elimina la venta, consulta Crear una venta. Ejemplo de solicitud { "production_id": 39978 } Ejemplo de respuesta { "success": true } Errores Error Motivo No production_id in input Falta production_id Production not found or access denied Producción no encontrada o ya eliminada A production linked to a sale cannot be deleted. Edit the sale instead La producción se creó para una venta