industry-department-solutions
latest
false
- Overview
- API Resources
Supply Chain & Retail Solutions API guide
Last updated Apr 16, 2026
Product Cost
Overview
The product_cost resource represents the cost of products in specific regions. This resource stores cost information used for margin calculations and pricing decisions.
Resource Endpoint
/api/v2/ingest/object/{prefix}PRODUCT_COST{suffix}
/api/v2/ingest/object/{prefix}PRODUCT_COST{suffix}
Supported Methods
| Method | Return Type | Description |
|---|---|---|
| POST | Response | Ingest (create/update) product cost 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) - Foreign key reference to products
- region_id (string) - Foreign key reference to regions
- updated_at (datetime) - Timestamp of when the record was last updated
Attributes
| Attribute | Data Type | Required | Description |
|---|---|---|---|
product_id | string | Yes | Unique identifier for each product. Used to join product metadata to quotations and sales for model training and guardrails. |
region_id | string | Yes | Region identifier (Primary Key, Foreign Key) |
updated_at | datetime | Yes | Timestamp when the record was updated. Used to identify the most up-to-date data in the UI and when optimising prices. For model training, used to match the cost price to the date of each quote. |
product_cost | float | No | Cost price of the product. Used to calculate the margin/profit applied to all quotations and sales orders for model training and optimising prices. |
Relationships
Outbound References
None
Inbound References
- product - Foreign key
product_idreferences product - region - Foreign key
region_idreferences region
JSON Representation
{
"solutionName": "QP_OOTB",
"data": [
{
"product_id": "PROD-001",
"region_id": "EMEA-UK",
"updated_at": "2025-01-28T10:00:00Z",
"product_cost": 89.50
}
],
"operationType": "UPSERT"
}
{
"solutionName": "QP_OOTB",
"data": [
{
"product_id": "PROD-001",
"region_id": "EMEA-UK",
"updated_at": "2025-01-28T10:00:00Z",
"product_cost": 89.50
}
],
"operationType": "UPSERT"
}
Example Request
curl -X POST \
'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_PRODUCT_COST_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "QP_OOTB",
"data": [
{
"product_id": "PROD-001",
"region_id": "EMEA-UK",
"updated_at": "2025-01-28T10:00:00Z",
"product_cost": 89.50
}
],
"operationType": "UPSERT"
}'
curl -X POST \
'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_PRODUCT_COST_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "QP_OOTB",
"data": [
{
"product_id": "PROD-001",
"region_id": "EMEA-UK",
"updated_at": "2025-01-28T10:00:00Z",
"product_cost": 89.50
}
],
"operationType": "UPSERT"
}'
Important Notes
- Foreign Key Dependencies: Requires valid
product_idandregion_idto exist in their respective tables - Margin Calculation: Used in combination with list prices to calculate profit margins
- Regional Variations: Costs may vary by region due to shipping, taxes, and local factors
- Custom Attributes: Additional custom attributes can be added using the
/PRODUCT_COST/add-attributeendpoint - Data Validation: All attributes are validated according to their defined data types
Related Resources
- product - Product master data
- region - Regional definitions
- list_price - List pricing for margin calculation