Ingredients

Gestión de Ingredientes

Los endpoints de ingredientes permiten administrar el inventario de materias primas.

• GET /ingredients: Obtiene todos los ingredientes del inventario.

  • Authorization: Requiere access token válido (enviado automáticamente via cookies)
  • cURL Example:

  curl -X GET "http://127.0.0.1:9154/ingredients" \
    -H 'Cookie: accessToken=your_access_token_here' \
    -H 'Cookie: refreshToken=your_refresh_token_here' 

  • Response Body (Éxito - 200 OK):

  [
    {
      "id": "9bd8a46f-9a41-40a7-bb7b-c31567cdc7c1",
      "name": "Arroz",
      "category_id": "b80b3b3f-4fc4-4fab-a988-182de6985c27",
      "quantity": 50.0,
      "unit": "kg",
      "low_stock_threshold": 10.0,
      "cost_per_unit": 2.50
    },
    {
      "id": "7d77727b-a183-425c-99ae-34494f032c9c",
      "name": "Pollo",
      "category_id": "0914018f-f127-4433-aab2-1d3738af312f",
      "quantity": 25.0,
      "unit": "kg",
      "low_stock_threshold": 5.0,
      "cost_per_unit": 8.90
    }
  ]

  • Response Body (Sin contenido - 204 No Content):

  "No ingredients found"

• GET /ingredients/{id}: Obtiene un ingrediente específico por su ID.

  • Authorization: Requiere access token válido (enviado automáticamente via cookies)
  • Path Parameters:
    • id (string): ID del ingrediente a obtener
  • cURL Example:

  curl -X GET "http://127.0.0.1:9154/ingredients/abae1423-ba25-49c2-b54a-d0d55c727baf" \
    -H 'Cookie: accessToken=your_access_token_here' \
    -H 'Cookie: refreshToken=your_refresh_token_here' 

  • Response Body (Éxito - 200 OK):

  {
    "id": "a9cf05f5-e99e-47a5-a50f-bb3546d75a50",
    "name": "Arroz",
    "category_id": "8425ff0d-2322-4c92-875b-588002a8e0e9",
    "quantity": 50.0,
    "unit": "kg",
    "low_stock_threshold": 10.0,
    "cost_per_unit": 2.50
  }

  • Response Body (Error - 400 Bad Request):

  "Missing or malformed ID"

  • Response Body (Error - 404 Not Found):

  "Ingredient not found"

• GET /ingredients/low_stock/{threshold}: Obtiene ingredientes con stock bajo según el umbral especificado.

  • Authorization: Requiere access token válido (enviado automáticamente via cookies)
  • Path Parameters:
    • threshold (float): Umbral de stock bajo
  • cURL Example:

  curl -X GET "http://127.0.0.1:9154/ingredients/low_stock/15.0" \
    -H 'Cookie: accessToken=your_access_token_here' \
    -H 'Cookie: refreshToken=your_refresh_token_here' 

  • Response Body (Éxito - 200 OK):

  [
    {
      "id": "91b0df69-ee28-4e48-bd8f-419cb8fd184f",
      "name": "Arroz",
      "category_id": "54d14313-badf-447c-88a6-5342f09cca22",
      "quantity": 8.0,
      "unit": "kg",
      "low_stock_threshold": 10.0,
      "cost_per_unit": 2.50
    }
  ]

  • Response Body (Sin contenido - 204 No Content):

  "No low stock ingredients found"

  • Response Body (Error - 400 Bad Request):

  "Invalid or missing threshold parameter"

• POST /ingredients: Crea un nuevo ingrediente.

  • Authorization: Requiere access token válido (enviado automáticamente via cookies)
  • Request Body:

  {
    "name": "string",
    "category_id": "string",
    "quantity": 0.0,
    "unit": "string",
    "low_stock_threshold": 0.0,
    "cost_per_unit": 0.0
  }

  • cURL Example:

  curl -X POST "http://127.0.0.1:9154/ingredients" \
    -H 'Cookie: accessToken=your_access_token_here' \
    -H 'Cookie: refreshToken=your_refresh_token_here' \
    -H "Content-Type: application/json" \
    -d '{
      "name": "Aceite de Oliva",
      "category_id": "e13018bf-ffa3-4b22-aa35-6e782f29302a",
      "quantity": 20.0,
      "unit": "litros",
      "low_stock_threshold": 5.0,
      "cost_per_unit": 4.50
    }'

  • Response Body (Éxito - 201 Created):

  "Ingredient added successfully"

• PUT /ingredients/{id}: Actualiza un ingrediente existente.

  • Authorization: Requiere access token válido (enviado automáticamente via cookies)
  • Path Parameters:
    • id (string): ID del ingrediente a actualizar
  • Request Body:

  {
    "name": "string",
    "category_id": "string",
    "quantity": 0.0,
    "unit": "string",
    "low_stock_threshold": 0.0,
    "cost_per_unit": 0.0
  }

  • cURL Example:

  curl -X PUT "http://127.0.0.1:9154/ingredients/11993e13-b748-4634-ab78-2080f212e98e" \
    -H 'Cookie: accessToken=your_access_token_here' \
    -H 'Cookie: refreshToken=your_refresh_token_here' 
    -H "Content-Type: application/json" \
    -d '{
      "name": "Arroz Bomba",
      "category_id": "e13018bf-ffa3-4b22-aa35-6e782f29302a",
      "quantity": 60.0,
      "unit": "kg",
      "low_stock_threshold": 15.0,
      "cost_per_unit": 3.00
    }'

  • Response Body (Éxito - 200 OK):

  "Ingredient updated successfully"

  • Response Body (Error - 400 Bad Request):

  "Missing or malformed ID"

  • Response Body (Error - 404 Not Found):

  "Ingredient not found"

• DELETE /ingredients/{id}: Elimina un ingrediente del inventario.

  • Authorization: Requiere access token válido (enviado automáticamente via cookies)
  • Path Parameters:
    • id (string): ID del ingrediente a eliminar
  • cURL Example:

  curl -X DELETE "http://127.0.0.1:9154/ingredients/e13018bf-ffa3-4b22-aa35-6e782f29302a" \
    -H 'Cookie: accessToken=your_access_token_here' \
    -H 'Cookie: refreshToken=your_refresh_token_here' 

  • Response Body (Éxito - 200 OK):

  "Ingredient deleted successfully"

  • Response Body (Error - 400 Bad Request):

  "Missing or malformed ID"

  • Response Body (Error - 404 Not Found):

  "Ingredient not found"

Notas importantes:

• Todos los endpoints de ingredientes requieren autenticación
• Los IDs de ingredientes son UUID generados automáticamente
• Un ingrediente debe estar asociado a una categoría válida (category_id)
• Las unidades pueden ser: kg, litros, gramos, unidades, etc.
• El sistema alertará cuando la cantidad esté por debajo del low_stock_threshold
• El cost_per_unit es importante para el cálculo de costos de platos