Skip to content

Configure Availability and Buyer-Review Integration

This integration lets tenant-operated middleware supply available-to-promise information to Configure and receive an explicit buyer-review request when a configured BOM has shortages. It is designed to complement an ERP, not reproduce one.

Boundary and ownership

Velosity calculates the configured BOM requirements and presents an availability snapshot. The tenant's middleware translates ERP-specific data and owns ERP credentials, item mappings, allocation policies, purchasing workflow, and retries on its side.

The ERP remains authoritative for inventory transactions, reservations, purchase orders, receiving, costing, and fulfillment. Neither of the interfaces below creates a PO or changes inventory.

Availability assessment

Use the authenticated tenant-scoped endpoint to assess up to 200 required components:

POST /v1/inventory/availability/assessments
Content-Type: application/json

{
  "requestID": "0e29cfd7-6a6c-437d-ae31-fa28c12e9554",
  "requestedAtUTC": "2026-09-02T15:00:00Z",
  "requirements": [
    {
      "itemID": "COMPONENT-001",
      "itemNumber": "BRACKET-10",
      "quantity": 12,
      "uOM": "EA"
    }
  ]
}

The response uses this stable provider-neutral shape:

{
  "source": "Tenant ERP middleware",
  "snapshotAtUTC": "2026-09-02T15:00:04Z",
  "isHealthy": true,
  "items": [
    {
      "itemID": "COMPONENT-001",
      "onHandQuantity": 10,
      "allocatedQuantity": 3,
      "availableQuantity": 7,
      "inboundQuantity": 20,
      "nextReceiptUTC": "2026-09-09T00:00:00Z",
      "uOM": "EA"
    }
  ]
}

availableQuantity should reflect the tenant's actual available-to-promise rule. allocatedQuantity, inboundQuantity, and nextReceiptUTC are optional, but should be provided when the ERP supports them. Always identify the source and snapshot time so a buyer can judge freshness.

Buyer-review webhook

Configure an outbound webhook in Setup > Webhooks with:

Setting Value
Entity Material Request
Event Created
Base URL and Resource Tenant middleware endpoint

The webhook is sent only when a Purchasing or Admin user explicitly selects Send to buyer review for a configuration with an actual shortage. It is not sent automatically as stock changes or while a user configures a product.

The body is a shortage notification:

{
  "notificationID": "e3d702d5-3a33-4f83-ba79-4472693f7c21",
  "productID": "PRODUCT-001",
  "productName": "Configured Assembly",
  "availabilitySource": "Tenant ERP middleware",
  "snapshotAtUTC": "2026-09-02T15:00:04Z",
  "items": [
    {
      "itemID": "COMPONENT-001",
      "itemNumber": "BRACKET-10",
      "description": "Mounting bracket",
      "uOM": "EA",
      "requiredQuantity": 12,
      "onHandQuantity": 10,
      "availableQuantity": 7,
      "shortfallQuantity": 5
    }
  ]
}

Treat notificationID as an idempotency key. Persist and deduplicate it before submitting a purchasing request or creating any ERP work item. Verify the existing Velosity webhook signature when a secret is configured, and return a successful response only after the request is durably accepted.

Middleware implementation checklist

  • Authenticate to Velosity with a tenant-scoped integration identity.
  • Maintain stable mappings between Velosity item IDs and ERP item identifiers.
  • Compute ATP using the ERP's reservation, allocation, and inbound-receipt rules.
  • Return source and snapshot time with every assessment.
  • Deduplicate buyer-review notifications by notificationID.
  • Keep purchase-order approval and creation in the ERP or purchasing workflow.
  • Monitor failed webhook deliveries and reconcile them with webhook logs.