4klyft API (1.0.0)

This API provides comprehensive endpoints for managing:

• Routes & Execution: Create, manage, and execute delivery routes
• Shipments & Loads: Track shipments from pickup to delivery
• Fleet Management: Manage carriers, vehicles, and drivers
• Proof of Delivery: Capture signatures, photos, and delivery confirmations
• Settings: Configure system-wide and tenant-specific settings
• Webhooks: Subscribe to real-time event notifications
• Analytics: Access delivery performance metrics and reports

All API endpoints (except /api/docs and /api/v1/iam/auth/*) require JWT Bearer token authentication. Include the token in the Authorization header:

Authorization: Bearer <your-jwt-token>

API requests are rate-limited to ensure fair usage. Standard limits are:

• 1000 requests per minute for read operations
• 100 requests per minute for write operations

The API uses RFC 7807 Problem Details for error responses.

A purchase order — the buy-side counterpart of a Sales Order. Placed against a supplier, carries priced lines referencing purchased items by opaque ResourceUri, and moves through Draft → Approved → Issued → Acknowledged → PartiallyReceived → Received → Closed (or Cancelled).

Receiving is NOT a user action on this resource — to receive against a PO you create a Goods Receipt with the PO as its subject; the received quantities flow back onto the PO lines automatically.

A purchase return (return-to-vendor / RTV) — the buy-side mirror of the customer RMA. Returns goods to a supplier, optionally citing a source purchase order and/or inbound delivery, and moves through Draft → Approved → Issued → Completed (or Cancelled).

Issued is where goods physically leave back to the vendor; Completed is where a vendor debit note posts to Finance. Neither the physical (GoodsIssue) nor financial (debit note) leg is exposed on this resource yet — they are P1 follow-ups that attach to the Issued / Completed transitions.

A supplier (vendor) — the buy-side counterpart of a shipping Client. Links an existing Partner (carrying the Supplier role) to supplier-master fields: payment terms, lead time, and default currency.

Tenant-managed reference data.