industry-department-solutions
latest
false
Supply Chain & Retail Solutions API guide
- Overview
- API Resources
product API resource representing products in the B2C pricing application, including descriptions and category associations.
Overview
The product resource represents products in the B2C pricing application. This resource stores product information including descriptions and category associations.
Resource Endpoint
/api/v2/ingest/object/{prefix}PRODUCT{suffix}
/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
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 product identifier (Primary Key) |
name | string | Yes | No | Display name of the product |
description | string | Yes | Yes | Detailed product description |
lowest_product_category_id | string | Yes | No | Reference to the most specific (leaf) category (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
This resource has relationships to:
- product_extra - Products can have extra attributes
- product_pricing_daily - Products can have daily pricing data
- purchase_order - Products can appear in purchase orders
- sale - Products can be sold
- stock - Products can have stock levels
- tax - Products can have tax rates
Inbound References
- product_category - Foreign key
lowest_product_category_idreferences product_category
JSON Representation
{
"solutionName": "MP_OOTB",
"data": [
{
"product_id": "PROD-001",
"name": "Premium Wireless Headphones",
"description": "High-quality wireless headphones with noise cancellation",
"lowest_product_category_id": "CAT-AUDIO",
"created_at": "2025-01-10T08:00:00Z",
"updated_at": "2025-01-28T10:00:00Z"
}
],
"operationType": "UPSERT"
}
{
"solutionName": "MP_OOTB",
"data": [
{
"product_id": "PROD-001",
"name": "Premium Wireless Headphones",
"description": "High-quality wireless headphones with noise cancellation",
"lowest_product_category_id": "CAT-AUDIO",
"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_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "MP_OOTB",
"data": [
{
"product_id": "PROD-001",
"name": "Premium Wireless Headphones",
"description": "High-quality wireless headphones with noise cancellation",
"lowest_product_category_id": "CAT-AUDIO",
"created_at": "2025-01-10T08:00:00Z",
"updated_at": "2025-01-28T10:00:00Z"
}
],
"operationType": "UPSERT"
}'
curl -X POST \
'https://ingestion.peak.ai/api/v2/objects/MP_PRODUCT_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "MP_OOTB",
"data": [
{
"product_id": "PROD-001",
"name": "Premium Wireless Headphones",
"description": "High-quality wireless headphones with noise cancellation",
"lowest_product_category_id": "CAT-AUDIO",
"created_at": "2025-01-10T08:00:00Z",
"updated_at": "2025-01-28T10:00:00Z"
}
],
"operationType": "UPSERT"
}'
Important Notes
- Primary Key: This resource uses
product_idas the primary key - Category Association: The
lowest_product_category_idlinks products to their most specific category - Extended Attributes: Use the
product_extraresource for additional product attributes - Central Entity: Product is referenced by many other B2C entities (pricing, sales, stock, tax)
- Custom Attributes: Additional custom attributes can be added using the
/PRODUCT/add-attributeendpoint - Data Validation: All attributes are validated according to their defined data types
Related Resources
- product_category - Category classifications
- product_extra - Additional product attributes
- product_pricing_daily - Daily pricing data
- purchase_order - Purchase orders for products
- sale - Sales transactions
- stock - Stock levels
- tax - Tax rates