Engine API Reference

Integrate the self-hosted PackCPQ calculation core directly with your in-house ERP, CRM, and CAD schedulers.

Restricted Documentation

To protect the calculation engine's proprietary folding math and algorithms, detailed schema properties, gRPC Protobuf files, SDK code, and integration sandboxes are restricted. They are available exclusively to licensed clients via the system's administration panel.

Book Demo Walkthrough

1. Authentication

Authenticate API client requests using secure bearer tokens. All endpoints require the Authorization: Bearer <token> header.

POST/api/v1/auth/login

Operational

Exchanges client credentials for a temporary JWT authorization token.

Request Payload (JSON)

{
  "client_id": "pk_live_8F1cE9...",
  "client_secret": "sk_live_9A3dD2..."
}

Response Payload (JSON)

{
  "status": "authenticated",
  "access_token": "eyJhbGciOiJIUzI1NiIsIn...",
  "expires_in": 3600
}

2. Core Calculations

Calculate dimensions, costs, and pricing structures on demand. Optimized for real-time CRM price queries.

POST/api/v1/quotes/calculate

Operational

Calculates board cost, surface area, structural weight, and margin markup based on FEFCO template styles.

Request Payload (JSON)

{
  "length_mm": 350,
  "width_mm": 250,
  "depth_mm": 150,
  "board_grade": "200B-C-Flute",
  "style_key": "FEFCO-0201",
  "quantity": 1000
}

Response Payload (JSON)

{
  "surface_area_sqm": 0.485,
  "net_weight_g": 320,
  "raw_material_cost": 0.85,
  "markup_applied": 1.35,
  "unit_price_usd": 1.15,
  "total_price_usd": 1150
}

3. Users Management

Create and manage active salesperson and cost estimator access profiles.

GET/api/v1/users

Operational

List all configured system users. Filterable by active role type (e.g. Sales, Estimator).

Response Payload (JSON)

[
  {
    "user_id": "usr_9D32F",
    "name": "Jane Miller",
    "email": "[email protected]",
    "role": "estimator",
    "status": "active"
  },
  {
    "user_id": "usr_10A8D",
    "name": "Mark R.",
    "email": "[email protected]",
    "role": "sales_representative",
    "status": "active"
  }
]

4. Client Contacts

Sync company profiles and client email contacts for quotation delivery hooks.

POST/api/v1/contacts

Operational

Registers a new client contact for pricing logs and delivery history hooks.

Request Payload (JSON)

{
  "company_name": "Midwest Distributors",
  "contact_email": "[email protected]",
  "vat_id": "US9418231"
}

Response Payload (JSON)

{
  "contact_id": "con_55B9A",
  "company_name": "Midwest Distributors",
  "status": "registered"
}

5. System Diagnostics

Retrieve deployment health metrics, database connectivity statuses, and license validation stats.

GET/api/v1/plants/status

Operational

Checks license keys status, database latency, and active container replication statuses.

Response Payload (JSON)

{
  "status": "healthy",
  "active_plants": 3,
  "database_latency_ms": 12,
  "license_key_valid": true,
  "checkin_timestamp": "2026-07-15T11:00:00Z"
}

DELETE/api/v1/cache

Operational

Forces a system recalculation check by flushing all cached raw material indexes and shipping profiles.

Response Payload (JSON)

{
  "cache_flushed": true,
  "keys_removed": 142,
  "timestamp": "2026-07-15T11:00:05Z"
}