Supply Chain & Retail Solutions API guide

Overview​

Resource Endpoint​

/api/v2/ingest/object/INV_PRICING_OOTB
/api/v2/ingest/object/INV_PRICING_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.
• created_at (timestamp) - Timestamp when the pricing 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",
      "unit_cost_price": 12.50,
      "unit_list_price": 24.99,
      "valid_from": "2025-01-01 00:00:00",
      "valid_to": "2025-12-31 23:59:59",
      "created_at": "2025-01-15 08:00:00"
    }
  ],
  "operationType": "UPSERT"
}
{
  "solutionName": "INV_OOTB",
  "data": [
    {
      "product_id": "PROD-001",
      "location_id": "LOC-001",
      "unit_cost_price": 12.50,
      "unit_list_price": 24.99,
      "valid_from": "2025-01-01 00:00:00",
      "valid_to": "2025-12-31 23:59:59",
      "created_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_PRICING_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "INV_OOTB",
    "data": [
      {
        "product_id": "PROD-001",
        "location_id": "LOC-001",
        "unit_cost_price": 12.50,
        "unit_list_price": 24.99,
        "valid_from": "2025-01-01 00:00:00",
        "valid_to": "2025-12-31 23:59:59",
        "created_at": "2025-01-15 08:00:00"
      }
    ],
    "operationType": "UPSERT"
  }'
curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/INV_PRICING_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "INV_OOTB",
    "data": [
      {
        "product_id": "PROD-001",
        "location_id": "LOC-001",
        "unit_cost_price": 12.50,
        "unit_list_price": 24.99,
        "valid_from": "2025-01-01 00:00:00",
        "valid_to": "2025-12-31 23:59:59",
        "created_at": "2025-01-15 08:00:00"
      }
    ],
    "operationType": "UPSERT"
  }'

Important Notes​

• product_id, location_id, and created_at together form the composite primary key. All three fields must be provided on every record.
• All timestamps must be provided in YYYY-MM-DD HH:MM:SS format.
• unit_cost_price and unit_list_price must be non-negative float values.
• valid_from and valid_to are optional; omitting them implies the pricing record has no bounded validity window.
• Multiple pricing records can exist for the same product-location combination to represent different validity periods.
• product_id must correspond to an existing record in the Products resource.
• location_id must correspond to an existing record in the Locations resource.

Related Resources​

• Products
• Locations
• Purchase Orders
• Customer Orders