Supply Chain & Retail Solutions API guide

Overview​

Resource Endpoint​

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

Supported Methods​

Request Headers​

Properties​

Primary Keys​

• product_id (string) - Unique identifier for the product

Attributes​

Relationships​

Outbound References​

• product_extra - Products can have extra attributes
• product_pricing_daily - Products can have daily pricing data
• purchase_order - Products can appear in purchase orders
• sale - Products can be sold
• stock - Products can have stock levels
• tax - Products can have tax rates

Inbound References​

• product_category - Foreign key lowest_product_category_id references product_category

JSON Representation​

{
  "solutionName": "QP_OOTB",
  "data": [
    {
      "product_id": "PROD-001",
      "name": "Premium Wireless Headphones",
      "description": "High-quality wireless headphones with noise cancellation",
      "lowest_product_category_id": "CAT-AUDIO",
      "created_at": "2025-01-10T08:00:00Z",
      "updated_at": "2025-01-28T10:00:00Z"
    }
  ],
  "operationType": "UPSERT"
}
{
  "solutionName": "QP_OOTB",
  "data": [
    {
      "product_id": "PROD-001",
      "name": "Premium Wireless Headphones",
      "description": "High-quality wireless headphones with noise cancellation",
      "lowest_product_category_id": "CAT-AUDIO",
      "created_at": "2025-01-10T08:00:00Z",
      "updated_at": "2025-01-28T10:00:00Z"
    }
  ],
  "operationType": "UPSERT"
}

Example Request​

curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_PRODUCT_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "QP_OOTB",
    "data": [
      {
        "product_id": "PROD-001",
        "name": "Premium Wireless Headphones",
        "description": "High-quality wireless headphones with noise cancellation",
        "lowest_product_category_id": "CAT-AUDIO",
        "created_at": "2025-01-10T08:00:00Z",
        "updated_at": "2025-01-28T10:00:00Z"
      }
    ],
    "operationType": "UPSERT"
  }'
curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_PRODUCT_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "QP_OOTB",
    "data": [
      {
        "product_id": "PROD-001",
        "name": "Premium Wireless Headphones",
        "description": "High-quality wireless headphones with noise cancellation",
        "lowest_product_category_id": "CAT-AUDIO",
        "created_at": "2025-01-10T08:00:00Z",
        "updated_at": "2025-01-28T10:00:00Z"
      }
    ],
    "operationType": "UPSERT"
  }'

Important Notes​

• Primary Key: This resource uses product_id as the primary key
• Category Association: The lowest_product_category_id links products to their most specific category
• Extended Attributes: Use the product_extra resource for additional product attributes
• Central Entity: Product is referenced by many other B2C entities (pricing, sales, stock, tax)
• Custom Attributes: Additional custom attributes can be added using the /PRODUCT/add-attribute endpoint
• Data Validation: All attributes are validated according to their defined data types

Related Resources​

• product_category - Category classifications
• product_extra - Additional product attributes
• product_pricing_daily - Daily pricing data
• purchase_order - Purchase orders for products
• sale - Sales transactions
• stock - Stock levels
• tax - Tax rates