4klyft API (1.0.0)
Commerce and order-fulfilment platform API for 4klyft.
This API provides endpoints for managing:
- Catalog (PIM/DAM): products, variants, attributes, options, categories, brands, collections, assortments, and media
- Sales: orders, customers, merchants, sales channels, and channel order import
- Inventory: stock items, levels, lots, and serial units across custodians
- Warehousing & Operations: goods receipt/issue, holds, and custodian operations
- Fulfilment: fulfilment orders dispatched to third-party (3PL) providers
- Shipping: carriers, shipments, labels, tracking, returns, and proof of delivery
- Finance & Billing: payments, settlements, invoices, credit notes, tax, and subscriptions
- Integration: sales-channel connections, providers, webhooks, and catalog/order sync
- Documents: operational document generation and requests
- Storage: file/drive storage with chunked upload and signed access
- Identity & Access (IAM): authentication, users, roles, permissions, and tenants
- Platform services: notifications, scheduling, numbering, data exchange, analytics, and workspace tables & views
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>
Every /api/ request is rate-limited per caller — by your authenticated identity when a token is present, otherwise by client IP. The authentication endpoints (/auth/login, /auth/refresh, /auth/request-password-reset) carry stricter, IP-based limits.
Each response advertises your current budget via headers:
X-RateLimit-Limit— the bucket sizeX-RateLimit-Remaining— tokens left in the current windowX-RateLimit-Reset— Unix timestamp when a token next frees up
Exceeding a limit returns 429 Too Many Requests (RFC 6585) with a Retry-After header (seconds to wait). Back off and retry after the indicated delay rather than hammering the endpoint.
Overview
4klyft API SupportLicense
Proprietary
Servers
https://api.4klyft.com