Kotlin / JVM SDKCopy Anchor Link

Runtime: JVM 17 or later.

Download the SDK.

Extract the archive and add every JAR in lib to your application's classpath. It includes the client, Kotlin's standard library, OkHttp, serialization, coroutines and their runtime dependencies. The standalone client JAR is also available for applications that already provide those libraries.

Kotlin methods suspend while waiting for HTTP responses or concurrency permits. Java callers can use the existing *Blocking methods. orders provides canonical reads and cursor polling; publicApi returns JsonElement for every published operation. Close the client at application shutdown.

ConnectCopy Anchor Link

import sa.linkit.client.LinkitClient

suspend fun readOrders(token: String) {
    LinkitClient.quickSetup("https://linkit.works", token).use { client ->
        val order = client.orders.getById("order-record-id")
        println(order.id)
    }
}

API useCopy Anchor Link

Use the server origin, such as https://linkit.works, as the base URL. Pass IDs as stored; the SDK adds /api/v1 and escapes path parameters. A branch's iv_id, its record id, a product ID and a SKU's iv_id are different identifiers.

Create branches and products before the SKUs that refer to them. Create orders with existing tenant records and a stable source identity. Order reads return snapshot envelopes; canonical reads normalize channel, status, amounts and lines. Persist the change-feed cursor after processing a page. A 304 means no changes; a 410 requires a new snapshot and cursor.

The generated public API service covers all 136 published operations. It also exposes customer addresses and groups, catalog metadata, offers, payment flows, queue status, analytics and webhook subscription management. Consult the API reference for each request body's fields. A method's route coverage does not grant permission to call it.

POST and PATCH are sent once. GET, HEAD, OPTIONS, PUT and DELETE may be retried after transient failures. Confirm the result of an uncertain write before repeating it. Health and ping omit bearer authentication; system health requires it.

Branch creation uses the dashboard's wallet rules. Trial and grace accounts are exempt; later, a shortfall returns BILLING_INSUFFICIENT_WALLET_BALANCE with the required and available SAR amounts. Only successfully inserted new branches incur activation fees.

Order deletionCopy Anchor Link

The existing raw deleteOrdersBulk method has no body argument, so it cannot supply the order_ids required by bulk deletion. For individual deletes, call client.publicApi.deleteV1Orders(id) for each order and check each result; separate deletes are not an atomic batch.

API reference · Route coverage · All downloads