industry-department-solutions
latest
false
- Overview
- API Resources
Supply Chain & Retail Solutions API guide
Last updated Apr 16, 2026
Competitor Price
Overview
The competitor_price resource tracks competitor pricing data for specific product-region combinations over time. This competitive intelligence enables comparison against your own pricing to inform pricing strategy and competitive positioning decisions. This resource is optional and only needs to be ingested if competitive pricing analysis is required.
Resource Endpoint
/api/v2/ingest/object/{prefix}COMPETITOR_PRICE{suffix}
/api/v2/ingest/object/{prefix}COMPETITOR_PRICE{suffix}
Supported Methods
| Method | Return Type | Description |
|---|---|---|
| POST | Response | Ingest (create/update) competitor 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
- updated_at (datetime) - Timestamp of when the record was last updated
Attributes
| Attribute | Data Type | Required | Description |
|---|---|---|---|
product_id | string | Yes | Product identifier (Primary Key, Foreign Key) |
region_id | string | Yes | Region identifier (Primary Key, Foreign Key) |
updated_at | datetime | Yes | Last update timestamp (Primary Key) |
competitor_price | float | No | Competitor's price for this product in this region |
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",
"competitor_price": 149.99
}
],
"operationType": "UPSERT"
}
{
"solutionName": "QP_OOTB",
"data": [
{
"product_id": "PROD-001",
"region_id": "EMEA-UK",
"updated_at": "2025-01-28T10:00:00Z",
"competitor_price": 149.99
}
],
"operationType": "UPSERT"
}
Example Request
curl -X POST \
'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_COMPETITOR_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",
"updated_at": "2025-01-28T10:00:00Z",
"competitor_price": 149.99
}
],
"operationType": "UPSERT"
}'
curl -X POST \
'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_COMPETITOR_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",
"updated_at": "2025-01-28T10:00:00Z",
"competitor_price": 149.99
}
],
"operationType": "UPSERT"
}'
Important Notes
- Foreign Key Dependencies: Requires valid
product_idandregion_idto exist in their respective tables - Pricing Intelligence: Used to compare your pricing against competitor offerings
- Custom Attributes: Additional custom attributes can be added using the
/COMPETITOR_PRICE/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 - Your list pricing for comparison