Product Extra

product_extra API resource for storing additional dynamic attributes on B2C pricing application products as flexible key-value pairs.

Overview

The product_extra resource represents additional dynamic attributes for products in the B2C pricing application. This resource enables flexible key-value pairs for product-specific metadata.

Resource Endpoint

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

Supported Methods

Method	Return Type	Description
POST	Response	Ingest (create/update) product extra 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_extra_attribute (string) - Name of the extra attribute
• product_extra_value (string) - Value of the extra attribute
• product_id (string) - Foreign key reference to products

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_extra_attribute	string	Yes	No	Attribute name (Primary Key)
product_extra_value	string	Yes	No	Attribute value (Primary Key)
product_id	string	Yes	No	Product identifier (Primary Key, Foreign Key)
created_at	timestamp	Yes	Yes	Timestamp when the record was created
updated_at	timestamp	Yes	Yes	Timestamp when the record was last updated

Relationships

Outbound References

None

Inbound References

• product - Foreign key product_id references product

JSON Representation

{
  "solutionName": "MP_OOTB",
  "data": [
    {
      "product_extra_attribute": "color",
      "product_extra_value": "black",
      "product_id": "PROD-001",
      "created_at": "2025-01-10T08:00:00Z",
      "updated_at": "2025-01-28T10:00:00Z"
    }
  ],
  "operationType": "UPSERT"
}

Example Request

curl -X POST \
  'https://ingestion.peak.ai/api/v2/objects/MP_PRODUCT_EXTRA_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "MP_OOTB",
    "data": [
      {
        "product_extra_attribute": "color",
        "product_extra_value": "black",
        "product_id": "PROD-001",
        "created_at": "2025-01-10T08:00:00Z",
        "updated_at": "2025-01-28T10:00:00Z"
      },
      {
        "product_extra_attribute": "size",
        "product_extra_value": "medium",
        "product_id": "PROD-001",
        "created_at": "2025-01-10T08:00:00Z",
        "updated_at": "2025-01-28T10:00:00Z"
      }
    ],
    "operationType": "UPSERT"
  }'

Important Notes

• Foreign Key Dependencies: Requires valid product_id to exist in the products object
• Flexible Schema: Enables storing variable product attributes without schema changes
• Multiple Attributes: A single product can have many extra attributes
• Use Cases: Ideal for variant attributes (color, size), specifications, or custom metadata
• Custom Attributes: Additional custom attributes can be added using the /PRODUCT_EXTRA/add-attribute endpoint
• Data Validation: All attributes are validated according to their defined data types

Related Resources

• product - Base product information