Ir al contenido principal

REST API: Productos y herramientas

Cómo crear, modificar y borrar ingredientes/productos y materiales/herramientas.

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

  • start integer · obligatorio — Posición de la primera fila, empezando en 0.

  • rows integer · obligatorio — Número de filas a devolver.

  • filter string · opcional — Texto a buscar en el nombre, el nombre alternativo o el código. Con withTypes=true, también en el nombre de las familias.

  • types array · opcional — Ids de familias; repite el parámetro para cada una. El producto debe tener todas.

  • marked boolean · opcional — true devuelve solo los marcados. Por defecto, false.

  • hidden boolean · opcional — true devuelve solo los ocultos; false, solo los no ocultos. Por defecto, false.

  • used boolean · opcional — true devuelve solo los que se usan en alguna elaboración.

  • notUsed boolean · opcional — true devuelve solo los que no se usan en ninguna elaboración.

  • withPrice boolean · opcional — true devuelve solo los que tienen coste en el centro de coste.

  • withNoPrice boolean · opcional — true devuelve solo los que no tienen coste en el centro de coste.

  • withVendor boolean · opcional — true devuelve solo los que tienen algún proveedor del centro de coste.

  • withNoVendor boolean · opcional — true devuelve solo los que no tienen ningún proveedor del centro de coste.

  • withUnits boolean · opcional — true incluye la unidad. Por defecto, false.

  • withTypes boolean · opcional — true incluye las familias. Por defecto, false.

  • withCost boolean · opcional — true incluye 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
}
]
  • id string — Identificador del producto.

  • descr string — Nombre.

  • codi string — Código en el centro de coste.

  • color integer — Color (RGB) de su primera familia. 0 si no tiene familias.

  • type integer — 0 producto · 2 herramienta.

  • hasData boolean — Si se utiliza en alguna elaboración.

  • tag integer — Marca: 1 correcto · 2 falta información · 3 error. null si no tiene.

  • tagComment string — Comentario de la marca.

  • idUnit, unit string — Unidad del producto. Solo con withUnits.

  • cost number — Coste por unidad en el centro de coste. Solo con withCost.

  • listComponentTypes array — Familias básicas, cada una con id y descr. Solo con withTypes.

  • listComponentTypesOthers array — Familias de tipo propiedad o coste, con los mismos campos. Solo con withTypes.


Crear un producto o herramienta

/ingredient crea un producto y /material, una herramienta. Devuelve su id.

POST /ingredient
POST /material

Cuerpo

  • descr string · obligatorio — Nombre.

  • idUnit string · obligatorio — Identificador de la unidad del producto.

  • listComponentTypes array · obligatorio — Familias, cada una con su id. Envía [] si no tiene.

  • listEquivalences array · obligatorio — Equivalencias con otras unidades, hasta 4. Envía [] si no hay equivalencias.

  • altDescr string · opcional — Nombre alternativo, normalmente el comercial.

  • codi string · opcional — Código en el centro de coste.

  • barcode string · opcional — Código de barras en el centro de coste.

  • includeInOrder boolean · opcional — true lo incluye en los pedidos. Por defecto, false.

  • averageCost boolean · opcional — true: el coste es la media de las compras del último mes.

  • fixedCost boolean · opcional — true: el coste es fijo. Si no se envía ninguno de los dos, se usa el coste de la última compra.

  • cost number · opcional — Coste por unidad en el centro de coste. Se ignora sin permiso para ver costes.

  • minStock, maxStock number · opcional — Stock mínimo y máximo en el centro de coste.

  • caducity number · opcional — Caducidad en días.

  • listStores array · opcional — Almacenes del centro de coste donde se guarda, cada uno con su id. Se ignora sin permiso para editar almacenes.

Cada equivalencia:

  • idUnitFrom string · obligatorio — Identificador de la otra unidad.

  • quantityTo number · obligatorio — Cantidad equivalente.

  • inverted boolean · opcional — false: 1 idUnitFrom = quantityTo unidades del producto. true: 1 unidad del producto = quantityTo idUnitFrom. 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

  • idComponent string · 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}/cost

Parámetros de ruta

  • idComponent string · obligatorio — Identificador del producto o herramienta.

Cuerpo

  • value number · obligatorio — Nuevo coste por unidad. Con null, 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.

¿Ha quedado contestada tu pregunta?