industry-department-solutions
latest
false
- Overview
- API Resources
Supply Chain & Retail Solutions API guide
Last updated Apr 16, 2026
Suppliers
Overview
The Suppliers resource represents the external vendors and supply sources used in the procurement process. Each record captures a supplier's identity and the ordering constraints they impose, such as minimum order quantities and minimum order values. Suppliers are referenced by other resources as the source_id field to establish supply relationships.
Resource Endpoint
/api/v2/ingest/object/INV_SUPPLIERS_OOTB
/api/v2/ingest/object/INV_SUPPLIERS_OOTB
Supported Methods
| Method | Return Type | Description |
|---|---|---|
| POST | Response | Ingest (create/update) Suppliers 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
- supplier_id (string) - Unique identifier for the supplier. Part of the composite primary key.
- updated_at (timestamp) - Timestamp of the most recent update to the record. Part of the composite primary key.
Attributes
| Attribute | Data Type | Required | Description |
|---|---|---|---|
supplier_id | string | Yes | Unique identifier for the supplier |
supplier_name | string | Yes | Human-readable name of the supplier |
minimum_order_quantity | integer | No | The minimum number of units that must be ordered from this supplier |
moq_unit_of_measure | string | No | The unit of measure applicable to the minimum order quantity (e.g. "units", "cases") |
minimum_order_value | integer | No | The minimum monetary value that must be met per order from this supplier |
mov_unit_of_measure | string | No | The currency or unit applicable to the minimum order value (e.g. "GBP", "USD") |
updated_at | timestamp | Yes | Timestamp of the most recent update to this record |
Relationships
Outbound References
The suppliers resource is referenced via source_id in the following resources:
- order_parameters —
source_id→suppliers.supplier_id - purchase_orders —
source_id→suppliers.supplier_id - transfers —
source_id→suppliers.supplier_id - manufacturing_orders —
source_id→suppliers.supplier_id
Inbound References
The suppliers resource does not reference any other resource as a foreign key.
JSON Representation
{
"solutionName": "INV_OOTB",
"data": [
{
"supplier_id": "SUP-001",
"supplier_name": "Global Parts Ltd",
"minimum_order_quantity": 100,
"moq_unit_of_measure": "units",
"minimum_order_value": 500,
"mov_unit_of_measure": "GBP",
"updated_at": "2025-01-15 08:00:00"
}
],
"operationType": "UPSERT"
}
{
"solutionName": "INV_OOTB",
"data": [
{
"supplier_id": "SUP-001",
"supplier_name": "Global Parts Ltd",
"minimum_order_quantity": 100,
"moq_unit_of_measure": "units",
"minimum_order_value": 500,
"mov_unit_of_measure": "GBP",
"updated_at": "2025-01-15 08:00:00"
}
],
"operationType": "UPSERT"
}
Example Request
curl -X POST \
'https://service.peak.ai/ingestion-api/api/v2/ingest/object/INV_SUPPLIERS_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "INV_OOTB",
"data": [
{
"supplier_id": "SUP-001",
"supplier_name": "Global Parts Ltd",
"minimum_order_quantity": 100,
"moq_unit_of_measure": "units",
"minimum_order_value": 500,
"mov_unit_of_measure": "GBP",
"updated_at": "2025-01-15 08:00:00"
}
],
"operationType": "UPSERT"
}'
curl -X POST \
'https://service.peak.ai/ingestion-api/api/v2/ingest/object/INV_SUPPLIERS_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "INV_OOTB",
"data": [
{
"supplier_id": "SUP-001",
"supplier_name": "Global Parts Ltd",
"minimum_order_quantity": 100,
"moq_unit_of_measure": "units",
"minimum_order_value": 500,
"mov_unit_of_measure": "GBP",
"updated_at": "2025-01-15 08:00:00"
}
],
"operationType": "UPSERT"
}'
Important Notes
supplier_idandupdated_attogether form the composite primary key. Both fields must be provided on every record.- The
supplier_idvalue is used as thesource_idfield in related resources such as Purchase Orders, Order Parameters, Transfers, and Manufacturing Orders. minimum_order_quantityandminimum_order_valueare optional. When omitted, the system assumes no minimum constraints apply.- Ensure
moq_unit_of_measureandmov_unit_of_measureare populated when their corresponding minimum values are provided. - Timestamps must be provided in
YYYY-MM-DD HH:MM:SSformat.