API docs by Redocly

4klyft API (1.0.0)

Download OpenAPI specification:

4klyft API Support: support@4klyft.com License: Proprietary

Logistics operations API for the 4klyft platform.

Overview

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

Authentication

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>

Rate Limiting

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

Error Handling

The API uses RFC 7807 Problem Details for error responses.

BillingInvoice

Resource 'BillingInvoice' operations.

Retrieves the collection of BillingInvoice resources.

Retrieves the collection of BillingInvoice resources.

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
{
  • "totalItems": 0,
  • "search": {
    },
  • "view": {
    },
  • "member": [
    ]
}

Retrieves a BillingInvoice resource.

Retrieves a BillingInvoice resource.

Authorizations:
Bearer
path Parameters
id
required
string

BillingInvoice identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": "string",
  • "number": "string",
  • "tenantId": "string",
  • "subscriptionId": "string",
  • "periodStartedAt": "string",
  • "periodEndsAt": "string",
  • "lineItems": [
    ],
  • "subtotalCents": 0,
  • "taxCents": 0,
  • "totalCents": 0,
  • "currency": "string",
  • "status": "string",
  • "issuedAt": "string",
  • "dueAt": "string",
  • "paidAt": "string",
  • "paymentMethod": "string",
  • "externalReference": "string",
  • "createdAt": "string"
}

BillingSubscription

Resource 'BillingSubscription' operations.

Retrieves a BillingSubscription resource.

Retrieves a BillingSubscription resource.

Authorizations:
Bearer

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": "string",
  • "tenantId": "string",
  • "planId": "string",
  • "status": "string",
  • "trialEndsAt": "string",
  • "currentPeriodStartedAt": "string",
  • "currentPeriodEndsAt": "string",
  • "cancellationRequestedAt": "string",
  • "cancellationEffectiveAt": "string",
  • "paymentMethodRef": "string",
  • "createdAt": "string"
}

Creates a BillingSubscription resource.

Creates a BillingSubscription resource.

Authorizations:
Bearer
Request Body schema:
required

The new BillingSubscription resource

reason
string or null

Optional cancellation reason for audit purposes.

Responses

Request samples

Content type
{
  • "reason": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": "string",
  • "tenantId": "string",
  • "planId": "string",
  • "status": "string",
  • "trialEndsAt": "string",
  • "currentPeriodStartedAt": "string",
  • "currentPeriodEndsAt": "string",
  • "cancellationRequestedAt": "string",
  • "cancellationEffectiveAt": "string",
  • "paymentMethodRef": "string",
  • "createdAt": "string"
}

Creates a BillingSubscription resource.

Creates a BillingSubscription resource.

Authorizations:
Bearer
Request Body schema:
required

The new BillingSubscription resource

planId
required
string

Responses

Request samples

Content type
{
  • "planId": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": "string",
  • "tenantId": "string",
  • "planId": "string",
  • "status": "string",
  • "trialEndsAt": "string",
  • "currentPeriodStartedAt": "string",
  • "currentPeriodEndsAt": "string",
  • "cancellationRequestedAt": "string",
  • "cancellationEffectiveAt": "string",
  • "paymentMethodRef": "string",
  • "createdAt": "string"
}

BillingUsageReport

Resource 'BillingUsageReport' operations.

Retrieves a BillingUsageReport resource.

Retrieves a BillingUsageReport resource.

Authorizations:
Bearer

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "tenantId": "string",
  • "from": "string",
  • "to": "string",
  • "totals": [
    ]
}