Supply Chain & Retail Solutions API guide

Overview​

Resource Endpoint​

/api/v2/ingest/object/INV_PRODUCTS_PARENT_CHILD_MAPPING_OOTB
/api/v2/ingest/object/INV_PRODUCTS_PARENT_CHILD_MAPPING_OOTB

Supported Methods​

Request Headers​

Properties​

Primary Keys​

• child_id (string) - Unique identifier for the child product. 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​

Relationships​

Outbound References​

Inbound References​

• products (parent) — parent_id → products.product_id
• products (child) — child_id → products.product_id

JSON Representation​

{
  "solutionName": "INV_OOTB",
  "data": [
    {
      "parent_id": "PROD-001",
      "child_id": "PROD-001-RED",
      "child_label": "variant",
      "child_rank": 1,
      "updated_at": "2025-01-15 08:00:00"
    }
  ],
  "operationType": "UPSERT"
}
{
  "solutionName": "INV_OOTB",
  "data": [
    {
      "parent_id": "PROD-001",
      "child_id": "PROD-001-RED",
      "child_label": "variant",
      "child_rank": 1,
      "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_PRODUCTS_PARENT_CHILD_MAPPING_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "INV_OOTB",
    "data": [
      {
        "parent_id": "PROD-001",
        "child_id": "PROD-001-RED",
        "child_label": "variant",
        "child_rank": 1,
        "updated_at": "2025-01-15 08:00:00"
      }
    ],
    "operationType": "UPSERT"
  }'
curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/INV_PRODUCTS_PARENT_CHILD_MAPPING_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "INV_OOTB",
    "data": [
      {
        "parent_id": "PROD-001",
        "child_id": "PROD-001-RED",
        "child_label": "variant",
        "child_rank": 1,
        "updated_at": "2025-01-15 08:00:00"
      }
    ],
    "operationType": "UPSERT"
  }'

Important Notes​

• child_id and updated_at together form the composite primary key. Both fields must be provided on every record.
• Each child_id can only have one parent_id; a child product maps to exactly one parent in the hierarchy.
• parent_id and child_id must both correspond to existing records in the Products resource. Ensure parent products are ingested before their child mappings.
• child_label is required and should consistently describe the relationship type across your dataset (e.g. always "variant" for size/colour variants).
• child_rank is required and must be a positive integer. Lower values typically indicate higher priority or display order.
• 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
• Product Extra