Industry & Department Solutions

industry-department-solutions

latest

false

Supply Chain & Retail Solutions API guide

Suppliers

Suppliers API resource representing external vendors in the procurement process, including minimum order quantities and values for inventory planning.

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/{prefix}SUPPLIERS{suffix}
/api/v2/ingest/object/{prefix}SUPPLIERS{suffix}

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. Used as the primary key for deduplication and UPSERT operations.

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 (for example, "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 (for example, "GBP", "USD")

Relationships

Outbound References

The suppliers resource does not reference any other resource as a foreign key.

Inbound References

The following resources reference suppliers via source_id:

order_parameters — source_id → suppliers.supplier_id
purchase_orders — source_id → suppliers.supplier_id
transfers — source_id → suppliers.supplier_id

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"
    }
  ],
  "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"
    }
  ],
  "operationType": "UPSERT"
}

Example Request

curl -X POST \
  'https://ingestion.peak.ai/api/v2/objects/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"
      }
    ],
    "operationType": "UPSERT"
  }'
curl -X POST \
  'https://ingestion.peak.ai/api/v2/objects/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"
      }
    ],
    "operationType": "UPSERT"
  }'

Important Notes

supplier_id is the primary key, used for deduplication and UPSERT operations.
The supplier_id value is used as the source_id field in related resources such as Purchase Orders, Order Parameters, and Transfers.
minimum_order_quantity and minimum_order_value are optional. When omitted, the system assumes no minimum constraints apply.
Ensure moq_unit_of_measure and mov_unit_of_measure are populated when their corresponding minimum values are provided.

Was this page helpful?

PREVIOUSStock

NEXTTransfers

Overview​

Resource Endpoint​

Supported Methods​

Request Headers​

Properties​

Primary Keys​

Attributes​

Relationships​

Outbound References​

Inbound References​

JSON Representation​

Example Request​

Important Notes​

Related Resources​