Product

product API resource for the B2B pricing application, with categorization and bespoke product indicators used in quote pricing scenarios.

Overview

The product resource represents product entities in the B2B pricing application. This resource stores product information including categorization and bespoke product indicators.

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

Resource Endpoint

/api/v2/ingest/object/{prefix}PRODUCT{suffix}

Supported Methods

Method	Return Type	Description
POST	Response	Ingest (create/update) product 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
• 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.
updated_at	datetime	Yes	Yes	Timestamp when the record was updated. Used to identify the most up-to-date data in the UI and to match product metadata to the date of each quote in model training.
product_name	string	Yes	No	Product name. Used in the UI to identify products.
bespoke_product	boolean	Yes	Yes	Whether the product is bespoke (custom-made) or standard. Used in model training as a feature to determine the optimal quote price.
product_category	string	Yes	Yes	Product category. Used in model training as a feature to determine the optimal quote price.
product_subcategory	string	Yes	Yes	Product sub-category. Used in model training as a feature to determine the optimal quote price.

Relationships

Outbound References

This resource has relationships to:

• competitor_price - Products can have competitive pricing data
• list_price - Products can have list prices across regions
• product_cost - Products can have cost information
• quote_line - Products can appear in quote line items
• sale - Products can be sold

Inbound References

None

JSON Representation

{
  "solutionName": "QP_OOTB",
  "data": [
    {
      "product_id": "PROD-001",
      "updated_at": "2025-01-28T10:00:00Z",
      "product_name": "Premium Widget",
      "bespoke_product": false,
      "product_category": "Electronics",
      "product_subcategory": "Components"
    }
  ],
  "operationType": "UPSERT"
}

Example Request

curl -X POST \
  'https://ingestion.peak.ai/api/v2/objects/QP_PRODUCT_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "QP_OOTB",
    "data": [
      {
        "product_id": "PROD-001",
        "updated_at": "2025-01-28T10:00:00Z",
        "product_name": "Premium Widget",
        "bespoke_product": false,
        "product_category": "Electronics",
        "product_subcategory": "Components"
      }
    ],
    "operationType": "UPSERT"
  }'

Important Notes

• Bespoke Products: The bespoke_product flag can be used to identify custom or made-to-order products
• 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}PRODUCT{suffix} — for example, QP_PRODUCT_OOTB), as returned by Describe a solution's schema
• Data Validation: All attributes are validated according to their defined data types

Related Resources

• competitor_price - Competitor pricing for products
• list_price - List pricing for products
• product_cost - Cost information for products
• quote_line - Quote line items referencing products
• sale - Sales records for products
• region - Geographic regions for pricing