industry-department-solutions
latest
false
- Overview
- API Resources
Supply Chain & Retail Solutions API guide
Overview
The Manufacturing Orders resource represents production work orders that govern the internal manufacture of products at factory locations. Each record tracks a single manufacturing order through its full lifecycle, from the initial planned quantities and scheduled dates through to actual production start and end times, units produced, and current status.
Resource Endpoint
/api/v2/ingest/object/INV_MANUFACTURING_ORDERS_OOTB
/api/v2/ingest/object/INV_MANUFACTURING_ORDERS_OOTB
Supported Methods
| Method | Return Type | Description |
|---|---|---|
| POST | Response | Ingest (create/update) Manufacturing Orders records via UPSERT operation |
Request Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Your Personal Access Token (PAT) from platform.peak.ai |
Content-Type | Yes | Must be application/json |
Properties
Primary Keys
- product_id (string) - Unique identifier for the product being manufactured. Part of the composite primary key.
- location_id (string) - Unique identifier for the factory location. Part of the composite primary key.
- order_number (string) - Unique identifier for the manufacturing order. Part of the composite primary key.
- updated_at (timestamp) - Timestamp of the most recent update to the record. Part of the composite primary key.
Attributes
| Attribute | Data Type | Required | Description |
|---|---|---|---|
product_id | string | Yes | Unique identifier for the product being manufactured |
location_id | string | Yes | Unique identifier for the factory or production site |
order_number | string | Yes | Unique identifier for this manufacturing order |
source_id | string | Yes | Identifier of the production line or internal source initiating the order |
ordered_at | timestamp | Yes | Datetime when the manufacturing order was created |
ordered_units | integer | Yes | Number of units planned for production |
expected_start_date | timestamp | Yes | Planned datetime for production to begin |
actual_start_date | timestamp | No | Actual datetime production commenced |
expected_end_date | timestamp | Yes | Planned datetime for production to be completed |
actual_end_date | timestamp | No | Actual datetime production was completed |
produced_units | integer | No | Number of units actually produced |
status | string | No | Current status of the manufacturing order (e.g. "scheduled", "in_progress", "completed") |
updated_at | timestamp | Yes | Timestamp of the most recent update to this record |
Relationships
Outbound References
The manufacturing_orders resource does not reference any downstream resources as foreign keys.
Inbound References
The following resources are referenced by manufacturing_orders:
- products —
product_id→products.product_id - locations —
location_id→locations.location_id
JSON Representation
{
"solutionName": "INV_OOTB",
"data": [
{
"order_number": "MO-2025-001",
"product_id": "PROD-001",
"location_id": "LOC-001",
"source_id": "LINE-001",
"ordered_at": "2025-01-05 08:00:00",
"ordered_units": 500,
"expected_start_date": "2025-01-10 06:00:00",
"actual_start_date": "2025-01-10 06:30:00",
"expected_end_date": "2025-01-12 18:00:00",
"actual_end_date": "2025-01-12 17:45:00",
"produced_units": 498,
"status": "completed",
"updated_at": "2025-01-12 18:00:00"
}
],
"operationType": "UPSERT"
}
{
"solutionName": "INV_OOTB",
"data": [
{
"order_number": "MO-2025-001",
"product_id": "PROD-001",
"location_id": "LOC-001",
"source_id": "LINE-001",
"ordered_at": "2025-01-05 08:00:00",
"ordered_units": 500,
"expected_start_date": "2025-01-10 06:00:00",
"actual_start_date": "2025-01-10 06:30:00",
"expected_end_date": "2025-01-12 18:00:00",
"actual_end_date": "2025-01-12 17:45:00",
"produced_units": 498,
"status": "completed",
"updated_at": "2025-01-12 18:00:00"
}
],
"operationType": "UPSERT"
}
Example Request
curl -X POST \
'https://ingestion.peak.ai/api/v2/objects/INV_MANUFACTURING_ORDERS_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "INV_OOTB",
"data": [
{
"order_number": "MO-2025-001",
"product_id": "PROD-001",
"location_id": "LOC-001",
"source_id": "LINE-001",
"ordered_at": "2025-01-05 08:00:00",
"ordered_units": 500,
"expected_start_date": "2025-01-10 06:00:00",
"actual_start_date": "2025-01-10 06:30:00",
"expected_end_date": "2025-01-12 18:00:00",
"actual_end_date": "2025-01-12 17:45:00",
"produced_units": 498,
"status": "completed",
"updated_at": "2025-01-12 18:00:00"
}
],
"operationType": "UPSERT"
}'
curl -X POST \
'https://ingestion.peak.ai/api/v2/objects/INV_MANUFACTURING_ORDERS_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "INV_OOTB",
"data": [
{
"order_number": "MO-2025-001",
"product_id": "PROD-001",
"location_id": "LOC-001",
"source_id": "LINE-001",
"ordered_at": "2025-01-05 08:00:00",
"ordered_units": 500,
"expected_start_date": "2025-01-10 06:00:00",
"actual_start_date": "2025-01-10 06:30:00",
"expected_end_date": "2025-01-12 18:00:00",
"actual_end_date": "2025-01-12 17:45:00",
"produced_units": 498,
"status": "completed",
"updated_at": "2025-01-12 18:00:00"
}
],
"operationType": "UPSERT"
}'
Important Notes
product_id,location_id,order_number, andupdated_attogether form the composite primary key. All four fields must be provided on every record.expected_start_dateandexpected_end_dateare required planned dates; theiractual_counterparts are optional and should be populated as production progresses.produced_unitsandactual_start_date/actual_end_dateshould be updated incrementally as the order progresses.- The
location_idfor a manufacturing order should reference a location whereis_factoryis set totrue. - All timestamps must be provided in
YYYY-MM-DD HH:MM:SSformat.