Supply Chain & Retail Solutions API guide

Overview​

Resource Endpoint​

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

Supported Methods​

Request Headers​

Properties​

Primary Keys​

• region_id (string) - Unique identifier for the region
• updated_at (datetime) - Timestamp of when the record was last updated

Attributes​

Relationships​

Outbound References​

• competitor_price - Regions can have competitive pricing data
• list_price - Regions can have list prices for products
• product_cost - Regions can have product cost information
• quote_line - Regions can be associated with quote lines

Inbound References​

JSON Representation​

{
  "solutionName": "QP_OOTB",
  "data": [
    {
      "region_id": "EMEA-UK",
      "updated_at": "2025-01-28T10:00:00Z",
      "region_name": "United Kingdom"
    }
  ],
  "operationType": "UPSERT"
}
{
  "solutionName": "QP_OOTB",
  "data": [
    {
      "region_id": "EMEA-UK",
      "updated_at": "2025-01-28T10:00:00Z",
      "region_name": "United Kingdom"
    }
  ],
  "operationType": "UPSERT"
}

Example Request​

curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_REGION_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "QP_OOTB",
    "data": [
      {
        "region_id": "EMEA-UK",
        "updated_at": "2025-01-28T10:00:00Z",
        "region_name": "United Kingdom"
      }
    ],
    "operationType": "UPSERT"
  }'
curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_REGION_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "QP_OOTB",
    "data": [
      {
        "region_id": "EMEA-UK",
        "updated_at": "2025-01-28T10:00:00Z",
        "region_name": "United Kingdom"
      }
    ],
    "operationType": "UPSERT"
  }'

Important Notes​

• Geographic Scope: Regions define the geographic boundaries for pricing and cost calculations
• Custom Attributes: Additional custom attributes can be added using the /REGION/add-attribute endpoint
• Data Validation: All attributes are validated according to their defined data types

Related Resources​

• competitor_price - Competitor pricing by region
• list_price - List pricing by region
• product_cost - Product costs by region
• quote_line - Quote lines associated with regions