Production Consumption

Get Order Consumption

Returns the raw materials consumed (or planned) for a specific production order, including planned vs actual quantities and variance tracking.

GET/api/v1/orders/{order_id}/consumption

Path Parameters

Parameter	Type	Description
order_id	string	The production order ID (UUID)

Example Request

cURL

curl -X GET "https://api.prediko.io/api/v1/orders/822417ae-8511-41dc-8b3a-18789a600414/consumption" \
  -H "Authorization: Bearer YOUR_API_KEY"

Python

import requests

order_id = "822417ae-8511-41dc-8b3a-18789a600414"
response = requests.get(
    f"https://api.prediko.io/api/v1/orders/{order_id}/consumption",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
consumption = response.json()

JavaScript

const orderId = "822417ae-8511-41dc-8b3a-18789a600414";
const response = await fetch(
  `https://api.prediko.io/api/v1/orders/${orderId}/consumption`,
  {
    headers: { "Authorization": "Bearer YOUR_API_KEY" }
  }
);
const consumption = await response.json();

Response

{
  "order_id": "822417ae-8511-41dc-8b3a-18789a600414",
  "data": [
    {
      "raw_material_name": "DB-GD-DST",
      "raw_material_id": "51510c11-d106-4771-8aca-a1aac99c1600",
      "planned_quantity": 10.0,
      "actual_quantity_used": 8.5,
      "quantity_variance": -1.5,
      "unit_cost": 2.30,
      "total_cost": 23.0,
      "warehouse_name": "Main Warehouse"
    }
  ]
}

Response Fields

Field	Type	Description
order_id	string	The production order ID
data	array	List of raw material consumption entries

Consumption Entry Object

Field	Type	Description
raw_material_name	string	Name of the raw material SKU
raw_material_id	string	Unique identifier of the raw material SKU
planned_quantity	number	Planned consumption quantity (recipe ratio x ordered qty)
actual_quantity_used	number	Actual consumption quantity (auto-calculated or manually overridden)
quantity_variance	number	actual_quantity_used - planned_quantity. Positive = loss/waste, negative = better yield, zero = exact match
unit_cost	number | null	Cost per unit of the raw material
total_cost	number | null	Total cost for this raw material in the order
warehouse_name	string | null	Warehouse where the raw material is stored

Variance Tracking

The quantity_variance field is computed automatically:

Variance	Meaning	Example
Positive	Over-consumption (loss/waste: spillage, evaporation, defect)	Planned 100, used 108 → variance = +8
Negative	Under-consumption (better yield than expected)	Planned 100, used 95 → variance = -5
Zero	Production matched the recipe exactly	Planned 100, used 100 → variance = 0

Variance Tracking Workflow

1. Create a Production Order → system computes planned_quantity from BOM recipe
2. Order completes → actual_quantity_used is auto-set based on received finished goods
3. Call PUT /api/v1/orders/{order_id}/consumption to override with the real measured value
4. Read back the consumption → quantity_variance reflects the difference

---

Update Consumption

Override the auto-calculated actual_quantity_used with the real measured value. This is required for accurate yield/waste tracking.

PUT/api/v1/orders/{order_id}/consumption

Path Parameters

Parameter	Type	Description
order_id	string	The production order ID (UUID)

Request Body

Field	Type	Required	Description
raw_material_ids	array	Yes	List of raw material SKU IDs to update
actual_quantity_used	number	Yes	Actual quantity consumed (must be > 0)

Example Request

cURL

curl -X PUT "https://api.prediko.io/api/v1/orders/822417ae-8511-41dc-8b3a-18789a600414/consumption" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "raw_material_ids": ["51510c11-d106-4771-8aca-a1aac99c1600"],
    "actual_quantity_used": 12.5
  }'

Python

import requests

order_id = "822417ae-8511-41dc-8b3a-18789a600414"
response = requests.put(
    f"https://api.prediko.io/api/v1/orders/{order_id}/consumption",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
        "raw_material_ids": ["51510c11-d106-4771-8aca-a1aac99c1600"],
        "actual_quantity_used": 12.5
    }
)
updated_consumption = response.json()

Response

Returns the updated consumption data for the order (same format as GET).

{
  "order_id": "822417ae-8511-41dc-8b3a-18789a600414",
  "data": [
    {
      "raw_material_name": "DB-GD-DST",
      "raw_material_id": "51510c11-d106-4771-8aca-a1aac99c1600",
      "planned_quantity": 10.0,
      "actual_quantity_used": 12.5,
      "quantity_variance": 2.5,
      "unit_cost": 2.30,
      "total_cost": 28.75,
      "warehouse_name": "Main Warehouse"
    }
  ]
}

Important

The consumption update only works for processed orders (CONFIRMED, PARTIALLY_RECEIVED, or FULLY_RECEIVED). Attempting to update consumption for a DRAFT order will result in an error.

Error Responses

Status	Description
404	Order not found
401	Invalid or missing API key
500	Internal server error