Supply Chain & Retail Solutions API guide

Overview​

Resource Endpoint​

/api/v2/ingest/object/INV_PRODUCTION_LINES_OOTB
/api/v2/ingest/object/INV_PRODUCTION_LINES_OOTB

Supported Methods​

Request Headers​

Properties​

Primary Keys​

• product_id (string) - Unique identifier for the product produced on this line. Part of the composite primary key.
• location_id (string) - Unique identifier for the factory location. Part of the composite primary key.
• production_line_id (string) - Unique identifier for the production line. Part of the composite primary key.
• created_at (timestamp) - Timestamp when the production line record was created. 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",
      "production_line_id": "LINE-001",
      "created_at": "2025-01-01 00:00:00",
      "line_capacity": 1000,
      "product_batch_size": 50,
      "valid_from": "2025-01-01 00:00:00",
      "valid_to": "2025-12-31 23:59:59"
    }
  ],
  "operationType": "UPSERT"
}
{
  "solutionName": "INV_OOTB",
  "data": [
    {
      "product_id": "PROD-001",
      "location_id": "LOC-001",
      "production_line_id": "LINE-001",
      "created_at": "2025-01-01 00:00:00",
      "line_capacity": 1000,
      "product_batch_size": 50,
      "valid_from": "2025-01-01 00:00:00",
      "valid_to": "2025-12-31 23:59:59"
    }
  ],
  "operationType": "UPSERT"
}

Example Request​

curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/INV_PRODUCTION_LINES_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "INV_OOTB",
    "data": [
      {
        "product_id": "PROD-001",
        "location_id": "LOC-001",
        "production_line_id": "LINE-001",
        "created_at": "2025-01-01 00:00:00",
        "line_capacity": 1000,
        "product_batch_size": 50,
        "valid_from": "2025-01-01 00:00:00",
        "valid_to": "2025-12-31 23:59:59"
      }
    ],
    "operationType": "UPSERT"
  }'
curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/INV_PRODUCTION_LINES_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "INV_OOTB",
    "data": [
      {
        "product_id": "PROD-001",
        "location_id": "LOC-001",
        "production_line_id": "LINE-001",
        "created_at": "2025-01-01 00:00:00",
        "line_capacity": 1000,
        "product_batch_size": 50,
        "valid_from": "2025-01-01 00:00:00",
        "valid_to": "2025-12-31 23:59:59"
      }
    ],
    "operationType": "UPSERT"
  }'

Important Notes​

• product_id, location_id, production_line_id, and created_at together form the composite primary key. All four fields must be provided on every record.
• line_capacity and product_batch_size are optional but recommended for accurate production planning and scheduling.
• valid_from and valid_to are optional and can be used to time-bound a production line's association with a product-location pair.
• The location_id should reference a location where is_factory is set to true in the Locations resource.
• All timestamps must be provided in YYYY-MM-DD HH:MM:SS format.
• 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
• Manufacturing Orders