List Price

list_price API resource representing standard product list prices in specific regions and price lists before discounts or negotiations.

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.

→ For business context (purpose, usage notes, how this resource is used in the solution), see List price dataset in the User Guide.

Resource Endpoint

/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

About Required + Nullable: every attribute key must appear in each payload (Required: Yes). Nullable: Yes means the value can be null when you don't have data; Nullable: No means a non-null value is required. See Schema definition structure for the underlying rules.

Attribute	Data Type	Required	Nullable	Description
product_id	string	Yes	No	Unique identifier for each product. Used to join product metadata to quotations and sales for model training and guardrails.
region_id	string	Yes	No	Region identifier (Primary Key, Foreign Key)
price_list_id	string	Yes	No	Price list identifier (Primary Key)
updated_at	datetime	Yes	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	Yes	Yes	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_id references product
• region - Foreign key region_id references 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"
}

Example Request

curl -X POST \
  'https://ingestion.peak.ai/api/v2/objects/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_id and region_id to exist in their respective tables
• Multiple Price Lists: The price_list_id allows for different pricing structures (e.g., standard, premium, volume)
• Custom Attributes: Custom attributes can be added with POST /api/v2/schema/{objectName}/add-attribute, where {objectName} is this table's fully qualified warehouse name ({prefix}LIST_PRICE{suffix} — for example, QP_LIST_PRICE_OOTB), as returned by Describe a solution's schema
• 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