Order Parameters

Order Parameters API resource defining replenishment configuration per product-location-source combination, including planning parameters used by the inventory optimization engine.

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/{prefix}ORDER_PARAMETERS{suffix}

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.
• location_id (string) - Unique identifier for the location these parameters apply to. 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 (for example, 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

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
    }
  ],
  "operationType": "UPSERT"
}

Example Request

curl -X POST \
  'https://ingestion.peak.ai/api/v2/objects/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
      }
    ],
    "operationType": "UPSERT"
  }'

Important Notes

• product_id and location_id together form the composite primary key. Both fields must be provided on every record.
• service_level should be expressed as a decimal between 0 and 1 (for example, 0.95 for a 95% target fill rate).
• source_id should correspond to a valid supplier_id in the Suppliers resource.
• location_id should correspond to a valid record in the Locations resource.
• minimum_guardrail is optional; when omitted, the system will not enforce a minimum stock floor for this product-location.

Related Resources

• Products
• Locations
• Suppliers
• Stock
• Purchase Orders