Lista, crea y elimina productos (ingredientes) y herramientas (materiales), y actualiza su coste.
GET /listIngredientsPaged
GET /listMaterialsPaged
POST /ingredient
POST /material
DELETE /ingredient/{idComponent}
DELETE /material/{idComponent}
PUT /ingredient/{idComponent}/cost
PUT /material/{idComponent}/cost
Antes de empezar
URL base: https://app.tspoonlab.com/recipes/api
Cabeceras
rememberme· obligatorio — Token de sesión que devuelve el login.order· opcional — Id del centro de coste (Centros de coste). Por defecto, el centro activo del usuario. Códigos, costes y stocks se leen y se guardan en este centro.
Login — Devuelve el token en texto plano.
curl https://app.tspoonlab.com/recipes/api/login \
-d [email protected] \
-d password=XXXXXXX
Permisos — Para listar, permiso para ver productos o herramientas; para crear y eliminar, permiso para añadir o eliminar productos o herramientas; para actualizar el coste, permiso para editarlos.
Las respuestas pueden incluir otros campos además de los documentados. Usa solo los documentados.
Listar productos y herramientas
/listIngredientsPaged lista los productos y /listMaterialsPaged, las herramientas.
GET /listIngredientsPaged
GET /listMaterialsPaged
Parámetros de consulta
startinteger · obligatorio — Posición de la primera fila, empezando en 0.rowsinteger · obligatorio — Número de filas a devolver.filterstring · opcional — Texto a buscar en el nombre, el nombre alternativo o el código. ConwithTypes=true, también en el nombre de las familias.typesarray · opcional — Ids de familias; repite el parámetro para cada una. El producto debe tener todas.markedboolean · opcional —truedevuelve solo los marcados. Por defecto,false.hiddenboolean · opcional —truedevuelve solo los ocultos;false, solo los no ocultos. Por defecto,false.usedboolean · opcional —truedevuelve solo los que se usan en alguna elaboración.notUsedboolean · opcional —truedevuelve solo los que no se usan en ninguna elaboración.withPriceboolean · opcional —truedevuelve solo los que tienen coste en el centro de coste.withNoPriceboolean · opcional —truedevuelve solo los que no tienen coste en el centro de coste.withVendorboolean · opcional —truedevuelve solo los que tienen algún proveedor del centro de coste.withNoVendorboolean · opcional —truedevuelve solo los que no tienen ningún proveedor del centro de coste.withUnitsboolean · opcional —trueincluye la unidad. Por defecto,false.withTypesboolean · opcional —trueincluye las familias. Por defecto,false.withCostboolean · opcional —trueincluye el coste. Por defecto,false.
Ejemplo
curl "https://app.tspoonlab.com/recipes/api/listIngredientsPaged?start=0&rows=50&withUnits=true&withCost=true" \
-H "rememberme: $TOKEN"
Respuesta
[
{
"id": "3515834441676562996102040001",
"descr": "Tomate pera",
"codi": "P-0102",
"color": 15158332,
"type": 0,
"hasData": true,
"tag": null,
"tagComment": null,
"idUnit": "3515834441676562996102040002",
"unit": "kg",
"cost": 1.35,
"listComponentTypes": null,
"listComponentTypesOthers": null
}
]
idstring — Identificador del producto.descrstring — Nombre.codistring — Código en el centro de coste.colorinteger — Color (RGB) de su primera familia.0si no tiene familias.typeinteger —0producto ·2herramienta.hasDataboolean — Si se utiliza en alguna elaboración.taginteger — Marca:1correcto ·2falta información ·3error.nullsi no tiene.tagCommentstring — Comentario de la marca.idUnit,unitstring — Unidad del producto. Solo conwithUnits.costnumber — Coste por unidad en el centro de coste. Solo conwithCost.listComponentTypesarray — Familias básicas, cada una conidydescr. Solo conwithTypes.listComponentTypesOthersarray — Familias de tipo propiedad o coste, con los mismos campos. Solo conwithTypes.
Crear un producto o herramienta
/ingredient crea un producto y /material, una herramienta. Devuelve su id.
POST /ingredient
POST /material
Cuerpo
descrstring · obligatorio — Nombre.idUnitstring · obligatorio — Identificador de la unidad del producto.listComponentTypesarray · obligatorio — Familias, cada una con suid. Envía[]si no tiene.listEquivalencesarray · obligatorio — Equivalencias con otras unidades, hasta 4. Envía[]si no hay equivalencias.altDescrstring · opcional — Nombre alternativo, normalmente el comercial.codistring · opcional — Código en el centro de coste.barcodestring · opcional — Código de barras en el centro de coste.includeInOrderboolean · opcional —truelo incluye en los pedidos. Por defecto,false.averageCostboolean · opcional —true: el coste es la media de las compras del último mes.fixedCostboolean · opcional —true: el coste es fijo. Si no se envía ninguno de los dos, se usa el coste de la última compra.costnumber · opcional — Coste por unidad en el centro de coste. Se ignora sin permiso para ver costes.minStock,maxStocknumber · opcional — Stock mínimo y máximo en el centro de coste.caducitynumber · opcional — Caducidad en días.listStoresarray · opcional — Almacenes del centro de coste donde se guarda, cada uno con suid. Se ignora sin permiso para editar almacenes.
Cada equivalencia:
idUnitFromstring · obligatorio — Identificador de la otra unidad.quantityTonumber · obligatorio — Cantidad equivalente.invertedboolean · opcional —false: 1idUnitFrom=quantityTounidades del producto.true: 1 unidad del producto =quantityToidUnitFrom. Por defecto,false.
Ejemplo
curl https://app.tspoonlab.com/recipes/api/ingredient \
-H "rememberme: $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"descr": "Tomate pera",
"idUnit": "3515834441676562996102040002",
"listComponentTypes": [ { "id": "3515834441676562996102040003" } ],
"listEquivalences": [ { "idUnitFrom": "3515834441676562996102040004", "quantityTo": 0.15 } ],
"codi": "P-0102",
"includeInOrder": true,
"cost": 1.35
}'
Respuesta
{ "id": "3515834441676562996102040001" }Eliminar un producto o herramienta
La eliminación es definitiva.
DELETE /ingredient/{idComponent}
DELETE /material/{idComponent}Parámetros de ruta
idComponentstring · obligatorio — Identificador del producto o herramienta.
Ejemplo
curl -X DELETE https://app.tspoonlab.com/recipes/api/ingredient/3515834441676562996102040001 \
-H "rememberme: $TOKEN"
Respuesta — Sin contenido.
Actualizar el coste
Cambia el coste en el centro de coste y, si ha cambiado, recalcula el coste de las elaboraciones, agrupaciones y eventos de ese centro que lo usan.
PUT /ingredient/{idComponent}/cost
PUT /material/{idComponent}/costParámetros de ruta
idComponentstring · obligatorio — Identificador del producto o herramienta.
Cuerpo
valuenumber · obligatorio — Nuevo coste por unidad. Connull, o si se omite, se elimina el coste.
Ejemplo
curl -X PUT https://app.tspoonlab.com/recipes/api/ingredient/3515834441676562996102040001/cost \
-H "rememberme: $TOKEN" \
-H "Content-Type: application/json" \
-d '{"value": 1.42}'
Respuesta — Sin contenido.
¿Necesitas ayuda? Escríbenos desde el chat de soporte, en la esquina inferior derecha.
