Industry & Department Solutions

industry-department-solutions

latest

false

Supply Chain & Retail Solutions API guide

Products

Products API resource for the Inventory Management solution, representing the item catalogue with identity, categorization, packaging, and supplier reference.

Overview

The Products resource represents the catalogue of items managed within the inventory system. Each product record captures the item's identity, categorisation, packaging details, and source supplier reference. Products are the central entity in the data model, referenced by nearly every other resource.

Resource Endpoint

/api/v2/ingest/object/{prefix}PRODUCTS{suffix}
/api/v2/ingest/object/{prefix}PRODUCTS{suffix}

Supported Methods

Method	Return Type	Description
POST	Response	Ingest (create/update) Products 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. Used as the primary key for deduplication and UPSERT operations.

Attributes

Attribute	Data Type	Required	Description
`product_id`	string	Yes	Unique identifier for the product
`product_name`	string	No	Human-readable name of the product
`product_description`	string	No	Detailed description of the product
`product_category`	string	No	Category or classification of the product
`source_id`	string	Yes	Identifier of the primary supplier or source for this product
`pack_size`	integer	Yes	Number of individual units contained within a single pack
`minimum_order_quantity`	integer	No	Minimum number of units that can be ordered at one time
`product_image_urls`	string	No	URL or comma-separated list of URLs pointing to product images

Relationships

Outbound References

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

Inbound References

The following resources reference products via product_id:

stock_daily — product_id → products.product_id
pricing — product_id → products.product_id
order_parameters — product_id → products.product_id
purchase_orders — product_id → products.product_id
transfers — product_id → products.product_id
manufacturing_orders — product_id → products.product_id
sku_calendar — product_id → products.product_id
sales_daily — product_id → products.product_id
customer_orders — product_id → products.product_id
product_extra — product_id → products.product_id
forecast — product_id → products.product_id

JSON Representation

{
  "solutionName": "INV_OOTB",
  "data": [
    {
      "product_id": "PROD-001",
      "product_name": "Blue Widget",
      "product_description": "A sturdy blue widget",
      "product_category": "Widgets",
      "source_id": "SUP-001",
      "pack_size": 12,
      "minimum_order_quantity": 24,
      "product_image_urls": "https://example.com/img/prod001.jpg"
    }
  ],
  "operationType": "UPSERT"
}
{
  "solutionName": "INV_OOTB",
  "data": [
    {
      "product_id": "PROD-001",
      "product_name": "Blue Widget",
      "product_description": "A sturdy blue widget",
      "product_category": "Widgets",
      "source_id": "SUP-001",
      "pack_size": 12,
      "minimum_order_quantity": 24,
      "product_image_urls": "https://example.com/img/prod001.jpg"
    }
  ],
  "operationType": "UPSERT"
}

Example Request

curl -X POST \
  'https://ingestion.peak.ai/api/v2/objects/INV_PRODUCTS_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "INV_OOTB",
    "data": [
      {
        "product_id": "PROD-001",
        "product_name": "Blue Widget",
        "product_description": "A sturdy blue widget",
        "product_category": "Widgets",
        "source_id": "SUP-001",
        "pack_size": 12,
        "minimum_order_quantity": 24,
        "product_image_urls": "https://example.com/img/prod001.jpg"
      }
    ],
    "operationType": "UPSERT"
  }'
curl -X POST \
  'https://ingestion.peak.ai/api/v2/objects/INV_PRODUCTS_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "INV_OOTB",
    "data": [
      {
        "product_id": "PROD-001",
        "product_name": "Blue Widget",
        "product_description": "A sturdy blue widget",
        "product_category": "Widgets",
        "source_id": "SUP-001",
        "pack_size": 12,
        "minimum_order_quantity": 24,
        "product_image_urls": "https://example.com/img/prod001.jpg"
      }
    ],
    "operationType": "UPSERT"
  }'

Important Notes

product_id is the primary key, used for deduplication and UPSERT operations.
source_id should match a valid supplier_id in the Suppliers resource to maintain referential integrity.
pack_size is required and must be a positive integer representing the number of sellable units per pack.
Records are ingested via UPSERT: an existing record with matching primary keys will be updated; otherwise a new record is inserted.

Was this page helpful?

PREVIOUSProduct Extra

NEXTPurchase Orders

Overview​

Resource Endpoint​

Supported Methods​

Request Headers​

Properties​

Primary Keys​

Attributes​

Relationships​

Outbound References​

Inbound References​

JSON Representation​

Example Request​

Important Notes​

Related Resources​