industry-department-solutions
latest
false
- Overview
- API Resources
Supply Chain & Retail Solutions API guide
Last updated Apr 16, 2026
Order Parameters
Overview
The Order Parameters resource represents the replenishment configuration for a product-location-source combination. Each record defines the planning parameters used by the inventory optimisation engine to calculate recommended order quantities, including review cycles, service level targets, lead times, and minimum stock guardrails.
Resource Endpoint
/api/v2/ingest/object/INV_ORDER_PARAMETERS_OOTB
/api/v2/ingest/object/INV_ORDER_PARAMETERS_OOTB
Supported Methods
| Method | Return Type | Description |
|---|---|---|
| POST | Response | Ingest (create/update) Order Parameters 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. 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 |
location_id | string | Yes | Unique identifier for the location these parameters apply to |
source_id | string | Yes | Identifier of the supplier or source from which replenishment is made |
review_period_days | integer | Yes | Number of days between inventory review cycles |
service_level | float | Yes | Target service level as a decimal (e.g. 0.95 for 95%) |
lead_time_days | integer | Yes | Number of days from order placement to expected receipt |
minimum_guardrail | integer | No | Minimum stock quantity to maintain as a safety buffer |
updated_at | timestamp | Yes | Timestamp of the most recent update to this record |
Relationships
Outbound References
The order_parameters resource does not reference any downstream resources as foreign keys.
Inbound References
The following resources are referenced by order_parameters:
- products —
product_id→products.product_id - locations —
location_id→locations.location_id
JSON Representation
{
"solutionName": "INV_OOTB",
"data": [
{
"product_id": "PROD-001",
"location_id": "LOC-001",
"source_id": "SUP-001",
"review_period_days": 7,
"service_level": 0.95,
"lead_time_days": 14,
"minimum_guardrail": 50,
"updated_at": "2025-01-15 08:00:00"
}
],
"operationType": "UPSERT"
}
{
"solutionName": "INV_OOTB",
"data": [
{
"product_id": "PROD-001",
"location_id": "LOC-001",
"source_id": "SUP-001",
"review_period_days": 7,
"service_level": 0.95,
"lead_time_days": 14,
"minimum_guardrail": 50,
"updated_at": "2025-01-15 08:00:00"
}
],
"operationType": "UPSERT"
}
Example Request
curl -X POST \
'https://service.peak.ai/ingestion-api/api/v2/ingest/object/INV_ORDER_PARAMETERS_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "INV_OOTB",
"data": [
{
"product_id": "PROD-001",
"location_id": "LOC-001",
"source_id": "SUP-001",
"review_period_days": 7,
"service_level": 0.95,
"lead_time_days": 14,
"minimum_guardrail": 50,
"updated_at": "2025-01-15 08:00:00"
}
],
"operationType": "UPSERT"
}'
curl -X POST \
'https://service.peak.ai/ingestion-api/api/v2/ingest/object/INV_ORDER_PARAMETERS_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "INV_OOTB",
"data": [
{
"product_id": "PROD-001",
"location_id": "LOC-001",
"source_id": "SUP-001",
"review_period_days": 7,
"service_level": 0.95,
"lead_time_days": 14,
"minimum_guardrail": 50,
"updated_at": "2025-01-15 08:00:00"
}
],
"operationType": "UPSERT"
}'
Important Notes
product_idandupdated_attogether form the composite primary key. Both fields must be provided on every record.service_levelshould be expressed as a decimal between0and1(e.g.0.95for a 95% target fill rate).source_idshould correspond to a validsupplier_idin the Suppliers resource.location_idshould correspond to a valid record in the Locations resource.minimum_guardrailis optional; when omitted, the system will not enforce a minimum stock floor for this product-location.- Timestamps must be provided in
YYYY-MM-DD HH:MM:SSformat.