Supply Chain & Retail Solutions API guide

Overview​

Resource Endpoint​

/api/v2/ingest/object/INV_STOCK_OOTB
/api/v2/ingest/object/INV_STOCK_OOTB

Supported Methods​

Request Headers​

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​

Relationships​

Outbound References​

Inbound References​

• 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",
      "available_stock": 500
    }
  ],
  "operationType": "UPSERT"
}
{
  "solutionName": "INV_OOTB",
  "data": [
    {
      "product_id": "PROD-001",
      "location_id": "LOC-001",
      "day_date": "2025-01-15",
      "available_stock": 500
    }
  ],
  "operationType": "UPSERT"
}

Example Request​

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

Important Notes​

• product_id, location_id, and day_date together form the composite primary key. All three fields must be provided on every record.
• day_date must be in YYYY-MM-DD format.
• available_stock must be a non-negative integer. A value of 0 is valid and indicates no stock on hand.
• product_id must correspond to an existing record in the Products resource.
• location_id must 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.

Related Resources​

• Products
• Locations
• Sales
• Order Parameters