industry-department-solutions
latest
false
- Overview
- API Resources
Supply Chain & Retail Solutions API guide
Last updated Apr 16, 2026
List Price
Overview
The list_price resource represents list prices for products in specific regions and price lists. This resource stores the standard pricing before any discounts or negotiations.
Resource Endpoint
/api/v2/ingest/object/{prefix}LIST_PRICE{suffix}
/api/v2/ingest/object/{prefix}LIST_PRICE{suffix}
Supported Methods
| Method | Return Type | Description |
|---|---|---|
| POST | Response | Ingest (create/update) list price 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
- price_list_id (string) - Identifier for the price list
- 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) |
price_list_id | string | Yes | Price list identifier (Primary 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 list price to the date of each quote. |
list_price | float | No | List price for the product. Used to calculate the discount 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",
"price_list_id": "PL-STD-2025",
"updated_at": "2025-01-28T10:00:00Z",
"list_price": 199.99
}
],
"operationType": "UPSERT"
}
{
"solutionName": "QP_OOTB",
"data": [
{
"product_id": "PROD-001",
"region_id": "EMEA-UK",
"price_list_id": "PL-STD-2025",
"updated_at": "2025-01-28T10:00:00Z",
"list_price": 199.99
}
],
"operationType": "UPSERT"
}
Example Request
curl -X POST \
'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_LIST_PRICE_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "QP_OOTB",
"data": [
{
"product_id": "PROD-001",
"region_id": "EMEA-UK",
"price_list_id": "PL-STD-2025",
"updated_at": "2025-01-28T10:00:00Z",
"list_price": 199.99
}
],
"operationType": "UPSERT"
}'
curl -X POST \
'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_LIST_PRICE_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "QP_OOTB",
"data": [
{
"product_id": "PROD-001",
"region_id": "EMEA-UK",
"price_list_id": "PL-STD-2025",
"updated_at": "2025-01-28T10:00:00Z",
"list_price": 199.99
}
],
"operationType": "UPSERT"
}'
Important Notes
- Foreign Key Dependencies: Requires valid
product_idandregion_idto exist in their respective tables - Multiple Price Lists: The
price_list_idallows for different pricing structures (e.g., standard, premium, volume) - Custom Attributes: Additional custom attributes can be added using the
/LIST_PRICE/add-attributeendpoint - Data Validation: All attributes are validated according to their defined data types
Related Resources
- product - Product master data
- region - Regional definitions
- customer - Customers can be assigned to specific price lists
- competitor_price - Competitor pricing for comparison