industry-department-solutions
latest
false
- Overview
- API Resources
Supply Chain & Retail Solutions API guide
Last updated Apr 16, 2026
Product Category
Overview
The product_category resource represents product categories in the B2C pricing application. This resource supports hierarchical category structures with parent-child relationships.
Resource Endpoint
/api/v2/ingest/object/{prefix}PRODUCT_CATEGORY{suffix}
/api/v2/ingest/object/{prefix}PRODUCT_CATEGORY{suffix}
Supported Methods
| Method | Return Type | Description |
|---|---|---|
| POST | Response | Ingest (create/update) product category 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_category_id (string) - Unique identifier for the product category
Attributes
| Attribute | Data Type | Required | Description |
|---|---|---|---|
product_category_id | string | Yes | Unique product category identifier (Primary Key) |
name | string | No | Display name of the category |
metadata | string | No | Additional metadata or attributes in JSON format |
parent_product_category_id | string | No | Reference to parent category for hierarchical structure (Foreign Key) |
created_at | datetime | No | Timestamp when the record was created |
updated_at | datetime | No | Timestamp when the record was last updated |
Relationships
Outbound References
This resource has relationships to:
- product - Categories can contain multiple products
- product_category (self-reference) - Categories can have child categories
Inbound References
- product_category - Foreign key
parent_product_category_idreferences itself for hierarchical structure
JSON Representation
{
"solutionName": "QP_OOTB",
"data": [
{
"product_category_id": "CAT-ELEC",
"name": "Electronics",
"metadata": "{\"display_order\": 1, \"is_featured\": true}",
"parent_product_category_id": null,
"created_at": "2025-01-10T08:00:00Z",
"updated_at": "2025-01-28T10:00:00Z"
}
],
"operationType": "UPSERT"
}
{
"solutionName": "QP_OOTB",
"data": [
{
"product_category_id": "CAT-ELEC",
"name": "Electronics",
"metadata": "{\"display_order\": 1, \"is_featured\": true}",
"parent_product_category_id": null,
"created_at": "2025-01-10T08:00:00Z",
"updated_at": "2025-01-28T10:00:00Z"
}
],
"operationType": "UPSERT"
}
Example Request
curl -X POST \
'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_PRODUCT_CATEGORY_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "QP_OOTB",
"data": [
{
"product_category_id": "CAT-ELEC",
"name": "Electronics",
"metadata": "{\"display_order\": 1, \"is_featured\": true}",
"parent_product_category_id": null,
"created_at": "2025-01-10T08:00:00Z",
"updated_at": "2025-01-28T10:00:00Z"
}
],
"operationType": "UPSERT"
}'
curl -X POST \
'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_PRODUCT_CATEGORY_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "QP_OOTB",
"data": [
{
"product_category_id": "CAT-ELEC",
"name": "Electronics",
"metadata": "{\"display_order\": 1, \"is_featured\": true}",
"parent_product_category_id": null,
"created_at": "2025-01-10T08:00:00Z",
"updated_at": "2025-01-28T10:00:00Z"
}
],
"operationType": "UPSERT"
}'
Important Notes
- Primary Key: This resource uses
product_category_idas the primary key - Hierarchical Structure: The
parent_product_category_idenables multi-level category trees - Self-Referencing: Categories can reference other categories as parents
- Flexible Metadata: The
metadatafield allows storing additional structured information - Custom Attributes: Additional custom attributes can be added using the
/PRODUCT_CATEGORY/add-attributeendpoint - Data Validation: All attributes are validated according to their defined data types
Related Resources
- product - Products belonging to categories
- product_category - Parent/child category relationships