TypeScript SDKCopy Anchor Link

Runtime: Node.js 18 or later, or a runtime with fetch.

Download the SDK.

Extract the archive's package directory to vendor/linkit. Import the compiled ESM entry shown below, or use dist/cjs/index.cjs from CommonJS. Type declarations are included in dist. The runtime has no third-party dependencies.

The typed orders service decodes snapshot/list envelopes and offers getCanonicalAsync, changesAsync and streamChanges. publicApi returns raw response data for all published routes. Request hooks apply to those calls too.

ConnectCopy Anchor Link

import { BaseLinkitClient, LinkitConfiguration } from './vendor/linkit/dist/esm/index.js';

const configuration = new LinkitConfiguration();
configuration.baseUrl = 'https://linkit.works';
const client = new BaseLinkitClient(configuration);
try {
    await client.initializeAsync(token);
    const orders = await client.publicApi.getV1Orders({ page: 1, limit: 50, format: 'canonical' });
    console.log(orders);
} finally {
    client.dispose();
}

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. An existing configuration.onBeforeRequest hook can attach that JSON body. 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