industry-department-solutions
latest
false
Supply Chain & Retail Solutions API guide
- Overview
- API Resources
Stock API resource representing daily opening and closing inventory levels per product-location, enabling time-series analysis of inventory positions across the supply chain.
Overview
The Stock resource represents daily on-hand inventory levels for a given product at a given location. Each record captures the opening and closing stock quantities on a specific date, enabling time-series analysis of inventory positions across the supply chain network.
Resource Endpoint
/api/v2/ingest/object/{prefix}STOCK_DAILY{suffix}
/api/v2/ingest/object/{prefix}STOCK_DAILY{suffix}
Supported Methods
| Method | Return Type | Description |
|---|---|---|
| POST | Response | Ingest (create/update) Stock 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. Part of the composite primary key.
- location_id (string) - Unique identifier for the location. Part of the composite primary key.
- day_date (date) - The calendar date for which the stock level is recorded. Part of the composite primary key.
Attributes
| Attribute | Data Type | Required | Description |
|---|---|---|---|
product_id | string | Yes | Unique identifier for the product |
location_id | string | Yes | Unique identifier for the location |
day_date | date | Yes | The date of the stock snapshot, in YYYY-MM-DD format |
opening_stock | integer | Yes | Quantity of the product on hand at the start of the given date |
closing_stock | integer | Yes | Quantity of the product on hand at the end of the given date |
Relationships
Outbound References
The stock_daily resource does not reference any downstream resources as foreign keys.
Inbound References
The following resources are referenced by stock_daily:
- products —
product_id→products.product_id - locations —
location_id→locations.location_id
JSON Representation
{
"solutionName": "INV_OOTB",
"data": [
{
"product_id": "PROD-001",
"location_id": "LOC-001",
"day_date": "2025-01-15",
"opening_stock": 520,
"closing_stock": 500
}
],
"operationType": "UPSERT"
}
{
"solutionName": "INV_OOTB",
"data": [
{
"product_id": "PROD-001",
"location_id": "LOC-001",
"day_date": "2025-01-15",
"opening_stock": 520,
"closing_stock": 500
}
],
"operationType": "UPSERT"
}
Example Request
curl -X POST \
'https://ingestion.peak.ai/api/v2/objects/INV_STOCK_DAILY_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "INV_OOTB",
"data": [
{
"product_id": "PROD-001",
"location_id": "LOC-001",
"day_date": "2025-01-15",
"opening_stock": 520,
"closing_stock": 500
}
],
"operationType": "UPSERT"
}'
curl -X POST \
'https://ingestion.peak.ai/api/v2/objects/INV_STOCK_DAILY_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "INV_OOTB",
"data": [
{
"product_id": "PROD-001",
"location_id": "LOC-001",
"day_date": "2025-01-15",
"opening_stock": 520,
"closing_stock": 500
}
],
"operationType": "UPSERT"
}'
Important Notes
product_id,location_id, andday_datetogether form the composite primary key. All three fields must be provided on every record.day_datemust be inYYYY-MM-DDformat.opening_stockandclosing_stockmust be non-negative integers. A value of0is valid and indicates no stock on hand.product_idmust correspond to an existing record in the Products resource.location_idmust correspond to an existing record in the Locations resource.- Records are ingested via UPSERT: an existing record with matching primary keys will be updated; otherwise a new record is inserted.